Domain name for API request: dcdb.tencentcloudapi.com.
This API is used to modify the instance data encryption.
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: ModifyDBEncryptAttributes. |
Version | Yes | String | Common Params. The value used for this API: 2018-04-11. |
Region | No | String | Common Params. This parameter is not required for this API. |
InstanceId | Yes | String | Instance ID in the format of tdsqlshard-ow728lmc |
EncryptEnabled | Yes | Integer | Whether to enable the data encryption (Once enabled, it can’t be disabled). Valid values: 1 (Yes), 0 (No. Default). |
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. |
This example shows you how to enable the transparent data encryption for an instance.
POST / HTTP/1.1
Host: dcdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDBEncryptAttributes
<Common request parameters>
{
"InstanceId": "tdsqlshard-xxx",
"EncryptEnabled": 0
}
{
"Response": {
"RequestId": "afb70c41-025e-4cec-bec3-6207a5d635d6"
}
}
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 |
---|---|
FailedOperation.OssOperationFailed | Failed to request the backend API. |
InternalError.DbOperationFailed | Failed to query the database. |
InvalidParameter | Parameter error. |
ResourceUnavailable.BadInstanceStatus | Incorrect instance status. Unable to initialize. |
ResourceUnavailable.InstanceAlreadyDeleted | The database instance has been dropped. |
ResourceUnavailable.InstanceHasBeenLocked | The database instance has been locked. Operations are not allowed. |
ResourceUnavailable.InstanceStatusAbnormal | Incorrect database instance status. Operations are not allowed. |
UnauthorizedOperation.PermissionDenied | You have no permission to manipulate this API or resource. |
UnsupportedOperation.InvalidOperation | Unsupported operation. |
Was this page helpful?