Updated on 2025-08-26 GMT+08:00

Obtaining Custom Tags

Function

This API is used to obtain custom tags.

Calling Method

For details, see Calling APIs.

URI

GET /cce/v1/{project_id}/{resource_type}/tags

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Details:

Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

Constraints:

None

Options:

Project IDs of the account

Default value:

N/A

resource_type

Yes

String

Definition

Resource type

Constraints

N/A

Range

  • cce-cluster: cluster

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Details:

The request body type or format

Constraints:

The GET method is not verified.

Options:

  • application/json

  • application/json;charset=utf-8

  • application/x-pem-file

  • multipart/form-data (used when the FormData parameter is present)

Default value:

N/A

X-Auth-Token

Yes

String

Details:

Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see Obtaining a User Token.

Constraints:

None

Options:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

tags

Array of CustomizeResourceTag objects

Definition

Custom tags

Constraints

N/A

Table 4 CustomizeResourceTag

Parameter

Type

Description

key

String

Definition

Key

Constraints

N/A

Range

  • The value cannot be empty and cannot start or end with spaces. A maximum of 128 characters is supported.

  • The value can contain letters, digits, and spaces in UTF-8 format.

  • The value can contain the following special characters: _.:=+-@

  • The value cannot start with _sys_.

Default Value

N/A

values

Array of strings

Definition

Value list

Constraints

N/A

Range

N/A

Default Value

N/A

Example Requests

None

Example Responses

Status code: 200

The custom tags have been obtained.

{
  "tags" : [ {
    "key" : "key1",
    "values" : [ "value1", "value2" ]
  } ]
}

Status Codes

Status Code

Description

200

The custom tags have been obtained.

Error Codes

See Error Codes.