华为云用户手册

请求示例 合约资产使用控制策略执行。 GET https://{endpoint}/v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/contracts/{contract_id}/policy/validation?action=DOWNLOAD&app_id=70d5c8d0-fe76-4cf0-9d30-********

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码： 200 successful operation 连接器列表。 { "data" : [ { "connector_id" : "c1bf9bd7-52fc-435b-ae55-************", "connector_name" : "连接器B" }, { "connector_id" : "b40b0d94-3201-4687-93aa-************", "connector_name" : "连接器A" } ], "total" : 2, "error_code" : null, "error_msg" : null }

URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID，开通的数据交换平台实例ID。 获取方法请参考获取实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 type 是 String 查询类型。 枚举值： ADMIN offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 最小值：0 最大值：999999 缺省值：0 limit 否 Integer 每页显示条目数量，最大数量999，超过999后只返回999 （当前华为云规范防止单页返回过大）。 最小值：0 最大值：999 缺省值：10

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data Array of ConnectorInfo objects 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 ConnectorInfo 参数 参数类型 描述 connector_id String 连接器ID。 connector_name String 连接器名称。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码： 200 OK Offer列表 { "data" : [ { "offer_id" : "e49cc59d-48a7-46b2-bfea-************", "offer_code" : "Fconnector-****88ad1de6fc124c519e56************", "offer_name" : "offer1", "offer_description" : "", "create_time" : "2023-12-01T15:06:48Z", "offer_status" : "ON_BOARD" }, { "offer_id" : "fbf85846-3782-46dc-affb-************", "offer_code" : "Fconnector-****1fc857ef325a4a458042************", "offer_name" : "offer2", "offer_description" : "", "create_time" : "2023-11-29T10:19:53Z", "offer_status" : "ON_BOARD" } ], "total" : 2, "error_code" : null, "error_msg" : null }

URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/offers 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String 实例ID，开通的数据交换平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定数据交换平台下连接器的ID。 获取方法请参考获取连接器ID。 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offer_name 否 String offer名称。 offer_status 否 String offer状态（默认返回已上架offer）： APPROVING： 审批中 APPROVE_REJECTED：审批拒绝 ON_BOARDING：上架中 ON_BOARD：已上架 ON_BOARD_FAILED：上架失败 OFF_BOARDING：下架中 OFF_BOARD：已下架 OFF_BOARD_FAILED：下架失败 枚举值： APPROVING APPROVE_REJECTED ON_BOARDING ON_BOARD ON_BOARD_FAILED OFF_BOARDING OFF_BOARD OFF_BOARD_FAILED offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 最小值：0 最大值：999999 缺省值：0 limit 否 Integer 每页显示条目数量，最大数量999，超过999后只返回999 （当前华为云规范防止单页返回过大）。 最小值：0 最大值：999 缺省值：10

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data Array of Offer objects 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 Offer 参数 参数类型 描述 offer_id String Offer ID。 offer_code String offer编码。 offer_name String offer名称。 offer_description String offer描述。 create_time String offer创建时间。 offer_status String offer状态： APPROVING： 审批中 APPROVE_REJECTED：审批拒绝 ON_BOARDING：上架中 ON_BOARD：已上架 ON_BOARD_FAILED：上架失败 OFF_BOARDING：下架中 OFF_BOARD：已下架 OFF_BOARD_FAILED：下架失败 枚举值： APPROVING APPROVE_REJECTED ON_BOARDING ON_BOARD ON_BOARD_FAILED OFF_BOARDING OFF_BOARD OFF_BOARD_FAILED 状态码： 400 表6 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/offers/{offer_id} 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String 实例ID，开通的数据交换平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定数据交换平台下连接器的ID。 获取方法请参考获取连接器ID。 offer_id 是 String Offer ID。 project_id 是 String 项目ID。 获取方法请参考获取项目ID。

