获取角色基本信息

最近更新时间: 2026-09-17 00:05:46

1. 接口描述

接口请求域名： tbdsnew.api3.fincloud.tencent.cn。

在服务组件的角色管理下，点击角色名进入到角色详情页面，该接口将返回该角色节点的基本信息

默认接口请求频率限制：20次/秒。

接口更新时间：2024-11-01 12:25:21。

接口既验签名又鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeInstanceServiceBasicInfo
Version	是	否	String	公共参数，本接口取值：2019-01-03
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
InstanceId	是	否	String	集群ID 示例值： tbds-1vzudj86
ServiceName	是	否	String	服务名称示例值： ZOOKEEPER
RoleName	是	否	String	角色名称示例值： Zookeeper
HostIP	是	否	String	主机ip 示例值： 172.16.0.89

3. 输出参数

参数名称	类型	描述
AbstractItems	Array of AbstractItems	角色基本信息列表注意：此字段可能返回 null，表示取不到有效值。示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError	内部错误。
InternalError.OpenTSDBHttpReturnCodeNotOK	请求OpenTSDB失败。

5. 示例

示例1 获取角色基本信息

输入示例

POST / HTTP/1.1
Host: tbdsnew.api3.{conf.main_domain}
Content-Type: application/json
X-TC-Action: DescribeInstanceServiceBasicInfo
<公共请求参数>

{
  "InstanceId": "tbds-1vzudj86",
  "ServiceName": "ZOOKEEPER",
  "RoleName": "Zookeeper",
  "HostIP": "172.16.0.89"
}

输出示例

{
  "Response": {
    "AbstractItems": [
      {
        "ItemKey": "HealthState",
        "ItemValue": "1",
        "Title": "健康状态"
      },
      {
        "ItemKey": "HostIP",
        "ItemValue": "172.16.0.89",
        "Title": "节点IP"
      }
    ],
    "RequestId": "81345292-258a-411f-a002-2f313210c144"
  }
}