更新时间:2026-07-29 GMT+08:00

导出任务列表 - ExportJobList

功能介绍

导出任务列表

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

POST /v5/{project_id}/export-jobs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

租户在某一Region下的Project ID。

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

参数解释

发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。

约束限制:

不涉及。

取值范围:

application/json

默认取值:

application/json

X-Auth-Token

String

参数解释

从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

X-Language

String

参数解释:

请求语言类型。

约束限制:

请根据语言环境,参考支持的范围指定请求语言类型。

取值范围:

  • en-us:英语
  • zh-cn:中文
  • es-us:西班牙语
  • pt-br:葡萄牙语

默认取值:

en-us

表3 请求Body参数

参数

是否必选

参数类型

描述

job_type

String

参数解释:

DRS任务的业务场景类型。用于筛选导出特定业务场景类型的任务列表。

约束限制:

不涉及。

取值范围:

  • backupMigration 备份迁移
  • subscription 订阅

默认取值:

不涉及

name

String

参数解释:

任务名称。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及

status

String

参数解释:

任务状态。默认查询所有状态的任务。

约束限制:

不涉及。

取值范围:

当job_type是migration,sync,cloudDataGuard

任务状态取值如下:

  • CREATING:创建中。
  • CREATE_FAILED:创建失败。
  • CONFIGURATION:配置中。
  • STARTJOBING:启动中。
  • WAITING_FOR_START:等待启动中。
  • START_JOB_FAILED:任务启动失败。
  • FULL_TRANSFER_STARTED:全量迁移中,灾备场景为初始化。
  • FULL_TRANSFER_FAILED:全量迁移失败,灾备场景为初始化失败。
  • FULL_TRANSFER_COMPLETE:全量迁移完成,灾备场景为初始化完成。
  • INCRE_TRANSFER_STARTED:增量迁移中,灾备场景为灾备中。
  • INCRE_TRANSFER_FAILED:增量迁移失败,灾备场景为灾备异常。
  • RELEASE_RESOURCE_STARTED:结束任务中。
  • RELEASE_RESOURCE_FAILED:结束任务失败。
  • RELEASE_RESOURCE_COMPLETE:已结束。
  • CHANGE_JOB_STARTED:任务变更中。
  • CHANGE_JOB_FAILED:任务变更失败。
  • CHILD_TRANSFER_STARTING:子任务启动中。
  • CHILD_TRANSFER_STARTED:子任务迁移中。
  • CHILD_TRANSFER_COMPLETE:子任务迁移完成。
  • CHILD_TRANSFER_FAILED:子任务迁移失败。
  • RELEASE_CHILD_TRANSFER_STARTED:子任务结束中。
  • RELEASE_CHILD_TRANSFER_COMPLETE:子任务已结束。
  • 异常状态可单独查询,也可以通过以下方式查询全部异常任务:CREATE_FAILED,START_JOB_FAILED,FULL_TRANSFER_FAILED,INCRE_TRANSFER_FAILED,RELEASE_RESOURCE_FAILED,CHANGE_JOB_FAILED,CHILD_TRANSFER_FAILED。

当job_type是backupMigration

任务状态取值如下:

  • SUCCESS:成功。
  • TRANSFERRING:备份迁移中。
  • FAILED:失败。
  • PRECHECK FAILED:预检查失败。

当job_type是subscription

任务状态取值如下:

  • SUBSCRIPTION_STARTED:创建中。
  • CREATE_FAILED:创建失败。
  • SUBSCRIPTION_FAILED:订阅失败。
  • CONFIGURATION:配置中。
  • STARTJOBING:启动中。
  • REBUILD_NODE_STARTED:故障恢复。
  • REBUILD_NODE_FAILED:故障恢复失败。
  • START_JOB_FAILED:任务启动失败。

默认取值:

不涉及

dbs_instance_ids

Array of strings

参数解释:

数据库实例ID。

约束限制:

最大数量为10。

取值范围:

不涉及。

默认取值:

不涉及。

description

String

参数解释:

描述。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

create_at

String

参数解释:

创建时间。

约束限制:

当job_type取值:migration,sync,cloudDataGuard, 任务创建时间,比如"2026-05-25T13:41:00.127Z|2026-05-28T13:41:00.999Z"

当job_type取值:backupMigration, 表示任务创建时间,比如"2026-05-25T13:41:00.127Z|2026-05-28T13:41:00.999Z"

当job_type取值:subscription,表示消费时间点,比如"2026-05-25T13:25:46.383Z|2026-05-28T13:25:46.999Z"

取值范围:

不涉及。

