DeleteClientKey - Key Management Service - Alibaba Cloud Documentation Center

Before you delete a client key, make sure that the client key is no longer in use. If you delete a client key that is in use, applications that use the client key cannot access Key Management Service (KMS). Exercise caution when you delete a client key.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	DeleteClientKey	The operation that you want to perform. Set the value to DeleteClientKey.
ClientKeyId	String	Yes	KAAP.66abf237-63f6-4625-b8cf-47e1086e****	The ID of the client key.

Response parameters

Parameter	Type	Example	Description
RequestId	String	2312e45f-b2fa-4c34-ad94-3eca50932916	The ID of the request, which is used to locate and troubleshoot issues.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DeleteClientKey
&ClientKeyId=KAAP.66abf237-63f6-4625-b8cf-47e1086e****
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DeleteClientKeyResponse>
    <RequestId>2312e45f-b2fa-4c34-ad94-3eca50932916</RequestId>
</DeleteClientKeyResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "2312e45f-b2fa-4c34-ad94-3eca50932916"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter is not valid.	The specified parameter is invalid.
404	InvalidAccessKeyId.NotFound	The Access Key ID provided does not exist in our records.	The specified AccessKey ID does not exist.

For a list of error codes, see Service error codes.