Wei, Hongmin ab04d48074 TMS API 1024 Version

Reviewed-by: Ziuzko, Alevtina <alevtina.ziuzko@t-systems.com>
Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com>
Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>

2023-11-17 10:45:11 +00:00

13 KiB

Raw Permalink Blame History

Modifying Predefined Tags

Function

This API is used for modifying predefined tags.

URI

PUT /v1.0/predefine_tags

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
old_tag	Yes	Object	Specifies the tag to be modified. For details, see Table 3.
new_tag	Yes	Object	Specifies the tag that has been modified. For details, see Table 4.

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

new_tag field description

**Table 4** Fields
Name	Mandatory	Type	Description
key	Yes	String	Specifies the key. It can contain up to 36 Unicode characters and cannot be left blank. 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

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

{
    "new_tag": {
        "key": "ENV1",
        "value": "DEV1"
    },
    "old_tag": {
        "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

13 KiB Raw Permalink Blame History