Updated on 2026-09-07 GMT+08:00

Modifying Subscription Task Information

Function

This API is used to modify subscription task information.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permissions are required for calling this API.

URI

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region For details about how to obtain the project ID, see Obtaining a Project ID.
job_id	Yes	String	Task ID. For details about how to obtain the task ID, see Obtaining a Task ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	No	String	MIME type of the request body. Use the default value application/json. For APIs used to upload objects or images, the value varies depending on the flow type.
X-Auth-Token	Yes	String	User token obtained from IAM. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a request is processed, the value of X-Subject-Token in the header is the token value.
X-Language	No	String	Request language type Enumerated values: en-us zh-cn

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	No	String	Task name. The task name can be 4 to 50 characters in length. It is case-insensitive and can contain only letters, digits, hyphens (-), and underscores (_). Minimum length: 4 Maximum length: 50
description	No	String	Description.
consume_time	No	Long	Consumption start time. After the consumption start time is changed, the incremental data obtained starts from the changed consumption start time. Constraints: The modified consumption start time must be within the time range of the subscription task (from the time when the task is created to the current time). The value is a timestamp, for example, 1769393264000.

Response Parameters

Status code: 200

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

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

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

Example Response

Status code: 200

{ }

Status code: 400

Bad Request

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

Status Codes

Status Code	Description
200	OK
400	Bad Request

For other statuses, see Status Code.

Error Code

For details, see Error Code.

Parent topic: Task Management