文档首页/ 数据复制服务 DRS/ API参考/ API v5（公测中）/ 实例管理/ 修改订阅任务的信息 - UpdateSubscriptionInfo
更新时间：2026-05-11 GMT+08:00
查看PDF
分享

修改订阅任务的信息 - UpdateSubscriptionInfo

功能介绍

修改订阅任务的信息

授权信息

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

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

URI

PUT /v5/{project_id}/subscriptions/{job_id}/info

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的Project ID。

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

job_id

是

String

任务ID。

获取方法请参见获取任务ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

否

String

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

X-Auth-Token

是

String

从IAM服务获取的用户Token。

用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

否

String

请求语言类型。

枚举值：

  • en-us

  • zh-cn
表3 请求Body参数

参数

是否必选

参数类型

描述

name

否

String

任务名称。

约束：任务名称在4位到50位之间，不区分大小写，可以包含字母、数字、中划线或下划线，不能包括其他特殊字符。

  • 最小长度：4

  • 最大长度：50

description

否

String

描述。

consume_time

否

Long

消费时间点，在修改完消费时间点后，拉取到的增量数据从修改后的消费时间点开始。

约束：修改的时间点必须在订阅任务的时间范围内（从任务创建到当前时间之间），取值为时间戳，例如：1769393264000。

响应参数

状态码：200

状态码：400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/subscriptions/fc77e18b-21c8-4040-96b5-ae599d3jb201/info

{
  "name" : "DRS-123123123",
  "description" : "TEST",
  "consume_time" : 1769850935472
}

响应示例

状态码：200

{ }

状态码：400

Bad Request

{
  "error_code" : "DRS. 10130018",
  "error_msg" : "The subscription task cannot have a consumption time set if it is not started. "
}

状态码

状态码

描述

200

OK

400

Bad Request

其他状态请参见状态码。

错误码

请参见错误码。

父主题： 实例管理

相关文档