华为云用户手册

  • URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/subscriptions/approvals 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID,开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID,指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。 表2 Query参数 参数 是否必选 参数类型 描述 subscription_id 否 String 订阅ID。 offset 否 Integer 偏移量,表示从此偏移量开始查询,offset大于等于0。 最小值:0 最大值:999999 缺省值:0 最小值:0 最大值:999999 缺省值:0 limit 否 Integer 每页显示条目数量,最大数量999,超过999后只返回999(防止单页返回过大)。 最小值:1 最大值:999 缺省值:10 最小值: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 }
  • 响应参数 状态码: 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 错误描述。
  • 请求参数 表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
  • 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 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}/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
  • 请求参数 表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。 最小长度:1 最大长度:100000
  • 响应参数 状态码: 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 表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:数据传输中 SUC CES S:成功 FAILED:失败 CLOSED:到期关闭 TERMINATED:已终止 REJECTED:审批驳回 枚举值: APPROVING RUNNING SUCCESS FAILED CLOSED TERMINATED REJECTED create_time 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 合约列表。 { "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 }
  • 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 最小值:0 最大值:999999 缺省值:0 limit 否 Integer 每页显示条目数量,最大数量999,超过999后只返回999(防止单页返回过大)。 最小值:1 最大值:999 缺省值:10 最小值:1 最大值:999 缺省值:10 transactional_mode 是 String 交换模式: PEER_TO_PEER: 点对点 SUBSCRIBE:订阅 枚举值: PEER_TO_PEER SUBSCRIBE name 否 String 合约名称。
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,通过调用IAM服务“获取用户Token”接口获取(响应消息头中X-Subject-Token的值)。 x-eds-proxy-userid 否 String 如果X-Auth-Token是租户ID,那么x-eds-proxy-userid填写实际被代理的真实用户ID。 最小长度:0 最大长度:100000
  • 请求示例 查询数据资产统计列表。 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 表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 Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码: 500 表8 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。
  • 响应示例 状态码: 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 } ] } ] }
  • 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" : [ { "type" : "UNSTRUCTURED", "name" : "OBS4", "id" : "70d5c8d0-fe76-4cf0-9d30-***********", "temp_id" : "335ac118-758e-4324-9d41-***********", "temp_name" : "文档下载", "natives" : false, "operation" : [ "DOWNLOAD" ], "description" : "abc", "icon" : "icon: data:image/png;base64,iVBORw0KGgoAAAAN*** // ***代表省略的图标编码", "connection" : { "datasource_type" : "OBS", "connection" : null }, "create_user_id" : "test-***********", "create_user_name" : "test-***********", "create_date" : "2023-11-21T16:50:53Z" } ], "total" : 1, "error_code" : null, "error_msg" : null }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data Array of AppInfo objects 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 AppInfo 参数 参数类型 描述 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 name String 应用名称。 id String 应用ID。 temp_id String 应用模板ID。 temp_name String 应用模板名称。 natives Boolean 是否内置应用 true:内置 false:自创 operation Array of strings 应用操作。 枚举值: VIEW PROCESS DOWNLOAD description String 应用描述。 icon String 应用图标。 connection DataSourceConnect object 应用连接信息。 create_user_id String 创建人ID。 create_user_name String 创建人名称。 create_date String 创建时间。 表6 DataSourceConnect 参数 参数类型 描述 datasource_type String 数据源类型。 枚举值: MRS _HIVE ORACLE MYSQL DWS GAUSS_DB FTP SFTP OBS WPS API connection DataSourceConnection object 数据源连接信息。 表7 DataSourceConnection 参数 参数类型 描述 obs_connection ObsConnection object OBS数据源连接信息。 表8 ObsConnection 参数 参数类型 描述 endpoint String OBS访问地址。 参数校验规则:最小长度1,最大长度1000,匹配 域名 正则表达式。 bucket_name String OBS名称。 参数校验规则:最小长度1,最大长度100,匹配字母、数字、下划线、.及-。 access_key String OBS永久访问密钥。 参数校验规则:最大长度1024。 secret_key String OBS永久密钥。 参数校验规则:最大长度1024。 path String OBS访问路径。 参数校验规则:最小长度1,最大长度100,只能包含英文字母、数字、下划线、中文、/、\及-。 状态码: 400 表9 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码: 500 表10 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。
  • URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/applications 表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 app_name 否 String 实例化APP名称。 ids 否 Array 实例化APP ID。 operations 否 Array 执行动作过滤。 枚举值: VIEW PROCESS DOWNLOAD status 否 Array 状态: NORMAL:正常使用状态 DISABLE:停用状态,不再分配给新的eds实例 枚举值: NORMAL DISABLE
  • 响应示例 状态码: 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 }
  • 响应参数 状态码: 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 DATA_TABLE_PROCESSING self Boolean 资源是否是自己的。 natives Boolean 是否内置应用 true:内置 false:自创 operation Array of strings 限制使用的操作。 枚举值: VIEW PROCESS DOWNLOAD status String 状态: NORMAL:正常使用状态 DISABLE:停用状态,不再分配给新的eds实例 枚举值: NORMAL DISABLE icon String 应用图标。 create_time 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 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
  • 修订记录 发布日期 修订记录 2024-11-6 第七次正式发布。 修改如下章节: 添加连接器用户入参role_list枚举值变更。 归档接收的合约数据入参data_packet_id变更为data_packet_ids,参数类型变更为Array of strings。 查询合约列表入参status增加枚举值CLOSED(到期关闭)。 上架offer入参data_resource_list的data_artifact_id属性修改为非必填。 订阅offer入参where由数组更改为device_ip、device_mac属性。 点对点生成合约入参删除mask_sensitive。 更新错误码。 删除如下章节: 查询应用中用户绑定的资源列表 提交合约 下载文件 资产使用次数统计 查询指定连接器的数据接收者列表 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 第一次正式发布。
  • 调用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。
  • 调用API获取项目ID 项目ID还用通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”,其中{Endpoint}为IAM的终端节点,可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下,其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "cn-north-4", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }
  • 状态码 状态码如表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协议的版本,无法完成处理。 父主题: 附录
  • EDS权限分类 表1 细化权限说明 权限 对应API接口 授权项 依赖的授权项 IAM项目 企业项目 查询指定空间实例下所有连接器 - eds:connector:list - √ × 申请开通连接器 - eds:connector:apply - √ × 创建实例 - eds:instance:create - √ × 删除连接器 - eds:connector:delete - √ × 申请加入连接器 - eds:connector:join - √ × 创建连接器 - eds:connector:create - √ × 删除空间实例 - eds:instance:delete - √ × 申请加入实例 - eds:instance:join - √ × 父主题: 权限和授权项
共100000条