华为云用户手册

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

响应参数 状态码： 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 String Offer所属连接器名。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 data - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 data - 返回null。 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

URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/audit-logs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID，开通的数据交换平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定数据交换平台下连接器的ID。 获取方法请参考获取连接器ID。 表2 Query参数 参数 是否必选 参数类型 描述 connector_keywords 否 String 连接器名称过滤关键字。 user_keywords 否 String 用户名称过滤关键字。 action 否 String 执行动作过滤： VIEW：查看 MODIFY：加工 DOWNLOAD：下载 枚举值： VIEW MODIFY DOWNLOAD start_time 否 String 发生时间。 end_time 否 String 结束时间。 offset 否 Integer 分页查询页码，表示从此页码开始查询，offset大于等于0。 最小值：0 最大值：999999 缺省值：0 limit 否 Integer 每页显示条目数量，最大数量999，超过999后只返回999（防止单页返回过大）。 最小值：1 最大值：999 缺省值：10

响应示例 状态码： 200 OK 审计日志列表。 { "data" : [ { "audit_log_id" : "2a178fd057834c13a457************", "resource_id" : "bdcfd032-fe52-448b-a673-************", "resource_name" : "三清山.jpg", "customer_user_id" : null, "customer_user_name" : null, "customer_connector_id" : "c1bf9bd7-52fc-435b-ae55-************", "customer_connector_name" : "连接器B", "happend_time" : "2023-12-01T16:10:28Z", "action" : "VIEW", "description" : null }, { "audit_log_id" : "74ae9d9af228437e89ad************", "resource_id" : "7c9cafa2-0eb0-4dae-bd8d-************", "resource_name" : "三清山.jpg", "customer_user_id" : null, "customer_user_name" : null, "customer_connector_id" : "c1bf9bd7-52fc-435b-ae55-************", "customer_connector_name" : "连接器B", "happend_time" : "2023-12-01T15:09:36Z", "action" : "VIEW", "description" : null } ] }

响应示例 状态码： 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}/broker/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，待查询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 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 - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 data - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/teams 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID，开通的数据交换平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定数据交换平台下连接器的ID。 获取方法请参考获取连接器ID。 表2 Query参数 参数 是否必选 参数类型 描述 team_name 否 String 团队名称。 参数校验规则：只能包含英文字母、数字、下划线、中文及-，并且只能以中文和英文开头，最小长度1，最大长度100。 offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 最小值：0 最大值：999999 缺省值：0 limit 否 Integer 每页显示条目数量，最大数量999，超过999后只返回999（防止单页返回过大）。 最小值：1 最大值：999 缺省值：10

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data Array of TeamInfo objects 团队详情。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 TeamInfo 参数 参数类型 描述 team_id String 团队ID team_name String 团队名称 状态码： 400 表6 响应Body参数 参数 参数类型 描述 data - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 data - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码： 200 OK 资源列表。 { "data" : [ { "team_id": "40**********67bd9fc", "team_name": "测试3" }, { "team_id": "ffac5**********e54a1b78", "team_name": "测试2" } ], "total" : 2, "error_code" : null, "error_msg" : null }

响应示例 状态码： 200 OK Offer列表 { "data" : [ { "offer_id" : "29146bc7-c5ab-4369-8611-************", "offer_name" : "offer20231121AC-EXCEL", "offer_type" : 2, "need_approval" : null, "can_terminate" : null, "ownered_company_name" : null, "ownered_company_id" : null, "ownered_connector_name" : "连接器A", "ownered_connector_id" : "b40b0d94-3201-4687-93aa-************", "offer_creator_name" : null, "offer_creator_id" : null, "offer_description" : "", "offer_followed_info" : { "offer_subscription" : true, "offer_favorite" : true, "offer_subscription_num" : 2, "offer_favorite_num" : 0, "offer_view_num" : 1 }, "mask_sensitive" : null, "use_control_policies_template" : null } ] }

URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/broker/offers 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID，开通的数据交换平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定数据交换平台下连接器的ID。 获取方法请参考获取连接器ID。 表2 Query参数 参数 是否必选 参数类型 描述 key_words 否 String 搜索的关键字，如果是多个关键字，通过空格分开，例如：上架次数；默认为全量搜索。 ownered_company_name 否 String 限定租户名，即限定企业。 ownered_connector_name 否 String 限定连接器名。 offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 最小值：0 最大值：999999 缺省值：0 limit 否 Integer 每页显示条目数量，最大数量999，超过999后只返回999（防止单页返回过大）。 最小值：1 最大值：999 缺省值：10

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data Array of OfferSummary objects 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 OfferSummary 参数 参数类型 描述 offer_id String Offer ID。 offer_name String Offer名称。 offer_type Integer Offer公开范围：公开-1、受控-2。 need_approval Boolean 是否需要审批。 注：开启【需要审批】后，下载合约资源的加工产物时需要审批。 can_terminate Boolean 是否允许提供方删除数据。 ownered_company_name String Offer所属的企业，即所属租户名。 ownered_company_id String Offer所属的企业ID，即所属租户ID。 ownered_connector_name String Offer所属的连接器，即所属连接器名。 ownered_connector_id String Offer所属的连接器ID，即所属连接器id。 offer_creator_name String Offer创建者名称。 offer_creator_id String Offer创建者ID。 offer_description String Offer描述。 offer_followed_info OfferFollowed object Offer引用信息。 mask_sensitive Array of MaskSensitive objects 结构化数据列脱敏信息。 use_control_policies_template Array of UseControlPoliciesInner objects 合约使用控制策略列表。 表6 OfferFollowed 参数 参数类型 描述 offer_subscription Boolean Offer订阅状态。 offer_favorite Boolean Offer收藏状态。 offer_subscription_num Integer Offer订阅次数。 offer_favorite_num Integer Offer收藏次数。 offer_view_num Integer Offer查看次数。 表7 MaskSensitive 参数 参数类型 描述 attribute_code String 属性code。 reserve_head_len Integer 首端保留长度。 reserve_tail_len Integer 尾端保留长度。 表8 UseControlPoliciesInner 参数 参数类型 描述 action String 执行动作过滤： VIEW：查看 MODIFY：加工 DOWNLOAD：下载 枚举值： VIEW MODIFY DOWNLOAD when TimeInterval object 限制使用时间。 how_many Integer 限制使用次数。 where Array of strings 限制地点列表。 who Array of strings 限制用户列表。 application Array of strings 限制应用列表。 additional_attributes DatabaseAttributes object 策略的扩展属性。 user_type String 限制用户类型。 USER ：指定用户 TEAM ：指定团队 枚举值： USER TEAM 表9 TimeInterval 参数 参数类型 描述 start_time String 起始时间。 end_time String 截止时间。 表10 DatabaseAttributes 参数 参数类型 描述 column String 可见行。 rows Arrays of RowDTO 可见列。 表11 RowDTO 参数 参数类型 描述 column_name String 参数名称。 condition String 参数条件。 value String 参数条件值。 状态码： 400 表12 响应Body参数 参数 参数类型 描述 data - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表13 响应Body参数 参数 参数类型 描述 data - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码： 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 }

响应参数 状态码： 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 - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 data - 返回null。 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 表4 响应Body参数 参数 参数类型 描述 data Array of ApplicationTemplate objects 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 ApplicationTemplate 参数 参数类型 描述 id String 应用模板ID。 name String 应用模板名称。 description String 应用模板描述。 type String 应用模板类型： STRUCTURED：支持jdbc、csv下载 TRUSTED_ENV：支持可信环境下载 LOCAL_DOWN：支持本地下载 LUCKY_EXCEL：支持excel本地预览 UNSTRUCTURED：支持 obs sftp ftp下载 PDF_JS：支持pdf本地预览 STRUCTURED_VIEW：支持csv jdbc本地预览 WPS：wps应用 IMAGE_VIEWER：本地图片查看 枚举值： STRUCTURED TRUSTED_ENV LOCAL_DOWN LUCKY_EXCEL UNSTRUCTURED PDF_JS STRUCTURED_VIEW WPS IMAGE_VIEWER self Boolean 资源是否是自己的。 natives Boolean 是否内置应用, true内置，false自创。 operation Array of strings 限制使用的操作。 枚举值： VIEW PRO CES S DOWNLOAD status String 状态： NORMAL：正常使用状态 DISABLE：停用状态，不再分配给新的eds实例 枚举值： NORMAL DISABLE icon String 应用图标。 create_time String 创建时间。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 data - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 data - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/applications/templates 表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" : [ { "id" : "234ac118-d58e-4324-9d41-************", "name" : "PDF_JS", "description" : "用于预览PDF文件，仅供测试", "type" : "PDF_JS", "self" : null, "natives" : true, "operation" : [ "VIEW" ], "status" : "NORMAL", "icon" : "icon: data:image/png;base64,iVBORw0KGgoAAAAN*** // ***代表省略的图标编码", "create_time" : "2023-05-23T21:37:02Z" }, { "id" : "234c118-758e-4324-9d41-************", "name" : "本地下载", "description" : "用于将文件下载到本地", "type" : "LOCAL_DOWN", "self" : null, "natives" : true, "operation" : [ "DOWNLOAD" ], "status" : "NORMAL", "icon" : "icon: data:image/png;base64,iVBORw0KGgoAAAAN*** // ***代表省略的图标编码", "create_time" : "2023-05-23T21:37:02Z" } ], "total" : 2, "error_code" : null, "error_msg" : null }

