Domain name for API request: tcss.tencentcloudapi.com.
This API is used to query the information of a container.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: DescribeAssetContainerDetail. |
Version | Yes | String | Common Params. The value used for this API: 2020-11-01. |
Region | No | String | Common Params. This parameter is not required. |
ContainerId | Yes | String | Container ID |
Parameter Name | Type | Description |
---|---|---|
HostID | String | Server ID |
HostIP | String | Server IP |
ContainerName | String | Container name |
Status | String | Status |
RunAs | String | Operator |
Cmd | String | Command line |
CPUUsage | Integer | CPU utilization * 1000 |
RamUsage | Integer | Memory usage in KB |
ImageName | String | Image name |
ImageID | String | Image ID |
POD | String | Pod |
K8sMaster | String | K8s master node |
ProcessCnt | Integer | Number of processes in the container |
PortCnt | Integer | Number of ports in the container |
ComponentCnt | Integer | Number of components |
AppCnt | Integer | Number of applications |
WebServiceCnt | Integer | Number of web services |
Mounts | Array of ContainerMount | Mount |
Network | ContainerNetwork | Container network information |
CreateTime | String | Creation time |
ImageCreateTime | String | Image creation time |
ImageSize | Integer | Image size |
HostStatus | String | Server status. Valid values: offline , online , pause . |
NetStatus | String | Network statusNORMAL : Not isolated.ISOLATED : Isolated.ISOLATING : Isolating.ISOLATE_FAILED : Isolation failed.RESTORING : Recovering.RESTORE_FAILED : Recovery failed. |
NetSubStatus | String | Sub-status of the network |
IsolateSource | String | Isolation source Note: This field may return null, indicating that no valid values can be obtained. |
IsolateTime | String | Isolation time Note: This field may return null, indicating that no valid values can be obtained. |
NodeID | String | Node ID |
NodeName | String | Node name |
NodeSubNetID | String | Node subnet ID |
NodeSubNetName | String | Node subnet name |
NodeSubNetCIDR | String | Subnet IP range |
PodName | String | Pod name |
PodIP | String | Pod IP |
PodStatus | String | Pod status |
ClusterID | String | Cluster ID |
ClusterName | String | Cluster name |
NodeType | String | Node type. Values: NORMAL (default), SUPER |
NodeUniqueID | String | UID of the super node |
PublicIP | String | Public IP |
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to query the information of a container.
POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAssetContainerDetail
<Common request parameters>
{
"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"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
InternalError | An internal error occurred. |
InvalidParameter | The parameter is incorrect. |
InvalidParameter.ParsingError | A parameter parsing error occurred. |
ResourceNotFound | The resource does not exist. |
Was this page helpful?