- API Reference
- APIs
- CMK Management
- Querying CMK Tags
Querying CMK Tags¶
Function¶
This API allows you to query tags of a specified CMK.
TMS may use this API to query all tags of a specified CMK.
URI¶
URI format
GET /v1.0/{project_id}/kms/{key_id}/tags
Parameter description
Table 1 Parameter description¶ Parameter
Mandatory
Type
Description
project_id
Yes
String
Project ID
key_id
Yes
String
36-byte ID of a CMK that matches the regular expression ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$
Example: 0d0466b0-e727-4d9c-b35d-f84bb474a37f
Requests¶
None
Responses¶
Parameter | Mandatory | Type | Description |
---|---|---|---|
tags | Yes | Array of objects | list of tags, including tag keys and tag values.
|
existTagNum | Yes | Integer | Number of key tags. |
Examples¶
The following example describes how to query CMK tags.
Example request
None
Example response
{ "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value3" } ], "existTagsNum":2 }
or
{ "error": { "error_code": "KMS.XXXX", "error_msg": "XXX" } }
Status Codes¶
Table 3 lists the normal status code returned by the response.
Status Code | Status | Description |
---|---|---|
200 | OK | Request processed successfully. |
Exception status code. For details, see Status Codes.