tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyDBEncryptAttributes

Last updated: 2023-04-19 11:41:55

1. API Description

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.

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 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).

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 None

This example shows you how to enable the transparent data encryption for an instance.

Input Example

POST / HTTP/1.1
Host: dcdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDBEncryptAttributes
<Common request parameters>

{
    "InstanceId": "tdsqlshard-xxx",
    "EncryptEnabled": 0
}

Output Example

{
    "Response": {
        "RequestId": "afb70c41-025e-4cec-bec3-6207a5d635d6"
    }
}

5. Developer Resources

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.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.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy