doc-exports/docs/tms/api-ref/en-us_topic_0056765935.html

Creating or Deleting Predefined Tags

Function

This API is used to create or delete predefined tags. You can add tags to resources using the predefined tags.

This API supports idempotency and batch processing.

Idempotent operations refer to invoking the same API for multiple times by using the same parameters, which have the same impact on the system.

URI

POST /v1.0/predefine_tags/action

Request

• Parameter description

  Table 1 Request header parameters

  Parameter	Mandatory	Type	Description
  X-Auth-Token	Yes	String	Specifies the user token. TMS is a global service. When calling the IAM API to obtain a user token, set scope to domain. The value of X-Subject-Token in the response header is the user token.

  Table 2 Parameters

  Name	Mandatory	Type	Description
  action	Yes	String	Specifies the operation identifier. This parameter value is case sensitive and can be create or delete.
  tags	Yes	Array of objects	Specifies the tags. For details, see Table 3.

• tags field description

  Table 3 Fields

  Name	Mandatory	Type	Description
  key	Yes	String	Specifies the key. It cannot be left blank and can contain a maximum of 36 Unicode characters. Only digits, letters, hyphens (-), at signs (@), and underscores (_) are allowed.
  value	Yes	String	Specifies the value. Each value contains a maximum of 43 Unicode characters and can be an empty string. Only digits, letters, hyphens (-), at signs (@), and underscores (_) are allowed.

• Example request

  POST https://{TMS endpoint}/v1.0/predefine_tags/action

  {
      "action": "create",
      "tags": [
          {
              "key": "ENV1",
              "value": "DEV1"
          },
          {
              "key": "ENV2",
              "value": "DEV2"
          }
      ]
  }

Example Response

Status code: 200

Successful operation

Status Codes

See Status Codes.

Error Codes

See Error Codes.

Parent topic: Predefined Tag Operations