华为云用户手册

  • 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
  • 请求参数 表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
  • 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。
  • 请求参数 表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/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
  • 响应参数 状态码: 200 表7 响应Body参数 参数 参数类型 描述 total_count Integer 总数。 resources Array of objects 资源列表。 详情请参见表8。 表8 resources字段数据结构说明 参数 参数类型 描述 resource_id String 资源ID。 resource_detail String 资源详情。 资源对象,用于扩展。默认为空。 resource_name String 资源名称。 tags Array of objects 标签列表。 详情请参见表9。 表9 tags字段数据结构说明 参数 参数类型 描述 key String 标签键。 value String 标签值。
  • URI POST /v5/{project_id}/{resource_type}/resource-instances/filter 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 resource_type 是 String 资源类型。 migration:实时迁移 sync:实时同步 cloudDataGuard:实时灾备 subscription:数据订阅 backupMigration:备份迁移 replay:录制回放 枚举值: migration sync cloudDataGuard subscription backupMigration replay 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 查询记录数,默认为1000,limit最多为1000,不能为负数,最小值为1。 offset 否 Integer 索引位置,偏移量从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。
  • 响应示例 状态码: 200 OK { "resources" : [ { "tags" : [ { "key" : "aaaaa", "value" : "bbbbb" }, { "key" : "zzzz", "value" : "" } ], "resource_id" : "2f4af282-d13e-4b10-a1eb-609b47fjb201", "resource_detail" : "", "resource_name" : "DRS-5634" } ], "total_count" : 1 }
  • 请求参数 表3 请求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 表4 请求Body参数 参数 是否必选 参数类型 描述 without_any_tag 否 Boolean 不包含任意一个标签,该字段为true时查询所有不带标签的资源,此时忽略 “tags”字段。该字段为false或者未提供该参数时,该条件不生效,即返回所有资源或按"tags","matches"等条件过滤。 tags 否 Array of objects 包含标签,最多包含20个key,每个key下面的value最多20个。 详情请参见表5。 matches 否 Array of objects 搜索字段,key为要匹配的字段,如resource_name等。value为匹配的值。 详情请参见表6。 表5 tags字段数据结构说明 参数 是否必选 参数类型 描述 key 是 String 标签键。 values 是 Array of strings 标签值。 表6 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 }
  • 请求示例 同步任务批量删除标签。 https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/sync/2f4af282-d13e-4b10-a1eb-609b47fjb201/tags/delete { "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ] }
  • URI POST /v5/{project_id}/{resource_type}/{resource_id}/tags/delete 表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。
  • 请求参数 表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参数 参数 是否必选 参数类型 描述 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 表3 请求Body参数 参数 是否必选 参数类型 描述 tags 是 Array of objects 标签列表。 详情请参见表4。 表4 tags字段数据结构说明 参数 是否必选 参数类型 描述 key 是 String 标签键。 长度为1-128个unicode字符。 可以包含任何语种字母、数字、空格和_.:=+-@,但首尾不能含有空格,不能以_sys_开头。 最小长度:1 最大长度:128 value 否 String 标签值,删除标签时非必填。 最大长度255个unicode字符。 可以包含任何语种字母、数字、空格和_.:=+-@。 最大长度:255
  • 请求示例 同步任务批量添加资源标签。 https://{endpoint}//v5/5237e10fe9aa4ad5b16b6a5245248314/sync/2f4af282-d13e-4b10-a1eb-609b47fjb201/tags/create { "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ] }
  • URI POST /v5/{project_id}/{resource_type}/{resource_id}/tags/create 表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。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 count Integer 历史记录总数。 parameter_history_config_list Array of objects 任务参数历史修改列表。 详情请参见表4。 表4 parameter_history_config_list字段数据结构说明 参数 参数类型 描述 name String 参数名称。 old_value String 旧参数值。 new_value String 新参数值。 is_update_success Boolean 更新结果。true:成功,false:失败 is_applied Boolean 是否已应用。true:已应用,false:未应用 update_time String 参数修改时间。 apply_time String 参数应用时间。
  • 请求参数 表2 请求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
  • URI GET /v5/{project_id}/jobs/{job_id}/configuration-histories 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 job_id 是 String 任务ID。 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量,表示从此偏移量开始查询,offset 大于等于 0。 默认为0。 limit 否 Integer 每页显示的条目数量。默认为10,取值范围【1-1000】。 begin_time 否 String 开始时间,UTC时间,例如:2020-09-01T18:50:20Z。 end_time 否 String 结束时间,UTC时间,例如:2020-09-01T19:50:20Z。 name 否 String 参数名称。
  • 请求示例 查询任务的参数配置修改历史 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/configuration-histories?offset={offset}&limit={limit}&begin_time={begin_time}&end_time={end_time}
  • 响应示例 状态码: 200 任务参数配置修改历史列表 { "count" : 0, "parameter_history_config_list" : [ { "name" : "strapplier_thread_numing", "old_value" : "10", "new_value" : "20", "is_update_success" : true, "is_applied" : "true", "update_time" : "2020-09-01T18:50:20Z", "apply_time" : "2020-09-01T18:50:20Z" } ] }
共100000条
提示

您即将访问非华为云网站,请注意账号财产安全