Querying Basic Container Information List

Function

This API is used to query the basic container information list.

URI

GET /v5/{project_id}/container/kubernetes

Table 1 Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Table 2 Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps.
container_name	No	String	Container name
pod_name	No	String	Pod name
image_name	No	String	Image name
cluster_container	No	Boolean	Whether the container is managed by a cluster
limit	No	Integer	Number of records displayed on each page
offset	No	Integer	Offset, which specifies the start position of the record to be returned.

Request Parameters

Table 3 Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token.

Response Parameters

Status code: 200

Table 4 Response body parameters
Parameter	Type	Description
total_num	Integer	Total number of containers
last_update_time	Long	Last update time
data_list	Array of ContainerBaseInfo objects	Basic container information list

Table 5 ContainerBaseInfo
Parameter	Type	Description
container_id	String	Container ID
container_name	String	Container name
image_name	String	Image name
status	String	Container status. Its value can be: Running Terminated Waiting
create_time	Long	Creation time
cpu_limit	String	CPU limit
memory_limit	String	Memory limit
restart_count	Integer	Number of restarts
pod_name	String	Pod name
cluster_name	String	Cluster
cluster_id	String	Cluster ID
cluster_type	String	Cluster type. Its value can be: k8s: native Kubernetes cluster cce: CCE cluster self_built_hw: customer-built cluster on cloud self_built_idc: IDC on-premises cluster
risky	Boolean	Whether there are risks
low_risk	Integer	Number of low risks
medium_risk	Integer	Number of medium risks
high_risk	Integer	Number of high risks
fatal_risk	Integer	Number of critical risks

Example Requests

Search for containers whose names contain install-agent-ds and return the first 10 records.

GET https://{endpoint}/v5/{project_id}/container/kubernetes?offset=0&limit=10&enterprise_project_id=all_granted_eps&contianer_name=install-agent-ds

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "last_update_time" : 1710097200019,
  "data_list" : [ {
    "container_id" : "d7354abc9c18c68ab3e48e3481624125e415766b6d03eefc5770ff70c5391c8d",
    "container_name" : "node-exporter",
    "image_name" : "official/node-exporter:3.9.5",
    "status" : "Running",
    "create_time" : 1708453039000,
    "cpu_limit" : "500m",
    "memory_limit" : "1Gi",
    "restart_count" : 0,
    "pod_name" : "node-exporter-l4m75",
    "cluster_name" : "glz-hss",
    "cluster_id" : "352f4ef1-ce57-11ee-8cb3-0255ac100b0f",
    "cluster_type" : "cce",
    "risky" : false,
    "low_risk" : 0,
    "medium_risk" : 0,
    "high_risk" : 0,
    "fatal_risk" : 0
  } ]
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent topic: Container Management

Предыдущая статья

Querying the Container Node List

Следующая статья

Event Management

Была ли эта статья полезна?

Поддержка Юридические документы