文档首页/ 云容器引擎 CCE_Autopilot集群/ API参考/ API/ 集群管理（Autopilot）/ 获取指定项目下的集群

更新时间：2024-11-08 GMT+08:00

在线调试

CLI示例

查看PDF

获取指定项目下的集群

功能介绍

该API用于获取指定项目下所有集群的详细信息。

调用方法

请参见如何调用API。

URI

GET /autopilot/v3/projects/{project_id}/clusters

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：项目ID，获取方式请参见如何获取接口URI中参数。约束限制：不涉及取值范围：账号的项目ID 默认取值：不涉及

表2 Query参数
参数	是否必选	参数类型	描述
detail	否	String	查询集群详细信息。若设置为true，获取集群下已安装插件列表中包含名称(addonTemplateName)、版本号(version)、插件的状态信息(status)，放入到annotation中。
status	否	String	集群状态，取值如下 Available：可用，表示集群处于正常状态。 Unavailable：不可用，表示集群异常，需手动删除。 ScalingUp：扩容中，表示集群正处于扩容过程中。 ScalingDown：缩容中，表示集群正处于缩容过程中。 Creating：创建中，表示集群正处于创建过程中。 Deleting：删除中，表示集群正处于删除过程中。 Upgrading：升级中，表示集群正处于升级过程中。 Resizing：规格变更中，表示集群正处于变更规格中。 ResizeFailed：规格变更异常，表示集群变更规格异常。 RollingBack：回滚中，表示集群正处于回滚过程中。 RollbackFailed：回滚异常，表示集群回滚异常。 Hibernating：休眠中，表示集群正处于休眠过程中。 Hibernation：已休眠，表示集群正处于休眠状态。 Freezing：冻结中，表示集群正处于冻结过程中。 Frozen：已冻结，表示集群正处于冻结状态。 UnFreezing：解冻中，表示集群正处于解冻过程中。 Awaking：唤醒中，表示集群正处于从休眠状态唤醒的过程中。 Empty：集群无任何资源（已废弃） Error：错误，表示集群资源异常，可尝试手动删除。
type	否	String	集群类型： VirtualMachine：CCE集群
version	否	String	集群版本过滤

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
Content-Type	是	String	参数解释：消息体的类型（格式）约束限制： GET方法不做校验取值范围： application/json application/json;charset=utf-8 application/x-pem-file 默认取值：不涉及
X-Auth-Token	是	String	参数解释：调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值，获取方式请参见获取token。约束限制：不涉及取值范围：不涉及默认取值：不涉及

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
kind	String	Api type
apiVersion	String	API version
items	Array of AutopilotCluster objects	集群对象列表，包含了当前项目下所有集群的详细信息。您可通过items.metadata.name下的值来找到对应的集群。

表5 AutopilotCluster
参数	参数类型	描述
kind	String	API类型，固定值“Cluster”或“cluster”，该值不可修改。
apiVersion	String	API版本，固定值“v3”，该值不可修改。
metadata	AutopilotClusterMetadata object	集群的基本信息，为集合类的元素类型，包含一组由不同名称定义的属性。
spec	AutopilotClusterSpec object	spec是集合类的元素类型，您对需要管理的集群对象进行详细描述的主体部分都在spec中给出。CCE通过spec的描述来创建或更新对象。
status	AutopilotClusterStatus object	集合类的元素类型，用于记录对象在系统中的当前状态信息，包含了集群状态和本次创建集群作业的jobID

表6 AutopilotClusterMetadata
参数	参数类型	描述
name	String	集群名称。命名规则：以小写字母开头，由小写字母、数字、中划线(-)组成，长度范围4-128位，且不能以中划线(-)结尾。
uid	String	集群ID，资源唯一标识，创建成功后自动生成，填写无效。在创建包周期集群时，响应体不返回集群ID。
alias	String	集群显示名，用于在 CCE 界面显示，该名称创建后可修改。命名规则：以小写字母开头，由小写字母、数字、中划线(-)组成，长度范围4-128位，且不能以中划线(-)结尾。显示名和其他集群的名称、显示名不可以重复。在创建集群、更新集群请求体中，集群显示名alias未指定或取值为空，表示与集群名称name一致。在创建集群等响应体中，集群显示名alias未配置时将不返回。
annotations	Map<String,String>	集群注解，由key/value组成： "annotations": { "key1" : "value1", "key2" : "value2" } 说明： Annotations不用于标识和选择对象。Annotations中的元数据可以是small或large，structured或unstructured，并且可以包括标签不允许使用的字符。该字段不会被数据库保存，当前仅用于指定集群待安装插件。
labels	Map<String,String>	集群标签，key/value对格式。说明：该字段值由系统自动生成，用于升级时前端识别集群支持的特性开关，用户指定无效。
creationTimestamp	String	集群创建时间
updateTimestamp	String	集群更新时间

