Help Center> Database Security Service> API Reference> API> Tag APIs> Querying Project Tags

Updated on 2024-04-11 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying Project Tags

Function

This API is used to query project tags.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
resource_type	Yes	String	Resource type.Default usage: auditInstance

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	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	Key. The value can contain up to 128 characters.The key must comply with the 3.1 KEY character set specifications.
values	Array of strings	Value list. Enter a maximum of 255 characters.The value must comply with specifications described in 3.2 Character Set Specifications for VALUE.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error	Object	Error message.

**Table 6** ErrorDetail
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error information.

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error	Object	Error message.

**Table 8** ErrorDetail
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error information.

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error	Object	Error message.

**Table 10** ErrorDetail
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error information.

Example Requests

/v1/{project_id}/{resource_type}/tags

Example Responses

Status code: 200

Success

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

Status code: 400

Failure

{
  "error" : {
    "error_code" : "DBSS.XXXX",
    "error_msg" : "XXX"
  }
}

Status Codes

Status Code	Description
200	Success
400	Failure
403	Authentication failed.
500	Server error.

Error Codes

See Error Codes.

Parent topic: Tag APIs

Previous topic: Tag APIs

Next topic: Querying Resource Instances by Tag

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.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

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

Chatbot