响应示例 状态码： 200 OK Offer详情。 { "data" : { "offer_id" : "fbf85846-3782-46dc-affb-************", "offer_name" : "offer-mysql-20231129AA", "offer_resources" : [ { "resource_id" : "25546208-0854-49a0-9023-************", "resource_title" : "mysqlteset20231120184721", "resource_type" : null, "resource_category" : null } ], "need_approval" : false, "can_terminate" : true, "use_control_policies_template" : [ { "action" : "VIEW", "when" : { "start_time" : "2023-11-29T10:19:03Z", "end_time" : "2023-12-29T10:19:03Z" }, "how_many" : null, "where" : [ ], "who" : [ ], "application" : [ "22aac118-d58e-4324-9d41-************" ], "additional_attributes" : { "column" : "id,animal_name,category" } }, { "action" : "DOWNLOAD", "when" : { "start_time" : "2023-11-29T10:19:03Z", "end_time" : "2023-12-29T10:19:03Z" }, "how_many" : null, "where" : [ ], "who" : [ ], "application" : [ "dae4237f-9880-4fb9-a618-************" ], "additional_attributes" : { "column" : "id,animal_name,category" } } ], "mask_sensitive" : [ { "attribute_code" : "animal_name", "reserve_head_len" : 1, "reserve_tail_len" : 1 } ] }, "total" : 0, "error_code" : null, "error_msg" : null }

响应示例 状态码： 200 OK 用户操作结果。 { "data" : { "user_name" : "test_user", "user_id" : "f528b3337a724e0b9d7************", "result_code" : "SUCCESS", "result_description" : "success" }, "total" : 0, "error_code" : null, "error_msg" : null }

请求示例 添加连接器用户。 POST https://{endpoint}/v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/users { "role_list" : [ "ROLE_DATA_RECEIVER", "ROLE_CONNECTOR_OPERATOR" ], "user_id" : "57125ads46e7cbcfa201************" }

URI POST /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/users 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String 实例ID，开通的数据交换平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定数据交换平台下连接器的ID。 获取方法请参考获取连接器ID。 project_id 是 String 项目ID。 获取方法请参考获取项目ID。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data UserInfo object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 UserInfo 参数 参数类型 描述 user_name String IAM用户名。 user_id String IAM用户ID。 result_code String 用户操作结果返回码。 枚举值： SUCCESS FAILED result_description String 用户操作结果描述。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 user_id 是 String IAM用户ID。 role_list 是 Array of strings 角色列表： ROLE_DATA_VIEWER：数据查看者 ROLE_DATA_OPERATOR：数据操作者 ROLE_CONTRACT_APPROVER：数据接收者 ROLE_OFFER_APPROVER：合约审批人 ROLE_CONNECTOR_AUDITOROffer：审批人 ROLE_CONNECTOR_AUDITOR：连接器配置员 ROLE_DATA_RECEIVER：审计员 枚举值： ROLE_DATA_VIEWER ROLE_DATA_OPERATOR ROLE_DATA_RECEIVER ROLE_CONTRACT_APPROVER ROLE_OFFER_APPROVER ROLE_CONNECTOR_OPERATOR ROLE_CONNECTOR_AUDITOR

响应示例 状态码： 200 OK 操作结果。 { "data" : { "operation_id" : "90bedec2-2efc-41d4-8223-************", "result_code" : "SUCCESS", "result_description" : "Revoke subscription success." }, "total" : 0, "error_code" : null, "error_msg" : null }

