DeleteImportedKeyMaterial

Last updated: 2020-07-17 11:10:56

1. API Description

Domain name for API request: kms.tencentcloudapi.com.

This API is used to delete the imported key material. It is only valid for EXTERNAL CMKs. Specifically, it puts a CMK into PendingImport status instead of deleting the CMK, so that the CMK can be used again after key material is reimported. To delete the CMK completely, please call the ScheduleKeyDeletion API.

A maximum of 10 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DeleteImportedKeyMaterial.
Version Yes String Common parameter. The value used for this API: 2019-01-18.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
KeyId Yes String Specifies the EXTERNAL CMK for which to delete the key material.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Deleting the imported key material

Input Example

https://kms.tencentcloudapi.com/?Action=DeleteImportedKeyMaterial
&KeyId=23e80852-1e38-11e9-b129-5cb9019b4b01
&<common request parameters>

Output Example

{
  "Response": {
    "RequestId": "1b580852-1e38-11e9-b129-5cb9019b4b00"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.CmkUsedByCloudProduct The CMK is being used by a Tencent Cloud product.
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameterValue.InvalidKeyId Invalid KeyId.
ResourceUnavailable.CmkNotFound The CMK does not exist.
ResourceUnavailable.CmkStateNotSupport This operation cannot be performed under the current CMK status.
UnsupportedOperation.NotExternalCmk Incorrect CMK type. Only External CMKs are supported.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help