华为云用户手册

  • 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。
  • 修订记录 发布日期 修订记录 2024-12-9 第八次正式发布。 修改如下章节: 使用前必读章节、获取连接器ID章节,修改“华北-北京四”Endpoint为“eds-combine.cn-north-4.myhuaweicloud.com”,“华南-广州-友好用户环境”Endpoint为“eds-combine.cn-south-4.myhuaweicloud.com”。 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 第一次正式发布。
  • 响应消息体 响应消息体通常以结构化格式返回,与响应消息头中Content-type对应,传递除响应消息头之外的内容。 对于管理员创建 IAM 用户接口,返回如下消息体。为篇幅起见,这里只展示部分内容。 { "user": { "id": "c131886aec...", "name": "IAMUser", "description": "IAM User Description", "areacode": "", "phone": "", "email": "***@***.com", "status": null, "enabled": true, "pwd_status": false, "access_mode": "default", "is_domain_owner": false, "xuser_id": "", "xuser_type": "", "password_expires_at": null, "create_time": "2024-05-21T09:03:41.000000", "domain_id": "d78cbac1..........", "xdomain_id": "30086000........", "xdomain_type": "", "default_project_id": null } } 当接口调用出错时,会返回错误码及错误信息说明,错误响应的Body体格式如下所示。 { "error_msg": "Request body is invalid.", "error_code": "IAM.0011" } 其中,error_code表示错误码,error_msg表示错误描述信息。
  • 支持的授权项 策略包含系统策略和自定义策略,如果系统策略不满足授权要求,管理员可以创建自定义策略,并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应,授权项列表说明如下: 权限:允许或拒绝某项操作。 对应API接口:自定义策略实际调用的API接口。 授权项:自定义策略中支持的Action,在自定义策略中的Action中写入授权项,可以实现授权项对应的权限功能。 依赖的授权项:部分Action存在对其他Action的依赖,需要将依赖的Action同时写入授权项,才能实现对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project):自定义策略的授权范围,包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目,表示此授权项对应的自定义策略,可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目,不支持企业项目,表示仅能在IAM中给用户组授权并生效,如果在企业管理中授权,则该自定义策略不生效。关于IAM项目与企业项目的区别,详情请参见:IAM和企业管理的区别。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data Array of SubscriptionResponse objects 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 SubscriptionResponse 参数 参数类型 描述 offer_id String Offer ID。 offer_name String Offer名称。 subscription_id String 订阅返回ID。 subscription_reason String 订阅理由。 status String 订阅状态: WAIT_TO_APPROVE:待审批 REJECTED:已驳回 PASSED:已通过 REVOKED:已撤销 枚举值: WAIT_TO_APPROVE REJECTED PASSED REVOKED create_time String 创建时间。 creator 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" : [ { "offer_id" : "6168c382-5184-4ec8-8a04-************", "offer_name" : "offer-mysql-20231129AA", "subscription_id" : "90bedec2-2efc-41d4-8223-************", "subscription_reason" : "Subscribe by OpenApi.", "status" : "WAIT_TO_APPROVE", "create_time" : "2023-12-01T17:53:03Z", "creator" : "************" }, { "offer_id" : "b74b4c6b-0c00-4a9d-86c3-************", "offer_name" : "offer-mysql-20231129AA", "subscription_id" : "7343b305-75f9-4979-ade0-************", "subscription_reason" : "Subscribe by OpenApi.", "status" : "WAIT_TO_APPROVE", "create_time" : "2023-12-01T17:47:23Z", "creator" : "************" } ], "total" : 2, "error_code" : null, "error_msg" : null}
  • URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/subscriptions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID,开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID,指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。 表2 Query参数 参数 是否必选 参数类型 描述 subscription_id 否 String 订阅ID。 参数校验规则:最小长度1,最大长度50,匹配字母、数字和符号-。 status 否 String 审批状态。 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 错误描述。
  • 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
  • 响应示例 状态码: 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 OK 操作结果。 { "data" : { "operation_id" : "90bedec2-2efc-41d4-8223-************", "result_code" : "SUCCESS", "result_description" : "Revoke subscription success." }, "total" : 0, "error_code" : null, "error_msg" : null}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 data OperationResult object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表4 OperationResult 参数 参数类型 描述 operation_id String 操作资源ID。 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 DELETE /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/subscriptions/{subscription_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID,开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID,指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。 subscription_id 是 String 订阅ID。
  • 请求参数 表2 请求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参数 参数 参数类型 描述 contract_id String 合约ID。 contract_name String 合约名称。 result_code String 审批操作结果返回码。 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 错误描述。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,通过调用IAM服务“获取用户Token”接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 request_id 是 String 订阅请求id。 参数校验规则:最小长度1,最大长度50,匹配字母、数字和符号-。 approval_reason 否 String 审批理由。 参数校验规则:最小长度1,最大长度200,以字母数字中文开头,只含有字母数字汉字下划线和符号-。 approval_result 是 Boolean 审批是否通过。 contract_name 是 String 生成合约名称。 can_terminate 否 Boolean 是否允许提供方提前终止合约。
  • URI POST /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。
  • 请求示例 审批请求体。 POST https://{endpoint}/v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/subscriptions/approvals{ "approval_result" : "true", "approval_reason" : "审批通过", "request_id" : "7343b305-75f9-4979-ade0-********", "contract_name" : "测试合约4"}
  • 基本概念 账号 用户注册时的账号,账号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于账号是付费主体,为了确保账号安全,建议您不要直接使用账号进行日常管理工作,而是创建用户并使用他们进行日常管理工作。 用户 由账号在IAM中创建的用户,是云服务的使用人员,具有身份凭证(密码和访问密钥)。 在我的凭证下,用户可以查看账号ID和IAM用户ID。通常在调用API的鉴权过程中,用户需要用到账号、用户和密码信息。 区域(Region) 从地理位置和网络时延维度划分,同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region,通用Region指面向公共租户提供通用云服务的Region;专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 详情请参见区域和可用区。 可用区(AZ,Availability Zone) 一个可用区是一个或多个物理数据中心的集合,有独立的风火水电,AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连,以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目,这个项目由系统预置,用来隔离物理区域间的资源(计算资源、存储资源和网络资源),以默认项目为单位进行授权,用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制,可以在区域默认的项目中创建子项目,并在子项目中创建资源,然后以子项目为单位进行授权,使得用户仅能访问特定子项目中的资源,使得资源的权限控制更加精确。 图1 项目隔离模型 同样在我的凭证下,您可以查看项目ID。 企业项目 企业项目是项目的升级版,针对企业不同项目间的资源进行分组和管理,具有逻辑隔离能力。企业项目中可以包含多个区域的资源,且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理用户指南》。
  • Token认证 Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。 使用Token前请确保Token离过期有足够的时间,防止调用API的过程中Token过期导致调用API失败。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用接口时,请求body中auth.scope的取值需要选择project,如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 获取Token 后,再调用其他接口时,您需要在请求消息头中添加“X-Auth-Token”,其值即为获取到的Token。例如Token值为“ABCDEFG....”,则调用接口时将“X-Auth-Token: ABCDEFG....”加到请求消息头即可,如下所示。 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/usersContent-Type: application/json X-Auth-Token: ABCDEFG.... 您还可以通过这个视频教程了解如何使用Token认证:https://bbs.huaweicloud.com/videos/101333 。
  • 响应参数 状态码: 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 错误描述。
  • 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。
  • 响应示例 状态码: 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}
  • 响应示例 状态码: 200 OK 用户操作结果。 { "data" : { "headers" : { }, "body" : { "data" : "success", "total" : 0, "error_code" : null, "error_msg" : null }, "statusCodeValue" : 200, "statusCode" : "OK" }, "total" : 0, "error_code" : null, "error_msg" : null}
  • 响应参数 状态码: 200 表16 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码: 400 表17 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码: 500 表18 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。
  • 请求示例 点对点发送合约 POST /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/contracts/point-to-point{ "contract_description" : "合约描述", "approver_id" : "9999900******", "contract_name" : "点对点发送合约", "file_assets" : [ { "artifact_ids" : [ "f21e5c1e-ec9b******" ], "data_resource_id" : "7da43bc2-c301******" } ], "connector_policies" : [ { "connector_id" : "2747e1be-dba2*****", "policy_json" : { "view" : { "enable" : true, "times" : 100, "app" : "321ac118-758e******" }, "modify" : { "enable" : false, "times" : "", "app" : "" }, "download" : { "enable" : true, "times" : 100, "app" : "234c118-758e******" }, "approval" : { "enable" : false }, "terminate" : { "enable" : true }, "use" : { "users" : "2******", "teams" : "", "timeInterval" : { "startTime" : "2023-12-11T16:25:27Z", "endTime" : "2024-01-10T16:25:27Z" } }, "database" : { "column" : "", "rows" : [ ] } } } ]}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,通过调用IAM服务“获取用户Token”接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 contract_name 是 String 合约名称。 参数校验规则:只能包含英文字母,数字,下划线,中文及-,并且只能以中文和英文开头,最小长度1,最大长度100。 contract_description 否 String 合约描述。 参数校验规则:最大长度500。 connector_policies 是 Array of ConnectorPolicyRequest objects 每个连接器对应的策略信息。 approver_id 是 String 点对点审批人。 参数校验规则:最小长度1,最大长度50,匹配字母、数字和符号-。 file_assets 是 Array of FileAssetRequest objects 多资产id。 表4 ConnectorPolicyRequest 参数 是否必选 参数类型 描述 connector_id 是 String 连接器ID。 policy_json 是 PolicyJsonRequest object 数据使用策略。 表5 PolicyJsonRequest 参数 是否必选 参数类型 描述 view 否 ViewDTO object 查看策略。 modify 否 ModifyDTO object 修改策略。 terminate 否 TerminateDTO object 终止策略。 approval 否 ApprovalDTO object 审批策略。 download 否 DownloadDTO object 下载策略。 use 否 UseDTO object 使用对象策略。 database 否 DatabaseDTO object 数据库策略。 表6 ViewDTO 参数 是否必选 参数类型 描述 enable 是 Boolean 是否允许查看。 times 否 String 次数,仅当enable参数为true时生效。 app 否 String 应用,仅当enable参数为true时生效。 表7 ModifyDTO 参数 是否必选 参数类型 描述 enable 是 Boolean 是否允许修改。 times 否 String 次数,仅当enable参数为true时生效。 app 否 String 应用,仅当enable参数为true时生效。 表8 TerminateDTO 参数 是否必选 参数类型 描述 enable 是 Boolean 是否允许提供方提前终止合约。 表9 ApprovalDTO 参数 是否必选 参数类型 描述 enable 是 Boolean 是否需要审批。 表10 DownloadDTO 参数 是否必选 参数类型 描述 enable 是 Boolean 是否允许下载。 times 否 String 次数,仅当enable参数为true时生效。 app 否 String 应用,仅当enable参数为true时生效。 表11 UseDTO 参数 是否必选 参数类型 描述 users 否 String 使用人,与teams字段二选一填入 teams 否 String 使用团队,与users字段二选一填入 timeInterval 否 TimeIntervalDTO object 时间区间。 表12 TimeIntervalDTO 参数 是否必选 参数类型 描述 startTime 是 String 开始时间,需要与endTime配合生效。使用UTC时间格式。 endTime 是 String 结束时间,需要与startTime配合生效。使用UTC时间格式。 表13 DatabaseDTO 参数 是否必选 参数类型 描述 column 是 String 列过滤策略。 rows 是 Array of RowDTO objects 行过滤策略。 表14 RowDTO 参数 是否必选 参数类型 描述 column_name 否 String 参数名称,需要与condition、value配合生效。 condition 否 String 参数条件,需要与column_name、value配合生效。 value 否 String 参数条件值,需要与column_name、condition配合生效。 表15 FileAssetRequest 参数 是否必选 参数类型 描述 data_resource_id 是 String 数据资源ID。 file_path 否 String 文件路径。 artifact_ids 是 Array of strings 资源下的文件ID集合。
  • URI POST /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/contracts/point-to-point 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID,开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID,指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。
  • 请求消息头 附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。 如下公共消息头需要添加到请求中。 Content-Type:消息体的类型(格式),必选,默认取值为“application/json”,有其他取值时会在具体接口中专门说明。 Authorization:签名认证信息,可选,当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充该字段。 X-Sdk-Date:请求发送的时间,可选,当使用AK/SK方式认证时,使用SDK对请求进行签名的过程中会自动填充该字段。 X-Auth-Token:用户Token,可选,当使用Token方式认证时,必须填充该字段。用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 X-Project-ID:子项目ID,可选,在多项目场景中使用。如果云服务资源创建在子项目中,AK/SK认证方式下,操作该资源的接口调用需要在请求消息头中携带X-Project-ID。 X-Domain-ID:账号ID,可选。AK/SK认证方式下,全局服务的接口调用时,需在请求消息头中携带X-Domain-ID。
共99354条