Querying Resource Tags of an Account in a Project_Tag Management_API Description_API Reference

Function

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

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which uniquely identifies a project. To obtain the value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain the token by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. For details, see Obtaining a User Token. Constraints N/A Range String type. The value can contain 1 to 28,000 characters. Default Value N/A

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	The tag key. A key can contain 1 to 128 characters. A key can contain UTF-8 letters, digits, spaces, and the following characters: . :=+ - @. sys* is reserved as the prefix of system tags and cannot be used by users. Regular expression ^((?!sys)[\p{L}\p{Z}\p{N}.:=+\-@])$.c is recommended.
values	Array of strings	Value list. A value can contain 0 to 255 characters. A key can contain UTF-8 letters, digits, spaces, and the following characters: . :/=+-@. Recommended regular expression: ^([\p{L}\p{Z}\p{N}.:/=+-@]*)$. The tag value can be empty or null. The predefined tag value cannot be empty.

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	Token verification failed.

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

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

Status Codes

Status Code	Description
200	Show Project Tags Success
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found

Error Codes

See Error Codes.

Querying Resource Tags of an Account in a Project