Batch Adding or Deleting Key Tags
Function
This API is used to add or delete key tags in batches.
Calling Method
For details, see Calling APIs.
URI
POST /v1.0/{project_id}/kms/{key_id}/tags/action
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID |
| key_id | Yes | String | Key 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. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| tags | Yes | Array of TagItem objects | Tag list, which is a collection of key-value pairs. |
| action | Yes | String | Operation type. The value can only be create or delete. |
| sequence | No | String | A 36-byte serial number of a request message, for example, 919c82d4-8046-4722-9094-35c3c6524cff |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| key | Yes | String | Key. The value can contain up to 36 unicodes. This parameter cannot be left empty. The following nonprintable characters cannot be included: ASCII(0-31), *, <, >, , and =. |
| value | No | String | Key. The value can contain up to 43 unicodes. This parameter can be left empty. The following nonprintable characters cannot be included: ASCII(0-31), *, <, >, , and =. |
Response Parameters
Status code: 204
No Content
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
Add multiple key tags. For tag 1, the key is key1 and the value is value1. For tag 2, the key is key and the value is value3.
{
"action" : "create",
"tags" : [ {
"key" : "key1",
"value" : "value1"
}, {
"key" : "key",
"value" : "value3"
} ]
} Example Responses
None
Status Codes
| Status Code | Description |
|---|---|
| 204 | No Content |
| 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.
