更新时间:2025-08-29 GMT+08:00
分享

获取集群配置

功能介绍

获取集群配置

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

region

String

参数解释:

区域ID,用于查询目的区域内的资产。获取方式请参见获取区域ID

约束限制:

不涉及

取值范围:

字符长度1-128位

默认取值:

不涉及

表4 请求Body参数

参数

是否必选

参数类型

描述

cluster_info_list

Array of cluster_info_list objects

集群id列表

cluster_id_list

Array of strings

集群id列表

表5 cluster_info_list

参数

是否必选

参数类型

描述

cluster_id

String

集群id

cluster_name

String

集群名称

响应参数

状态码:200

表6 响应Body参数

参数

参数类型

描述

total_num

Integer

配置总数

data_list

Array of ClusterConfigResponseInfo objects

配置信息列表

表7 ClusterConfigResponseInfo

参数

参数类型

描述

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集群防护类型

protect_status

String

参数解释:

防护状态

约束限制:

不涉及

取值范围:

  • protecting:防护中。

  • part_protect:部分防护。

  • creating:开启中。

  • error_protect:防护异常。

  • unprotect:未防护。

  • wait_protect:待防护。

默认取值:

不涉及

cluster_type

String

集群类型

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" : "6a321faa6e6c4a18b5bf19dd9543test",
    "cluster_name" : "cluster_name_test"
  }
}

响应示例

状态码:200

请求已成功

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

SDK代码示例

SDK代码示例如下。

查询集群名称为cluster_name_test,集群id为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());
        }
    }
}

查询集群名称为cluster_name_test,集群id为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)

查询集群名称为cluster_name_test,集群id为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)
    }
}

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

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档