华为云用户手册

  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 request_id 否 String 订阅请求id。 approval_reason 否 String 审批理由。 approval_result 否 Boolean 审批是否通过。 contract_name 否 String 生成合约名称。
  • 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。
  • 响应示例 状态码: 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" : "SUCCESS", "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" : [ ], "who" : [ "************" ], "application" : [ "321ac118-758e-4324-9d41-************" ], "additional_attributes" : { "column" : "id,category", "rows" : [ { "column_name" : null, "condition" : "!=", "value" : "1" } ] } }, { "action" : "MODIFY", "when" : { "start_time" : "2023-12-05T20:24:37Z", "end_time" : "2023-12-25T20:24:37Z" }, "how_many" : null, "where" : [ ], "who" : [ "************" ], "application" : [ "321ac118-758e-4324-9d41-************" ], "additional_attributes" : { "column" : "id,category", "rows" : [ { "column_name" : null, "condition" : "!=", "value" : "1" } ] } }, { "action" : "DOWNLOAD", "when" : { "start_time" : "2023-12-05T20:24:37Z", "end_time" : "2023-12-25T20:24:37Z" }, "how_many" : null, "where" : [ ], "who" : [ "************" ], "application" : [ "321ac118-758e-4324-9d41-************" ], "additional_attributes" : { "column" : "id,category", "rows" : [ { "column_name" : null, "condition" : "!=", "value" : "1" } ] } } ], "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 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String 实例ID,开通的数据交换平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID,指定数据交换平台下连接器的ID。 获取方法请参考获取连接器ID。 contract_id 是 String 合约ID。 project_id 是 String 项目ID。 获取方法请参考获取项目ID。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data String 返回数据。 total Long 总数。 error_code String 错误码。 error_msg 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 POST /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/transfer 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID,开通的数据交换平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID,指定数据交换平台下连接器的ID。 获取方法请参考获取连接器ID。
  • 响应参数 状态码: 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 连接器名称。 状态码: 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" : [ { "connector_id" : "b40b0d94-3201-4687-93aa-************", "connector_name" : "连接器A" }, { "connector_id" : "c1bf9bd7-52fc-435b-ae55-************", "connector_name" : "连接器B" } ], "total" : 2, "error_code" : null, "error_msg" : null }
  • URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/user-connectors 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String 实例ID,开通的数据交换平台实例ID。 获取方法请参考获取实例ID。 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量,表示从此偏移量开始查询,offset大于等于0。 最小值:0 最大值:999999 缺省值:0 limit 否 Integer 每页显示条目数量,最大数量999,超过999后只返回999 (当前华为云规范防止单页返回过大)。 最小值:0 最大值:999 缺省值:10
  • 响应示例 状态码: 200 OK 用户操作结果。 { "data" : { "user_name" : "test_user", "user_id" : "f528b3337a724e0b9d7************", "result_code" : "SUCCESS", "result_description" : "success" }, "total" : 0, "error_code" : null, "error_msg" : null }
  • URI DELETE /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/users/{user_id} 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String 实例ID,开通的数据交换平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID,指定数据交换平台下连接器的ID。 获取方法请参考获取连接器ID。 user_id 是 String 用户ID。 project_id 是 String 项目ID。 获取方法请参考获取项目ID。
  • 响应参数 状态码: 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 错误描述。
  • URI PUT /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 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:100000 表3 请求Body参数 参数 是否必选 参数类型 描述 data_packet_ids 否 Array of strings 数据包ID。 new_folder_id 否 String 新的目录ID。
  • 请求示例 归档接收的合约数据。 PUT https://{endpoint}/v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/contracts/received-data-resources { "data_packet_ids" : [ "44d2f35e-0371-433f-b5b6-************" ], "new_folder_id" : "ROOT" }
  • 响应示例 状态码: 200 OK 归档返回结果。 { "data" : [ { "data_packet_id" : "44d2f35e-0371-433f-b5b6-************", "data_resource_id" : "323daf49-15ee-4ad2-b6f0-************" } ], "total" : 1, "error_code" : null, "error_msg" : null }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data Array of DataPackageResourceResponse objects 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 DataPackageResourceResponse 参数 参数类型 描述 data_packet_id String 数据包ID。 data_resource_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 错误描述。
  • 查看加工生成的资源 登录交换数据空间官网。 单击“管理控制台”,进入交换数据空间控制台界面。 单击“我的空间”,在交换数据空间实例中,选择实例,单击实例卡片上的“连接器”。 单击实例下的连接器,选择界面左侧导航栏中的“数据目录”,选择“团队数据”,进入“我的团队”页面。 在“我的团队”页面找到需要查看加工生成资源的团队卡片,单击团队卡片上的“加工生成”,进入团队加工生成资源页面。 单击资源名称,即可查看加工生成资源的详情。
  • 删除加工生成的资源 进入交换数据空间控制台界面,单击“我的空间”,在交换数据空间实例中,选择实例,单击实例卡片上的“连接器”。 单击实例下的连接器,选择界面左侧导航栏中的“数据目录”,选择“团队数据”,进入“我的团队”页面。 在“我的团队”页面找到需要删除加工生成资源的团队卡片,单击团队卡片上的“加工生成”,进入团队加工生成资源页面。 单击待删除的加工生成资源对应行“操作”列的“删除”。 在弹出的提示窗口,单击“确定”,完成删除。
  • 按合约查询团队收发的合约 进入交换数据空间控制台界面,单击“我的空间”,在交换数据空间实例中,选择实例,单击实例卡片上的“连接器”。 单击实例下的连接器,选择界面左侧导航栏中的“数据目录”,选择“团队数据”,进入“我的团队”页面。 在“我的团队”页面找到需要查询团队收发合约的团队卡片,单击团队卡片上的“团队收发”,进入团队收发的合约页面。 单击界面中的“按合约”,即可看到按合约展示的团队收发合约。 单击合约右上角“消息”,支持输入留言信息,并查看交换方与接收方之前的留言消息。 单击合约下的批次名称,查看该批次下的数据信息及批次信息。
  • 按交换方查询团队收发的合约 登录交换数据空间官网。 单击“管理控制台”,进入交换数据空间控制台界面。 单击“我的空间”,在交换数据空间实例中,选择实例,单击实例卡片上的“连接器”。 单击实例下的连接器,选择界面左侧导航栏中的“数据目录”,选择“团队数据”,进入“我的团队”页面。 在“我的团队”页面找到需要查询团队收发合约的团队卡片,单击团队卡片上的“团队收发”,进入团队收发的合约页面。 单击界面中的“按交换方”,即可看到按交换方展示的团队收发合约。 单击合约操作列“详情”,查看合约详情信息,在合约详情页面,单击“全部消息”页签,支持输入留言信息,并查看交换方与接收方之前的留言消息。
  • 查看归档资源详情 登录交换数据空间官网。 单击“管理控制台”,进入交换数据空间控制台界面。 单击“我的空间”,在交换数据空间实例中,选择实例,单击实例卡片上的“连接器”。 单击实例下的连接器,选择界面左侧导航栏中的“数据目录”,选择“团队数据”,进入“我的团队”页面。 在“我的团队”页面找到需要查看外部接收资源的团队卡片,单击团队卡片上的“归档数据”,进入团队归档数据页面。 单击资源名称,即可查看资源的详情。
  • 删除归档资源 进入交换数据空间控制台界面,单击“我的空间”,在交换数据空间实例中,选择实例,单击实例卡片上的“连接器”。 单击实例下的连接器,选择界面左侧导航栏中的“数据目录”,选择“团队数据”,进入“我的团队”页面。 在“我的团队”页面找到需要删除外部接收资源的团队卡片,单击团队卡片上的“归档数据”,进入团队归档数据页面。 单击待删除的资源对应行“操作”列的“删除”。 在弹出的提示窗口,单击“确定”,完成删除。
  • 点对点交换 登录交换数据空间官网。 单击“管理控制台”,进入交换数据空间控制台界面。 单击“我的空间”,在交换数据空间实例中,选择实例,单击实例卡片上的“连接器”。 单击实例下的连接器,选择界面左侧导航栏中的“数据目录”,选择“团队数据”,进入“我的团队”页面。 在“我的团队”页面找到需要交换资源的团队卡片,单击团队卡片上的“本地接入”,进入团队资源页面。 在团队资源页面单击想要交换的资源文件右侧“操作”列的“点对点发送”,相关操作请参考点对点交换。
  • 新增资源 登录交换数据空间官网。 单击“管理控制台”,进入交换数据空间控制台界面。 单击“我的空间”,在交换数据空间实例中,选择实例,单击实例卡片上的“连接器”。 单击实例下的连接器,选择界面左侧导航栏中的“数据目录”,选择“团队数据”,进入“我的团队”页面。 在“我的团队”页面找到需要新增资源的团队卡片,单击团队卡片上的“本地接入”,进入团队资源页面。 在团队资源页面单击“新增资源”,相关操作请参考新增资源。
  • 上架offer 登录交换数据空间官网。 单击“管理控制台”,进入交换数据空间控制台界面。 单击“我的空间”,在交换数据空间实例中,选择实例,单击实例卡片上的“连接器”。 单击实例下的连接器,选择界面左侧导航栏中的“数据目录”,选择“团队数据”,进入“我的团队”页面。 在“我的团队”页面找到需要交换资源的团队卡片,单击团队卡片上的“本地接入”,进入团队资源页面。 在团队资源页面单击想要上架到数据市场的资源文件右侧“操作”列的“上架offer”,相关操作请参考数据市场交换。
  • 删除成员 进入交换数据空间控制台界面,单击“我的空间”,在交换数据空间实例中,选择实例,单击实例卡片上的“连接器”。 单击实例下的连接器,选择界面左侧导航栏中的“数据目录”,选择“团队数据”,进入“我的团队”页面。 在“我的团队”页面找到需要添加成员的团队卡片,在团队卡片右上方单击“成员管理”,进入“成员管理”页面。 在“成员管理”页面,单击成员列表操作列“删除”,然后在弹框中单击“确定”,成员删除成功。
  • 添加成员 登录交换数据空间官网。 单击“管理控制台”,进入交换数据空间控制台界面。 单击“我的空间”,在交换数据空间实例中,选择实例,单击实例卡片上的“连接器”。 单击实例下的连接器,选择界面左侧导航栏中的“数据目录”,选择“团队数据”,进入“我的团队”页面。 在“我的团队”页面找到需要添加成员的团队卡片,在团队卡片右上方单击“成员管理”,进入“成员管理”页面。 在“成员管理”页面单击“添加成员”,在弹出的窗口中选择成员,然后单击“确定”,完成成员的添加。
  • 应用迁移 添加注册中心集群信息。 参考3.f访问Nacos Sync服务。 在左侧导航栏选择“集群配置”,增加一个您自建的Nacos集群,若使用多个命名空间,需要多次添加。 命名空间为您自建待迁移应用所在的命名空间ID,用户密码为默认管理员的用户密码,若未使用鉴权功能修改过,默认为nacos,集群IP为您自己部署Nacos的IP与端口号。 集群名字可以自定义,但是一旦确认,不能被修改,否则基于此集群增加的任务,在Nacos Sync重启后,将不会恢复成功。 同1.b增加一个CSE Nacos的集群,若使用多个命名空间,需要多次添加。 命名空间为您想要迁移至CSE Nacos的命名空间ID,用户密码为默认管理员的用户密码,若未使用鉴权功能修改过,默认为nacos,集群IP为CSE Nacos的内网地址+端口号,其获取方式可参考查看Nacos引擎详细信息,端口号为8848。 添加完成后,可以在列表中查询到增加的集群。 添加同步任务。 参考3.f访问Nacos Sync服务,增加一个同步任务,从您自建的Nacos集群同步到CSE Nacos集群,同步的粒度是服务,其中源集群为您自建的Nacos,目标集群为CSE Nacos。 目标集群的服务名与分组名,需要与源集群的服务名和分组名一致,否则同步不了,不同的服务需要新建不同的任务。 添加完成之后,可以在服务同步列表中,查看已添加的同步任务: 确认是否完成数据同步,检查数据是否同步成功到CSE Nacos集群,可参考查看服务列表查看CSE Nacos中出现同步任务中的服务,即表示同步成功。 对所有待迁移的应用进行迁移与同步任务,并准备升级客户端应用的Nacos连接配置。
  • 注册中心替换 自建Nacos当中的服务提供实例,需要增加CSE Nacos到自建Nacos的反向同步任务,以保证业务不中断。 观察自建的Nacos集群和CSE 的 Nacos集群,查看两个集群的服务实例是否一致,健康状态是否正常。 修改客户端连接Nacos的配置,将服务中原有的自建Nacos集群访问地址更新成CSE Nacos集群的客户端访问地址,获取方式请参考查看Nacos引擎详细信息。 spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848 # 将该地址改为CSE Nacos的集群地址 依次重新部署自建Nacos的服务实例,此时您的服务只在CSE Nacos 集群中进行了注册,完成了替换。 图示为Nacos Sync同步后的CSE Nacos服务实例。 进行服务端的重启替换时,需新增从CSE Nacos到自建Nacos的服务端任务,保证业务不中断。 Nacos Sync同步任务正常后,在升级provider服务时,新建CSE Nacos到自建Nacos的同步任务,再逐步替换配置、重启,最后下线自建Nacos与Nacos Sync组件。
共100000条