1. 接口描述
接口请求域名: keewidb.tencentcloudapi.com 。
本接口(DescribeInstanceReplicas)用于获取实例副本节点信息。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeInstanceReplicas。 |
Version | 是 | String | 公共参数,本接口取值:2022-03-08。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 实例 ID,如:kee-6ubh****。 示例值:kee-6ubhgouj |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 实例所有节点数量,包括主节点、副本节点。 示例值:10 |
ReplicaGroups | Array of ReplicaGroup | 实例节点信息。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例1
输入示例
POST / HTTP/1.1
Host: keewidb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstanceReplicas
<公共请求参数>
{
"InstanceId": "kee-9clk****"
}
输出示例
{
"Response": {
"ReplicaGroups": [
{
"GroupId": 1081,
"GroupName": "ng-00",
"KeeWiDBNodes": [
{
"NodeId": "fc9d0d4d3f33570320cd2034d75c34521ef1c3ef",
"Role": "master",
"Status": "Normal"
},
{
"NodeId": "d05b99e5e07b7d3d29a4c6f65d410aada0849797",
"Role": "master",
"Status": "Normal"
},
{
"NodeId": "be2aba737c920f17e9151266a9ee59a08ca3727e",
"Role": "master",
"Status": "Normal"
}
],
"Role": "master",
"ZoneId": "ap-guangzhou-2"
},
{
"GroupId": 1082,
"GroupName": "ng-01",
"KeeWiDBNodes": [
{
"NodeId": "af40204e08f25e7848aaaf344cb05c2fb6fd63c6",
"Role": "replica",
"Status": "Normal"
},
{
"NodeId": "2c0dd8607c8187c45ec6943337fb43e60e3d6add",
"Role": "replica",
"Status": "Normal"
},
{
"NodeId": "5ddd5a5aa3d4448553fe94d0c0741236f144b9f5",
"Role": "replica",
"Status": "Normal"
}
],
"Role": "replica",
"ZoneId": "ap-guangzhou-3"
}
],
"RequestId": "a9575963-23f6-48d7-a1a8-bc31ee861f31",
"TotalCount": 2
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.SystemError | 内部系统错误,和业务无关。 |
FailedOperation.UnSupportError | 实例不支持该接口。 |
InvalidParameter.PermissionDenied | 接口没有cam权限。 |