交换数据空间 EDS-华为云

交换数据空间 EDS-查询指定offer详情:响应示例

响应示例状态码： 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" : [ ], "who" : [ ], "user_type": null, "application" : [ "22aac118-d58e-4324-9d41-************" ], "additional_attributes" : { "column" : "id,animal_name,category", "rows": null } }, { "action" : "DOWNLOAD", "when" : { "start_time" : "2023-11-29T10:19:03Z", "end_time" : "2023-12-29T10:19:03Z" }, "how_many" : null, "where" : [ ], "who" : [ ], "user_type": null, "application" : [ "dae4237f-9880-4fb9-a618-************" ], "additional_attributes" : { "column" : "id,animal_name,category", "rows": null } } ], "mask_sensitive" : [ { "attribute_code" : "animal_name", "reserve_head_len" : 1, "reserve_tail_len" : 1 } ] }, "total" : 0, "error_code" : null, "error_msg" : null }

交换数据空间 EDS

交换数据空间 EDS-查询指定offer详情:响应参数

响应参数状态码： 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：下架失败枚举值： 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 SubscribeTypeEnum Offer订阅的类型。枚举值： 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 限制使用次数。 where Array of strings 限制地点列表。 who Array of strings 限制用户列表。 application Array of strings 限制应用模板id列表。 additional_attributes DatabaseAttributes object 策略的扩展属性。 user_type String 限制用户类型。 USER ：指定用户 TEAM ：指定团队枚举值： USER TEAM 表7 MaskSensitive 参数参数类型描述 attribute_code String 属性code。 reserve_head_len Integer 首端保留长度。 reserve_tail_len Integer 尾端保留长度。表8 TimeInterval 参数参数类型描述 start_time String 起始时间。 end_time String 截止时间。表9 DatabaseAttributes 参数参数类型描述 column String 可见行。 rows Arrays of RowDTO 可见列。表10 RowDTO 参数参数类型描述 column_name String 参数名称。 condition String 参数条件。 value String 参数条件值。状态码： 400 表11 响应Body参数参数参数类型描述 data - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。状态码： 500 表12 响应Body参数参数参数类型描述 data - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

交换数据空间 EDS

交换数据空间 EDS-查询指定offer详情:URI

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。参数校验规则：最小长度1，最大长度50，匹配字母数字和符号-。 project_id 是 String 项目ID。获取方法请参考获取项目ID。

交换数据空间 EDS

交换数据空间 EDS-搜索offer列表（不限连接器）:响应示例

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

交换数据空间 EDS

交换数据空间 EDS-搜索offer列表（不限连接器）:响应参数

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

交换数据空间 EDS

交换数据空间 EDS-搜索offer列表（不限连接器）:URI

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

交换数据空间 EDS

交换数据空间 EDS-修订记录

修订记录发布日期修订记录 2024-5-30 第六次正式发布。修改如下章节：查询offer详情（不限连接器）出参增加subscription_type参数。查询指定offer详情出参增加subscription_type参数。 2024-4-28 第五次正式发布。新增如下章节：移除空间成员连接器收回查询连接器数据主权保护倡议签署连接器数据主权保护倡议查询应用中用户绑定的资源列表修改如下章节：查询指定租户的连接器详情出参增加protocol_signed参数。查询用户实例列表接口出参增加administrator_user_id参数。更新错误码。 2024-3-15 第四次正式发布。新增如下章节：资产使用次数统计修改如下章节：修改搜索offer列表（不限连接器）、查询offer详情（不限连接器）、查询指定offer详情、订阅Offer、查询合约详情接口的限制使用时间参数（when）和策略的扩展属性参数（additional_attributes）类型。查询用户连接器列表，查询连接器列表接口出参新增protocol_signed参数。实例添加客租户接口入参增加iam_user_id和iam_user_name参数。 2024-1-31 第三次正式发布。新增如下章节：查询指定offer资源列表（指定连接器）查询用户实例列表查询指定连接器下的团队列表查询指定连接器的数据接收者列表修改如下章节：错误码，新增错误码EDS.00031013、EDS.00031014、EDS.00031015、EDS.00031016、EDS.00031017、EDS.00031018、EDS.00031020。修改查询搜索条件（不限连接器）、搜索offer列表（不限连接器）、查询指定offer资源列表（不限连接器）、查询指定连接器下的offer列表、我的订阅、订阅待审批列表、查询合约列表、查询接收的合约数据、查看实例化应用列表、查询应用模板列表、查询数据资产的审计日志列表、查询数据资产统计列表、查询用户连接器列表、查询连接器列表等接口的limit参数说明。查询指定offer详情接口出参增加offer_status参数。查询用户连接器列表接口出参增加create_user_id、create_user_name、connector_owner_name、connector_owner_Id参数。查询连接器列表接口出参增加create_user_id、create_user_name、connector_owner_name、connector_owner_Id参数查询指定租户连接器详情接口出参增加create_user_id、create_user_name、connector_owner_name、connector_owner_Id参数。订阅Offer接口入参增加user_type参数。点对点生成合约接口入参删除deviceIps、deviceMacs参数。上架offer接口入参删除deviceIps、deviceMacs参数。 2024-1-2 第二次正式发布。新增如下章节：查询搜索条件（不限连接器）搜索offer列表（不限连接器）查询offer详情（不限连接器）查询指定offer资源列表（不限连接器）上架offer 订阅Offer 我的订阅撤销订阅订阅待审批列表审批订阅请求查询合约列表点对点生成合约查询接收的合约数据归档接收的合约数据合约资产使用控制策略执行查询应用模板列表新增应用查看实例化应用列表下载文件查询数据资产统计列表实例添加客租户连接器转让添加连接器用户修改如下章节：应用内部授权，新增搜索offer列表（不限连接器）、查询搜索条件（不限连接器）、查询offer详情（不限连接器）、查询指定offer资源列表（不限连接器）、上架offer、我的订阅、订阅Offer、订阅待审批列表、审批订阅请求、撤销订阅、查询合约列表、点对点生成合约、查询接收的合约数据、归档接收的合约数据、合约资产使用控制策略执行、查看实例化应用列表、新增应用、查询应用模板列表、下载文件、连接器转让等API权限说明。错误码，新增错误码EDS.00012301。 2023-08-28 第一次正式发布。

