1. 接口描述
接口请求域名: cdb.tencentcloudapi.com 。
查询实例支持代理版本和参数
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeProxySupportParam。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-20。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 实例ID 示例值:cdb-aykuksx3 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ProxyVersion | String | 支持最大代理版本 注意:此字段可能返回 null,表示取不到有效值。 示例值:1.3.1 |
SupportPool | Boolean | 是否支持连接池 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
PoolMin | Integer | 连接池最小值 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
PoolMax | Integer | 连接池最大值 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
SupportTransSplit | Boolean | 是否支持事务拆分 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
SupportPoolMinVersion | String | 支持连接池的最小代理版本 注意:此字段可能返回 null,表示取不到有效值。 示例值:1.1.1 |
SupportTransSplitMinVersion | String | 支持事务拆分的最小代理版本 注意:此字段可能返回 null,表示取不到有效值。 示例值:1.3.1 |
SupportReadOnly | Boolean | 是否支持设置只读 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
SupportAutoLoadBalance | Boolean | 是否自动均衡负载 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
SupportAccessMode | Boolean | 是否支持接入模式 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询实例支持代理版本和参数
输入示例
POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProxySupportParam
<公共请求参数>
{
"InstanceId": "cdb-xxx"
}
输出示例
{
"Response": {
"RequestId": "xx-xxx-xxx",
"ProxyVersion": "1.3.1",
"SupportPool": true,
"PoolMin": 1,
"PoolMax": 10,
"SupportTransSplit": true,
"SupportTransSplitMinVersion": "1.3.1",
"SupportPoolMinVersion": "1.1.1",
"SupportReadOnly": true,
"SupportAutoLoadBalance": true,
"SupportAccessMode": true
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError.DBRecordNotExistError | 数据库实例不存在。 |
InternalError.ExecHttpRequestError | 执行http请求错误。 |
InternalError.UnknownError | 未知错误。 |
InvalidParameter.ControllerNotFoundError | 未找到该接口。 |
OperationDenied.OperationDeniedError | 操作拒绝。 |
ResourceNotFound.InstanceNotFoundError | 高可用版实例不存在。 |