更新时间:2025-08-15 GMT+08:00

查询pod基本信息列表

功能介绍

查询pod基本信息列表

调用方法

请参见如何调用API

URI

GET /v5/{project_id}/kubernetes/pods

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

offset

Integer

参数解释:

偏移量:指定返回记录的开始位置

约束限制:

不涉及

取值范围:

最小值0,最大值2000000

默认取值:

默认为0

limit

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

pod_name

String

pod名称

namespace_name

String

命名空间名称

cluster_name

String

所属集群名称

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total_num

Long

pod总数

data_list

Array of PodBaseInfo objects

pod列表

pod_info_list

Array of ServerlessPodInfo objects

实例基本信息列表

表5 PodBaseInfo

参数

参数类型

描述

pod_name

String

pod名称

namespace_name

String

命名空间名称

cluster_name

String

所属集群

node_name

String

所属节点名称

cpu

String

CPU使用量

memory

String

内存使用量

cpu_limit

String

cpu限制

memory_limit

String

内存限制

node_ip

String

所属节点IP

pod_ip

String

Pod IP

status

String

Pod状态,包含以下几种

-Pending:pod已被Kubernetes系统接受,但尚未创建一个或多个容器镜像

-Running:pod已经绑定到一个节点,并且所有的容器都已经创建完毕

-Succeeded:pod中的所有容器都已成功终止,不会重新启动

-Failed:pod中的所有容器都已终止,并且至少有一个容器因故障而终止

-Unknown:由于某种原因无法获取pod的状态,通常是由于与pod的主机通信时出错

create_time

Long

创建时间

region_id

String

regionId

id

String

ID

cluster_id

String

集群id

cluster_type

String

集群类型,包含以下几种:

  • k8s:原生集群

  • cce:CCE集群

  • ali:阿里云集群

  • tencent:腾讯云集群

  • azure:微软云集群

  • aws:亚马逊集群

  • self_built_hw:华为云自建集群

  • self_built_idc:IDC自建集群

表6 ServerlessPodInfo

参数

参数类型

描述

pod_name

String

实例名称

namespace_name

String

命名空间名称

cluster_name

String

所属集群

cpu

String

CPU使用量

memory

String

内存使用量

cpu_limit

String

cpu限制

memory_limit

String

内存限制

pod_ip

String

实例 IP

protect_status

String

防护状态,包含如下2种。

  • closed :未防护。

  • opened :防护中。

  • protection_exception :防护异常。

detect_result

String

Serverless安全检测结果,包含如下4种。

  • undetected :未检测。

  • clean :无风险。

  • risk :有风险。

  • scanning :检测中。

status

AnyType

Pod状态,包含以下几种

-Pending:pod已被Kubernetes系统接受,但尚未创建一个或多个容器镜像

-Running:pod已经绑定到一个节点,并且所有的容器都已经创建完毕

-Succeeded:pod中的所有容器都已成功终止,不会重新启动

-Failed:pod中的所有容器都已终止,并且至少有一个容器因故障而终止

-Unknown:由于某种原因无法获取pod的状态,通常是由于与pod的主机通信时出错

create_time

Long

创建时间

请求示例

查询pod基本信息列表

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

响应示例

状态码:200

请求已成功

{
  "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代码示例

SDK代码示例如下。

 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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码