表7 AutopilotClusterSpec
参数	参数类型	描述
category	String	集群类别。Autopilot集群仅支持Turbo类型。
type	String	集群Master节点架构： VirtualMachine：Master节点为x86架构服务器
flavor	String	集群规格，cce.autopilot.cluster
version	String	集群版本，与Kubernetes社区基线版本保持一致，建议选择最新版本。在CCE控制台支持创建三种最新版本的集群。可登录CCE控制台创建集群，在“版本”处获取到集群版本。其它集群版本，当前仍可通过api创建，但后续会逐渐下线，具体下线策略请关注CCE官方公告。说明：若不配置，默认创建最新版本的集群。
platformVersion	String	CCE集群平台版本号，表示集群版本(version)下的内部版本。用于跟踪某一集群版本内的迭代，集群版本内唯一，跨集群版本重新计数。不支持用户指定，集群创建时自动选择对应集群版本的最新平台版本。 platformVersion格式为：cce.X.Y X: 表示内部特性版本。集群版本中特性或者补丁修复，或者OS支持等变更场景。其值从1开始单调递增。 Y: 表示内部特性版本的补丁版本。仅用于特性版本上线后的软件包更新，不涉及其他修改。其值从0开始单调递增。
description	String	集群描述，对于集群使用目的的描述，可根据实际情况自定义，默认为空。集群创建成功后可通过接口更新指定的集群来做出修改，也可在CCE控制台中对应集群的“集群详情”下的“描述”处进行修改。仅支持utf-8编码。
customSan	Array of strings	集群的API Server服务端证书中的自定义SAN（Subject Alternative Name）字段，遵从SSL标准X509定义的格式规范。Autopilot集群暂不支持。不允许出现同名重复。格式符合IP和域名格式。示例: SAN 1: DNS Name=example.com SAN 2: DNS Name=www.example.com SAN 3: DNS Name=example.net SAN 4: IP Address=93.184.216.34
enableSnat	Boolean	集群是否配置SNAT，仅Autopilot集群创建接口使用和返回。开启后您的集群可以通过NAT网关访问公网，默认使用所选的VPC中已有的NAT网关，否则系统将会为您自动创建一个默认规格的NAT网关并绑定弹性公网IP，自动配置SNAT规则。
enableSWRImageAccess	Boolean	集群是否配置镜像访问，仅Autopilot集群创建接口使用和返回。为确保您的集群节点可以从容器镜像服务中拉取镜像，默认使用所选VPC中已有的SWR和OBS终端节点，否则将会为您自动新建SWR和OBS终端节点。
enableAutopilot	Boolean	是否为Autopilot集群。
ipv6enable	Boolean	集群是否使用IPv6模式。Autopilot集群暂不支持。
hostNetwork	AutopilotHostNetwork object	节点网络参数，包含了虚拟私有云VPC和子网的ID信息，而VPC是集群内节点之间的通信依赖，所以是必选的参数集。
containerNetwork	AutopilotContainerNetwork object	容器网络参数，包含了容器网络类型和容器网段的信息。
eniNetwork	AutopilotEniNetwork object	云原生网络2.0网络配置。
serviceNetwork	AutopilotServiceNetwork object	服务网段参数，包含IPv4 CIDR。
authentication	AutopilotAuthentication object	集群认证方式相关配置。Autopilot集群暂不支持。
billingMode	Integer	集群的计费方式。 0: 按需计费默认为“按需计费”。
kubernetesSvcIpRange	String	服务网段参数，kubernetes clusterIP取值范围。创建集群时如若未传参，默认为"10.247.0.0/16"。该参数废弃中，推荐使用新字段serviceNetwork，包含IPv4服务网段。
clusterTags	Array of AutopilotResourceTag objects	集群资源标签
kubeProxyMode	String	服务转发模式： iptables：社区传统的kube-proxy模式，完全以iptables规则的方式来实现service负载均衡。该方式最主要的问题是在服务多的时候产生太多的iptables规则，非增量式更新会引入一定的时延，大规模情况下有明显的性能问题。说明：默认使用iptables转发模式。
az	String	可用区（仅查询返回字段）。 CCE支持的可用区请参考地区和终端节点
extendParam	AutopilotClusterExtendParam object	集群扩展字段，可配置多可用区集群、专属CCE集群，以及将集群创建在特定的企业项目下等。
configurationsOverride	Array of AutopilotPackageConfiguration objects	覆盖集群默认组件配置。Autopilot集群暂不支持。

