Creating a Subscription Task_Task Management_APIs V5.0_API Reference

Function

This API is used to create a subscription task.

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

POST /v5/{project_id}/subscription

**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.

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	Yes	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	Task description.
instance_type	No	String	Instance type. Only RDS is supported.
enterprise_project_id	Yes	String	Enterprise project ID. Default value: "", indicating that tasks in all enterprise projects are queried.
tags	No	Array of objects	Tags. For details, see ResourceTag.
source_endpoint_info	Yes	object	Source database information. For details, see SubscriptionSourceEndpointInfo.
is_grant_new_agency	No	Boolean	Whether to create an agency. The value can be: true: An agency is to be created. false: No agency is to be created. The default value is false.

**Table 4** ResourceTag
Parameter	Mandatory	Type	Description
key	No	String	Tag key. The value can contain a maximum of 36 characters, including letters, digits, underscores (_), and hyphens (-).
value	No	String	Tag value. A tag value can contain letters, digits, spaces, and any of the following characters: _ . : / = + - @

**Table 5** SubscriptionSourceEndpointInfo
Parameter	Mandatory	Type	Description
id	Yes	String	DB instance ID.
type	No	String	DB instance type. Only MySQL is supported.

Response Parameters

Status code: 202

**Table 6** Response body parameters
Parameter	Type	Description
job_id	String	Task ID.

Status code: 400

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

Example Request

https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/subscription

{
  "name" : "DRS-123",
  "source_endpoint_info" : {
    "id" : "1cb044d1ca7b41b7935d336f72a7a45cin01"
  },
  "enterprise_project_id" : "0"
}

Example Response

Status code: 202

{
  "job_id" : "1caa1fec-ad7f-4281-b0f6-ad41e67a346c"
}

Status code: 400

Bad Request

{
  "error_code" : "DRS.M00202",
  "error_msg" : "The value of name is invalid."
}

Status Codes

Status Code	Description
202	OK
400	Bad Request

For other statuses, see Status Code.

Error Code

For details, see Error Code.

Creating a Subscription Task