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

Modifying Predefined Tags

Function

This API is used for modifying predefined tags.

URI

PUT /v1.0/predefine_tags

Request

• Parameter description

  Table 1 Parameters in the request

  Name	Mandatory	Type	Description
  old_tag	Yes	Object	Specifies the tag to be modified. For details, see Table 2.
  new_tag	Yes	Object	Specifies the tag that has been modified. For details, see Table 3.

• old_tag field description

  Table 2 Parameter description

  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 (-), 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 (-), and underscores (_) are allowed.

• new_tag field description

  Table 3 Parameter description

  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 (-), 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 (-), and underscores (_) are allowed.

• Example request

  PUT https://{TMS endpoint}/v1.0/predefined_tags

  {
      "new_tag": {
          "key": "ENV1",
          "value": "DEV1"
      },
      "old_tag": {
          "key": "ENV2",
          "value": "DEV2"
      }
  }

Response

• Parameter description

  None

• Example response

  None

Status Codes

See Status Codes.

Error Codes

See Error Codes.

Parent topic: Predefined Tag Operations