查询云数据库实例的配置信息
最近更新时间:2019-02-22 14:28:12
1. 接口描述
接口请求域名: cdb.tencentcloudapi.com 。
本接口(DescribeDBInstanceConfig)用于云数据库实例的配置信息,包括同步模式,部署模式等。
默认接口请求频率限制:100次/秒。
注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cdb.ap-shanghai-fsi.tencentcloudapi.com 。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeDBInstanceConfig |
Version | 是 | String | 公共参数,本接口取值:2017-03-20 |
Region | 是 | String | 公共参数,详见产品支持的地域列表。 |
InstanceId | 是 | String | 实例ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例ID相同。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ProtectMode | Integer | 主库数据保护方式,主实例属性,可能的返回值:0-异步复制方式,1-半同步复制方式,2-强同步复制方式。 |
DeployMode | Integer | 主库部署方式,主实例属性,可能的返回值:0-单可用部署,1-多可用区部署。 |
Zone | String | 主库可用区的正式名称,如ap-shanghai-1。 |
SlaveConfig | SlaveConfig | 从库的配置信息。 |
BackupConfig | BackupConfig | ECDB第二个从库的配置信息,只有ECDB实例才有这个字段。 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询云数据库实例的配置信息
输入示例
https://cdb.tencentcloudapi.com/?Action=DescribeDBInstanceConfig
&InstanceId=cdb-f35wr6wj
&<公共请求参数>
输出示例
{
"Response":{
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
"SlaveConfig":{
"ReplicationMode":"async",
"Zone":"ap-guangzhou-3"
},
"ProtectMode":0,
"Zone":"ap-guangzhou-3",
"DeployMode":1
}
}
5. 开发者资源
API Explorer
该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
错误码 | 描述 |
---|---|
InvalidParameter | 参数错误。 |
InvalidParameter.InstanceNotFound | 实例不存在。 |
如果有其他疑问,您也可以在问答社区中寻求帮助。前往问答社区 >