Verifying a Task Name

This API is used to verify a task name during task creation.

This API can be used only in certain regions. For details, see Endpoints.

POST /v5/{project_id}/jobs/name-validation

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region. For details, see Obtaining a Project ID.

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	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. The default value is application/json.
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. Default value: en-us Enumerated values: en-us zh-cn

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Task name, which must start with a letter and consist of 4 to 50 characters. It can contain only letters, digits, hyphens (-), and underscores (_).
type	Yes	String	Task type. trans: used for real-time migration, synchronization, and disaster recovery. subscription: used for data subscription. offline: used for backup migration.

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
is_valid	Boolean	Whether the task name is valid.

Status code: 422

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code. Minimum length: 12 Maximum length: 12
error_msg	String	Error message. Minimum length: 1 Maximum length: 512

Verifying a task name

https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/name-validation
{
  "name": "DRS-211",
  "type": "trans"
}

Status code: 200

{
  "is_valid": true
}

Status code: 422

Bad Request

{
  "error_code": "DRS.M00277",
  "error_msg": "The task name already exists."
}

For details, see Error Code.

Parent topic: Task Operations

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.