华为云用户手册

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 分页查询页码，表示从此页码开始查询。 最小值：0 最大值：999999 缺省值：0 limit 否 Integer 每页显示条目数量，最大数量999，超过999后只返回999（防止单页返回过大）。 最小值：1 最大值：999 缺省值：10

响应示例 状态码： 200 OK 用户操作结果。 { "data" : { "user_name" : "test_user", "user_id" : "f528b3337a724e0b9d7************", "result_code" : "SUC CES S", "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_CONNECTOR_ADMINISTRATOR", "ROLE_DATA_SENDER" ], "user_id" : "57125ads46e7cbcfa201************"}

请求参数 表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_SYSTEM_ADMINISTRATOR: 系统管理员 ROLE_CONNECTOR_ADMINISTRATOR: 连接器管理员 ROLE_BUSINESS_AUDIT: 连接器审计员 ROLE_DATA_APPROVER: 数据审批人 ROLE_RESOURCE_APPROVER: 资源审批人 ROLE_AGRT_APPROVER: 合约审批人 ROLE_TEAM_CREATOR: 团队创建人 ROLE_DATA_SENDER: 数据发送人 ROLE_RESOURCE_ADMINISTRATOR: 资源管理员 ROLE_DATA_CONSUMER: 数据消费者 ROLE_CONTRACT_ADMINISTRATOR: 合约管理员 ROLE_DATA_SOURCE_ADMINISTRATOR: 数据源管理员 枚举值： ROLE_SYSTEM_ADMINISTRATOR ROLE_CONNECTOR_ADMINISTRATOR ROLE_BUSINESS_AUDIT ROLE_DATA_APPROVER ROLE_RESOURCE_APPROVER ROLE_AGRT_APPROVER ROLE_TEAM_CREATOR ROLE_DATA_SENDER ROLE_RESOURCE_ADMINISTRATOR ROLE_DATA_CONSUMER ROLE_CONTRACT_ADMINISTRATOR ROLE_DATA_SOURCE_ADMINISTRATOR

响应参数 状态码： 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 错误描述。

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

响应参数 状态码： 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 错误描述。

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

URI POST /v1/{project_id}/eds/instances/{instance_id}/domains 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID，开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 domain_id 是 String 租户ID。 参数校验规则：最大长度50。 domain_name 是 String 租户名称。 参数校验规则：最大长度100。 iam_user_id 是 String 主用户ID。 参数校验规则：最大长度50。 iam_user_name 是 String 主用户名称。 参数校验规则：最大长度100。

响应参数 状态码： 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}/connectors/{connector_id}/retrieve 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID，开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 data String 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 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 表4 响应Body参数 参数 参数类型 描述 data Array of OfferResourceDetail objects 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 OfferResourceDetail 参数 参数类型 描述 resource_id String 资源ID。 resource_title String 资源名称。 resource_type String 资源的文件类型。 resource_category String 资源分类： DATASET： 数据集 FILE：文件 枚举值： DATASETS FILE artifacts Array of Artifact objects 数据清单。 resource_dataset_attribute_list Array of ResourceDatasetAttribute objects 数据集资源属性列表。 表6 Artifact 参数 参数类型 描述 data_resource_id String 所属资源ID。 artifact_id String 资产ID。 artifact_code String 资产编码。 artifact_title String 文件名称。 byte_size Long 文件大小。 media_type String 资产格式类型。 表7 ResourceDatasetAttribute 参数 参数类型 描述 attribute_code String 属性编码。 attribute_data_type String 数据类型。 length Integer 长度。 num_prec Integer 精度。 num_scale Integer 位数。 sort_order Integer 排序号。 real_data_type String 属性真实数据类型。 状态码： 400 表8 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码： 200 OK 资源列表。 { "data" : [ { "resource_id" : "25546208-0854-49a0-9023-************", "resource_title" : "JDBC_TEST", "resource_type" : "jdbc", "resource_category" : "DATASETS", "artifacts" : [ { "data_resource_id" : "25546208-0854-49a0-9023-************", "artifact_id" : "303b4f5f-596e-41c9-ad50-************", "artifact_code" : "Aconnector-****c95b3165df8742afa8c0************", "artifact_title" : "animals", "byte_size" : 16384, "media_type" : "jdbc" } ], "resource_dataset_attribute_list" : [ { "attribute_code" : "id", "attribute_data_type" : "INTEGER", "length" : null, "num_prec" : 10, "num_scale" : 0, "sort_order" : 0, "real_data_type" : "integer" }, { "attribute_code" : "animal_name", "attribute_data_type" : "STRING", "length" : 255, "num_prec" : null, "num_scale" : null, "sort_order" : 1, "real_data_type" : "varchar(255)" }, { "attribute_code" : "category", "attribute_data_type" : "STRING", "length" : 255, "num_prec" : null, "num_scale" : null, "sort_order" : 2, "real_data_type" : "varchar(255)" }, { "attribute_code" : "habitat", "attribute_data_type" : "STRING", "length" : 255, "num_prec" : null, "num_scale" : null, "sort_order" : 3, "real_data_type" : "varchar(255)" } ] } ], "total" : 0, "error_code" : null, "error_msg" : null}

URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/offers/{offer_id}/resources 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID，开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。 offer_id 是 String Offer ID。 参数校验规则：最小长度1，最大长度100000。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 最小值：0 最大值：999999 缺省值：0 limit 否 Integer 每页显示条目数量，最大数量999，超过999后只返回999（防止单页返回过大）。 最小值：1 最大值：999 缺省值：10

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data Array of SearchOfferFilter objects 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 SearchOfferFilter 参数 参数类型 描述 ownered_company_name String Offer所属的企业，即所属租户名。 ownered_connector Array of strings Offer所属连接器名。 状态码： 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}/broker/offers/filters 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID，开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 最小值：0 最大值：999999 缺省值：0 limit 否 Integer 每页显示条目数量，最大数量999，超过999后只返回999（防止单页返回过大）。 最小值：1 最大值：999 缺省值：10

响应示例 状态码： 200 OK 合约数据包列表。 { "data" : [ { "data_packet_name" : "演示合约1", "data_packet_id" : "44d2f35e-0371-433f-b5b6-************", "contract_id" : "AGRTconnector-****3b53a05caccd4c53b509************", "creator" : "************", "create_time" : "2023-12-05T20:24:42Z", "updater" : "************", "update_time" : "2023-12-05T20:24:42Z", "shared_company_name" : null, "shared_company_id" : null, "shared_connector_name" : "连接器A", "shared_connector_id" : "b40b0d94-3201-4687-93aa-************" }, { "data_packet_name" : "演示合约2", "data_packet_id" : "448e88db-70c0-430b-a195-************", "contract_id" : "AGRTconnector-****b252e8d809754d6aaef7************", "creator" : "0574abfba400d2a91f5ec01111a89fcf", "create_time" : "2023-11-29T10:06:40Z", "updater" : "************", "update_time" : "2023-11-29T10:06:40Z", "shared_company_name" : null, "shared_company_id" : null, "shared_connector_name" : "连接器A", "shared_connector_id" : "b40b0d94-3201-4687-93aa-************" } ], "total" : 2, "error_code" : null, "error_msg" : null}

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务“获取用户Token”接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：100000 x-eds-proxy-userid 否 String 如果X-Auth-Token是租户ID，那么x-eds-proxy-userid填写实际被代理的真实用户ID。 最小长度：0 最大长度：100000

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data Array of DataPackageResource objects 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 DataPackageResource 参数 参数类型 描述 data_packet_name String 数据包名称。 data_packet_id String 数据包ID。 contract_id String 合约ID。 creator String 创建人。 create_time String 创建时间。 updater String 更新人。 update_time String 更新时间。 shared_company_name String 数据包提供方所属的企业，即所属租户名。 shared_company_id String 数据包提供方所属的企业id，即所属租户id。 shared_connector_name String 数据包提供方所属的连接器，即所属连接器名。 shared_connector_id String 数据包提供方所属的连接器id，即所属连接器id。 状态码： 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}/contracts/received-data-resources 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID，开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。 表2 Query参数 参数 是否必选 参数类型 描述 scope 是 String 查询范围： ALL：所有 READ：已读 UNREAD：未读 枚举值： ALL READ UNREAD offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 最小值：0 最大值：999999 缺省值：0 limit 否 Integer 每页显示条目数量，最大数量999，超过999后只返回999（防止单页返回过大）。 最小值：1 最大值：999 缺省值：10

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 data OfferDetail object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表4 OfferDetail 参数 参数类型 描述 offer_id String Offer ID。 offer_name String offer名称。 offer_status String offer状态： APPROVING： 审批中 APPROVE_REJECTED：审批拒绝 ON_BOARDING：上架中 ON_BOARD：已上架 ON_BOARD_FAILED：上架失败 OFF_BOARDING：下架中 OFF_BOARD：已下架 OFF_BOARD_FAILED：下架失败 offer_resources Array of OfferResource objects offer关联的资源信息。 数组长度：0 - 9999 subscription_type String 订阅类型： OPEN_DATA：公开数据 CONTROLLED_DATA：受控数据 need_approval Boolean 是否需要审批。 注：开启【需要审批】后，下载合约资源的加工产物时需要审批。 can_terminate Boolean 是否允许提供方删除数据。 use_control_policies_template Array of UseControlPoliciesInner objects 合约使用控制策略列表。 mask_sensitive Array of MaskSensitive objects 结构化数据列脱敏信息。 表5 OfferResource 参数 参数类型 描述 resource_id String 资源ID。 resource_title String 资源名称。 resource_type String 资源的文件类型。 resource_category String 资源分类： DATASET： 数据集 FILE：文件 枚举值： DATASETS FILE 表6 UseControlPoliciesInner 参数 参数类型 描述 action String 执行动作过滤： VIEW：查看 MODIFY：加工 DOWNLOAD：下载 枚举值： VIEW MODIFY DOWNLOAD when TimeInterval object 限制使用时间。 how_many Integer 限制使用次数。 参数校验规则：最小值1，最大值10000。 where Where object 限制地点列表。 who Array of strings 限制用户/团队列表。（目前不支持多个用户或者团队） user_type String 限制用户类型。（团队订阅时who和user_type必填） USER ：指定用户 TEAM ：指定团队 枚举值： USER TEAM application Array of strings 限制应用列表。 additional_attributes DatabaseAttributes object 策略的扩展属性。 表7 TimeInterval 参数 参数类型 描述 start_time String 起始时间，UTC时间格式。 end_time String 截止时间，UTC时间格式。 表8 Where 参数 参数类型 描述 device_ip Array of strings 限定访问IP。 device_mac Array of strings 限定访问设备MAC。 表9 DatabaseAttributes 参数 参数类型 描述 column String 可见列。 rows Array of RowDTO objects 可见行。 表10 RowDTO 参数 参数类型 描述 column_name String 参数名称，需要与condition、value配合生效。 condition String 参数条件，需要与column_name、value配合生效。 value String 参数条件值，需要与column_name、condition配合生效。 表11 MaskSensitive 参数 参数类型 描述 attribute_code String 属性code。 reserve_head_len Integer 首端保留长度。 最大值：5000 reserve_tail_len Integer 尾端保留长度。 最大值：5000 状态码： 400 表12 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表13 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码： 200 OK Offer详情。 { "data" : { "offer_id" : "fbf85846-3782-46dc-affb-************", "offer_name" : "offer-mysql-20231129AA", "offer_status" : "ON_BOARD", "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" : { "device_ip" : [ ], "device_mac" : [ ] }, "who" : [ ], "user_type" : null, "application" : [ "22aac118-d58e-4324-9d41-************" ], "additional_attributes" : { "column" : "", "rows" : [ ] } }, { "action" : "DOWNLOAD", "when" : { "start_time" : "2023-11-29T10:19:03Z", "end_time" : "2023-12-29T10:19:03Z" }, "how_many" : null, "where" : { "device_ip" : [ ], "device_mac" : [ ] }, "who" : [ ], "user_type" : null, "application" : [ "dae4237f-9880-4fb9-a618-************" ], "additional_attributes" : { "column" : "", "rows" : [ ] } } ], "mask_sensitive" : null }, "total" : 0, "error_code" : null, "error_msg" : null}

URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/offers/{offer_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID，开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。 offer_id 是 String Offer ID。 参数校验规则：最小长度1，最大长度50，匹配字母、数字和符号-。

状态码 状态码如表1所示 表1 状态码 状态码 编码 错误码说明 100 Continue 继续请求。 这个临时响应用来通知客户端，它的部分请求已经被服务器接收，且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如，切换到HTTP的新版本协议。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求，但未处理完成。 203 Non-Authoritative Information 非授权信息，请求成功。 204 NoContent 请求完全成功，同时HTTP响应不包含响应体。 在响应OPTIONS方法的HTTP请求时返回此状态码。 205 Reset Content 重置内容，服务器处理成功。 206 Partial Content 服务器成功处理了部分GET请求。 300 Multiple Choices 多种选择。请求的资源可包括多个位置，相应可返回一个资源特征与地址的列表用于用户终端（例如：浏览器）选择。 301 Moved Permanently 永久移动，请求的资源已被永久的移动到新的URI，返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址。 使用GET和POST请求查看。 304 Not Modified 所请求的资源未修改，服务器返回此状态码时，不会返回任何资源。 305 Use Proxy 所请求的资源必须通过代理访问。 306 Unused 已经被废弃的HTTP状态码。 400 BadRequest 非法请求。 建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 402 Payment Required 保留请求。 403 Forbidden 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 404 NotFound 所请求的资源不存在。 建议直接修改该请求，不要重试该请求。 405 MethodNotAllowed 请求中带有该资源不支持的方法。 建议直接修改该请求，不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证，与401类似，但请求者应当使用代理进行授权。 408 Request Time-out 服务器等候请求时发生超时。 客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。 返回该状态码，表明请求的资源已被永久删除。 411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息。 412 Precondition Failed 未满足前提条件，服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大，服务器无法处理，因此拒绝请求。为防止客户端的连续请求，服务器可能会关闭连接。如果只是服务器暂时无法处理，则会包含一个Retry-After的响应信息。 414 Request-URI Too Large 请求的URI过长（URI通常为网址），服务器无法处理。 415 Unsupported Media Type 服务器无法处理请求附带的媒体格式。 416 Requested range not satisfiable 客户端请求的范围无效。 417 Expectation Failed 服务器无法满足Expect的请求头信息。 422 UnprocessableEntity 请求格式正确，但是由于含有语义错误，无法响应。 429 TooManyRequests 表明请求超出了客户端访问频率的限制或者服务端接收到多于它能处理的请求。建议客户端读取相应的Retry-After首部，然后等待该首部指出的时间后再重试。 500 InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能，无法完成请求。 502 Bad Gateway 充当网关或代理的服务器，从远端服务器接收到了一个无效的请求。 503 ServiceUnavailable 被请求的服务无效。 建议直接修改该请求，不要重试该请求。 504 ServerTimeout 请求在给定的时间内无法完成。客户端仅在为请求指定超时（Timeout）参数时会得到该响应。 505 HTTP Version not supported 服务器不支持请求的HTTP协议的版本，无法完成处理。 父主题： 附录

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 data ContractDetail object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表4 ContractDetail 参数 参数类型 描述 contract_id String 合约ID。 contract_name String 合约名称。 contract_description String 合约描述。 owner_connector_id String 提供者连接器ID。 owner_connector_name String 提供者连接器名称。 subscribe_connector_id String 订阅连接器ID。 subscribe_connector_name String 订阅连接器名称。 subscriber_name String 订阅人名称。 subscriber_id String 订阅人ID。 approver_id String 审批人ID。 approver_name String 审批人名称。 offer_id String Offer ID。 offer_name String offer名称。 transactional_mode String 交换模式： PEER_TO_PEER： 点对点 SUBSCRIBE：订阅 枚举值： PEER_TO_PEER SUBSCRIBE status String 合约状态： APPROVING： 审批中 RUNNING：数据传输中 SUCCESS：成功 FAILED：失败 CLOSED：到期关闭 TERMINATED：已终止 REJECTED：审批驳回 枚举值： APPROVING RUNNING SUCCESS FAILED CLOSED TERMINATED REJECTED create_time String 创建时间。 need_approval Boolean 是否需要审批。 注：开启【需要审批】后，下载合约资源的加工产物时需要审批。 can_terminate Boolean 是否允许提供方删除数据。 use_control_policies Array of UseControlPoliciesInner objects 合约使用控制策略列表。 artifacts Array of Artifact objects 合约资产列表。 表5 UseControlPoliciesInner 参数 参数类型 描述 action String 执行动作过滤： VIEW：查看 MODIFY：加工 DOWNLOAD：下载 枚举值： VIEW MODIFY DOWNLOAD when TimeInterval object 限制使用时间。 how_many Integer 限制使用次数。 参数校验规则：最小值1，最大值10000。 where Where object 限制地点列表。 who Array of strings 限制用户/团队列表。（目前不支持多个用户或者团队） user_type String 限制用户类型。（团队订阅时who和user_type必填） USER ：指定用户 TEAM ：指定团队 枚举值： USER TEAM application Array of strings 限制应用列表。 additional_attributes DatabaseAttributes object 策略的扩展属性。 表6 TimeInterval 参数 参数类型 描述 start_time String 起始时间，UTC时间格式。 end_time String 截止时间，UTC时间格式。 表7 Where 参数 参数类型 描述 device_ip Array of strings 限定访问IP。 device_mac Array of strings 限定访问设备MAC。 表8 DatabaseAttributes 参数 参数类型 描述 column String 可见列。 rows Array of RowDTO objects 可见行。 表9 RowDTO 参数 参数类型 描述 column_name String 参数名称，需要与condition、value配合生效。 condition String 参数条件，需要与column_name、value配合生效。 value String 参数条件值，需要与column_name、condition配合生效。 表10 Artifact 参数 参数类型 描述 data_resource_id String 所属资源ID。 artifact_id String 资产ID。 artifact_code String 资产编码。 artifact_title String 文件名称。 byte_size Long 文件大小。 media_type String 资产格式类型。 状态码： 400 表11 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表12 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码： 200 OK 合约详情。 { "data" : { "contract_id" : "AGRTconnector-****3b53a05caccd4c53b509************", "contract_name" : "测试合约3", "contract_description" : "OpenApi demo.", "owner_connector_id" : "b40b0d94-3201-4687-93aa-************", "owner_connector_name" : "连接器A", "subscribe_connector_id" : "c1bf9bd7-52fc-435b-ae55-************", "subscribe_connector_name" : "连接器B", "subscriber_name" : "************", "subscriber_id" : "************", "approver_id" : "************", "approver_name" : "************", "offer_id" : "fbf85846-3782-46dc-affb-************", "offer_name" : "offer-mysql-20231129AA", "transactional_mode" : "SUBSCRIBE", "status" : "SUCCESS", "create_time" : "2023-12-05T20:24:37Z", "need_approval" : false, "can_terminate" : true, "use_control_policies" : [ { "action" : "VIEW", "when" : { "start_time" : "2023-12-05T20:24:37Z", "end_time" : "2023-12-25T20:24:37Z" }, "how_many" : null, "where" : { "device_ip" : [ ], "device_mac" : [ ] }, "who" : [ "************" ], "user_type" : null, "application" : [ "321ac118-758e-4324-9d41-************" ], "additional_attributes" : { "column" : "", "rows" : [ ] } }, { "action" : "MODIFY", "when" : { "start_time" : "2023-12-05T20:24:37Z", "end_time" : "2023-12-25T20:24:37Z" }, "how_many" : null, "where" : { "device_ip" : [ ], "device_mac" : [ ] }, "who" : [ "************" ], "user_type" : null, "application" : [ "321ac118-758e-4324-9d41-************" ], "additional_attributes" : { "column" : "", "rows" : [ ] } }, { "action" : "DOWNLOAD", "when" : { "start_time" : "2023-12-05T20:24:37Z", "end_time" : "2023-12-25T20:24:37Z" }, "how_many" : null, "where" : { "device_ip" : [ ], "device_mac" : [ ] }, "who" : [ "************" ], "user_type" : null, "application" : [ "321ac118-758e-4324-9d41-************" ], "additional_attributes" : { "column" : "", "rows" : [ ] } } ], "artifacts" : [ { "data_resource_id" : "25546208-0854-49a0-9023-************", "artifact_id" : "303b4f5f-596e-41c9-ad50-************", "artifact_code" : null, "artifact_title" : "animals", "byte_size" : 16384, "media_type" : "jdbc" } ] }, "total" : 0, "error_code" : null, "error_msg" : null}

URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/contracts/{contract_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID，开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。 contract_id 是 String 合约ID。 参数校验规则：最小长度1，最大长度50，匹配字母、数字和符号-。

响应示例 状态码： 200 OK 订阅Offer返回体。 { "offer_id" : "834ed288-d8e1-4b70-9ed1-6744329955a8", "offer_name" : "上架Offer测试023", "subscription_id" : "8d9dec24-3bb9-47c2-ac6f-0a3d9e308d5a", "subscription_reason" : "同意一下", "status" : "WAIT_TO_APPROVE", "create_time" : "2023-12-07T09:11:36Z", "creator" : "0574abfba400d2a91f5ec01111a89fcf"}