创建客户端

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

1. 接口描述

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

经典集群中hadoop类型集群，客户端管理中的安装客户端. 调用该接口, 需先参考TBDS提供的"第三方客户端操作"文档对机器做前置工作

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

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

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：CreateClusterClient
Version	是	否	String	公共参数，本接口取值：2019-01-03
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
ClusterId	是	否	String	集群id 示例值： tbds-gpigyari
Ip	是	否	String	主机ip 示例值： 10.206.16.113
Ipv6	否	否	String	主机ip 示例值： 1
User	否	否	String	用户名示例值： tbds
Port	否	否	Int64	端口示例值： 22
Password	否	否	String	密码示例值： admintest@2023
ConfigOn	否	否	Int64	1 仅下载配置 0全量下载示例值： 0
AddMode	否	否	String	添加方式 auto自动安装 unauto 手动安装示例值： auto
HostUuid	否	否	String	主机uuid （保留字段，当前版本暂未支持）示例值： 1
InstallPath	否	否	String	安装路径示例值： /usr/local/service
DownloadPath	否	否	String	下载路径示例值： 1
TbdsVersion	否	否	String	版本 TBDS-5.3.1.X 示例值： TBDS-5.3.1.5
Arch	是	否	String	架构: x86_64 / aarch64 示例值： x86_64
IsInstall	是	否	Int64	2 更新客户端/1 安装/ 0 下载，isinsall为0 DownloadPath必填， Isinsall为1 InstallPath，Ip，User，Port，Password在安装客户端时为必填示例值： 1
Timeout	否	否	Int64	超时时间示例值： 1
CreateTime	否	否	String	创建时间示例值： 1
ServiceList	否	否	Array of String	选择安装客户端在组件列表示例值： ['hdfs']

3. 输出参数

参数名称	类型	描述
IsSuccess	Bool	是否成功示例值： 1
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
InvalidParameter	参数错误。
InternalError.DBWriteException	写DB异常。
InternalError.DBException	DB异常。
InternalError	内部错误。
FailedOperation	操作失败。
InternalError.AccountCgwError	内部服务调用异常。
InternalError.DBQueryException	DB查询异常。
ResourceNotFound.InstanceNotFound	无法找到该实例。

5. 示例

示例1 创建客户端

输入示例

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

{
  "ClusterId": "tbds-gpigyari",
  "Ip": "10.206.16.113",
  "AddMode": "auto",
  "IsInstall": 1,
  "InstallPath": "/usr/local/service",
  "TbdsVersion": "TBDS-5.3.1.5",
  "Arch": "x86_64",
  "User": "tbds",
  "Password": "admintest@2023",
  "Port": "22",
  "ConfigOn": 0,
  "ServiceList": [
    "hdfs"
  ]
}

输出示例

{
        "Response": {
            "IsSuccess": true,
            "RequestId": "c8cad716-eaab-459b-92e2-a2090c7dfce9"
        }
    }