1. 接口描述
接口请求域名: tbdsnew.api3.fincloud.tencent.cn。
获取集群信息
默认接口请求频率限制:20次/秒。
接口更新时间:2025-09-11 19:58:49。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeInstanceMessage |
| Version | 是 | 否 | String | 公共参数,本接口取值:2019-01-03 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| InstanceId | 是 | 否 | String | 实例名称 示例值: tbds-664nmwbe |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ClusterMessage | String | 集群信息,输出为base64格式 示例值: 1 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InternalError.CamCgwError | 内部服务调用异常。 |
| InternalError.DBException | DB异常。 |
| InvalidParameter | 参数错误。 |
5. 示例
示例1 获取集群信息
输入示例
POST / HTTP/1.1
Host: tbdsnew.api3.{conf.main_domain}
Content-Type: application/json
X-TC-Action: DescribeInstanceMessage
<公共请求参数>
{
"InstanceId": "tbds-664nmwbe"
}
输出示例
{
"Response": {
"ClusterMessage": "eyJOb2RlSW5mb3MiOlt7InR5cGUiOiJtYXN0ZXJcdTAwMjZjb3JlIiwiY291bnQiOjN9XX0=",
"RequestId": "462a51fd-fd05-41f1-88b1-09b92b55b376"
}
}