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

Obtaining Cluster Configurations

Function

This API is used to query cluster configuration.

Calling Method

For details, see Calling APIs.

URI

POST /v5/{project_id}/container/kubernetes/clusters/configs/batch-query

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.

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

region

No

String

Definition

Region ID, which is used to query assets in the required region. For details about how to obtain a region ID, see Obtaining a Region ID.

Constraints

N/A

Range

The value can contain 1 to 128 characters.

Default Value

N/A

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

cluster_info_list

Yes

Array of cluster_info_list objects

Cluster ID list

cluster_id_list

No

Array of strings

Cluster ID list

Table 5 cluster_info_list

Parameter

Mandatory

Type

Description

cluster_id

Yes

String

Cluster ID

cluster_name

Yes

String

Cluster name

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

total_num

Integer

Total number of configurations

data_list

Array of ClusterConfigResponseInfo objects

Configuration List

Table 7 ClusterConfigResponseInfo

Parameter

Type

Description

cluster_id

String

Cluster ID

protect_node_num

Integer

Number of protected nodes in a cluster

protect_interrupt_node_num

Integer

Number of nodes with protection interruption in a cluster

protect_degradation_node_num

Integer

Number of nodes where the cluster protection is downgraded.

unprotect_node_num

Integer

Number of nodes with protection interruption in a cluster

node_total_num

Integer

Total number of nodes in a cluster

cluster_name

String

Cluster name

charging_mode

String

Definition

Billing mode.

Constraints

N/A

Range

The options are as follows:

  • on_demand: pay-per-use

  • free: free of charge

Default Value

N/A

prefer_packet_cycle

Integer

Yearly/Monthly quotas are preferentially used. The default value is 0.

protect_type

String

CCE cluster protection type

protect_status

String

Definition

Protection status.

Constraints

N/A

Range

  • protecting: Resources are protected.

  • part_protect: Resources are partially protected.

  • creating: Protection is being enabled.

  • error_protect: The protection is abnormal.

  • unprotect: Resources are not protected.

  • wait_protect: Resources are to be protected.

Default Value

N/A

cluster_type

String

Cluster type

fail_reason

String

fail reason

Example Requests

Query the configuration of the cluster whose name is cluster_name_test and ID is 6a321faa6e6c4a18b5bf19dd9543test.

POST https://{endpoint}/v5{project_id}/container/kubernetes/clusters/configs/batch-query?enterprise_project_id=0

{
  "cluster_info_list" : {
    "cluster_id" : "6a321faa6e6c4a18b5bf19dd9543test",
    "cluster_name" : "cluster_name_test"
  }
}

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "cluster_id" : "6a321faa6e6c4a18b5bf19dd9543test",
    "protect_status" : "unprotect"
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

Query the configuration of the cluster whose name is cluster_name_test and ID is 6a321faa6e6c4a18b5bf19dd9543test.

 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 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.*;

import java.util.List;
import java.util.ArrayList;

public class ListCceClusterConfigSolution {

    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();
        ListCceClusterConfigRequest request = new ListCceClusterConfigRequest();
        try {
            ListCceClusterConfigResponse response = client.listCceClusterConfig(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());
        }
    }
}

Query the configuration of the cluster whose name is cluster_name_test and ID is 6a321faa6e6c4a18b5bf19dd9543test.

 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 = ListCceClusterConfigRequest()
        response = client.list_cce_cluster_config(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Query the configuration of the cluster whose name is cluster_name_test and ID is 6a321faa6e6c4a18b5bf19dd9543test.

 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.ListCceClusterConfigRequest{}
	response, err := client.ListCceClusterConfig(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.