1. 接口描述
接口请求域名: tcss.tencentcloudapi.com 。
查询容器详细信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeAssetContainerDetail。 |
Version | 是 | String | 公共参数,本接口取值:2020-11-01。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
ContainerId | 是 | String | 容器id |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
HostID | String | 主机id |
HostIP | String | 主机ip |
ContainerName | String | 容器名称 |
Status | String | 运行状态 |
RunAs | String | 运行账户 |
Cmd | String | 命令行 |
CPUUsage | Integer | CPU使用率 * 1000 |
RamUsage | Integer | 内存使用 KB |
ImageName | String | 镜像名 |
ImageID | String | 镜像ID |
POD | String | 归属POD |
K8sMaster | String | k8s 主节点 |
ProcessCnt | Integer | 容器内进程数 |
PortCnt | Integer | 容器内端口数 |
ComponentCnt | Integer | 组件数 |
AppCnt | Integer | app数 |
WebServiceCnt | Integer | websvc数 |
Mounts | Array of ContainerMount | 挂载 |
Network | ContainerNetwork | 容器网络信息 |
CreateTime | String | 创建时间 |
ImageCreateTime | String | 镜像创建时间 |
ImageSize | Integer | 镜像大小 |
HostStatus | String | 主机状态 offline,online,pause |
NetStatus | String | 网络状态 未隔离 NORMAL 已隔离 ISOLATED 隔离中 ISOLATING 隔离失败 ISOLATE_FAILED 解除隔离中 RESTORING 解除隔离失败 RESTORE_FAILED 示例值:xxx |
NetSubStatus | String | 网络子状态 示例值:xxx |
IsolateSource | String | 隔离来源 注意:此字段可能返回 null,表示取不到有效值。 示例值:xxx |
IsolateTime | String | 隔离时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:xxx |
NodeID | String | 节点ID |
NodeName | String | 节点名称 |
NodeSubNetID | String | 节点子网ID |
NodeSubNetName | String | 节点子网名称 |
NodeSubNetCIDR | String | 节点子网网段 |
PodName | String | pod名称 |
PodIP | String | pod ip |
PodStatus | String | pod状态 |
ClusterID | String | 集群ID |
ClusterName | String | 集群名称 |
NodeType | String | 节点类型:NORMAL: 普通节点(默认值) SUPER: 超级节点 |
NodeUniqueID | String | 超级节点唯一id |
PublicIP | String | 外网ip |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询容器信息
查询容器信息
输入示例
POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAssetContainerDetail
<公共请求参数>
{
"ContainerId": "cndajlhcklanca"
}
输出示例
{
"Response": {
"HostID": "abc",
"HostIP": "abc",
"ContainerName": "abc",
"Status": "abc",
"RunAs": "abc",
"Cmd": "abc",
"CPUUsage": 1,
"RamUsage": 1,
"ImageName": "abc",
"ImageID": "abc",
"POD": "abc",
"K8sMaster": "abc",
"ProcessCnt": 1,
"PortCnt": 1,
"ComponentCnt": 1,
"AppCnt": 1,
"WebServiceCnt": 1,
"Mounts": [
{
"Type": "abc",
"Source": "abc",
"Destination": "abc",
"Mode": "abc",
"RW": true,
"Propagation": "abc",
"Name": "abc",
"Driver": "abc"
}
],
"Network": {
"EndpointID": "abc",
"Mode": "abc",
"Name": "abc",
"NetworkID": "abc",
"Gateway": "abc",
"Ipv4": "abc",
"Ipv6": "abc",
"MAC": "abc"
},
"CreateTime": "abc",
"ImageCreateTime": "abc",
"ImageSize": 1,
"HostStatus": "abc",
"NetStatus": "abc",
"NetSubStatus": "abc",
"IsolateSource": "abc",
"IsolateTime": "abc",
"NodeID": "abc",
"NodeName": "abc",
"NodeSubNetID": "abc",
"NodeSubNetName": "abc",
"NodeSubNetCIDR": "abc",
"PodName": "abc",
"PodIP": "abc",
"PodStatus": "abc",
"ClusterID": "abc",
"ClusterName": "abc",
"NodeType": "abc",
"NodeUniqueID": "abc",
"PublicIP": "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 | 资源不存在。 |