URI DELETE /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/subscriptions/{subscription_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID，开通的数据交换平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定数据交换平台下连接器的ID。 获取方法请参考获取连接器ID。 subscription_id 是 String 订阅ID。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 data OperationResult object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表4 OperationResult 参数 参数类型 描述 operation_id String 操作资源ID。 result_code String 操作结果返回码： SUCCESS：操作成功 FAILED：操作失败 枚举值： SUCCESS FAILED result_description String 操作结果描述。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data String 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

URI POST /v1/{project_id}/eds/instances/{instance_id}/domains 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String 实例ID，开通的数据交换平台实例ID。 获取方法请参考获取实例ID。 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 domain_id 是 String 租户ID。 domain_name 是 String 租户名称。

URI POST /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/contracts 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String 实例ID，开通的数据交换平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定数据交换平台下连接器的ID。 获取方法请参考获取连接器ID。 project_id 是 String 项目ID。 获取方法请参考获取项目ID。

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 data ContractResult object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表6 ContractResult 参数 参数类型 描述 contract_id String 合约ID。 contract_name String 合约名称。 result_code String 操作结果返回码： SUCCESS：操作成功 FAILED：操作失败 枚举值： SUCCESS FAILED result_description String 操作结果描述。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

请求示例 提交合约。 POST https://{endpoint}/v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/contracts { "contract_name" : "测试合约3", "approver_id" : "************", "offer_id" : "fbf85846-3782-46dc-affb-************", "owner_connector_id" : "b40b0d94-3201-4687-93aa-************", "subscribe_connector_id" : "c1bf9bd7-52fc-435b-ae55-************", "subscriber_id" : "************", "need_approval" : false, "can_terminate" : true, "use_control_policies" : [ { "action" : "VIEW", "when" : { "start_time" : "2023-11-16T18:18:14Z", "end_time" : "2023-12-16T18:18:14Z" }, "how_many" : null, "where" : [ ], "who" : [ "************" ], "application" : [ "321ac118-758e-4324-9d41-************" ], "additional_attributes" : { "column" : "id,category", "column02" : "id,animal_name,category", "rows" : [ { "column_name" : "id", "condition" : "!=", "value" : "1" } ] } }, { "action" : "DOWNLOAD", "when" : { "start_time" : "2023-11-16T18:18:14Z", "end_time" : "2023-12-16T18:18:14Z" }, "how_many" : null, "where" : [ ], "who" : [ "************" ], "application" : [ "dae4237f-9880-4fb9-a618-************" ], "additional_attributes" : { } }, { "action" : "MODIFY", "when" : { "start_time" : "2023-11-16T18:18:14Z", "end_time" : "2023-12-16T18:18:14Z" }, "how_many" : null, "where" : [ ], "who" : [ "************" ], "application" : [ "dae4237f-9880-4fb9-a618-************" ], "additional_attributes" : { } } ], "contract_description" : "OpenApi demo." }

响应示例 状态码： 200 OK 提交合约返回结构体。 { "data" : { "contract_id" : "AGRTconnector-****3b53a05caccd4c53b509************", "contract_name" : "测试合约3", "result_code" : "SUCCESS", "result_description" : "success" }, "total" : 0, "error_code" : null, "error_msg" : null }

URI PUT /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/contracts/{contract_id} 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String 实例ID，开通的数据交换平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定数据交换平台下连接器的ID。 获取方法请参考获取连接器ID。 contract_id 是 String 合约ID。 project_id 是 String 项目ID。 获取方法请参考获取项目ID。

响应示例 状态码： 200 OK 合约操作结果 { "data" : { "contract_id" : "AGRTconnector-****3b53a05caccd4c53b509************", "contract_name" : "测试合约3", "result_code" : "SUCCESS", "result_description" : "Cancel contract success." }, "total" : 0, "error_code" : null, "error_msg" : null }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 data ContractResult object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表4 ContractResult 参数 参数类型 描述 contract_id String 合约ID。 contract_name String 合约名称。 result_code String 操作结果返回码： SUCCESS：操作成功 FAILED：操作失败 枚举值： SUCCESS FAILED result_description String 操作结果描述。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

请求示例 审批请求体。 POST https://{endpoint}/v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/subscriptions/approvals { "approval_result" : "true", "approval_reason" : "审批通过", "request_id" : "7343b305-75f9-4979-ade0-********", "contract_name" : "测试合约4" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 contract_id String 合约ID。 contract_name String 合约名称。 result_code String 审批操作结果返回码。 result_description String 审批操作结果描述。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码： 200 OK 审批操作结果。 { "contract_id" : "AGRTconnector-****6b51ae804e0347c2b348************", "contract_name" : "测试合约4", "result_code" : "200", "result_description" : "Approval succeeded." }