tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

OpenDBInstanceEncryption

Last updated: 2024-11-20 11:14:55

    1. API Description

    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:

    1. Initialize an instance.

    2. Enable KMS service

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

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

    3. Output Parameters

    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.

    4. Example

    Example1 Enabling encryption

    Input Example

    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"
}

    Output Example

    {
    "Response": {
        "RequestId": "1ac120c8-744a-4c15-be4e-4431511c0233"
    }
}

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