首页 容器服务 ACK 分布式云容器平台ACK One API参考指南 API目录 集群 DescribeHubClusters - 查询已创建的主控实例列表

DescribeHubClusters - 查询已创建的主控实例列表

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

调试

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

调试

授权信息

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

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

请求参数

名称类型必填描述示例值
Profilestring

面向场景时的主控类型,取值:

  • Default:标准场景主控实例。
  • XFlow:工作流场景主控实例。

默认值:Default

Default

返回参数

名称类型描述示例值
object
RequestIdstring

请求ID。

2D676EFC-8C04-5CCE-A08E-BB97D24B47E8
Clustersarray

集群列表信息

object

集群信息列表。

Endpointsobject

集群访问端点。

IntranetApiServerEndpointstring

API Server 地址(内网)。

https://172.16.6.**:6443
PublicApiServerEndpointstring

API Server 地址(公网)。

https://123.57.21.***:6443
ClusterInfoobject

集群详情。

Profilestring

集群配置信息。

Default
CreationTimestring

集群创建时间。

2021-11-05T10:25:48Z
UpdateTimestring

集群最后更新时间。

2021-09-02T13:39:50Z
ErrorMessagestring

集群创建失败的错误提示。

Success
Versionstring

集群版本。

1.22.3-aliyun.1
Statestring

集群状态:

  • initial:初始化中
  • failed:创建失败
  • running:运行中
  • inactive:待激活
  • deleting:删除中
  • delete_failed:删除失败
  • deleted:已删除
running
ClusterIdstring

集群ID。

c2d3e0121ea214b438010502a8019****
Namestring

集群名称。

ackone-heyuan
RegionIdstring

地域ID。

cn-beijing
ClusterSpecstring

集群规格

  • ack.pro.small 基础版
ack.pro.small
Networkobject

集群的网络配置。

VpcIdstring

集群所属的VPC ID。

vpc-2zeusrwi7c2mlww4a****
VSwitchesarray

集群所属的交换机ID。

string

交换机ID。

["vsw-2ze1h7tt2fgr1gxlx****"]
SecurityGroupIDsarray

安全组id。

string

安全组id。

["sg-2ze1h7tt2fgr****"]
ClusterDomainstring

集群域名。

cluster.local
ApiServerobject

apiserver信息。

EnabledPublicboolean

是否开启公网API Server访问端点

  • true 开启公网访问端点
  • false 未开启公网访问端点
true
LoadBalancerIdstring

关联的负载均衡实例ID。

lb-bp1qyp4l6bscqxw69****
ApiServerEipIdstring

EIP实例ID。

eip-xxx
MeshConfigobject

服务网格(ASM)配置

EnableMeshboolean

是否启用服务网格(ASM)

  • true 启用
  • false 未启用
false
MeshIdstring

服务网格实例ID

c2d3e0121ea214b438010502a8019****
LogConfigobject

日志配置。

EnableLogboolean

是否启用审计日志配置

  • true 启用
  • false 停用
true
LogProjectstring

日志服务LogProject的名称。

audit-log-abc
LogStoreTTLstring

日志存储天数

7
Conditionsarray

集群删除条件信息列表

object

集群删除条件信息对象

Typestring

删除条件类型

DeletionProtection
Statusstring

删除条件状态,取值

  • True 不能删除
  • False 允许删除
  • Unknow 未知
True
Reasonstring

删除条件原因

Successful
Messagestring

删除条件错误信息

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"
      },
      "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!"
        }
      ]
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2021-12-30新增 OpenAPI
阿里云首页 容器服务Kubernetes版 相关技术圈