Domain name for API request: cdb.intl.tencentcloudapi.com.
This API is used to enable data storage encryption for instance and support users to specify custom keys.
Note that before enabling data storage encryption for instance, perform the following operations:
Perform instance initialization (https://www.tencentcloud.com/document/api/236/15873?from_cn_redirect=1).
Enable the KMS service (https://console.tencentcloud.com/kms2).
Grant the cloud database (MySQL) permission to access the KMS key (https://console.tencentcloud.com/cam/role). The role name is MySQL_QCSRole and the preset policy name is QcloudAccessForMySQLRole.
Closing is not allowed after encryption being enabled.
This API may take up to 10s, and the client may timeout. If the API call returns InternalError, please call DescribeDBInstanceInfo to confirm whether backend encryption is successfully enabled. After calling, if the parameter Encryption is YES, it means activation is successful.
A maximum of 20 requests can be initiated per second for this API.
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 Params. The value used for this API: OpenDBInstanceEncryption. |
| Version | Yes | String | Common Params. The value used for this API: 2017-03-20. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | Cloud database instance ID, which can be obtained through the DescribeDBInstances API. |
| KeyId | No | String | Custom key ID, the unique identifier of CMK. If left empty, the automatically generated key KMS-CDB by using Tencent Cloud will be used. |
| KeyRegion | No | String | Storage region of the custom key. For example: ap-guangzhou. This parameter is required when KeyId is not empty. |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: OpenDBInstanceEncryption
<Common request parameters>
{
"InstanceId": "cdb-qwer1234",
"KeyId": "KMS-CDB",
"KeyRegion": "ap-guangzhou"
}
{
"Response": {
"RequestId": "1ac120c8-744a-4c15-be4e-4431511c0233"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| AuthFailure | CAM signature/authentication error. |
| CdbError | Backend or process error. |
| InternalError.HttpRequestError | Request failed. |
| InternalError.KmsError | Failed to enable encryption |
| InternalError.UnknownError | Unknown error |
| InvalidParameter | Parameter error. |
| InvalidParameter.InstanceNotFound | The instance does not exist. |
| OperationDenied | Operation denied. |
フィードバック