Domain name for API request: cdb.tencentcloudapi.com.
This API is used to set the encryption status of an instance backup.
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: ModifyBackupEncryptionStatus. |
Version | Yes | String | Common Params. The value used for this API: 2017-03-20. |
Region | No | String | Common Params. This parameter is not required for this API. |
InstanceId | Yes | String | Instance ID in the format of cdb-XXXX, which is the same as that displayed in the TencentDB console. |
EncryptionStatus | Yes | String | Default encryption status for the new auto-generated physical backup files. Valid values: on , off . |
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to enable instance backup encryption.
POST / HTTP/1.1Host: cdb.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: ModifyBackupEncryptionStatus<Common request parameters>{ "InstanceId": "cdb-XXXX", "EncryptionStatus": "on"}
{
"Response": {
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
}
}
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. |
AuthFailure.InvalidAuthorization | Invalid authorization |
AuthFailure.SubAccountDenied | The sub-account has no permissions. |
FailedOperation | Operation failed. |
InternalError | An internal error occurred. |
InternalError.DBRecordNotExistError | The database record does not exist. |
InternalError.UnknownError | Unknown error |
InvalidParameterValue | Invalid parameter value |
InvalidParameterValue.InvalidParameterValueError | Invalid parameter value |
MissingParameter | Missing parameter |
OperationDenied.AccountOperationDenied | The Tencent Cloud account is not allowed to perform the operation due to insufficient permissions. |
OperationDenied.NotSupportBasic | Basic instances do not support this operation (feature). |
本页内容是否解决了您的问题?