请求示例 查询数据资产统计列表。 GET https://{endpoint}/v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/audit-logs/artifact-usages?artifact_id=66f6bb97-c70a-43d9-aa73-************&offset=0&limit=100

响应示例 状态码： 200 OK 资产使用情况列表。 { "data" : [ { "artifact_id" : "66f6bb97-c70a-43d9-aa73-************", "artifact_name" : "customers", "consumer_user_name" : "paas_roma_l00489135", "consumer_connector_id" : "c1bf9bd7-52fc-435b-ae55-************", "consumer_connector_name" : "连接器B", "action_count_list" : [ { "action" : "MODIFY", "count" : 1 }, { "action" : "DOWNLOAD", "count" : 1 }, { "action" : "VIEW", "count" : 2 } ] } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data Array of ArtifactUsage objects 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 ArtifactUsage 参数 参数类型 描述 artifact_id String 资产ID。 artifact_name String 资产名称。 consumer_user_name String 消费连接器用户名称。 consumer_connector_id String 消费连接器ID。 consumer_connector_name String 消费连接器名称。 action_count_list Array of ActionCount objects 使用次数。 表6 ActionCount 参数 参数类型 描述 action String 限制使用的操作： VIEW：查看 MODIFY：加工 DOWNLOAD：下载 枚举值： VIEW MODIFY DOWNLOAD count Integer 使用次数。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 data - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 data - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/audit-logs/artifact-usages 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID，开通的数据交换平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定数据交换平台下连接器的ID。 获取方法请参考获取连接器ID。 表2 Query参数 参数 是否必选 参数类型 描述 artifact_id 否 String 资产ID。 参数校验规则：最小长度1，最大长度50，匹配字母数字和符号-。 artifact_name 否 String 资产名称。 参数校验规则：只能包含英文字母、数字、下划线、中文及-，并且只能以中文和英文开头，最小长度1，最大长度200。 action 否 String 执行动作过滤： VIEW：查看 MODIFY：加工 DOWNLOAD：下载 枚举值： VIEW MODIFY DOWNLOAD start_time 否 String 开始时间。 end_time 否 String 结束时间。 offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 最小值：0 最大值：999999 缺省值：0 limit 否 Integer 每页显示条目数量，最大数量999，超过999后只返回999（防止单页返回过大）。 最小值：1 最大值：999 缺省值：10

响应示例 状态码： 200 OK 合约列表。 { "data" : [ { "contract_id" : "AGRTconnector-****94b22a8544ab486c8f45************", "contract_name" : "测试合约1", "contract_description" : "测试合约", "owner_connector_id" : "b40b0d94-3201-4687-93aa-************", "owner_connector_name" : "连接器A", "subscribe_connector_id" : "c1bf9bd7-52fc-435b-ae55-************", "subscribe_connector_name" : "连接器B", "transactional_mode" : "SUBSCRIBE", "status" : "SUCCESS", "create_time" : "2023-10-12T18:11:07Z" }, { "contract_id" : "AGRTconnector-****e1c57b62b46b411380a0************", "contract_name" : "测试合约2", "contract_description" : "测试合约", "owner_connector_id" : "b40b0d94-3201-4687-93aa-************", "owner_connector_name" : "连接器A", "subscribe_connector_id" : "c1bf9bd7-52fc-435b-ae55-************", "subscribe_connector_name" : "连接器B", "transactional_mode" : "SUBSCRIBE", "status" : "SUCCESS", "create_time" : "2023-10-12T16:20:20Z" } ], "total" : 2, "error_code" : null, "error_msg" : null }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data Array of Contract objects 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 Contract 参数 参数类型 描述 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 订阅连接器名称。 transactional_mode String 交换模式： PEER_TO_PEER： 点对点 SUBSCRIBE：订阅 枚举值： PEER_TO_PEER SUBSCRIBE status String 合约状态： APPROVING： 审批中 RUNNING：数据传输中 SUCCESS：成功 FAILED：失败 TERMINATED：已终止 REJECTED：审批驳回 枚举值： APPROVING RUNNING SUCCESS FAILED TERMINATED REJECTED create_time String 创建时间。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 data - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 data - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/contracts 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID，开通的数据交换平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定数据交换平台下连接器的ID。 获取方法请参考获取连接器ID。 表2 Query参数 参数 是否必选 参数类型 描述 sub_flag 是 Integer 子标志：我提供的合约-0、我收到的合约-1。 offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 最小值：0 最大值：999999 缺省值：0 limit 否 Integer 每页显示条目数量，最大数量999，超过999后只返回999（防止单页返回过大）。 最小值：1 最大值：999 缺省值：10 transactional_mode 否 String 交换模式： PEER_TO_PEER： 点对点 SUBSCRIBE：订阅 枚举值： PEER_TO_PEER SUBSCRIBE name 否 String 合约名称。

响应示例 状态码： 200 OK 资源列表。 { "data" : [ { "id": "d*********46d2e58", "name": "空间实例自测", "description": "", "resource_spec_code": "instance.basic", "type": "OPEN", "status": "NORMAL", "initialization": true, "charging_mode": "PERIOD", "belong_type": "OWNER", "enterprise_name": "XXX公司", "administrator_user_id":"6c4027c7536040619226f2**********" }, { "id": "5*********20d925ce5", "name": "HC交换空间", "description": "HC模式下的交换空间", "resource_spec_code": "instance.basic", "type": "STAR_SHAPE", "status": "NORMAL", "initialization": true, "charging_mode": "PERIOD", "belong_type": "OWNER", "enterprise_name": "XXX公司", "administrator_user_id":"6c4027c7536040619226f2**********" } ], "total" : 2, "error_code" : null, "error_msg" : null }

URI GET /v1/{project_id}/eds/instances/user-instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 实例名称。 参数校验规则：只能包含英文字母、数字、下划线、中文及-，并且只能以中文和英文开头，最小长度1，最大长度100。 resource_spec_code 否 String EDS实例类型。 枚举值： INSTANCE_FREE，免费版EDS实例 INSTANCE_BASIC，基础版EDS实例 INSTANCE_PROFESSIONAL，EDS实例专业版 status 否 String EDS实例状态，支持：NORMAL。 枚举值： CREATING CREATE_FAILED NORMAL FREEZE DELETE offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 最小值：0 最大值：999999 缺省值：0 limit 否 Integer 每页显示条目数量，最大数量999，超过999后只返回999（防止单页返回过大）。 最小值：1 最大值：999 缺省值：10

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data Array of InstanceApiInfo objects 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 InstanceApiInfo 参数 参数类型 描述 id String EDS实例ID。 name String EDS实例名称。 description String EDS实例描述信息。 resource_spec_code String EDS资源规格编码。 枚举值： INSTANCE_FREE INSTANCE_BASIC INSTANCE_PROFESSIONAL CONNECTOR_FREE CONNECTOR_PRESENTATION CONNECTOR_BASIC STRUCTURED_STORAGE_BASIC UNSTRUCTURED_STORAGE_BASIC type String EDS实例类型。 枚举值： INTERNAL STAR_SHAPE OPEN status String EDS实例状态：NORMAL。 枚举值： CREATING CREATE_FAILED NORMAL FREEZE DELETE initialization Boolean EDS实例是否已初始化。 charging_mode String 计费模式。 枚举值： PERIOD ON_DEMAND FREE_MODE H CS belong_type String EDS实例所属类型：OWNER/GUEST。 枚举值： OWNER GUEST STRANGER enterprise_name String 企业名称。 administrator_user_id String EDS实例管理员的用户ID。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 data - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 data - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。