Querying Resource Tags of an Account in a Project

Function

This API is used to query the resource tags of an account in a project.

URI

GET /v2/{project_id}/cbs/instance/tags

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see "Obtaining a Project ID."

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. You can obtain it by calling the IAM API. The value of X-Subject-Token in the response header is the user token. For details, see "Obtaining the Token of an IAM User."

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
tags	Array of Tags objects	Tag list.

**Table 4** Tags
Parameter	Type	Description
key	String	Tag key. NOTE: Note: A key can contain 1 to 128 characters. A key can contain UTF-8 letters, digits, spaces, and the following characters: _. : = + - @ Do not enter labels starting with *sys, which are system labels. Recommended regular expression: ^((?!sys)[\p{L}\p{Z}\p{N}_.:=+\-@])$
values	Array of strings	List of tag values. NOTE: Note: A value can contain 0 to 255 characters. Can contain UTF-8 letters, digits, spaces, and the following characters: . : / = + - @ Recommended regular expression: ^([\p{L}\p{Z}\p{N}.:/=+-@]*)$ The value can be empty or null. The value of a predefined tag cannot be empty or null.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_description	String	Incorrect request parameters.

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_description	String	Failed to verify the token.

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_description	String	Permissions required.

Status code: 404

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_description	String	Not CBH instances found.

Example Requests

None

Example Responses

Status code: 200

Show Project Tags Success

{
  "tags" : [ {
    "key" : "cbh-test",
    "values" : [ "test1", "test2" ]
  }, {
    "key" : "cbh-test1",
    "values" : [ "test3", "test4" ]
  } ]
}