导出任务列表 - ExportJobList
功能介绍
导出任务列表
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v5/{project_id}/export-jobs
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| 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 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| job_type | 是 | String | 参数解释: DRS任务的业务场景类型。用于筛选导出特定业务场景类型的任务列表。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及 |
| name | 否 | String | 参数解释: 任务名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
| status | 否 | String | 参数解释: 任务状态。默认查询所有状态的任务。 约束限制: 不涉及。 取值范围: 当job_type是migration,sync,cloudDataGuard 任务状态取值如下:
当job_type是backupMigration 任务状态取值如下:
当job_type是subscription 任务状态取值如下:
默认取值: 不涉及 |
| 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,该参数支持填写。 取值范围:
默认取值: 不涉及。 |
| billing_tag | 否 | String | 参数解释: 计费标识。 约束限制: 当job_type取值:migration,sync,cloudDataGuard,subscription,该参数支持填写。 取值范围:
默认取值: 不涉及 |
| billing_mode | 否 | String | 参数解释: 计费模式。 约束限制: 当job_type取值:migration,sync,cloudDataGuard,subscription,该参数支持填写。 取值范围:
默认取值: 不涉及 |
| 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,支持该参数填写。 取值范围:
默认取值: 不涉及 |
| direction | 否 | String | 参数解释: 数据流动方向。 约束限制: 当job_type取值migration,sync时支持传值, 取值:
当job_type取值cloudDataGuard时支持传值, 取值:
取值范围:
默认取值: 不涉及 |
| task_type | 否 | String | 参数解释: 同步类型。 约束限制: 当job_type取值migration,sync时支持传值。 取值范围:
默认取值: 不涉及 |
| sort_key | 否 | String | 参数解释: 返回结果按该关键字排序 约束限制: 不涉及。 取值范围:
默认取值: create_time |
| sort_dir | 否 | String | 参数解释: 降序或升序 约束限制: 不涉及。 取值范围:
默认取值: desc |
| tag | 否 | String | 参数解释: 标签 约束限制: 不涉及。 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:202
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 异步任务的唯一标识符,用于后续查询任务执行进度。 约束限制: 不涉及 取值范围: 不涉及 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,当任务报错时返回的错误代码。 约束限制:
取值范围: 格式为DRS.XXXXXX。 |
| error_msg | String | 参数解释: 错误详细信息,当任务执行失败时返回的具体错误描述。 约束限制:
取值范围: 不涉及。 |
请求示例
导出备份迁移任务列表
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"
} 错误码
请参见错误码。