检查主机

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

1. 接口描述

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

主机管理-检查主机

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

接口更新时间：2025-07-13 02:33:50。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：CheckHost
Version	是	否	String	公共参数，本接口取值：2019-01-03
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
HostInfos	是	否	Array of ServerInfo	要校验的主机信息示例值：查看

3. 输出参数

参数名称	类型	描述
ResultList	Array of CheckHostResult	主机校验的结果列表示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
InvalidParameter	参数错误。
MissingParameter	缺少参数错误。
UnknownParameter	未知参数错误。
InternalError	内部错误。
LimitExceeded	超过配额限制。
FailedOperation	操作失败。

5. 示例

示例1 检查主机

输入示例

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

{
  "HostInfos": [
    {
      "IP": "10.4.2.120",
      "Port": 22,
      "Username": "root",
      "Password": "123456"
    }
  ]
}

输出示例

{
    "Response": {
        "RequestId": "991c3ec6-f483-44b9-9c83-4abf99c0cb75",
        "ResultList": [{
            "IP": "10.4.2.120",
            "Status": 1,
            "Message": "10.4.2.120",
            "Arch": "aarch64"
        }]
    }
}