Querying Project Tags
Function
This API is used to query all tags in a specified project.
Calling Method
For details, see Calling APIs.
URI
GET /v1.0/{project_id}/kms/tags
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID |
Request 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 the user token. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| tags | Array of Tag objects | Tag list, which is the value pairs of key and value. key: Tag key. A tag key can contain up to 10 values. This parameter cannot be left empty or repeated. The value of a key must be unique and contain up to 36 characters. value: Tag value. There can be multiple values and each value can contain up to 43 characters. Each pair contains one key and one value. |
| Parameter | Type | Description |
|---|---|---|
| key | String | Key. The value can contain up to 36 unicode characters. This parameter cannot be left empty. The following nonprintable characters are not supported: ASCII(0-31), *, <, >, , and =. |
| values | Array of strings | Tag value set. |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error | Object | Error message |
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code returned by the error request |
| error_msg | String | Error information returned by the error request |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error | Object | Error message |
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code returned by the error request |
| error_msg | String | Error information returned by the error request |
Status code: 403
| Parameter | Type | Description |
|---|---|---|
| error | Object | Error message |
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code returned by the error request |
| error_msg | String | Error information returned by the error request |
Status code: 404
| Parameter | Type | Description |
|---|---|---|
| error | Object | Error message |
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code returned by the error request |
| error_msg | String | Error information returned by the error request |
Status code: 500
| Parameter | Type | Description |
|---|---|---|
| error | Object | Error message |
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code returned by the error request |
| error_msg | String | Error information returned by the error request |
Status code: 502
| Parameter | Type | Description |
|---|---|---|
| error | Object | Error message |
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code returned by the error request |
| error_msg | String | Error information returned by the error request |
Status code: 504
| Parameter | Type | Description |
|---|---|---|
| error | Object | Error message |
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code returned by the error request |
| error_msg | String | Error information returned by the error request |
Example Requests
None
Example Responses
Status code: 200
Request succeeded.
{
"tags" : [ {
"key" : "key1",
"values" : [ "value1", "value2" ]
}, {
"key" : "key2",
"values" : [ "value1", "value2" ]
} ]
} Status Codes
| Status Code | Description |
|---|---|
| 200 | Request succeeded. |
| 400 | Invalid request parameters. |
| 401 | Username and password are required for the requested page. |
| 403 | Authentication failed. |
| 404 | The resource does not exist. |
| 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 Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