表8 AutopilotHostNetwork
参数	参数类型	描述
vpc	String	用于创建控制节点的VPC的ID。获取方法如下：方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。方法2：通过虚拟私有云服务的API接口查询。链接请参见查询VPC列表
subnet	String	用于创建控制节点的subnet的网络ID。获取方法如下：方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。方法2：通过虚拟私有云服务的查询子网列表接口查询。链接请参见查询子网列表

表9 AutopilotContainerNetwork
参数	参数类型	描述
mode	String	容器网络类型 eni：云原生网络2.0，深度整合VPC原生ENI弹性网卡能力，采用VPC网段分配容器地址，支持ELB直通容器，享有高性能，创建集群时指定。

**表10** AutopilotEniNetwork
参数	参数类型	描述
subnets	Array of AutopilotNetworkSubnet objects	ENI所在子网的IPv4子网ID列表。获取方法如下：方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找IPv4子网ID。方法2：通过虚拟私有云服务的查询子网列表接口查询。链接请参见查询子网列表

**表11** AutopilotNetworkSubnet
参数	参数类型	描述
subnetID	String	用于创建控制节点和容器的subnet的IPv4子网ID(暂不支持IPv6)。获取方法如下：方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找IPv4子网ID。方法2：通过虚拟私有云服务的查询子网列表接口查询。链接请参见查询子网列表

**表12** AutopilotServiceNetwork
参数	参数类型	描述
IPv4CIDR	String	kubernetes clusterIP IPv4 CIDR取值范围。创建集群时若未传参，默认为"10.247.0.0/16"。

**表13** AutopilotAuthentication
参数	参数类型	描述
mode	String	集群认证模式。默认取值为“rbac”。

**表14** AutopilotResourceTag
参数	参数类型	描述
key	String	Key值。不能为空，最多支持128个字符可用UTF-8格式表示的汉字、字母、数字和空格支持部分特殊字符：_.:/=+-@ 不能以"_sys_"开头
value	String	Value值。可以为空但不能缺省，最多支持255个字符可用UTF-8格式表示的汉字、字母、数字和空格支持部分特殊字符：_.:/=+-@

**表15** AutopilotClusterExtendParam
参数	参数类型	描述
enterpriseProjectId	String	集群所属的企业项目ID。说明：需要开通企业项目功能后才可配置企业项目。
upgradefrom	String	记录集群通过何种升级方式升级到当前版本。

**表16** AutopilotPackageConfiguration
参数	参数类型	描述
name	String	组件名称
configurations	Array of AutopilotConfigurationItem objects	组件配置项

**表17** AutopilotConfigurationItem
参数	参数类型	描述
name	String	组件配置项名称
value	Object	组件配置项值

**表18** AutopilotClusterStatus
参数	参数类型	描述
phase	String	集群状态，取值如下 Available：可用，表示集群处于正常状态。 Unavailable：不可用，表示集群异常，需手动删除。 ScalingUp：扩容中，表示集群正处于扩容过程中。 ScalingDown：缩容中，表示集群正处于缩容过程中。 Creating：创建中，表示集群正处于创建过程中。 Deleting：删除中，表示集群正处于删除过程中。 Upgrading：升级中，表示集群正处于升级过程中。 Resizing：规格变更中，表示集群正处于变更规格中。 ResizeFailed：规格变更异常，表示集群变更规格异常。 RollingBack：回滚中，表示集群正处于回滚过程中。 RollbackFailed：回滚异常，表示集群回滚异常。 Hibernating：休眠中，表示集群正处于休眠过程中。 Hibernation：已休眠，表示集群正处于休眠状态。 Freezing：冻结中，表示集群正处于冻结过程中。 Frozen：已冻结，表示集群正处于冻结状态。 UnFreezing：解冻中，表示集群正处于解冻过程中。 Awaking：唤醒中，表示集群正处于从休眠状态唤醒的过程中。 Empty：集群无任何资源（已废弃） Error：错误，表示集群资源异常，可尝试手动删除。
jobID	String	任务ID,集群当前状态关联的任务ID。当前支持: 创建集群时返回关联的任务ID，可通过任务ID查询创建集群的附属任务信息；删除集群或者删除集群失败时返回关联的任务ID，此字段非空时，可通过任务ID查询删除集群的附属任务信息。说明：任务信息具有一定时效性，仅用于短期跟踪任务进度，请勿用于集群状态判断等额外场景。
reason	String	集群变为当前状态的原因，在集群在非“Available”状态下时，会返回此参数。
message	String	集群变为当前状态的原因的详细信息，在集群在非“Available”状态下时，会返回此参数。
endpoints	Array of AutopilotClusterEndpoints objects	集群中 kube-apiserver 的访问地址。
isLocked	Boolean	CBC资源锁定
lockScene	String	CBC资源锁定场景
lockSource	String	锁定资源
lockSourceId	String	锁定的资源ID
deleteOption	Object	删除配置状态（仅删除请求响应包含）
deleteStatus	Object	删除状态信息（仅删除请求响应包含）

