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.

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	Project ID. To obtain the value, 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 for obtaining a user token. The token is the value of X-Subject-Token in the response header. For details, see Obtaining a User Token.

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. It cannot be left blank. UTF-8 letters, digits, spaces, and the following characters are allowed: _ . :=+ - @. *sys* is reserved as the prefix of system tags and cannot be used by users. Recommended regular expression: ^((?!sys)[\p{L}\p{Z}\p{N}_.:=+\-@]*)$.c
values	Array of strings	The tag value list. Length: 0 to 255 characters UTF-8 letters, digits, spaces, and the following characters are allowed: _ . :/=+-@. 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	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" ]
  } ]
}

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.

Parent topic:Label Management

Previous topic: Label Management

Next topic: Querying the Tag Information of a CBH Instance

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot