客户端安装信息查看

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

1. 接口描述

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

客户端信息查看页面

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

接口更新时间：2025-09-12 14:57:34。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribeClusterClients
Version 是 否 String 公共参数，本接口取值：2019-01-03
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
InstanceId 是 否 String 集群ID
示例值： tbds-664nmwbe
ServiceList 否 否 Array of String 服务列表
示例值： ['FLINK']
RoleList 否 否 Array of String 支持"master","core","common","router","task"
示例值： []
OffSet 否 否 Int64 查询数据的偏移量，最小值为0
示例值： 0
Limit 否 否 Int64 每页返回数量，最小值为1，表示返回1条数据
示例值： 10
ConfStatusList 否 否 Array of Int64 配置状态，-2：配置失败，1：已同步
示例值： []
IpLike 否 否 String 需要查询的ip，用于模糊搜索
示例值： 1

3. 输出参数

参数名称 类型 描述
Total Int64 总数
示例值： 1
ClusterClientQueryInfoList Array of ClusterClientQueryInfo 客户端信息列表
注意：此字段可能返回 null，表示取不到有效值。
示例值：查看
ClusterClientQueryInfoFilter ClusterClientQueryInfoFilter 客户端信息筛选条件
注意：此字段可能返回 null，表示取不到有效值。
示例值：查看
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
InternalError.CamCgwError 内部服务调用异常。
InternalError.WoodServerError 内部服务调用异常。
UnauthorizedOperation.CheckCamAuth 校验账号操作无权限。
ResourceNotFound.InstanceNotFound 无法找到该实例。

5. 示例

示例1 客户端信息查看

输入示例

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

{
  "InstanceId": "tbds-664nmwbe",
  "OffSet": 0,
  "Limit": 10,
  "RoleList": [],
  "ServiceList": [
    "FLINK"
  ],
  "ConfStatusList": []
}

输出示例

{
  "Response": {
    "ClusterClientQueryInfoFilter": {
      "ConfStatusList": [
        -2,
        1
      ],
      "RoleList": [
        "Master",
        "Core",
        "Task",
        "Router"
      ]
    },
    "ClusterClientQueryInfoList": [
      {
        "ConfGroup": "flink-master,core-defaultGroup",
        "ConfStatus": 1,
        "Ip": "10.4.2.93",
        "Role": "master,core",
        "Service": "FLINK"
      },
      {
        "ConfGroup": "flink-master,core-defaultGroup",
        "ConfStatus": 1,
        "Ip": "10.4.2.120",
        "Role": "master,core",
        "Service": "FLINK"
      },
      {
        "ConfGroup": "flink-master,core-defaultGroup",
        "ConfStatus": 1,
        "Ip": "10.4.2.13",
        "Role": "master,core",
        "Service": "FLINK"
      }
    ],
    "RequestId": "e0b5800f-6cd5-4e4e-b459-3330aae3cdd2",
    "Total": 3
  }
}