Updated on 2025-10-28 GMT+08:00

Querying Resource Tags

Function

This API is used to query all resource tags.

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

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

resource_type

Yes

String

Specifies the resource type.

cph-server: cloud phone server

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.

It can be obtained by calling an Identity and Access Management (IAM) API. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

tags

Array of Tag objects

Resource tag list

Table 4 Tag

Parameter

Type

Description

key

String

Specifies the tag key.

  • A key can contain a maximum of 127 Unicode characters.

  • A key cannot be left blank, start or end with a space, nor start with sys. A key can contain letters, digits, spaces, and special characters _.:=+-@ of any language.

value

String

Specifies the list of tag values.

  • Each tag value can contain a maximum of 255 Unicode characters.

  • A tag value cannot be left blank nor start or end with a space. It can contain letters, digits, spaces, and special characters _.:=+-@.

Example Requests

Querying tags of a resource based on the resource ID

GET https://{CPH Endpoint}/v1/{project_id}/{resource_type}/{resource_id}/tags

Example Responses

Status code: 200

OK

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

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.