文档首页/ 云数据库 RDS/ API参考/ API v3（推荐）/ 数据迁移（PostgreSQL）/ 创建DRS同步任务 - CreateDrsJobTask
更新时间：2026-07-02 GMT+08:00
查看PDF
分享

创建DRS同步任务 - CreateDrsJobTask

功能介绍

创建DRS同步任务。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

rds:instance:createDrsJob

write

instance

-

-

drs:migrationJob:batchCreateJob、drs:migrationJob:listJobStatus、drs:migrationJob:batchTestConnection、drs:migrationJob:selectDatabaseObject、drs:migrationJob:batchPreCheckJob、drs:migrationJob:listPrecheckResult、drs:migrationJob:batchStartJob

URI

  • URI格式

    POST /v3/{project_id}/instances/{instance_id}/drs-job/create

  • 参数说明
    表1 参数说明

    参数

    是否必选

    参数类型

    描述

    project_id

    是

    String

    参数解释：

    租户在某一region下的project ID。

    获取方法请参见获取项目ID。

    约束限制：

    不涉及。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

    instance_id

    是

    String

    参数解释：

    实例ID。

    可调用查询数据库实例列表接口，通过表4中的“id”获取。

    约束限制：

    不涉及。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

请求参数

表2 参数说明

名称

是否必选

参数类型

说明

target_instance_id

是

String

参数解释：

目标实例ID。

可调用查询数据库实例列表接口，通过表4中的“id”获取。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

target_user_name

是

String

参数解释：

目标实例账号。

可调用查询数据库用户列表接口，通过表3中的“name”获取。

约束限制：

需要具有CREATEDB权限。

取值范围：

不涉及。

默认取值：

不涉及。

target_user_password

是

String

参数解释：

目标实例账号对应的密码。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

source_user_name

是

String

参数解释：

源实例账号。

可调用查询数据库用户列表接口，通过表3中的“name”获取。

约束限制：

源账号需要具有REPLICATION权限，若所选库存在无主键表，需要CREATEDB权限。

取值范围：

不涉及。

默认取值：

不涉及。

source_user_password

是

String

参数解释：

源实例账号对应的密码。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

database_list

是

List<String>

参数解释：

源实例数据库名称，个数与实例规格有关。

可调用查询数据库列表接口，通过表3中的“name”获取。

约束限制：

不涉及。

取值范围：

多个数据库名称用逗号隔开，示例：["test001","test002"]

默认取值：

不涉及。

drs_node_type

是

String

参数解释：

DRS实例规格。

约束限制：

不涉及。

取值范围：

  • micro：极小。
  • small：小。
  • medium：中。
  • high：大。
  • xlarge：超大。
  • 2xlarge：极大。

不同规格类型对应不同性能的性能上限，详细可参考实时同步链路规格说明。

默认取值：

不涉及。

enterprise_project_id

否

String

参数解释：

企业项目ID。

可调用查询数据库实例列表接口，通过表4中的“enterprise_project_id”获取。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求示例

创建DRS同步任务。 
POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/42d4b4fc17d144bbb3ba64a306e68c72in03/drs-job/create

{
    "target_instance_id": "2318c01884da47d08070d2d74a2378efin03",
    "database_list": [
        "test001"
    ],
    "source_user_name": "root",
    "source_user_password": "Test123456",
    "drs_node_type": "medium",
    "target_user_name": "root",
    "target_user_password": "Test123456",
    "enterprise_project_id": "0"
}

响应消息

  • 正常响应要素说明
    表3 要素说明

    名称

    参数类型

    说明

    job_id

    String

    参数解释：

    任务ID。

    取值范围：

    不涉及。
  • 正常响应样例 
    { 
        "job_id": "87620726-6802-46c0-9028-a8785e1f1921"
}
  • 异常响应

    请参见异常响应结果。

状态码

错误码

请参见错误码。

相关文档