Help Center> Data Encryption Workshop> API Reference> APIs> Secret Management APIs> Secret Tag Management> Querying a Secret Tag
View PDF

Querying a Secret Tag

Function

  • This API is used to query a secret tag.

Debugging

You can debug this API in API Explorer.

URI

GET /{version_id}/{project_id}/csms/{secret_id}/tags

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

version_id

Yes

String

API version

secret_id

Yes

String

Secret ID

Request Parameter

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. The token can be obtained by calling the IAM API. (The token is the value of X-Subject-Token in the response header.)

Response Parameters

Status code: 200

Table 3 Response body parameter

Parameter

Type

Description

tags

Array of TagItem objects

List of tags, including tag keys and tag values.

  • key indicates the tag key. A CMK can have a maximum of 10 keys, and each of them is unique and cannot be empty. A key cannot have duplicate values. The value of key contains a maximum of 36 characters.

  • value indicates the tag value. Each tag value can contain a maximum of 43 characters. A search result matches all the values.
Table 4 TagItem

Parameter

Type

Description

key

String

Key. The value contains a maximum of 36 Unicode characters. The value of key cannot be empty. It cannot contain ASCII characters (0–31), asterisks (*), angle brackets (< and >), backslashes (\), and equal signs (=).

value

String

Value. Each value contains a maximum of 43 Unicode characters and can be an empty string. It cannot contain ASCII characters (0–31), asterisks (*), angle brackets (< and >), backslashes (\), and equal signs (=).

Status code: 400

Table 5 Response body parameter

Parameter

Type

Description

error

ErrorDetail object
Table 6 ErrorDetail

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error information

Status code: 401

Table 7 Response body parameter

Parameter

Type

Description

error

ErrorDetail object
Table 8 ErrorDetail

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error code

Status code: 403

Table 9 Response body parameter

Parameter

Type

Description

error

ErrorDetail object
Table 10 ErrorDetail

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error information

Status code: 404

Table 11 Response body parameter

Parameter

Type

Description

error

ErrorDetail object
Table 12 ErrorDetail

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error information

Status code: 500

Table 13 Response body parameter

Parameter

Type

Description

error

ErrorDetail object
Table 14 ErrorDetail

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error information

Status code: 502

Table 15 Response body parameter

Parameter

Type

Description

error

ErrorDetail object
Table 16 ErrorDetail

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error information

Status code: 504

Table 17 Response body parameter

Parameter

Type

Description

error

ErrorDetail object
Table 18 ErrorDetail

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error information

Example Request

None

Example Response

None

Status Code

Status Code

Description

200

The request has succeeded.

400

Invalid request parameters.

401

Username and password are required to access the page requested.

403

Authentication failed.

404

The requested resource does not exist or is not found.

500

Internal service error.

502

Failed to complete the request. The server receives an invalid response from the upstream server.

504

Gateway timed out.

Error Code

For details, see Error Code.

Parent topic: Secret Tag Management