华为云用户手册

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

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 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 }

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

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，匹配字母、数字和符号-。

响应示例 状态码： 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" : "SUC CES S", "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 表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 表3 响应Body参数 参数 参数类型 描述 data ConnectorDetail object 连接器详情。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表4 ConnectorDetail 参数 参数类型 描述 connector_id String 连接器ID。 connector_name String 连接器名称。 connector_description String 连接器描述。 create_time String 连接器创建时间。 connector_status String 连接器当前状态。 枚举值： ACTIVE INACTIVE create_user_name String 连接器创建人名称。 create_user_id String 连接器创建人ID。 connector_owner_name String 连接器管理员名称。 connector_owner_Id String 连接器管理员ID。 protocol_signed Boolean 签署ids协议标识。 状态码： 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 连接器详情。 { "data" : { "connector_id" : "c1bf9bd7-52fc-435b-ae55-************", "connector_name" : "连接器B", "connector_description" : "测试连接器", "create_time" : "2023-10-09T11:15:48Z", "connector_status" : "ACTIVE", "create_user_name" : "pa*******135", "create_user_id" : "0574************", "connector_owner_name" : "pa*******135", "connector_owner_Id" : "0574************", "protocol_signed" : true }, "total" : 0, "error_code" : null, "error_msg" : null }

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

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 successful operation 查询用户实例列表。 { "data" : [ { "id" : "b40b0d94-3201-4687-93aa-************", "name" : "连接器A", "description" : "连接器A", "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" : "c1bf9bd7-52fc-435b-ae55-************", "name" : "连接器B", "description" : "连接器B", "resource_spec_code" : "instance.basic", "type" : "OPEN", "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 }

响应参数 状态码： 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实例状态。 枚举值： CREATING CREATE_FAILED NORMAL FREEZE initialization Boolean EDS实例是否已初始化。 charging_mode String 计费模式。 枚举值： PERIOD ON_DEMAND FREE_MODE H CS belong_type String EDS实例所属类型：OWNER/GUEST。 枚举值： OWNER GUEST enterprise_name String 企业名称。 administrator_user_id String 管理员用户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/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实例专业版 枚举值： INSTANCE_FREE INSTANCE_BASIC INSTANCE_PROFESSIONAL belong_type 否 Array 归属类型。 OWNER：实例的所有者 GUEST：实例的参与者 枚举值： OWNER GUEST status 否 String EDS实例状态。 枚举值： CREATING CREATE_FAILED NORMAL FREEZE offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 最小值：0 最大值：999999 缺省值：0 limit 否 Integer 每页显示条目数量，最大数量999，超过999后只返回999（防止单页返回过大）。 最小值：1 最大值：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 错误描述。

响应示例 状态码： 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 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID，开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定交换数据平台下连接器的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（防止单页返回过大）。 最小值：1 最大值：999 缺省值：10

响应示例 状态码： 200 OK 连接器列表。 { "data" : [ { "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 }, { "connector_id" : "c1bf9bd7-52fc-435b-ae55-************", "connector_name" : "连接器B", "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 }

URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/user-connectors 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID，开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 最小值：0 最大值：999999 缺省值：0 limit 否 Integer 每页显示条目数量，最大数量999，超过999后只返回999（防止单页返回过大）。 最小值：1 最大值：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 连接器名称。 create_user_name String 连接器创建人名称。 create_user_id String 连接器创建人ID。 connector_owner_name String 连接器管理员名称。 connector_owner_Id String 连接器管理员ID。 protocol_signed Boolean 签署ids协议标识。 状态码： 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 表4 响应Body参数 参数 参数类型 描述 data Array of ConnectorInfo objects 连接器信息。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 ConnectorInfo 参数 参数类型 描述 connector_id String 连接器ID。 connector_name String 连接器名称。 create_user_id String 创建人ID。 create_user_name String 创建人。 connector_owner_name String 连接器管理员名称。 connector_owner_Id String 连接器管理员ID。 protocol_signed Boolean 签署ids协议标识，true代表已经签署了协议，false表示没有签署。 状态码： 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 表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 successful operation 查询连接器列表。 { "data" : [ { "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" : "create_user_id", "protocol_signed" : true } ], "total" : 1, "error_code" : null, "error_msg" : null }

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 Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 EDS.00011001 Invalid parameter 无效的参数。 检查参数是否正确。 400 EDS.00011003 Get user information error 获取用户信息错误。 检查参数中的用户信息是否正确。 400 EDS.00011011 Convert time format error 转换时间格式错误。 检查日期格式是否正确。 400 EDS.00011012 Unknown server error 未知错误。 联系客服寻求帮助。 400 EDS.00011015 The user does not have the operation permission 用户无权执行此操作。 检查用户是否有操作API或者资源的权限。 400 EDS.00011016 Resource status error 资源状态异常。 检查要查询/操作的资源状态是否正常。 400 EDS.00011018 Failed to delete 删除失败。 检查资源是否存在；检查是否有权限删除资源。 400 EDS.00021006 This resource is frozen 此资源已冻结。 检查资源状态。 400 EDS.00021604 Domain already exists in the instance 客租户已加入当前空间。 检查操作租户是否已存在。 400 EDS.00021606 Domain not joined to this instance 域未加入此实例。 检查域ID和空间实例ID是否正确。 400 EDS.00021614 The EDS instance does not support transfer EDS实例不支持转让。 联系客服寻求帮助。 400 EDS.00021615 The EDS connector transfer failed EDS连接器转让失败。 联系客服寻求帮助。 400 EDS.00021619 Domain is in use 租户正在使用中。 租户正在使用中。 400 EDS.00021905 Connector does not exist 连接器不存在。 检查空间实例ID和连接器ID是否正确。 400 EDS.00021911 Connector does not belong to this user 连接器不属于此用户。 检查空间实例ID和连接器ID是否正确。 400 EDS.00021915 No permission to retrieve this connector 没有取回连接器的权限。 确认用户是否是连接器拥有者。 400 EDS.00021916 The EDS connector retrieve failed 取回连接器失败。 确认是否已签署协议；确认是否有权限做取回操作。 400 EDS.00031001 Invalid parameter 无效的参数。 检查参数是否正确。 400 EDS.00031002 User does not have permission 用户无权限。 检查用户是否有操作API或者资源的权限。 400 EDS.00031601 The eds instance does not exist 实例不存在。 检查实例ID是否正确。 400 EDS.00031603 User does not join eds instance 用户未加入实例。 确认用户是否加入实例。 400 EDS.00032201 Get iam users failed 获取 IAM 用户失败。 联系客服寻求帮助。 400 EDS.00032202 User does not owner of the connector 用户不是连接器所有者。 检查用户是否有操作API或者资源的权限。 400 EDS.00032203 Query user failed 查询用户信息失败。 联系客服寻求帮助。 403 EDS.00012301 Domain does not allow to access OpenAPI 租户不允许访问OpenAPI。 联系客服申请访问OpenAPI。 403 EDS.00021602 Current user is not manager of instance 当前用户不是实例的管理员。 确认接口是否只有实例管理员可调用。 403 EDS.00021620 Deletion of the domain is forbidden 禁止删除该租户。 禁止删除实例主租户。 403 EDS.00031602 Instance does not belong domain 实例不属于租户。 检查用户所属租户是否是实例所属者。 404 EDS.00011017 This resource does not exist 此资源不存在。 检查资源是否存在。 406 EDS.00010001 Not Acceptable 服务异常，不可接受。 联系客服寻求帮助。 406 EDS.00011019 The operation occur exception 执行操作时发生异常。 联系客服寻求帮助。 父主题： 附录

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 data UserInfo object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表4 UserInfo 参数 参数类型 描述 user_name String IAM用户名。 user_id String IAM用户ID。 result_code String 用户操作结果返回码。 枚举值： 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 OK 用户操作结果。 { "data" : { "user_name" : "test_user", "user_id" : "f528b3337a724e0b9d7************", "result_code" : "SUCCESS", "result_description" : "success" }, "total" : 0, "error_code" : null, "error_msg" : null }