Querying Project Tags

Function

This API is used to query all secret tags of a user in a specified project.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/csms/tags

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
tags	Array of TagResponse objects	Tag list, which is the value pairs of tag keys and values. key: Tag key. A secret can contain up to 20 keys. This value cannot be left blank or repeated. The value of a key must be unique and can contain up to 128 characters. value: Tag value. Each tag value can contain up to 255 characters. A search result matches all the values.

**Table 4** TagResponse
Parameter	Type	Description
key	String	Tag key,
values	Array of strings	Tag value set.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error	ErrorDetail object	Error message

**Table 6** ErrorDetail
Parameter	Type	Description
error_code	String	Error code returned for an error request.
error_msg	String	Error information returned for an error request.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error	ErrorDetail object	Error message

**Table 8** ErrorDetail
Parameter	Type	Description
error_code	String	Error code returned for an error request.
error_msg	String	Error information returned for an error request.

Status code: 403

**Table 9** Response body parameters
Parameter	Type	Description
error	ErrorDetail object	Error message

**Table 10** ErrorDetail
Parameter	Type	Description
error_code	String	Error code returned for an error request.
error_msg	String	Error information returned for an error request.

Status code: 404

**Table 11** Response body parameters
Parameter	Type	Description
error	ErrorDetail object	Error message

**Table 12** ErrorDetail
Parameter	Type	Description
error_code	String	Error code returned for an error request.
error_msg	String	Error information returned for an error request.

Status code: 500

**Table 13** Response body parameters
Parameter	Type	Description
error	ErrorDetail object	Error message

**Table 14** ErrorDetail
Parameter	Type	Description
error_code	String	Error code returned for an error request.
error_msg	String	Error information returned for an error request.

Status code: 502

**Table 15** Response body parameters
Parameter	Type	Description
error	ErrorDetail object	Error message

**Table 16** ErrorDetail
Parameter	Type	Description
error_code	String	Error code returned for an error request.
error_msg	String	Error information returned for an error request.

Status code: 504

**Table 17** Response body parameters
Parameter	Type	Description
error	ErrorDetail object	Error message

**Table 18** ErrorDetail
Parameter	Type	Description
error_code	String	Error code returned for an error request.
error_msg	String	Error information returned for an error request.

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "tags" : [ {
    "key" : "key1",
    "values" : [ "val1" ]
  }, {
    "key" : "key2",
    "values" : [ "val2" ]
  } ]
}

Status Codes

Status Code	Description
200	Request succeeded.
400	Invalid request parameter.
401	A username and password are required.
403	Authentication failed.
404	The requested resource does not exist or is not found.
500	Internal service error.
502	Failed to complete the request because the server receives an invalid response from an upstream server.
504	Gateway timed out.

Error Codes

See Error Codes.

Parent Topic: Secret Tag Management

Previous topic: Deleting a Secret Tag

Next topic: Event Management

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.

The system is busy. Please try again later.