查询创建客户端

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

1. 接口描述

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

查询已经安装的客户端

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

接口更新时间：2025-07-17 06:34:28。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeInstallClient
Version	是	否	String	公共参数，本接口取值：2019-01-03
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
ClusterId	是	否	String	集群id 示例值： tbds-664nmwbe
Ip	否	否	String	主机ip 示例值： 1
Ipv6	否	否	String	主机ipv6 （保留字段，当前版本暂未支持）示例值： 1
HostUuid	否	否	String	主机uuid （保留字段，当前版本暂未支持）示例值： 1
TbdsVersion	否	否	String	版本 531X 示例值： 1
Arch	否	否	String	机器架构 x86 arm 示例值： 1
Filters	否	否	Array of Filters	支持通过Ip过滤示例值：查看
OrderField	否	否	Array of OrderField	排序暂未使用示例值：查看
Status	否	否	Int64	状态 1 安装中 2 成功 -1 失败示例值： 1
Offset	否	否	Int64	页编号，默认值为0，表示第一页示例值： 0
Limit	否	否	Int64	每页返回数量，默认值为10，最大值为200 示例值： 10
IsInstall	否	否	Int64	0-下载 1-安装 2-更新 3-卸载示例值： 1

3. 输出参数

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

4. 错误码

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

错误码	描述
InternalError.DBException	DB异常。
InternalError.AccountCgwError	内部服务调用异常。
InternalError.DBWriteException	写DB异常。
InternalError	内部错误。
InternalError.DBQueryException	DB查询异常。
FailedOperation	操作失败。

5. 示例

示例1 查询创建客户端

输入示例

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

{
  "Limit": 10,
  "Offset": 0,
  "OrderFields": [],
  "ClusterId": "tbds-664nmwbe",
  "Filters": []
}

输出示例

{
        "Response": {
            "InstallClientCount": 0,
            "InstallClientList": [],
            "RequestId": "adcda9ef-2ad1-44d0-a497-8d3ea1cd0dec"
        }
    }