交换数据空间 EDS

交换数据空间 EDS-查询offer详情（不限连接器）:响应示例

响应示例状态码： 200 OK offer详情 { "data" : { "offer_id" : "321fd67b-ceba-4638-b54a-************", "offer_name" : "Offer20231121AD_EXCEL", "offer_type" : 2, "need_approval" : false, "can_terminate" : true, "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" : "a", "offer_followed_info" : { "offer_subscription" : true, "offer_favorite" : true, "offer_subscription_num" : 1, "offer_favorite_num" : 0, "offer_view_num" : 1 }, "mask_sensitive" : null, "use_control_policies_template" : [ { "action" : "VIEW", "when" : { "start_time" : "2023-11-21T16:25:27Z", "end_time" : "2023-12-21T16:25:27Z" }, "how_many" : null, "where" : [ ], "who" : [ ], "user_type": null, "application" : [ "321ac118-758e-4324-9d41-************" ], "additional_attributes" : { "column": null, "rows": null } }, { "action" : "DOWNLOAD", "when" : { "start_time" : "2023-11-21T16:25:27Z", "end_time" : "2023-12-21T16:25:27Z" }, "how_many" : null, "where" : [ ], "who" : [ ], "user_type": null, "application" : [ "dae4237f-9880-4fb9-a618-************" ], "additional_attributes" : { "column": null, "rows": null } } ] }, "total" : 0, "error_code" : null, "error_msg" : null }

交换数据空间 EDS

交换数据空间 EDS-查询offer详情（不限连接器）:URI

URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/broker/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，最大长度100。

交换数据空间 EDS

交换数据空间 EDS-查询offer详情（不限连接器）:响应参数

响应参数状态码： 200 表3 响应Body参数参数参数类型描述 data OfferSummary object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。表4 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描述。 subscription_type String Offer订阅的类型。枚举值： OPEN_DATA 公开 CONTROLLED_DATA 受控 offer_followed_info OfferFollowed object Offer引用信息。 mask_sensitive Array of MaskSensitive objects 结构化数据列脱敏信息。 use_control_policies_template Array of UseControlPoliciesInner objects 合约使用控制策略列表。表5 OfferFollowed 参数参数类型描述 offer_subscription Boolean Offer订阅状态。 offer_favorite Boolean Offer收藏状态。 offer_subscription_num Integer Offer订阅次数。 offer_favorite_num Integer Offer收藏次数。 offer_view_num Integer Offer查看次数。表6 MaskSensitive 参数参数类型描述 attribute_code String 属性code。 reserve_head_len Integer 首端保留长度。 reserve_tail_len Integer 尾端保留长度。表7 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 限制应用模板id列表。 additional_attributes DatabaseAttributes object 策略的扩展属性。 user_type String 限制用户类型。 USER ：指定用户 TEAM ：指定团队枚举值： USER TEAM 表8 TimeInterval 参数参数类型描述 start_time String 起始时间。 end_time String 截止时间。表9 DatabaseAttributes 参数参数类型描述 column String 可见行。 rows Arrays of RowDTO 可见列。表10 RowDTO 参数参数类型描述 column_name String 参数名称。 condition String 参数条件。 value String 参数条件值。状态码： 400 表11 响应Body参数参数参数类型描述 data - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。状态码： 500 表12 响应Body参数参数参数类型描述 data - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

交换数据空间 EDS

交换数据空间 EDS-查询搜索条件（不限连接器）:响应参数

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

交换数据空间 EDS

交换数据空间 EDS-查询搜索条件（不限连接器）:URI

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

交换数据空间 EDS

交换数据空间 EDS-获取连接器ID:调用API获取连接器ID

调用API获取连接器ID 连接器ID还可通过调用查询用户连接器列表API获取。获取连接器ID的接口为GET https://{eds-endpoint}/v1/{project_id}/eds/instances/{instance_id}/connectors/user-connectors，响应体中data下的“connector_id”即为连接器ID。 eds-endpoint为EDS的终端节点，EDS目前仅部署在“华北-北京四”区域，Endpoint为“eds.cn-north-4.myhuaweicloud.com”。 project_id为项目ID，开通服务后可在控制台查询，查询方法请参考获取项目ID。 instance_id为实例ID，创建实例后可在控制台查询，查询方法请参考获取实例ID。

交换数据空间 EDS 附录

交换数据空间 EDS-查询指定offer资源列表（不限连接器）:响应示例

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

交换数据空间 EDS

交换数据空间 EDS-查询指定offer资源列表（不限连接器）:响应参数

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

交换数据空间 EDS

云服务器内容精选

交换数据空间 EDS

7*24

备案

专业服务

退订

建议反馈

售前咨询热线