Querying the Basic Pod Information List

Function

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

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/kubernetes/pods

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.
offset	No	Integer	Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value The default value is 0.
limit	No	Integer	Definition Number of records displayed on each page. Constraints N/A Range Value range: 10-200 Default Value 10
pod_name	No	String	Pod name
namespace_name	No	String	Namespace
cluster_name	No	String	Cluster name

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Long	Total number of pods.
data_list	Array of PodBaseInfo objects	Pod list.
pod_info_list	Array of ServerlessPodInfo objects	Basic instance information list

**Table 5** PodBaseInfo
Parameter	Type	Description
pod_name	String	Pod name
namespace_name	String	Name
cluster_name	String	Cluster.
node_name	String	Node name
cpu	String	Used CPU
memory	String	Memory usage
cpu_limit	String	CPU limit
memory_limit	String	Memory Limit
node_ip	String	Node IP address
pod_ip	String	Pod IP
status	String	Pod status. It can be: Pending: The pod has been accepted by the Kubernetes system, but no container images have been created. Running: The pod has been bound to a node, and all containers have been created. Succeeded: All containers in the pod have been terminated and will not be restarted. Failed: All containers in the pod have been terminated, and at least one container was terminated due to a fault. Unknown: The pod status cannot be obtained, usually because of an error during the communication with the pod server.
create_time	Long	Created At
region_id	String	regionId
id	String	ID
cluster_id	String	Cluster ID
cluster_type	String	Cluster type. Its value can be: k8s: native Kubernetes cluster cce: CCE cluster ali: Alibaba Cloud cluster tencent: Tencent Cloud cluster azure: Microsoft Azure Cloud cluster aws: AWS Cloud cluster self_built_hw: customer-built cluster on Huawei Cloud self_built_idc: IDC on-premises cluster

**Table 6** ServerlessPodInfo
Parameter	Type	Description
pod_name	String	Instance Name
namespace_name	String	Name
cluster_name	String	Cluster.
cpu	String	Used CPU
memory	String	Memory usage
cpu_limit	String	CPU limit
memory_limit	String	Memory Limit
pod_ip	String	Pod IP
protect_status	String	Definition Protection status. Constraints N/A Range closed: not protected opened: The protection is in progress. protection_exception: protection exception Default Value N/A
detect_result	String	Serverless security check result. The options are as follows: undetected clean: No risk is detected. risk: Risks are detected. scanning
status	String	Pod status. It can be: Pending: The pod has been accepted by the Kubernetes system, but no container images have been created. Running: The pod has been bound to a node, and all containers have been created. Succeeded: All containers in the pod have been terminated and will not be restarted. Failed: All containers in the pod have been terminated, and at least one container was terminated due to a fault. Unknown: The pod status cannot be obtained, usually because of an error during the communication with the pod server.
create_time	Long	Created At

Example Requests

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

GET https://{endpoint}/v5/{project_id}/kubernetes/pods?offset=0&limit=200&enterprise_project_id=all_granted_eps

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 107,
  "data_list" : [ {
    "id" : "1d72f695-2bce-48b7-8576-c8e427cc08b7",
    "pod_name" : "node-problem-controller-667894bc4-nz5xj",
    "namespace_name" : "kube-system",
    "node_name" : "192.168.0.50",
    "node_ip" : "192.168.0.50",
    "pod_ip" : "10.0.2.131",
    "status" : "Running",
    "create_time" : 1753227292000,
    "cluster_name" : "hss-baseline-mww",
    "cluster_id" : "43411c30-450b-11f0-a624-0255ac1001b7",
    "cluster_type" : "cce",
    "region_id" : "cn-north-7"
  } ]
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Container Management

Previous topic: Querying the Kubernetes Endpoint List

Next topic: Synchronizing Cluster Information

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot