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

启动订阅任务 - StartSubscription

功能介绍

启动订阅任务

授权信息

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

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

URI

POST /v5/{project_id}/subscription/{job_id}/start

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的Project ID。

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及

job_id

String

参数解释

任务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:中文

默认取值:

en-us

响应参数

状态码:202

Accepted

状态码:400

表3 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

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

约束限制

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

取值范围

格式为DRS.XXXXXX。

error_msg

String

参数解释

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

约束限制

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

取值范围

不涉及。

请求示例

启动订阅任务

/v5/{project_id}/subscription/{job_id}/start

响应示例

状态码:202

Accepted

{ }

状态码:400

Bad Request

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

状态码

状态码

描述

200

OK

400

Bad Request

其他状态请参见状态码

错误码

请参见错误码