更新时间:2024-08-05 GMT+08:00

查询容器基本信息列表

功能介绍

查询容器基本信息列表

调用方法

请参见如何调用API

URI

GET /v5/{project_id}/container/kubernetes

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

最小长度:1

最大长度:128

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

企业项目ID,查询所有企业项目时填写:all_granted_eps

缺省值:0

最小长度:1

最大长度:256

container_name

String

容器名称

最小长度:0

最大长度:128

pod_name

String

所属Pod名称

最小长度:0

最大长度:128

image_name

String

镜像名称

最小长度:0

最大长度:128

cluster_container

Boolean

是否是集群纳管的容器

缺省值:false

limit

Integer

每页显示个数

最小值:1

最大值:1000

缺省值:10

offset

Integer

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

最小值:0

最大值:2000000

缺省值:0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

最小长度:1

最大长度:32768

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

容器总数

最小值:0

最大值:2147483647

last_update_time

Long

最近更新时间

最小值:0

最大值:4071095999000

data_list

Array of ContainerBaseInfo objects

容器基本信息列表

数组长度:0 - 2147483647

表5 ContainerBaseInfo

参数

参数类型

描述

container_id

String

容器ID

最小长度:0

最大长度:255

container_name

String

容器名称

最小长度:0

最大长度:255

image_name

String

镜像名称

最小长度:0

最大长度:255

status

String

容器状态,包含以下几种: -Running 运行中 -Terminated 终止 -Waiting 等待

最小长度:0

最大长度:64

create_time

Long

创建时间

最小值:0

最大值:4071095999000

cpu_limit

String

cpu限制

最小长度:0

最大长度:64

memory_limit

String

内存限制

最小长度:0

最大长度:64

restart_count

Integer

重启次数

最小值:0

最大值:20

pod_name

String

所属pod名称

最小长度:0

最大长度:64

cluster_name

String

所属集群

最小长度:0

最大长度:64

cluster_id

String

集群id

最小长度:0

最大长度:64

cluster_type

String

集群类型,包含以下几种: -k8s 原生集群 -cce CCE集群 -ali 阿里云集群 -tencent 腾讯云集群 -azure 微软云集群 -aws 亚马逊集群 -self_built_hw 华为云自建集群 -self_built_idc IDC自建集群

最小长度:0

最大长度:255

risky

Boolean

是否有风险

low_risk

Integer

低危风险数量

最小值:0

最大值:2147483647

medium_risk

Integer

中危风险数量

最小值:0

最大值:2147483647

high_risk

Integer

高危风险数量

最小值:0

最大值:2147483647

fatal_risk

Integer

致命风险数量

最小值:0

最大值:2147483647

请求示例

查询前10条容器名称为install-agent-ds的容器列表

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

响应示例

状态码: 200

容器基本信息列表

{
  "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
  } ]
}

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
48
49
50
51
52
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 ListContainersSolution {

    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");

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

        HssClient client = HssClient.newBuilder()
                .withCredential(auth)
                .withRegion(HssRegion.valueOf("<YOUR REGION>"))
                .build();
        ListContainersRequest request = new ListContainersRequest();
        request.withEnterpriseProjectId("<enterprise_project_id>");
        request.withContainerName("<container_name>");
        request.withPodName("<pod_name>");
        request.withImageName("<image_name>");
        request.withClusterContainer(<cluster_container>);
        request.withLimit(<limit>);
        request.withOffset(<offset>);
        try {
            ListContainersResponse response = client.listContainers(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
32
33
34
35
36
37
# 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"]

    credentials = BasicCredentials(ak, sk)

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

    try:
        request = ListContainersRequest()
        request.enterprise_project_id = "<enterprise_project_id>"
        request.container_name = "<container_name>"
        request.pod_name = "<pod_name>"
        request.image_name = "<image_name>"
        request.cluster_container = <ClusterContainer>
        request.limit = <limit>
        request.offset = <offset>
        response = client.list_containers(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
38
39
40
41
42
43
44
45
46
47
48
49
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")

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

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

    request := &model.ListContainersRequest{}
	enterpriseProjectIdRequest:= "<enterprise_project_id>"
	request.EnterpriseProjectId = &enterpriseProjectIdRequest
	containerNameRequest:= "<container_name>"
	request.ContainerName = &containerNameRequest
	podNameRequest:= "<pod_name>"
	request.PodName = &podNameRequest
	imageNameRequest:= "<image_name>"
	request.ImageName = &imageNameRequest
	clusterContainerRequest:= <cluster_container>
	request.ClusterContainer = &clusterContainerRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	response, err := client.ListContainers(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

容器基本信息列表

错误码

请参见错误码