华为云用户手册

  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 缺省值:application/json X-Auth-Token 是 String 从 IAM 服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 缺省值:en-us 枚举值: en-us zh-cn
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 common_permissions Array of strings DRS FullAccess: 数据复制服务 所有权限 engine_permissions Array of strings GaussDB ReadOnlyAccess:云数据库 GaussDB服务的只读访问权限。 GeminiDB ReadOnlyAccess:分布式多模NoSQL数据库服务只读权限。 GaussDBforMSQLReadOnlyAccess:云数据库HUAWEIGaussDBforMSQL服务的只读访问权限。 DWS ReadOnlyAccess: 数据仓库 服务只读权限。 DDM ReadOnlyAccess: 分布式数据库 中间件服务只读权限。 DDS ReadOnlyPolicy:文档数据库服务资源只读权限。 RDS ReadOnlyAccess:关系型数据库服务资源只读权限。 MRS ReadOnlyAccess: MapReduce服务 只读权限,包括集群查询操作、基础服务弹性云服务器、裸金属服务器、云硬盘、虚拟私有云只读权限。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 对比数量。 content_compare_result_infos Array of objects 对比信息列表。 详情请参见表5。 表5 content_compare_result_infost字段数据结构说明 参数 参数类型 描述 source_db String 源库名称。 target_db String 目标库名称。 source_table_name String 源库的表名称。 target_table_name String 目标库的表名称。 source_row_num Long 源库表行数。 target_row_num Long 目标库表行数。 difference_row_num Long 源库的表和目标库的表的差异值。 line_compare_result Boolean 行对比结果。 true:一致 false:不一致 content_compare_result Boolean 内容对比结果。 true:一致 false:不一致 message String 附加信息。 compare_line_config_filter String 行过滤配置条件
  • 响应示例 状态码: 200 OK { "total_count" : 2, "content_compare_result_infos" : [ { "source_db" : "db2", "source_table_name" : "tb2", "source_row_num" : 2434882, "target_db" : "db2", "target_table_name" : "tb2", "target_row_num" : 2434882, "difference_row_num" : 0, "line_compare_result" : true, "content_compare_result" : true }, { "source_db" : "db1", "source_table_name" : "tb1", "source_row_num" : 1, "target_db" : "db1", "target_table_name" : "tb1", "target_row_num" : 1, "difference_row_num" : 0, "line_compare_result" : true, "content_compare_result" : true } ] } 状态码: 400 Bad Request { "error_code" : "DRS.M00202", "error_msg" : "The value of jobId is invalid." }
  • URI GET /v3/{project_id}/jobs/{job_id}/compare/{compare_job_id}/content-detail 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 job_id 是 String 任务ID。 compare_job_id 是 String 对比任务ID。 表2 Query参数 参数 是否必选 参数类型 描述 target_db_name 否 String 目标库名称。 db_name 否 String 源库名称。 type 否 String 类型。 compare:对比 unCompare:无法对比 limit 否 Integer 每页显示的条目数量。 缺省值:1000 offset 否 Integer 偏移量,表示从此偏移量开始查询, offset大于等于0。 缺省值:0
  • URI GET /v3/{project_id}/jobs/{job_id}/compare/{compare_job_id}/content-overview 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 job_id 是 String 任务ID。 compare_job_id 是 String 对比任务ID。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 每页显示的条目数量。 缺省值:1000 offset 否 Integer 偏移量,表示从此偏移量开始查询, offset大于等于0。 缺省值:0
  • 响应示例 状态码: 200 OK { "total_count" : 1, "content_compare_result_infos" : [ { "status" : 2, "source_db" : "tb1", "target_db" : "tb1" } ] } 状态码: 400 Bad Request { "error_code" : "DRS.M00202", "error_msg" : "The value of jobId is invalid." }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 对比数量。 content_compare_result_infos Array of objects 信息列表。 详情请参见表5。 表5 content_compare_result_infos字段数据结构说明 参数 参数类型 描述 source_db String 源库名称。 target_db String 目标库名称。 status Integer 对比状态。 0:对比不一致 2:对比一致 3:目标库表不存在 4:对比失败 5:正在对比中 6:等待对比中 7:任务已取消 8:源库为空 9:目标库为空 10:源库和目标库都为空 11:源表不存在 12:目标表不存在 13:原表和目标表都不存在 14:源数据库连接失败 15:目标库数据库连接失败 16:源数据库执行SQL超时 17:目标数据库执行SQL超时 18:源数据库执行SQL错误 19:目标数据库执行SQL错误 20:源库和目标库都不存在 21:源库不存在 22:目标库不存在 23:行数为亿行,未进行对比 27:超时
  • 响应示例 状态码: 200 OK { "total_count" : 2, "table_line_compare_result_infos" : [ { "source_table_name" : "tb2", "source_row_num" : 2434882, "target_table_name" : "tb2", "target_row_num" : 2434882, "difference_row_num" : 0, "status" : 2 }, { "source_table_name" : "tb1", "source_row_num" : 1, "target_table_name" : "tb1", "target_row_num" : 1, "difference_row_num" : 0, "status" : 2 } ] } 状态码: 400 Bad Request { "error_code" : "DRS.M00202", "error_msg" : "The value of jobId is invalid." }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 对比数量。 table_line_compare_result_infos Array of objects 对比信息列表。 详情请参见表5。 表5 TableLineCompareResultInfo字段数据结构说明 参数 参数类型 描述 source_table_name String 源库表名称 source_row_num Long 源库表行数 target_table_name String 目标库表名称 target_row_num Long 目标库表行数 difference_row_num Long 行数差异值 status Integer 对比状态。 0:对比不一致 2:对比一致 3:目标库表不存在 4:对比失败 5:正在对比中 6:等待对比中 7:任务已取消 8:源库为空 9:目标库为空 10:源库和目标库都为空 11:源表不存在 12:目标表不存在 13:原表和目标表都不存在 14:源数据库连接失败 15:目标库数据库连接失败 16:源数据库执行SQL超时 17:目标数据库执行SQL超时 18:源数据库执行SQL错误 19:目标数据库执行SQL错误 20:源库和目标库都不存在 21:源库不存在 22:目标库不存在 23:行数为亿行,未进行对比 27:超时 compare_line_config_filter String 行过滤配置条件
  • URI GET /v3/{project_id}/jobs/{job_id}/compare/{compare_job_id}/line-detail 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 job_id 是 String 任务ID。 compare_job_id 是 String 对比任务ID。 表2 Query参数 参数 是否必选 参数类型 描述 status 否 Integer 对比状态。 0:对比不一致 2:对比一致 3:目标库表不存在 4:对比失败 5:正在对比中 6:等待对比中 7:任务已取消 8:源库为空 9:目标库为空 10:源库和目标库都为空 11:源表不存在 12:目标表不存在 13:原表和目标表都不存在 14:源数据库连接失败 15:目标库数据库连接失败 16:源数据库执行SQL超时 17:目标数据库执行SQL超时 18:源数据库执行SQL错误 19:目标数据库执行SQL错误 20:源库和目标库都不存在 21:源库不存在 22:目标库不存在 23:行数为亿行,未进行对比 27:超时 type 否 String 类型。 compare:查询正常对比的项 unCompare:查询无法对比的项 db_name 否 String 源数据库名。 target_db_name 否 String 目标数据库名。 query_tb_name 否 String 表名过滤关键字。 limit 否 Integer 每页显示的条目数量。 缺省值:1000 offset 否 Integer 偏移量,表示从此偏移量开始查询, offset大于等于0。 缺省值:0
  • 响应示例 状态码: 200 OK { "total_count" : 1, "data_compare_overview_infos" : [ { "status" : 2, "source_db_name" : "my_db", "target_db_name" : "my_db" } ] } 状态码: 400 Bad Request { "error_code" : "DRS.M00202", "error_msg" : "The value of jobId is invalid." }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 对比信息数量。 data_compare_overview_infos Array of objects 信息列表。 详情请参见表5。 表5 data_compare_overview_infos字段数据结构说明 参数 参数类型 描述 source_db_name String 源库库名。 target_db_name String 目标库库名。 status Integer 对比状态。 0:对比不一致 2:对比一致 3:目标库表不存在 4:对比失败 5:正在对比中 6:等待对比中 7:任务已取消 8:源库为空 9:目标库为空 10:源库和目标库都为空 11:源表不存在 12:目标表不存在 13:原表和目标表都不存在 14:源数据库连接失败 15:目标库数据库连接失败 16:源数据库执行SQL超时 17:目标数据库执行SQL超时 18:源数据库执行SQL错误 19:目标数据库执行SQL错误 20:源库和目标库都不存在 21:源库不存在 22:目标库不存在 23:行数为亿行,未进行对比 27:超时
  • 请求示例 查询行数对比总览 https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/f8688cfa-4e05-406f-a2e6-37a773cjb20y/table/compare/48c6acb4-1473-48fd-8676-df3705758c27/line-overview?offset=0&limit=10&status=2
  • URI GET /v3/{project_id}/jobs/{job_id}/compare/{compare_job_id}/line-overview 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 job_id 是 String 任务ID。 compare_job_id 是 String 对比任务ID。 表2 Query参数 参数 是否必选 参数类型 描述 status 否 Integer 对比状态。 0:对比不一致 2:对比一致 3:目标库表不存在 4:对比失败 5:正在对比中 6:等待对比中 7:任务已取消 8:源库为空 9:目标库为空 10:源库和目标库都为空 11:源表不存在 12:目标表不存在 13:原表和目标表都不存在 14:源数据库连接失败 15:目标库数据库连接失败 16:源数据库执行SQL超时 17:目标数据库执行SQL超时 18:源数据库执行SQL错误 19:目标数据库执行SQL错误 20:源库和目标库都不存在 21:源库不存在 22:目标库不存在 23:行数为亿行,未进行对比 27:超时 limit 否 Integer 每页显示的条目数量。 缺省值:1000 offset 否 Integer 偏移量,表示从此偏移量开始查询, offset大于等于0。 缺省值:0
  • URI POST /v3/{project_id}/jobs/{job_id}/table/compare/{compare_job_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 job_id 是 String 任务ID。 compare_job_id 是 String 对比任务ID。
  • URI DELETE /v3/{project_id}/jobs/{job_id}/compare/{compare_job_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 job_id 是 String 任务ID。 compare_job_id 是 String 对比任务ID。
  • 响应示例 状态码: 200 OK { "count" : 2, "compareJobs" : [ { "id" : "48c6acb4-1473-48fd-8676-df3705758c27", "type" : "lines", "options" : { }, "status" : "SUC CES SFUL", "start_time" : "2024-03-14T06:30:14Z", "end_time" : "2024-03-14T06:31:14Z", "export_status" : "INIT", "report_remain_seconds" : -1 }, { "id" : "9e01bd96-e627-4538-a545-5f31d1c88e94", "type" : "lines", "options" : { }, "status" : "SUCCESSFUL", "start_time" : "2024-03-14T06:30:14Z", "end_time" : "2024-03-14T06:31:14Z", "export_status" : "INIT", "report_remain_seconds" : -1, "proportion_value" : "1" } ] } 状态码: 400 Bad Request { "error_code" : "DRS.M00202", "error_msg" : "The value of jobId is invalid." }
  • URI GET /v3/{project_id}/jobs/{job_id}/table/compare 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 job_id 是 String 任务ID。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 每页显示的条目数量。 缺省值:1000 offset 否 Integer 偏移量,表示从此偏移量开始查询, offset大于等于0。 缺省值:0
  • URI GET /v3/{project_id}/node-type 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 engine_type 是 String 引擎类型 db_use_type 是 String 迁移场景。 migration:实时迁移 sync:实时同步 cloudDataGuard:实时灾备 枚举值: migration sync cloudDataGuard job_direction 是 String 迁移方向,up:入云 ,down:出云,non-dbs:自建。 枚举值: up down non-dbs is_use_sellout_info 否 Boolean 是否查询资源售罄情况 缺省值:false is_multi_write 否 Boolean 是否是双主灾备 缺省值:false
  • 响应示例 状态码: 200 OK { "node_types" : [ { "is_sellout" : false, "node_type" : "micro" }, { "is_sellout" : false, "node_type" : "small" }, { "is_sellout" : false, "node_type" : "medium" }, { "is_sellout" : false, "node_type" : "high" }, { "is_sellout" : false, "node_type" : "xlarge" } ] } 状态码: 400 Bad Request { "error_code" : "DRS.M00202", "error_msg" : "The value of job_direction is invalid." }
  • URI GET /v5/{project_id}/{resource_type}/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 resource_type 是 String 资源类型。 migration:实时迁移 sync:实时同步 cloudDataGuard:实时灾备 subscription:数据订阅 backupMigration:备份迁移 replay:录制回放 枚举值: migration sync cloudDataGuard subscription backupMigration replay
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 缺省值:application/json X-Auth-Token 是 String 从IAM服务获取的用户Token。用户Token也就是调用IAM获取用户Token接口的响应值,请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 缺省值:en-us 枚举值: en-us zh-cn
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 tags Array of objects 标签列表。 详情请参见表4。 表4 tags字段数据结构说明 参数 参数类型 描述 key String 标签键。 长度为1-128个unicode字符。 可以包含任何语种字母、数字、空格和_.:=+-@,但首尾不能含有空格,不能以_sys_开头。 最小长度:1 最大长度:128 value String 标签值,删除标签时非必填。 最大长度255个unicode字符。 可以包含任何语种字母、数字、空格和_.:=+-@。 最大长度:255
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 缺省值:application/json X-Auth-Token 是 String 从IAM服务获取的用户Token。用户Token也就是调用IAM获取用户Token接口的响应值,请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 缺省值:en-us 枚举值: en-us zh-cn
  • URI GET /v5/{project_id}/{resource_type}/{resource_id}/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 resource_type 是 String 资源类型。 migration:实时迁移 sync:实时同步 cloudDataGuard:实时灾备 subscription:数据订阅 backupMigration:备份迁移 replay:录制回放 枚举值: migration sync cloudDataGuard subscription backupMigration replay resource_id 是 String 资源ID,即DRS任务ID。
  • 请求示例 查询同步任务资源实例数量。 https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/sync/resource-instances/count { "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] }, { "key" : "key2", "values" : [ "value1", "value2" ] } ], "matches" : [ { "key" : "resource_name", "value" : "resource1" } ], "without_any_tag" : false }
  • URI POST /v5/{project_id}/{resource_type}/resource-instances/count 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 resource_type 是 String 资源类型。 migration:实时迁移 sync:实时同步 cloudDataGuard:实时灾备 subscription:数据订阅 backupMigration:备份迁移 replay:录制回放 枚举值: migration sync cloudDataGuard subscription backupMigration replay
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 缺省值:application/json X-Auth-Token 是 String 从IAM服务获取的用户Token。用户Token也就是调用IAM获取用户Token接口的响应值,请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 缺省值:en-us 枚举值: en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 without_any_tag 否 Boolean 不包含任意一个标签,该字段为true时查询所有不带标签的资源,此时忽略 “tags”字段。该字段为false或者未提供该参数时,该条件不生效,即返回所有资源或按"tags","matches"等条件过滤。 tags 否 Array of objects 包含标签,最多包含20个key,每个key下面的value最多20个。 详情请参见表4。 matches 否 Array of objects 搜索字段,key为要匹配的字段,如resource_name等。value为匹配的值。 详情请参见表5。 表4 tags字段数据结构说明 参数 是否必选 参数类型 描述 key 是 String 标签键。 values 是 Array of strings 标签值。 表5 matches字段数据结构说明 参数 是否必选 参数类型 描述 key 是 String 键。 value 是 String 值。
  • 请求示例 查询同步任务实例列表。 https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/sync/resource-instances/filter?limit=1000&offset=0 { "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] }, { "key" : "key2", "values" : [ "value1", "value2" ] } ], "matches" : [ { "key" : "resource_name", "value" : "resource1" } ], "without_any_tag" : false }
共100000条