Wei, Hongmin b99f77d8d1 TMS API 0721 Version

Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com>
Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>

2023-08-01 07:10:13 +00:00

10 KiB

Raw Blame History

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** Parameters in the request
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 2.

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

Example request

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

{
    "action": "create",
    "tags": [
        {
            "key": "ENV1",
            "value": "DEV1"
        },
        {
            "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

10 KiB Raw Blame History