Domain name for API request: cdb.intl.tencentcloudapi.com.
This API is used to enable the encryption feature for instance data storage, and custom keys are supported.
Note: Before enabling data storage encryption for an instance, you need to perform the following operations:
Enable KMS service
Grant permission to access KMS for TencentDB for MySQL. The role name is MySQL_QCSRole
, and the preset policy name is QcloudAccessForMySQLRole
.
This API calling may take up to 10 seconds, causing the client to time out. If it returns InternalError
, call DescribeDBInstanceInfo
to confirm whether the backend encryption is enabled successfully.
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 | TencentDB instance ID |
KeyId | No | String | Custom key ID, which is the unique CMK ID. If this value is empty, the key KMS-CDB auto-generated by Tencent Cloud will be used. |
KeyRegion | No | String | Custom storage region, such as ap-guangzhou. When KeyId is not empty, this parameter is required. |
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": "testkey",
"KeyRegion": "ap-guangzou"
}
{
"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. |
本页内容是否解决了您的问题?