Updated on 2023-05-09 GMT+08:00

Querying Key Tags

Function

  • Description: This API is used to query a key tag.

URI

GET /v1.0/{project_id}/kms/{key_id}/tags

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

key_id

Yes

String

Key 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 that is used for obtaining a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

tags

Array of TagItem objects

Tag list, which is a collection of key-value pairs.

  • key: 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. It can contain up to 36 characters.

  • value: Tag value. Each tag value can contain a maximum of 43 characters. The values are in the AND relationship.

existTagsNum

Integer

Number of key tags.

Table 4 TagItem

Parameter

Type

Description

key

String

Key. A tag key can contain a maximum of 36 Unicode characters. This parameter cannot be left blank. It cannot contain ASCII characters (0–31), asterisks (*), angle brackets (< and >), backslashes (), and equal signs (=).

value

String

Value A tag value contains a maximum of 43 Unicode characters and can be left blank. It cannot contain ASCII characters (0–31), asterisks (*), angle brackets (< and >), backslashes (), and equal signs (=).

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 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

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

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

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

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

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

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 processing succeeded.

{
  "tags" : [ {
    "key" : "key1",
    "value" : "value1"
  }, {
    "key" : "key2",
    "value" : "value2"
  } ],
  "existTagsNum" : 2
}

Status Codes

Status Code

Description

200

Request processing succeeded.

400

Invalid request parameters.

401

You must enter a username and password to access the requested page.

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 received an invalid response.

504

Gateway timed out.

Error Codes

See Error Codes.