Updated on 2024-07-04 GMT+08:00

Querying Basic Container Information List

Function

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

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/container/kubernetes

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Minimum: 1

Maximum: 128

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.

Default: 0

Minimum: 1

Maximum: 256

container_name

No

String

Container name

Minimum: 0

Maximum: 128

pod_name

No

String

Pod name

Minimum: 0

Maximum: 128

image_name

No

String

Image name

Minimum: 0

Maximum: 128

cluster_container

No

Boolean

Whether the container is managed by a cluster

Default: false

limit

No

Integer

Number of records displayed on each page

Minimum: 1

Maximum: 1000

Default: 10

offset

No

Integer

Offset, which specifies the start position of the record to be returned.

Minimum: 0

Maximum: 2000000

Default: 0

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

Minimum: 1

Maximum: 32768

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_num

Integer

Total number of containers

Minimum: 0

Maximum: 2147483647

last_update_time

Long

Last update time

Minimum: 0

Maximum: 4071095999000

data_list

Array of ContainerBaseInfo objects

Basic container information list

Array Length: 0 - 2147483647

Table 5 ContainerBaseInfo

Parameter

Type

Description

container_id

String

Container ID

Minimum: 0

Maximum: 255

container_name

String

Container name

Minimum: 0

Maximum: 255

image_name

String

Image name

Minimum: 0

Maximum: 255

status

String

Container status. Its value can be:

  • Running

  • Terminated

  • Waiting

Minimum: 0

Maximum: 64

create_time

Long

Creation time

Minimum: 0

Maximum: 4071095999000

cpu_limit

String

CPU limit

Minimum: 0

Maximum: 64

memory_limit

String

Memory limit

Minimum: 0

Maximum: 64

restart_count

Integer

Number of restarts

Minimum: 0

Maximum: 20

pod_name

String

Pod name

Minimum: 0

Maximum: 64

cluster_name

String

Cluster

Minimum: 0

Maximum: 64

cluster_id

String

Cluster ID

Minimum: 0

Maximum: 64

cluster_type

String

Cluster type. Its value can be:

  • k8s (native kubernetes cluster)

  • cce (CCE cluster) -ali (cluster on Alibaba Cloud) -tencent (cluster on Tencent Cloud)

  • azure (cluster on Azure Cloud)

  • aws (cluster on AWS Cloud)

  • self_built_hw (customer-built cluster on Huawei Cloud)

  • self_built_idc (customer-built IDC cluster)

Minimum: 0

Maximum: 255

risky

Boolean

Whether there are risks

low_risk

Integer

Number of low risks

Minimum: 0

Maximum: 2147483647

medium_risk

Integer

Number of medium risks

Minimum: 0

Maximum: 2147483647

high_risk

Integer

Number of high risks

Minimum: 0

Maximum: 2147483647

fatal_risk

Integer

Number of critical risks

Minimum: 0

Maximum: 2147483647

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

Basic container information list

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

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

Basic container information list

Error Codes

See Error Codes.