操作指南

API 文档

查询实例基本信息

最近更新时间:2022-07-05 06:08:28

我的收藏

1. 接口描述

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

查询实例基本信息(实例 ID ,实例名称,是否开通加密 )

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDBInstanceInfo。
Version String 公共参数,本接口取值:2017-03-20。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例 ID 。

3. 输出参数

参数名称 类型 描述
InstanceId String 实例 ID 。
InstanceName String 实例名称。
Encryption String 是否开通加密,YES 已开通,NO 未开通。
KeyId String 加密使用的密钥 ID 。
注意:此字段可能返回 null,表示取不到有效值。
KeyRegion String 密钥所在地域。
注意:此字段可能返回 null,表示取不到有效值。
DefaultKmsRegion String 当前 CDB 后端服务使用的 KMS 服务的默认地域。
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询实例信息

输入示例

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

{
    "InstanceId": "cdb-oaj9cbla"
}

输出示例

{
  "Response": {
    "DefaultKmsRegion": "ap-hongkong",
    "Encryption": "NO",
    "InstanceId": "cdb-oaj9cbla",
    "InstanceName": "cdb_name",
    "KeyId": "",
    "KeyRegion": "",
    "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
  }
}

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.UnknownError 未知错误。
InvalidParameter 参数错误。
InvalidParameter.ResourceNotExists 资源不存在。
目录