**表19** AutopilotClusterEndpoints
参数	参数类型	描述
url	String	集群中 kube-apiserver 的访问地址
type	String	集群访问地址的类型 Internal：用户子网内访问的地址 External：公网访问的地址

请求示例

无

响应示例

状态码： 200

表示获取集群列表成功。

{
  "kind" : "Cluster",
  "apiVersion" : "v3",
  "items" : [ {
    "kind" : "Cluster",
    "apiVersion" : "v3",
    "metadata" : {
      "name" : "test",
      "uid" : "de63df79-1de1-11ef-95a4-0255ac1007fa",
      "creationTimestamp" : "2024-05-29 17:35:40.770923 +0000 UTC",
      "updateTimestamp" : "2024-06-04 08:14:13.881756 +0000 UTC",
      "labels" : {
        "FeatureGates" : "arpOptimization,elbv3,xGPU"
      },
      "alias" : "s00648239-b003-v127"
    },
    "spec" : {
      "category" : "Turbo",
      "type" : "VirtualMachine",
      "flavor" : "cce.autopilot.cluster",
      "version" : "v1.27",
      "hostNetwork" : {
        "vpc" : "26958bf6-9ce3-4184-9e19-d793880a162b",
        "subnet" : "df93b82f-5196-43a9-a3f1-78deeab504eb"
      },
      "containerNetwork" : {
        "mode" : "eni"
      },
      "eniNetwork" : {
        "subnets" : [ {
          "subnetID" : "97205694-3537-45b6-9459-c98e9704574a"
        } ]
      },
      "serviceNetwork" : {
        "IPv4CIDR" : "10.247.0.0/16"
      },
      "authentication" : {
        "mode" : "rbac"
      },
      "billingMode" : 0,
      "kubernetesSvcIpRange" : "10.247.0.0/16",
      "kubeProxyMode" : "iptables",
      "az" : "cn-north-7c",
      "extendParam" : {
        "enterpriseProjectId" : "0",
        "upgradefrom" : ""
      }
    },
    "status" : {
      "phase" : "Available",
      "endpoints" : [ {
        "url" : "https://de63df79-1de1-11ef-95a4-0255ac1007fa.cluster.cce.cn-north-7.myhuaweicloud.com:5443",
        "type" : "Internal"
      } ]
    }
  } ]
}

SDK代码示例

SDK代码示例如下。

      
       
         
         
           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.cce.v3.region.CceRegion;
import com.huaweicloud.sdk.cce.v3.*;
import com.huaweicloud.sdk.cce.v3.model.*;


public class ListAutopilotClustersSolution {

    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);

        CceClient client = CceClient.newBuilder()
                .withCredential(auth)
                .withRegion(CceRegion.valueOf("<YOUR REGION>"))
                .build();
        ListAutopilotClustersRequest request = new ListAutopilotClustersRequest();
        try {
            ListAutopilotClustersResponse response = client.listAutopilotClusters(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());
        }
    }
}

          

        

      
     

      
       
         
         
           # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcce.v3.region.cce_region import CceRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcce.v3 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 = CceClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CceRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListAutopilotClustersRequest()
        response = client.list_autopilot_clusters(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

          

        

      
     

      
       
         
         
           package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    cce "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3/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 := cce.NewCceClient(
        cce.CceClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListAutopilotClustersRequest{}
	response, err := client.ListAutopilotClusters(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     

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

状态码

状态码	描述
200	表示获取集群列表成功。

错误码

请参见错误码。

父主题：集群管理（Autopilot）

上一篇：获取指定的集群

下一篇：更新指定的集群

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消