1. 接口描述
接口请求域名: cdb.tencentcloudapi.com 。
查询代理规格配置
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeProxyCustomConf。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-20。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 实例ID |
Offset | 否 | Integer | 分页 示例值:1 |
Limit | 否 | Integer | 限制 示例值:100 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Count | Integer | 代理配置数 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
CustomConf | CustomConfig | 代理配置 注意:此字段可能返回 null,表示取不到有效值。 |
WeightRule | Rule | 权重限制 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询数据库代理规格配置
输入示例
POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProxyCustomConf
<公共请求参数>
{
"InstanceId": "xx",
"Limit": 1,
"Offset": 0
}
输出示例
{
"Response": {
"Count": 3,
"CustomConf": [
{
"Cpu": 2,
"Device": "Z3",
"DeviceType": "custom",
"Memory": 4000,
"Type": "高可用版本"
},
{
"Cpu": 4,
"Device": "Z3",
"DeviceType": "custom",
"Memory": 8000,
"Type": "高可用版本"
},
{
"Cpu": 8,
"Device": "Z3",
"DeviceType": "custom",
"Memory": 16000,
"Type": "高可用版本"
}
],
"RequestId": "9bd2a785-2dc0-47dc-b285-2b154a218ea1",
"WeightRule": [
{
"LessThan": 2000,
"Weight": 1
},
{
"LessThan": 8000,
"Weight": 2
},
{
"LessThan": 16000,
"Weight": 4
},
{
"LessThan": 32000,
"Weight": 8
},
{
"LessThan": 48000,
"Weight": 10
},
{
"LessThan": 64000,
"Weight": 12
},
{
"LessThan": 96000,
"Weight": 14
},
{
"LessThan": 128000,
"Weight": 16
},
{
"LessThan": 192000,
"Weight": 24
},
{
"LessThan": 256000,
"Weight": 30
},
{
"LessThan": 488000,
"Weight": 50
},
{
"LessThan": 690000,
"Weight": 75
},
{
"LessThan": -1,
"Weight": 100
}
]
}
}
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.UnknownError | 未知错误。 |
ResourceNotFound.InstanceNotFundError | 该实例不存在。 |