Querying Tags of a Project

Function

This API is used to query all tags of a resource type in a region.

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}/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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Number of resources on each page. The value ranges from 1 to 100. The default value is 100. Generally, the value is set to 10, 20, or 50.
offset	No	Integer	Index position. If offset is set to N, the resource query starts from the N+1 piece of data. The default value is 0, indicating that the query starts from the first piece of data. The value cannot be a negative number.

Request Parameters

**Table 3** 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 4** Response body parameters
Parameter	Type	Description
tags	Array of Tags objects	Specifies resource tag list.

**Table 5** Tags
Parameter	Type	Description
key	String	Specifies the tag key. A key can contain a maximum of 127 Unicode characters. key must be specified.
values	Array of strings	Specifies the tag value list. A maximum of 10 values are supported. Values of the same tag must be unique. Each tag value can contain a maximum of 255 Unicode characters. If this parameter is left blank, any value can be used. All values of a tag key are in the OR relationship.

Example Requests

Querying all tags of a resource type in a region

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

Example Responses

Status code: 200

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