云数据库 MySQL 查询云数据库实例的配置信息-API 文档-文档中心-腾讯云

1. 接口描述

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

本接口(DescribeDBInstanceConfig)用于云数据库实例的配置信息，包括同步模式，部署模式等。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

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

3. 输出参数

参数名称	类型	描述
ProtectMode	Integer	主实例数据保护方式，可能的返回值：0 - 异步复制方式，1 - 半同步复制方式，2 - 强同步复制方式。示例值：0
DeployMode	Integer	主实例部署方式，可能的返回值：0 - 单可用部署，1 - 多可用区部署。示例值：1
Zone	String	实例可用区信息，格式如 "ap-shanghai-1"。示例值：ap-guangzhou-3
SlaveConfig	SlaveConfig	备库的配置信息。注意：此字段可能返回 null，表示取不到有效值。
BackupConfig	BackupConfig	强同步实例第二备库的配置信息。注意：此字段可能返回 null，表示取不到有效值。
Switched	Boolean	是否切换备库。示例值：false
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询云数据库实例的配置信息

输入示例

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

{
    "InstanceId": "cdb-f35wr6wj"
}

输出示例

{
    "Response": {
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
        "SlaveConfig": {
            "ReplicationMode": "async",
            "Zone": "ap-guangzhou-3"
        },
        "BackupConfig": {
            "ReplicationMode": "sync",
            "Vip": "",
            "Vport": 0,
            "Zone": "ap-guangzhou-3"
        },
        "ProtectMode": 0,
        "Zone": "ap-guangzhou-3",
        "DeployMode": 1,
        "Switched": false
    }
}

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: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
CdbError	后端错误或者流程错误。
InternalError.CdbError	系统错误。
InternalError.DBOperationError	数据库操作失败。
InternalError.InternalHttpServerError	请求执行异常。
InternalError.JSONError	json解析失败。
InternalError.NetworkError	网络错误。
InternalError.UndefinedError	未知错误。
InternalError.UnknownError	未知错误。
InvalidParameter	参数错误。
InvalidParameter.ControllerNotFoundError	未找到该接口。
InvalidParameter.InstanceNotFound	实例不存在。
InvalidParameterValue.InvalidParameterValueError	参数值无效。
OperationDenied	操作被拒绝。

查询云数据库实例的配置信息

本页目录：