Querying the Kubernetes Cluster List
Function
This API is used to query the Kubernetes cluster list.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/kubernetes/clusters
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 |
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 |
cluster_name |
No |
String |
Cluster name |
load_agent_info |
No |
Boolean |
Whether to load agent information. The default value is false. |
scene |
No |
String |
The scenario types are as follows: -cluster_risk: cluster risk scenario |
Request 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
Parameter |
Type |
Description |
---|---|---|
last_update_time |
Long |
Updated |
total_num |
Integer |
Total clusters |
cluster_info_list |
Array of KubernetesClusterInfo objects |
Cluster list |
Parameter |
Type |
Description |
---|---|---|
id |
String |
id |
cluster_name |
String |
Cluster name |
cluster_id |
String |
Specifies the cluster ID. |
cluster_type |
String |
Cluster type |
status |
String |
Cluster status. The options are as follows:
|
version |
String |
Version |
total_nodes_number |
Integer |
Total number of nodes. |
active_nodes_number |
Integer |
Number of normal nodes |
creation_timestamp |
Long |
Specifies the creation timestamp. |
agent_installed_num |
Integer |
Number of installed agent nodes in a cluster |
agent_install_failed_num |
Integer |
Number of nodes that fail to be installed in a cluster |
agent_not_install_num |
Integer |
Number of nodes where the agent is not installed in the cluster |
agent_ds_install_status |
String |
Agent-DS installation status in a cluster. When associating agent information, you need to consider the last_operate_time time. The options are as follows:
|
agent_ds_failed_reason |
String |
Operation failure cause. |
last_operate_timestamp |
Long |
Timestamp of the latest operation, which is the time when the daemonset script is installed. The agent is still being installed within 10 minutes. |
last_scan_time |
Long |
Timestamp of the last cluster scan |
sys_vul_num |
Integer |
Number of system vulnerabilities in a cluster |
app_vul_num |
Integer |
Number of application vulnerabilities in a cluster |
emg_vul_num |
Integer |
Number of emergency vulnerabilities in a cluster |
risk_assess_num |
Integer |
Number of risk evaluation problems in a cluster |
sec_comp_num |
Integer |
Number of security compliance issues in a cluster |
Example Requests
None
Example Responses
Status code: 200
Request succeeded.
{ "total_num" : 21, "last_update_time" : 1744311874662, "cluster_info_list" : [ { "id" : "1aee3ca1-69f0-4390-a7e5-adcf90e4728f", "cluster_name" : "yescrypt", "cluster_id" : "1aee3ca1-69f0-4390-a7e5-adcf90e4728f", "cluster_type" : "self_built_hw", "status" : "Available", "total_nodes_number" : 0, "active_nodes_number" : 0, "reation_timestamp" : 1743575464217 } ] }
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 ListKubernetesClusterDetailsSolution { 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(); ListKubernetesClusterDetailsRequest request = new ListKubernetesClusterDetailsRequest(); try { ListKubernetesClusterDetailsResponse response = client.listKubernetesClusterDetails(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 = ListKubernetesClusterDetailsRequest() response = client.list_kubernetes_cluster_details(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.ListKubernetesClusterDetailsRequest{} response, err := client.ListKubernetesClusterDetails(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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot