# 获取集群配置 - ListCceClusterConfig #### 功能介绍 获取集群配置。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-hss2.0/hss_02_0007.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-hss2.0/hss_02_0022.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI POST /v5/{project_id}/container/kubernetes/clusters/configs/batch-query 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-hss2.0/hss_02_0024.html)。 **约束限制**: 不涉及 **取值范围**: 字符长度1-256位 **默认取值**: 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | enterprise_project_id | 否 | String | **参数解释**: 企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见[获取企业项目ID](https://support.huaweicloud.com/api-hss2.0/hss_02_0027.html)。 如需查询所有企业项目下的资产请传参"all_granted_eps"。 **约束限制**: 开通企业项目功能后才需要配置企业项目ID参数。 **取值范围**: 字符长度1-256位 **默认取值**: 0，表示默认企业项目（default）。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见[获取用户Token](https://support.huaweicloud.com/api-hss2.0/hss_02_0009.html)。 **约束限制**: 不涉及 **取值范围**: 字符长度1-32768位 **默认取值**: 不涉及 | | region | 否 | String | **参数解释**: 区域ID，用于查询目的区域内的资产。获取方式请参见[获取区域ID](https://support.huaweicloud.com/api-hss2.0/hss_02_0026.html)。 **约束限制**: 不涉及 **取值范围**: 字符长度1-128位 **默认取值**: 不涉及 | 表4请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | cluster_info_list | 是 | Array of [cluster_info_list] objects | 集群id列表 | | cluster_id_list | 否 | Array of strings | 集群id列表 | 表5cluster_info_list | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | cluster_id | 是 | String | 集群id | | cluster_name | 是 | String | 集群名称 | #### 响应参数 **状态码：200** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_num | Integer | 配置总数 | | data_list | Array of [ClusterConfigResponseInfo] objects | 配置信息列表 | 表7ClusterConfigResponseInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | cluster_id | String | 集群id | | protect_node_num | Integer | 集群开启防护节点数量 | | protect_interrupt_node_num | Integer | 集群防护中断节点数量 | | protect_degradation_node_num | Integer | 集群防护降级节点数量 | | unprotect_node_num | Integer | 集群防护中断节点数量 | | node_total_num | Integer | 集群节点总数 | | cluster_name | String | 集群名称 | | charging_mode | String | **参数解释**: 付费模式 **取值范围**: 包含以下两种： - on_demand：按需。 - free：免费。 | | prefer_packet_cycle | Integer | 优先使用包周期配额；默认0 | | protect_type | String | **参数解释**: cce集群防护类型 **取值范围**: - cluster_level：集群级别。 - node_level：节点级别。 | | protect_status | String | **参数解释**: 防护状态 **取值范围**: - protecting：防护中。 - part_protect：部分防护。 - creating：开启中。 - error_protect：防护异常。 - unprotect：未防护。 - wait_protect：待防护。 | | cluster_type | String | **参数解释**: 集群类型 **取值范围**: - existing：存量集群。 - adding：新增集群。 | | fail_reason | String | fail reason | #### 请求示例 查询集群名称为cluster_name_test，集群id为6a321faa6e6c4a18b5bf19dd9543test集群配置 ``` POST https://{endpoint}/v5/{project_id}/container/kubernetes/clusters/configs/batch-query?enterprise_project_id=0 { "cluster_info_list" : [ { "cluster_id" : "de17d1db-7f4f-11f0-bf8e-0255ac1001b8", "cluster_name" : "test-networkpolicy" }, { "cluster_id" : "de17d1db-7f4f-11f0-bf8e-0255ac1001b9", "cluster_name" : "test-networkpolicy1" } ] } ``` #### 响应示例 **状态码：200** 请求已成功 ``` { "total_num" : 1, "data_list" : [ { "cluster_id" : "6a321faa6e6c4a18b5bf19dd9543test", "protect_status" : "unprotect" } ] } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 查询集群名称为cluster_name_test，集群id为6a321faa6e6c4a18b5bf19dd9543test集群配置 ``` 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("")) .build(); ListCceClusterConfigRequest request = new ListCceClusterConfigRequest(); CCEClusterInfoListRequestBody body = new CCEClusterInfoListRequestBody(); List listbodyClusterInfoList = new ArrayList<>(); listbodyClusterInfoList.add( new CCEClusterInfoListRequestBodyClusterInfoList() .withClusterId("de17d1db-7f4f-11f0-bf8e-0255ac1001b8") .withClusterName("test-networkpolicy") ); listbodyClusterInfoList.add( new CCEClusterInfoListRequestBodyClusterInfoList() .withClusterId("de17d1db-7f4f-11f0-bf8e-0255ac1001b9") .withClusterName("test-networkpolicy1") ); body.withClusterInfoList(listbodyClusterInfoList); request.withBody(body); 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()); } } } ``` - [Python] 查询集群名称为cluster_name_test，集群id为6a321faa6e6c4a18b5bf19dd9543test集群配置 ``` # 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("")) \ .build() try: request = ListCceClusterConfigRequest() listClusterInfoListbody = [ CCEClusterInfoListRequestBodyClusterInfoList( cluster_id="de17d1db-7f4f-11f0-bf8e-0255ac1001b8", cluster_name="test-networkpolicy" ), CCEClusterInfoListRequestBodyClusterInfoList( cluster_id="de17d1db-7f4f-11f0-bf8e-0255ac1001b9", cluster_name="test-networkpolicy1" ) ] request.body = CCEClusterInfoListRequestBody( cluster_info_list=listClusterInfoListbody ) 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) ``` - [Go] 查询集群名称为cluster_name_test，集群id为6a321faa6e6c4a18b5bf19dd9543test集群配置 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := hss.HssClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := hss.NewHssClient(hcClient) request := &model.ListCceClusterConfigRequest{} var listClusterInfoListbody = []model.CceClusterInfoListRequestBodyClusterInfoList{ { ClusterId: "de17d1db-7f4f-11f0-bf8e-0255ac1001b8", ClusterName: "test-networkpolicy", }, { ClusterId: "de17d1db-7f4f-11f0-bf8e-0255ac1001b9", ClusterName: "test-networkpolicy1", }, } request.Body = &model.CceClusterInfoListRequestBody{ ClusterInfoList: listClusterInfoListbody, } response, err := client.ListCceClusterConfig(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/HSS/sdk?api=ListCceClusterConfig&version=v5)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求已成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-hss2.0/ErrorCode.html)。