Help Center> Tag Management Service> API Reference> API Description> Operations on Predefined Tags> Creating and Deleting Predefined Tags
View PDF

Creating and Deleting Predefined Tags

Function

Used to create and delete predefined tags. You can add tags to resources using the predefined tags. This API supports idempotency and batch processing.

Debugging

You can use API Explorer to debug this API.

URI

POST /v1.0/predefine_tags/action

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. Note: TMS is a global service. Therefore, when calling the IAM service to obtain user tokens, set the scope field to domain. The value of X-Subject-Token in the response header is the user token.
Table 2 Request body parameters

Parameter

Mandatory

Type

Description

action

Yes

String

Operation ID (case sensitive): create, delete

tags

Yes

Array of PredefineTagRequest objects

Tag list.
Table 3 PredefineTagRequest

Parameter

Mandatory

Type

Description

key

Yes

String

Indicates the tag key. A tag key can contain up to 36 characters. The character set is as follows: A-Z, a-z, 0-9, hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF).

value

Yes

String

Value. The value contains a maximum of 43 characters and can be an empty string. Character set: AZ, a-z, 0-9, '.', '-', '_', UNICODE characters (\u4E00-\u9FFF), ...

Response Parameters

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Response error information.
Table 5 RespErrorMessage

Parameter

Type

Description

error_code

String

Request error code.

error_msg

String

Error message

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Response error information.
Table 7 RespErrorMessage

Parameter

Type

Description

error_code

String

Request error code.

error_msg

String

Error message

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Response error information.
Table 9 RespErrorMessage

Parameter

Type

Description

error_code

String

Request error code.

error_msg

String

Error message

Status code: 404

Table 10 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Response error information.
Table 11 RespErrorMessage

Parameter

Type

Description

error_code

String

Request error code.

error_msg

String

Error message

Status code: 405

Table 12 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Response error information.
Table 13 RespErrorMessage

Parameter

Type

Description

error_code

String

Request error code.

error_msg

String

Error message

Status code: 406

Table 14 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Response error information.
Table 15 RespErrorMessage

Parameter

Type

Description

error_code

String

Request error code.

error_msg

String

Error message

Status code: 409

Table 16 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Response error information.
Table 17 RespErrorMessage

Parameter

Type

Description

error_code

String

Request error code.

error_msg

String

Error message

Status code: 410

Table 18 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Response error information.
Table 19 RespErrorMessage

Parameter

Type

Description

error_code

String

Request error code.

error_msg

String

Error message

Status code: 412

Table 20 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Response error information.
Table 21 RespErrorMessage

Parameter

Type

Description

error_code

String

Request error code.

error_msg

String

Error message

Status code: 429

Table 22 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Response error information.
Table 23 RespErrorMessage

Parameter

Type

Description

error_code

String

Request error code.

error_msg

String

Error message

Status code: 500

Table 24 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Response error information.
Table 25 RespErrorMessage

Parameter

Type

Description

error_code

String

Request error code.

error_msg

String

Error message

Status code: 501

Table 26 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Response error information.
Table 27 RespErrorMessage

Parameter

Type

Description

error_code

String

Request error code.

error_msg

String

Error message

Status code: 503

Table 28 Response body parameters

Parameter

Type

Description

error

RespErrorMessage object

Response error information.
Table 29 RespErrorMessage

Parameter

Type

Description

error_code

String

Request error code.

error_msg

String

Error message

Example Requests

  • Creating Predefined Tags 
    POST https://{Endpoint}/v1.0/predefine_tags/action

{
  "action" : "create",
  "tags" : [ {
    "key" : "ENV",
    "value" : "DEV"
  }, {
    "key" : "ENV",
    "value" : "DEV"
  } ]
}
  • Deleting Predefined Tags 
    POST https://{Endpoint}/v1.0/predefine_tags/action

{
  "action" : "delete",
  "tags" : [ {
    "key" : "ENV",
    "value" : "DEV"
  }, {
    "key" : "ENV",
    "value" : "DEV"
  } ]
}

Example Responses

None

Status Codes

Status Code

Description

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method Not Allowed

406

Not Acceptable

409

Conflict

410

Gone

412

Precondition Failed

429

Too Many Requests

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

Error Codes

See Error Codes.