Deleting a Key Alias
Function
Delete an alias.
Calling Method
For details, see Calling APIs.
URI
DELETE /v1.0/{project_id}/kms/aliases
| 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 |
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 |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| aliases | Yes | Array of strings | Definition Alias to be deleted Constraints N/A Range N/A Default Value N/A |
| key_id | Yes | String | Definition ID of the key associated with the alias Constraints N/A Range N/A Default Value N/A |
Response Parameters
Status code: 204
The alias is deleted.
None
Example Requests
Delete aliases kms-1234 and kms-4567 from the associated bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e key.
{
"key_id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
"aliases" : [ "kms-1234", "kms-4567" ]
} Example Responses
None
Status Codes
| Status Code | Description |
|---|---|
| 204 | The alias is deleted. |
Error Codes
See Error Codes.
