启用数据存储加密

最近更新时间:2024-03-12 01:13:31

我的收藏

1. 接口描述

接口请求域名: cdb.tencentcloudapi.com 。

本接口(OpenDBInstanceEncryption)用于启用实例数据存储加密功能,支持用户指定自定义密钥。

注意,启用实例数据存储加密之前,需要进行以下操作:

1、进行 实例初始化 操作;

2、开启 KMS服务

3、对云数据库(MySQL)授予访问KMS密钥的权限,角色名为MySQL_QCSRole,预设策略名为QcloudAccessForMySQLRole;

该 API 耗时可能到10s,客户端可能超时,如果调用 API 返回 InternalError ,请您调用DescribeDBInstanceInfo 确认后端加密是否开通成功。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:OpenDBInstanceEncryption。
Version String 公共参数,本接口取值:2017-03-20。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 云数据库实例 ID。
示例值:cdb-qwer1234
KeyId String 用户自定义密钥ID,CMK唯一标识符。该值为空时,将使用腾讯云自动生成的密钥KMS-CDB。
示例值:testkey
KeyRegion String 用户自定义密钥的存储地域。如:ap-guangzhou 。KeyId不为空时,该参数必填。
示例值:ap-guangzou

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 开通加密服务

输入示例

POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: OpenDBInstanceEncryption
<公共请求参数>

{
    "InstanceId": "cdb-qwer1234",
    "KeyId": "testkey",
    "KeyRegion": "ap-guangzou"
}

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
CdbError 后端错误或者流程错误。
InternalError.HttpRequestError 请求失败。
InternalError.KmsError 开通加密失败。
InternalError.UnknownError 未知错误。
InvalidParameter 参数错误。
InvalidParameter.InstanceNotFound 实例不存在。
OperationDenied 操作被拒绝。