Querying Key Pair Tags
Function
This API is used to query key pair tags.
Calling Method
For details, see Calling APIs.
URI
GET /v3/{project_id}/keypairs/{resource_id}/tags
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition Project ID. For details, see Obtaining a Project ID. Constraints N/A Range The value returned by the IAM API is used, which contains 32 characters. Default Value N/A |
| resource_id | Yes | String | Definition Resource ID Constraints N/A Range N/A Default Value N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Definition User token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token. Constraints N/A Range Obtain the value by calling the IAM API for obtaining the user token. Default Value N/A |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| tags | Array of TagItem objects | Definition Tag list. If there is no tag, the array is empty by default. Definition N/A |
| sys_tags | Array of TagItem objects | Definition System tag list. If there is no tag in the list, an empty array is returned by default. Range N/A |
| Parameter | Type | Description |
|---|---|---|
| key | String | Definition Tag name Range The value can contain 1 to 128 characters and must match the regular expression ^((?!\s)(?!sys)[\p{L}\p{Z}\p{N}_.:=+\-@]*)(?<!\s)$. |
| value | String | Definition Tag value Range The value can contain at most 255 characters and must match the regular expression ^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)$. |
Example Requests
None
Example Responses
Status code: 200
{
"tags" : [ {
"key" : "key1",
"value" : "value1"
}, {
"key" : "key2",
"value" : "value2"
} ],
"sys_tags" : null
} Status Codes
| Status Code | Description |
|---|---|
| 200 | |
| 400 | Invalid parameter. |
| 401 | Authorization failed. |
| 403 | Insufficient permissions. |
| 404 | Resource not found. |
| 500 | System error. |
Error Codes
See Error Codes.