查询容器信息
最近更新时间: 2024-09-03 18:49:49
1. 接口描述
接口请求域名: tcss.api3.cloud.sunhongs.com。
查询容器详细信息
默认接口请求频率限制:20次/秒。
接口更新时间:2023-11-10 10:13:15。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| 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 | Uint64 | CPU使用率 * 1000 |
| RamUsage | Uint64 | 内存使用 KB |
| ImageName | String | 镜像名 |
| ImageID | String | 镜像ID |
| POD | String | 归属POD |
| K8sMaster | String | k8s 主节点 |
| ProcessCnt | Uint64 | 容器内进程数 |
| PortCnt | Uint64 | 容器内端口数 |
| ComponentCnt | Uint64 | 组件数 |
| AppCnt | Uint64 | app数 |
| WebServiceCnt | Uint64 | websvc数 |
| Mounts | ContainerMount | 挂载 |
| Network | ContainerNetwork | 容器网络信息 |
| CreateTime | String | 创建时间 |
| ImageCreateTime | String | 镜像创建时间 |
| ImageSize | Uint64 | 镜像大小 |
| HostStatus | String | 主机状态 offline,online,pause |
| NetStatus | String | 网络状态<br>未隔离 NORMAL<br>已隔离 ISOLATED<br>隔离中 ISOLATING<br>隔离失败 ISOLATE_FAILED<br>解除隔离中 RESTORING<br>解除隔离失败 RESTORE_FAILED |
| NetSubStatus | String | 网络子状态 |
| IsolateSource | String | 隔离来源 |
| IsolateTime | String | 隔离时间 |
| 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。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | |
| InternalError | |
| ResourceNotFound | |
| InvalidParameter.ParsingError |