Updated on 2024-03-27 GMT+08:00

Querying Tags of a Task

Function

This API is used to query tags of a specified task.

URI

GET /v5/{project_id}/jobs/{resource_type}/{job_id}/tags

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.

resource_type

Yes

String

Resource type.

  • migration: real-time migration.
  • sync: real-time synchronization.
  • cloudDataGuard: real-time disaster recovery.
  • subscription: data subscription.
  • backupMigration: backup migration.
  • replay: simulation replay.

Enumerated values:

  • migration
  • sync
  • cloudDataGuard
  • subscription
  • backupMigration
  • replay

job_id

Yes

String

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

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

tags

Array of objects

Tag list.

For details, see Table 4.

Table 4 Data structure description of field tags

Parameter

Type

Description

key

String

Tag key.

  • It must consist of 1 to 128 Unicode characters,
  • including letters, digits, spaces, and special characters _.:=+-@. However, it cannot start or end with a space, or start with _sys_.

Minimum length: 1

Maximum length: 128

value

String

Tag value. This parameter is optional for deleting a tag.

  • Each tag value can contain a maximum of 255 Unicode characters.
  • The value can contain letters of any language, digits, spaces, and special characters _.:=+-@

Maximum length: 255

Example Request

Querying real-time synchronization task tags

 https://{endpoint}/v5/246765b9f59445c3919fce121ea801f4/jobs/sync/e6842695-3ade-4937-827b-ff92776jb20a/tags

Example Response

Status code: 200

OK

{
  "tags": [
    {
      "key": "aaa",
      "value": "bbbb"
    }
  ]
}

Status Code

Status Code

Description

200

OK

Error Code

For details, see Error Code.