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 示例值:1bc888378a8d5b9e449feebbe10c3bb10d2376158978670793ed9349b53c**** |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
HostID | String | 主机id 示例值:04fdfbaf-322b-4f1e-9cb9-aaa149c1**** |
HostIP | String | 主机ip 示例值:10.206.6**** |
ContainerName | String | 容器名称 示例值:/k8s_controller_ingress-nginx-controller-5b4b4b47f-dtmbt_ingress-nginx_2b5c4086-f320-4fe8-9367-fa5161bcf78b**** |
Status | String | 运行状态 示例值:RUNNING |
RunAs | String | 运行账户 示例值:root |
Cmd | String | 命令行 示例值:/usr/bin/dumb-init -- /nginx-ingress-controller --publish-service=ingress-nginx/ingress-nginx-controller --election-id=ingress-controller-leader --leader-elect-retry-period=2s --leader-elect-renew-deadline=10s --leader-elect-lease-duration=15s --v=2 --ingress-class=nginx --controller-class=k8s.io/ingress-nginx --configmap=ingress-nginx/ingress-nginx-controller --watch-ingress-without-class=true --update-status-on-shutdown=false --time-buckets=0.01,0.1,1,10 --length-buckets=10,30,50,70,90 --size-buckets=10,100,1000,100000,1000**** |
CPUUsage | Integer | CPU使用率 * 1000 示例值:0 |
RamUsage | Integer | 内存使用 KB 示例值:0 |
ImageName | String | 镜像名 示例值:sha256:3184131ba9830b917fa81fc0e71de3ee26d36a538dc2f6196139b9abbe54**** |
ImageID | String | 镜像ID 示例值:sha256:3184131ba9830b917fa81fc0e71de3ee26d36a538dc2f6196139b9abbe54**** |
POD | String | 归属POD 示例值:k8s_node-ope** |
K8sMaster | String | k8s 主节点 示例值:etcd |
ProcessCnt | Integer | 容器内进程数 示例值:0 |
PortCnt | Integer | 容器内端口数 示例值:0 |
ComponentCnt | Integer | 组件数 示例值:0 |
AppCnt | Integer | app数 示例值:0 |
WebServiceCnt | Integer | websvc数 示例值:0 |
Mounts | Array of ContainerMount | 挂载 示例值:[{"Destination": "/var/run/secrets/kubernetes.io/serviceacc", "Driver": "", "Mode": "ro", "Name": "", "Propagation": "rprivate", "RW": false, "Source": "/var/lib/kubelet/pods/2fd62e4d-90d1-4cd8-a74a-1c63bfdbbcbe/volumes/kubernetes.io~secret/default-token-n", "Type": "bind"}] |
Network | ContainerNetwork | 容器网络信息 示例值:{"EndpointID": "", "Gateway": "", "Ipv4": "", "Ipv6": "", "MAC": "", "Mode": "", "Name": "", "NetworkID": ""} |
CreateTime | String | 创建时间 示例值:2024-11-01 10:1**** |
ImageCreateTime | String | 镜像创建时间 示例值:2023-11-16 16:4**** |
ImageSize | Integer | 镜像大小 示例值:298135055 |
HostStatus | String | 主机状态 offline,online,pause 示例值:ONLINE |
NetStatus | String | 网络状态 未隔离 NORMAL 已隔离 ISOLATED 隔离中 ISOLATING 隔离失败 ISOLATE_FAILED 解除隔离中 RESTORING 解除隔离失败 RESTORE_FAILED 示例值:NORMAL |
NetSubStatus | String | 网络子状态 示例值:NONE |
IsolateSource | String | 隔离来源 示例值:none |
IsolateTime | String | 隔离时间 示例值:1970-01-01 00:0**** |
NodeID | String | 节点ID 示例值:Node3gdy |
NodeName | String | 节点名称 示例值:tcs交付**** |
NodeSubNetID | String | 节点子网ID 示例值:subnet-5gu2*** |
NodeSubNetName | String | 节点子网名称 示例值:subnet*** |
NodeSubNetCIDR | String | 节点子网网段 示例值:10.0.200.0/24 |
PodName | String | pod名称 示例值:k8s_node-operation** |
PodIP | String | pod ip 示例值:10.0.1**** |
PodStatus | String | pod状态 示例值:Running |
ClusterID | String | 集群ID 示例值:cls-dfw3e*** |
ClusterName | String | 集群名称 示例值:clsfoo*** |
NodeType | String | 节点类型:NORMAL: 普通节点(默认值) SUPER: 超级节点 示例值:NORMAL |
NodeUniqueID | String | 超级节点唯一id 示例值:Node3gdy |
PublicIP | String | 外网ip 示例值:119.45.117**** |
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": {
"AppCnt": 0,
"CPUUsage": 0,
"ClusterID": "cls-m2x0ndjy",
"ClusterName": "tke2",
"Cmd": "/usr/bin/dumb-init -- /nginx-ingress-controller --publish-service=ingress-nginx/ingress-nginx-controller --election-id=ingress-controller-leader --leader-elect-retry-period=2s --leader-elect-renew-deadline=10s --leader-elect-lease-duration=15s --v=2 --ingress-class=nginx --controller-class=k8s.io/ingress-nginx --configmap=ingress-nginx/ingress-nginx-controller --watch-ingress-without-class=true --update-status-on-shutdown=false --time-buckets=0.01,0.1,1,10 --length-buckets=10,30,50,70,90 --size-buckets=10,100,1000,100000,1000****",
"ComponentCnt": 0,
"ContainerName": "cbs-csi",
"CreateTime": "2024-10-24 19:36:24",
"HostID": "8bc803fd-d85d-47b8-9e2b-9644674be677",
"HostIP": "1.1.1.1",
"HostStatus": "ONLINE",
"ImageCreateTime": "0001-01-01 08:05:43",
"ImageID": "sha256:563af",
"ImageName": "image:latest",
"ImageSize": 0,
"IsolateSource": "none ",
"IsolateTime": "1970-01-01 00:00:01",
"K8sMaster": "etcd",
"Mounts": [],
"NetStatus": "NORMAL",
"NetSubStatus": "NONE",
"Network": {
"EndpointID": "myService/us-west-1/instance",
"Gateway": "gateway",
"Ipv4": "127.0.0.1",
"Ipv6": "2001:db8:85a3::8a2e:370:7334",
"MAC": "00:1A:2B:3C:4D:5E",
"Mode": "mode",
"Name": "name",
"NetworkID": "1002"
},
"NodeID": "eklet-subnet-1ewk3avk",
"NodeName": "VM-1-254-tencentos",
"NodeSubNetCIDR": "10.0.200.0/24",
"NodeSubNetID": "subnet-5gu2***",
"NodeSubNetName": "subnet***",
"NodeType": "NORMAL",
"NodeUniqueID": "27501aaed5e639693783321219989889",
"POD": "tcss-aset-11-321",
"PodIP": "1.1.1.1",
"PodName": "tcss-asset-124321",
"PodStatus": "Running",
"PortCnt": 0,
"ProcessCnt": 0,
"PublicIP": "10.0.1.92",
"RamUsage": 0,
"RequestId": "6954374b-bfcd-4751-8358-3e3682551514",
"RunAs": "root",
"Status": "RUNNING",
"WebServiceCnt": 0
}
}
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 | 资源不存在。 |