默认取值:

不涉及。

completed_at

String

参数解释:

完成时间。

约束限制:

在job_type是backupMigration时支持该参数填写, 表示任务完成时间,比如"2026-05-25T13:41:00.127Z|2026-05-28T13:41:00.999Z"

取值范围:

不涉及。

默认取值:

不涉及。

enterprise_project_id

String

参数解释:

企业项目ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

engine_type

String

参数解释:

引擎类型。

约束限制:

当job_type取值:backupMigration 时,该参数取值是sqlserver

取值范围:

不涉及。

默认取值:

不涉及。

net_type

String

参数解释:

网络类型。

约束限制:

当job_type取值:migration,sync,cloudDataGuard,该参数支持填写。

取值范围:

  • eip:公网网络。
  • vpc:VPC网络。
  • vpn:VPN、专线网络。

默认取值:

不涉及。

billing_tag

String

参数解释:

计费标识。

约束限制:

当job_type取值:migration,sync,cloudDataGuard,subscription,该参数支持填写。

取值范围:

  • 0 计费中
  • 1 未计费

默认取值:

不涉及

billing_mode

String

参数解释:

计费模式。

约束限制:

当job_type取值:migration,sync,cloudDataGuard,subscription,该参数支持填写。

取值范围:

  • 0 计费中
  • 1 未计费

默认取值:

不涉及

public_ip

String

参数解释:

实例绑定的公网IP。

约束限制:

当job_type取值:migration,sync,cloudDataGuard,支持该参数填写。

取值范围:

不涉及。

默认取值:

不涉及。

instance_ip

String

参数解释:

DRS绑定的数据库实例IP。

约束限制:

当job_type取值:migration,sync,cloudDataGuard,支持该参数填写。

取值范围:

不涉及。

默认取值:

不涉及。

inner_ip

String

参数解释:

DRS绑定的内网IP。

约束限制:

当job_type取值:migration,sync,cloudDataGuard,支持该参数填写。

取值范围:

不涉及。

默认取值:

不涉及。

spec_type

String

参数解释:

规格类型。

约束限制:

当job_type取值:migration,sync,cloudDataGuard,支持该参数填写。

取值范围:

  • 2xlarge:极大规格。
  • xlarge:超大规格。
  • high:大规格。
  • medium:中规格。
  • small:小规格。
  • micro:极小规格。

默认取值:

不涉及

direction

String

参数解释:

数据流动方向。

约束限制:

当job_type取值migration,sync时支持传值,

取值:

  • up:入云
  • down:出云
  • non-dbs:自建
  • multiWrite:双向同步

当job_type取值cloudDataGuard时支持传值,

取值:

  • up:本云为备
  • down:本云为主
  • multiWrite:双主灾备

取值范围:

  • up
  • down
  • non-dbs
  • multiWrite

默认取值:

不涉及

task_type

String

参数解释:

同步类型。

约束限制:

当job_type取值migration,sync时支持传值。

取值范围:

  • FULL_INCR_TRANS
  • FULL_TRANS
  • INCR_TRANS

默认取值:

不涉及

sort_key

String

参数解释:

返回结果按该关键字排序

约束限制:

不涉及。

取值范围:

  • name
  • status
  • create_time
  • net_type
  • job_direction
  • pay_mode

默认取值:

create_time

sort_dir

String

参数解释:

降序或升序

约束限制:

不涉及。

取值范围:

  • desc 降序
  • asc 升序

默认取值:

desc

tag

String

参数解释:

标签

约束限制:

不涉及。

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:202

表4 响应Body参数

参数

参数类型

描述

id

String

参数解释:

异步任务的唯一标识符,用于后续查询任务执行进度。

约束限制:

不涉及

取值范围:

不涉及

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码,当任务报错时返回的错误代码。

约束限制

  • 最小长度:12
  • 最大长度:12

取值范围

格式为DRS.XXXXXX。

error_msg

String

参数解释

错误详细信息,当任务执行失败时返回的具体错误描述。

约束限制

  • 最小长度:1
  • 最大长度:512

取值范围

不涉及。

请求示例

导出备份迁移任务列表

https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/export-jobs 
 
{ 
  "job_type": backupMigration 
}

响应示例

状态码:202

ACCEPTED

{ 
  "id" : "0eacda0b-9422-4535-8b62-537d1833638b" 
}

状态码:400

Bad Request

{ 
  "error_code" : "DRS.10000023", 
  "error_msg" : "program exception" 
}

状态码

状态码

描述

200

OK

400

Bad Request

其他状态请参见状态码

错误码

请参见错误码