1. 接口描述
接口请求域名： dcdb.tencentcloudapi.com 。
本接口（DescribeDCDBInstanceNodeInfo）用于获取实例节点信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeDCDBInstanceNodeInfo。 |
| Version | 是 | String | 公共参数，本接口取值：2018-04-11。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例ID 示例值：tdsqlshard-8upuqubt |
| Limit | 否 | Integer | 单次最多返回多少条，取值范围为(0-100]，默认为100 示例值：100 |
| Offset | 否 | Integer | 返回数据的偏移值，默认为0 示例值：0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 节点总个数 示例值：4 |
| NodesInfo | Array of BriefNodeInfo | 节点信息 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取实例节点信息
输入示例
POST / HTTP/1.1
Host: dcdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDCDBInstanceNodeInfo
<公共请求参数>
{
"InstanceId": "tdsqlshard-8upuqubt"
}输出示例
{
"Response": {
"NodesInfo": [
{
"NodeId": "b991a3d602da35cf7bf64dcafcd5f7ad589aa6d9",
"Role": "master",
"ShardId": "shard-he2hj3al"
},
{
"NodeId": "9a498278e1775355cac16c23d65c59204aec52f1",
"Role": "slave",
"ShardId": "shard-he2hj3al"
},
{
"NodeId": "3c698ab9547674e361bae013439225356175668d",
"Role": "master",
"ShardId": "shard-mgsnag2z"
},
{
"NodeId": "2f0714ded5eaef1dd927fdc1429350470ce0017b",
"Role": "slave",
"ShardId": "shard-mgsnag2z"
}
],
"RequestId": "6b8b1984-c226-46d9-ac0a-81e241cf7cdc",
"TotalCount": 4
}
}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.OssOperationFailed | 请求后端接口失败。 |
| InternalError.InnerSystemError | 内部系统错误。 |
| InternalError.OperateDatabaseFailed | 数据库操作失败。 |
| InvalidParameter.InstanceNotFound | 未找到请求的实例。 |