Help Center/ Global Accelerator/ API Reference/ API/ Tag/ Adding Tags to a Resource
Updated on 2025-11-25 GMT+08:00
View PDF

Adding Tags to a Resource

Function

This API is used to add tags to a resource.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

POST /v1/{resource_type}/{resource_id}/tags/create

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

resource_type

Yes

Object

Resource type. Value range:

  • ga-accelerators: Global accelerators

  • ga-listeners: Listeners

resource_id

Yes

String

Specifies the resource ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token. The token can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

tags

Yes

Array of ResourceTag objects

Specifies the tags.
Table 4 ResourceTag

Parameter

Mandatory

Type

Description

key

Yes

String

The tag key.

  • A key can contain 1 to 128 characters. It cannot be left blank.

  • A key can contain UTF-8 letters, digits, spaces, and the following characters _.:=+-@

  • Do not enter a tag key starting with sys. Tag keys starting with sys are system tags.

value

Yes

String

The tag value.

  • A value can contain 0 to 255 characters.

  • A value can contain UTF-8 letters, digits, spaces, and the following characters _.:/=+-@

  • The tag value can be empty or null.

Response Parameters

Status code: 204

Table 5 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID.

Example Requests

Adding tags to a resource

POST https://{ga_endpoint}/v1/{resource_type}/{resource_id}/tags/create

{
  "tags" : [ {
    "key" : "tagKey",
    "value" : "tagValue"
  } ]
}

Example Responses

Status code: 204

Operation succeeded.

{
  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}

Status Codes

Status Code

Description

204

Operation succeeded.

Error Codes

See Error Codes.

Parent Topic: Tag