Help Center/ Data Replication Service/ API Reference/ APIs V5.0 (in OBT)/ Task Operations/ Verifying a Task Name
Updated on 2025-12-15 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Verifying a Task Name

Function

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

Constraints

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

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}/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.

Request Parameters

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.

Response Parameters

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

Example Request

Verifying a task name

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

Example Response

Status code: 200

OK 
{
  "is_valid": true
}

Status code: 422

Bad Request

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

Error Code

For details, see Error Code.

Parent topic: Task Operations