腾讯云分布式缓存数据库（兼容 Redis）查询实例备份加密配置

1. 接口描述

接口请求域名： redis.tencentcloudapi.com 。

本接口（DescribeBackupEncryptConfig）用于查询实例备份加密相关信息，包括开启状态、加密密钥等。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeBackupEncryptConfig。
Version	是	String	公共参数，本接口取值：2018-04-12。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	实例 ID，请登录Redis控制台在实例列表复制实例 ID。示例值：crs-lpj0rplv

3. 输出参数

参数名称	类型	描述
BackupEncrypt	Boolean	备份是否加密枚举值： true：加密 false：不加密示例值：true
EncryptKeyType	Integer	加密密钥类型。枚举值： 0：腾讯云托管（默认） 1：用户自定义 KMS 密钥示例值：0
KmsKeyId	String	KMS的密钥ID。参数格式：xxxxxxx-xxxx-xxxx-xxxx-xxxxxxx 示例值：b2f531ee-59a6-11f1-b8b2-5254008764f7
KmsRegion	String	KMS地域信息。参数格式：ap-xxxx 示例值：ap-guangzhou
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取备份加密配置

输入示例

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

{
    "InstanceId": "crs-lpj0rplv"
}

输出示例

{
    "Response": {
        "BackupEncrypt": true,
        "EncryptKeyType": 0,
        "KmsKeyId": "b2f531ee-59a6-11f1-b8b2-5254008764f7",
        "KmsRegion": "ap-guangzhou",
        "RequestId": "e15c50dc-2147-4c6d-adb1-6a3d7c3cf9dc"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。

查询实例备份加密配置

本页目录：