查询实例版本属性

最近更新时间:2024-11-11 01:11:22

我的收藏

1. 接口描述

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

本接口(DescribeDBFeatures)用于查询云数据库版本属性,包括是否支持数据库加密、数据库审计等功能。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDBFeatures。
Version String 公共参数,本接口取值:2017-03-20。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例 ID,格式如:cdb-c1nl9rpv 或者 cdbro-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。
示例值:cdb-qwerasdf

3. 输出参数

参数名称 类型 描述
IsSupportAudit Boolean 是否支持数据库审计功能。
示例值:true
AuditNeedUpgrade Boolean 开启审计是否需要升级内核版本。
示例值:false
IsSupportEncryption Boolean 是否支持数据库加密功能。
示例值:true
EncryptionNeedUpgrade Boolean 开启加密是否需要升级内核版本。
示例值:false
IsRemoteRo Boolean 是否为异地只读实例。
示例值:false
MasterRegion String 主实例所在地域。
示例值:ap-beijing
IsSupportUpdateSubVersion Boolean 是否支持小版本升级。
示例值:true
CurrentSubVersion String 当前内核版本。
示例值:20190203
TargetSubVersion String 可供升级的内核版本。
示例值:20190930
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询实例版本属性

查询实例特性,诸如内核小版本、是否开启审计等。

输入示例

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

{
    "InstanceId": "cdb-qwerasdf"
}

输出示例

{
    "Response": {
        "AuditNeedUpgrade": false,
        "CurrentSubVersion": "20230701",
        "EncryptionNeedUpgrade": false,
        "IsRemoteRo": false,
        "IsSupportAudit": true,
        "IsSupportEncryption": true,
        "IsSupportUpdateSubVersion": true,
        "MasterRegion": "",
        "RequestId": "68782c1e-d613-4451-b993-adef1cc7a3a6",
        "TargetSubVersion": "20230702"
    }
}

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签名/鉴权错误。
InternalError.DBOperationError 数据库操作失败。
InternalError.HttpError Http请求异常。
InternalError.JSONError json解析失败。
InternalError.NetworkError 网络错误。
InternalError.UnknownError 未知错误。
InvalidParameter 参数错误。
InvalidParameter.InstanceNotFound 实例不存在。
OperationDenied 操作被拒绝。