华为云用户手册

数据复制服务 DRS-查询资源实例列表:请求示例

请求示例查询同步任务实例列表。 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 }

数据复制服务 DRS
数据复制服务 DRS-查询资源实例列表:响应示例

响应示例状态码： 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 }

数据复制服务 DRS
数据复制服务 DRS-查询资源实例列表:URI

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条数据，表示从第一条数据开始查询）,必须为数字，不能为负数。

数据复制服务 DRS
数据复制服务 DRS-查询资源实例列表:请求参数

请求参数表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 值。

数据复制服务 DRS
数据复制服务 DRS-查询资源实例列表:响应参数

响应参数状态码： 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 标签值。

数据复制服务 DRS
数据复制服务 DRS-批量删除资源标签:请求参数

请求参数表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

数据复制服务 DRS
数据复制服务 DRS-批量删除资源标签:请求示例

请求示例同步任务批量删除标签。 https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/sync/2f4af282-d13e-4b10-a1eb-609b47fjb201/tags/delete { "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ] }

数据复制服务 DRS
数据复制服务 DRS-批量删除资源标签:URI

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。

数据复制服务 DRS
数据复制服务 DRS-批量添加资源标签:请求参数

请求参数表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

数据复制服务 DRS
数据复制服务 DRS-批量添加资源标签:请求示例

请求示例同步任务批量添加资源标签。 https://{endpoint}//v5/5237e10fe9aa4ad5b16b6a5245248314/sync/2f4af282-d13e-4b10-a1eb-609b47fjb201/tags/create { "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ] }

数据复制服务 DRS
数据复制服务 DRS-批量添加资源标签:URI

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。

数据复制服务 DRS
数据复制服务 DRS-查询任务的参数配置修改历史:请求参数

请求参数表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

数据复制服务 DRS
数据复制服务 DRS-查询任务的参数配置修改历史:请求示例

请求示例查询任务的参数配置修改历史 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/configuration-histories?offset={offset}&limit={limit}&begin_time={begin_time}&end_time={end_time}

数据复制服务 DRS
数据复制服务 DRS-查询任务的参数配置修改历史:响应示例

响应示例状态码： 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" } ] }

数据复制服务 DRS
数据复制服务 DRS-查询任务的参数配置修改历史:响应参数

响应参数状态码： 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 参数应用时间。

数据复制服务 DRS
数据复制服务 DRS-查询任务的参数配置修改历史:URI

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 参数名称。

数据复制服务 DRS
数据复制服务 DRS-查询任务参数配置列表:请求参数

请求参数表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

数据复制服务 DRS
数据复制服务 DRS-查询任务参数配置列表:URI

URI GET /v5/{project_id}/jobs/{job_id}/configurations 表1 路径参数参数是否必选参数类型描述 project_id 是 String 租户在某一Region下的Project ID。获取方法请参见获取项目ID。 job_id 是 String 任务ID。表2 Query参数参数是否必选参数类型描述 offset 否 String 偏移量，表示从此偏移量开始查询，offset 大于等于 0。默认为0 limit 否 String 每页显示的条目数量。默认为10，取值范围【1-1000】 name 否 String 根据参数名查询。

数据复制服务 DRS
数据复制服务 DRS-查询任务参数配置列表:响应参数

响应参数状态码： 200 表4 响应Body参数参数参数类型描述 count Integer 总数。 parameter_config_list Array of objects 任务参数列表。详情请参见表5。表5 parameter_config_list字段数据结构说明参数参数类型描述 name String 参数名称。 value String 参数值。 default_value String 参数默认值。 value_range String 参数值范围，如Integer取值0-1、Boolean取值true|false等。 is_need_restart Boolean 是否需要重启。默认为true, “false”表示否。“true”表示是。 description String 参数描述，目前只支持英文。 created_at String 创建时间，例如：2023-01-20T07:18:26Z。 updated_at String 更新时间，例如：2023-03-01T09:42:02Z。

数据复制服务 DRS
数据复制服务 DRS-查询任务参数配置列表:响应示例

响应示例状态码： 200 任务参数配置列表信息。 { "count" : 0, "parameter_config_list" : [ { "name" : "applier_thread_num", "value" : "20", "default_value" : "10", "value_range" : "1-512", "is_need_restart" : true, "description" : "The number of threads that write data to the target database during the full stage", "created_at" : "2020-09-01T18:50:20Z", "updated_at" : "2020-09-01T18:50:20Z" }, { "name" : "read_task_num", "value" : "20", "default_value" : "10", "value_range" : "1-512", "is_need_restart" : true, "description" : "The number of threads reading data from the source database during the full volume stage", "created_at" : "2020-09-01T18:50:20Z", "updated_at" : "2020-09-01T18:50:20Z" } ] }

数据复制服务 DRS
数据复制服务 DRS-更新任务的参数信息:请求示例

请求示例更新任务全量阶段写数据到目标数据库的线程数和全量阶段从源教据库读取数据的线程数。 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/modify-configuration { "values" : [ { "parameter_name" : "applier_thread_num", "parameter_value" : "20" }, { "parameter_name" : "read_task_num", "parameter_value" : "3" } ] }

数据复制服务 DRS 参数管理
数据复制服务 DRS-更新任务的参数信息:请求参数

请求参数表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参数参数是否必选参数类型描述 values 是 Array of objects 参数值对象，基于默认参数模板初始化的参数值。详情请参见表4。表4 values字段数据结构说明参数是否必选参数类型描述 parameter_name 是 String 参数名称，如：“applier_thread_num”，“read_task_num”等。为空时表示不修改参数值。 parameter_value 是 String 参数名称对应的参数值，如：“20”，“false”。parameter_name不为空时，parameter_value也不可为空。

数据复制服务 DRS 参数管理
数据复制服务 DRS-查询驱动文件列表(不再推广）:响应参数

响应参数状态码： 200 表4 响应Body参数参数参数类型描述 count Integer 驱动文件总数。 items Array of DriverInfo objects 驱动文件列表。表5 DriverInfo 参数参数类型描述 driver_name String 文件名称。 last_modified String 最后修改时间。 size Integer 文件大小，单位：byte

数据复制服务 DRS
数据复制服务 DRS-查询驱动文件列表(不再推广）:URI

URI GET /v5/{project_id}/jdbc-drivers 表1 路径参数参数是否必选参数类型描述 project_id 是 String 租户在某一Region下的Project ID。获取方法请参见获取项目ID。表2 Query参数参数是否必选参数类型描述 limit 否 Integer 每页显示的条目数量。默认为10 offset 否 Integer 偏移量，表示从此偏移量开始查询， offset 大于等于 0。默认为0

数据复制服务 DRS
数据复制服务 DRS-查询驱动文件列表(不再推广）:请求参数

请求参数表3 请求Header参数参数是否必选参数类型描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 X-Auth-Token 是 String 从IAM服务获取的用户Token。用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。

数据复制服务 DRS
数据复制服务 DRS-同步驱动文件(不再推广）:请求参数

请求参数表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 表3 请求Body参数参数是否必选参数类型描述 driver_name 是 String jdbc驱动文件名称，name的长度5-64，结尾以.jar结尾。

数据复制服务 DRS
数据复制服务 DRS-删除驱动文件(不再推广）:请求参数

请求参数表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 表3 请求Body参数参数是否必选参数类型描述 driver_names 是 Array of strings jdbc驱动文件列表，列表长度1-20，driver_name的长度5-64，结尾以.jar结尾。

数据复制服务 DRS
数据复制服务 DRS-上传驱动文件(不再推广）:请求参数

请求参数表2 请求Header参数参数是否必选参数类型描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用multipart/form-data，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 X-Auth-Token 是 String 从IAM服务获取的用户Token。用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。缺省值：en-us 枚举值： en-us zh-cn 表3 FormData参数参数是否必选参数类型描述 file 是 File 驱动文件，驱动文件名称长度5-64，以jar结尾，name相同会替换远程驱动文件

数据复制服务 DRS
数据复制服务 DRS-采集数据库位点信息:响应参数

响应参数状态码： 202 表4 响应Body参数参数参数类型描述 id String 查询结果ID。 job_id String 任务ID。 status String 查询状态。枚举值： pending failed success 状态码： 400 表5 响应Body参数参数参数类型描述 error_code String 错误码。最小长度：12 最大长度：12 error_msg String 错误描述。最小长度：1 最大长度：512

数据复制服务 DRS
数据复制服务 DRS-采集数据库位点信息:响应示例

响应示例状态码： 202 Accepted { "id" : "0eacda0b-9422-4535-8b62-537d1833638b", "job_id": "177738d1-4eee-4fcb-a4e1-09aea79jb20i", "status" : "pending" } 状态码： 400 Bad Request { "error_code" : "DRS.10000010", "error_msg" : "Job does not exist, please check job id." }

数据复制服务 DRS

共100000条

undefined

意见反馈

0/200

提交取消

提交成功！非常感谢您的反馈，我们会继续努力做到更好反馈提交失败！请稍后重试！

华为云用户手册

7*24

备案

专业服务

退订

建议反馈

售前咨询热线