调用DescribeHubClusters查询已创建的主控实例列表_容器服务 Kubernetes 版 ACK(ACK)-阿里云帮助中心

获取用户ACK One主控实例列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
adcp:DescribeHubClusters	List	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
Profile	string	否	面向场景时的主控类型，取值： `Default`：标准场景主控实例。 `XFlow`：工作流场景主控实例。默认值：`Default`。	Default
ResourceGroupId	string	否	资源组 ID	rg-aek3dinj3xkf***
Tag	array	否	标签。最多支持指定 20 个标签。
	Tag	否	标签。

返回参数

名称	类型	描述	示例值
	object	响应结果。
RequestId	string	请求 ID。	2D676EFC-8C04-5CCE-A08E-BB97D24B47E8
Clusters	object []	集群列表信息
Endpoints	object	集群访问端点。
IntranetApiServerEndpoint	string	API Server 地址（内网）。	https://172.16.6.**:6443
PublicApiServerEndpoint	string	API Server 地址（公网）。	https://123.57.21.***:6443
ClusterInfo	object	集群详情。
Profile	string	集群配置信息。	Default
CreationTime	string	集群创建时间。	2021-11-05T10:25:48Z
UpdateTime	string	集群最后更新时间。	2021-09-02T13:39:50Z
ErrorMessage	string	集群创建失败的错误提示。	Success
Version	string	集群版本。	1.22.3-aliyun.1
State	string	集群状态： initial：初始化中 failed：创建失败 running：运行中 inactive：待激活 deleting：删除中 delete_failed：删除失败 deleted：已删除	running
ClusterId	string	集群 ID。	c2d3e0121ea214b438010502a8019****
Name	string	集群名称。	ackone-heyuan
RegionId	string	地域 ID。	cn-beijing
ClusterSpec	string	集群规格 ack.pro.small 基础版	ack.pro.small
ResourceGroupID	string	资源组 ID。	rg-dt6rk4xm1r6***
Tags	object []	标签列表。
Key	string	标签的键。	headername
Value	string	标签的值。	release
Network	object	集群的网络配置。
VpcId	string	集群所属的 VPC ID。	vpc-2zeusrwi7c2mlww4a****
VSwitches	array	集群所属的交换机 ID。
	string	交换机 ID。	["vsw-2ze1h7tt2fgr1gxlx****"]
SecurityGroupIDs	array	安全组 id。
	string	安全组 id。	["sg-2ze1h7tt2fgr****"]
ClusterDomain	string	集群域名。	cluster.local
ApiServer	object	apiserver 信息。
EnabledPublic	boolean	是否开启公网 API Server 访问端点 true 开启公网访问端点 false 未开启公网访问端点	true
LoadBalancerId	string	关联的负载均衡实例 ID。	lb-bp1qyp4l6bscqxw69****
ApiServerEipId	string	EIP 实例 ID。	eip-xxx
MeshConfig	object	服务网格(ASM)配置
EnableMesh	boolean	是否启用服务网格(ASM) true 启用 false 未启用	false
MeshId	string	服务网格实例 ID	c2d3e0121ea214b438010502a8019****
LogConfig	object	日志配置。
EnableLog	boolean	是否启用审计日志配置 true 启用 false 停用	true
LogProject	string	日志服务 LogProject 的名称。	audit-log-abc
LogStoreTTL	string	日志存储天数	7
Conditions	object []	集群删除条件信息列表
Type	string	删除条件类型	DeletionProtection
Status	string	删除条件状态，取值 True 不能删除 False 允许删除 Unknow 未知	True
Reason	string	删除条件原因	Successful
Message	string	删除条件错误信息	Successful!

示例

正常返回示例

JSON格式

{
  "RequestId": "2D676EFC-8C04-5CCE-A08E-BB97D24B47E8",
  "Clusters": [
    {
      "Endpoints": {
        "IntranetApiServerEndpoint": "https://172.16.6.**:6443\n",
        "PublicApiServerEndpoint": "https://123.57.21.***:6443\n"
      },
      "ClusterInfo": {
        "Profile": "Default",
        "CreationTime": "2021-11-05T10:25:48Z",
        "UpdateTime": "2021-09-02T13:39:50Z",
        "ErrorMessage": "Success",
        "Version": "1.22.3-aliyun.1\n",
        "State": "running",
        "ClusterId": "c2d3e0121ea214b438010502a8019****",
        "Name": "ackone-heyuan",
        "RegionId": "cn-beijing",
        "ClusterSpec": "ack.pro.small",
        "ResourceGroupID": "rg-dt6rk4xm1r6***",
        "Tags": [
          {
            "Key": "headername",
            "Value": "release"
          }
        ]
      },
      "Network": {
        "VpcId": "vpc-2zeusrwi7c2mlww4a****",
        "VSwitches": [
          "[\"vsw-2ze1h7tt2fgr1gxlx****\"]"
        ],
        "SecurityGroupIDs": [
          "[\"sg-2ze1h7tt2fgr****\"]\n"
        ],
        "ClusterDomain": "cluster.local"
      },
      "ApiServer": {
        "EnabledPublic": true,
        "LoadBalancerId": "lb-bp1qyp4l6bscqxw69****",
        "ApiServerEipId": "eip-xxx"
      },
      "MeshConfig": {
        "EnableMesh": false,
        "MeshId": "c2d3e0121ea214b438010502a8019****"
      },
      "LogConfig": {
        "EnableLog": true,
        "LogProject": "audit-log-abc",
        "LogStoreTTL": "7"
      },
      "Conditions": [
        {
          "Type": "DeletionProtection",
          "Status": "True",
          "Reason": "Successful",
          "Message": "Successful!"
        }
      ]
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间

变更内容概要

操作

2024-05-13

OpenAPI 入参发生变更、OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
入参	OpenAPI 入参发生变更。
	新增入参：Tag
出参	OpenAPI 返回结构发生变更。

2024-04-17

OpenAPI 入参发生变更、OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
入参	OpenAPI 入参发生变更。
	新增入参：ResourceGroupId
出参	OpenAPI 返回结构发生变更。

2021-12-30

新增 OpenAPI

看变更集