1. 接口描述
接口请求域名: tcss.tencentcloudapi.com 。
查询主机详细信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeAssetHostDetail。 |
Version | 是 | String | 公共参数,本接口取值:2020-11-01。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
HostId | 是 | String | 主机id |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
UUID | String | 容器安全uuid |
UpdateTime | String | 更新时间 |
HostName | String | 主机名 |
Group | String | 主机分组 |
HostIP | String | 主机IP |
OsName | String | 操作系统 |
AgentVersion | String | agent版本 |
KernelVersion | String | 内核版本 |
DockerVersion | String | docker版本 |
DockerAPIVersion | String | docker api版本 |
DockerGoVersion | String | docker go 版本 |
DockerFileSystemDriver | String | docker 文件系统类型 |
DockerRootDir | String | docker root 目录 |
ImageCnt | Integer | 镜像数 |
ContainerCnt | Integer | 容器数 |
K8sMasterIP | String | k8s IP |
K8sVersion | String | k8s version |
KubeProxyVersion | String | kube proxy |
Status | String | "UNINSTALL":"未安装","OFFLINE":"离线", "ONLINE":"防护中 |
IsContainerd | Boolean | 是否Containerd |
MachineType | String | 主机来源;"TENCENTCLOUD":"腾讯云服务器","OTHERCLOUD":"非腾讯云服务器" |
PublicIp | String | 外网ip |
InstanceID | String | 主机实例ID |
RegionID | Integer | 地域ID |
Project | ProjectInfo | 所属项目 |
Tags | Array of TagInfo | 标签 |
ClusterID | String | 集群ID |
ClusterName | String | 集群名称 |
ClusterAccessedStatus | String | 集群接入状态 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询主机详细信息
查询主机详细信息
输入示例
POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAssetHostDetail
<公共请求参数>
{
"HostId": "dskaldjskld"
}
输出示例
{
"Response": {
"UUID": "abc",
"UpdateTime": "abc",
"HostName": "abc",
"Group": "abc",
"HostIP": "abc",
"OsName": "abc",
"AgentVersion": "abc",
"KernelVersion": "abc",
"DockerVersion": "abc",
"DockerAPIVersion": "abc",
"DockerGoVersion": "abc",
"DockerFileSystemDriver": "abc",
"DockerRootDir": "abc",
"ImageCnt": 1,
"ContainerCnt": 1,
"K8sMasterIP": "abc",
"K8sVersion": "abc",
"KubeProxyVersion": "abc",
"Status": "abc",
"IsContainerd": true,
"MachineType": "abc",
"PublicIp": "abc",
"InstanceID": "abc",
"RegionID": 0,
"Project": {
"ProjectName": "abc",
"ProjectID": 0
},
"Tags": [
{
"TagKey": "abc",
"TagValue": "abc"
}
],
"ClusterID": "abc",
"ClusterName": "abc",
"ClusterAccessedStatus": "abc",
"RequestId": "abc"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.ParsingError | 参数解析错误。 |
ResourceNotFound | 资源不存在。 |