Updated on 2025-08-15 GMT+08:00

Querying the Basic Pod Information List

Function

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

Calling Method

For details, see Calling APIs.

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

Parameter description:

Number of records displayed on each page.

Constraints:

N/A

Options:

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

Protection status. It can be:

  • closed

  • opened

  • protection_exception

detect_result

String

Serverless security check result. The options are as follows:

  • undetected

  • clean: No risk is detected.

  • risk: Risks are detected.

  • scanning

status

AnyType

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,
  "last_update_time" : 1753498970618,
  "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"
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.hss.v5.region.HssRegion;
import com.huaweicloud.sdk.hss.v5.*;
import com.huaweicloud.sdk.hss.v5.model.*;


public class ListK8sPodsSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        HssClient client = HssClient.newBuilder()
                .withCredential(auth)
                .withRegion(HssRegion.valueOf("<YOUR REGION>"))
                .build();
        ListK8sPodsRequest request = new ListK8sPodsRequest();
        try {
            ListK8sPodsResponse response = client.listK8sPods(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkhss.v5.region.hss_region import HssRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkhss.v5 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = HssClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(HssRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListK8sPodsRequest()
        response = client.list_k8s_pods(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := hss.NewHssClient(
        hss.HssClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListK8sPodsRequest{}
	response, err := client.ListK8sPods(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.