调用DescribeHubClusterDetails获取主控集群详情_容器服务 Kubernetes 版 ACK(ACK)-阿里云帮助中心

获取ACKOne多集群舰队的详细信息。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
adcp:DescribeHubClusterDetails	get	*Cluster `acs:adcp:{#regionId}:{#accountId}:cluster/{#ClusterId}`	无	无

请求参数

名称	类型	必填	描述	示例值
ClusterId	string	是	主控集群 ID。	c676decda7b8148d69a9aba751877****

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	52C1B7DF-96C1-5214-97B6-1B0859FEAFE5
Cluster	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	集群创建时间。	2022-03-23T06:22:28Z
UpdateTime	string	集群更新时间。	2022-03-21T02:51:35.542Z
ErrorMessage	string	集群创建失败的错误提示。	The specified product does not exist.
Version	string	集群版本。	1.22.3-aliyun.1
State	string	集群状态： initial：初始化中 failed：创建失败 running：运行中 inactive：待激活 deleting：删除中 delete_failed：删除失败 deleted：已删除	running
ClusterId	string	主控集群 ID。	cb09fda0dc2f94a8397c76638c7ecf***
Name	string	集群名称。	ackone-heyuan
RegionId	string	集群所在地域 ID	cn-beijing
ClusterSpec	string	集群规格 ack.pro.small 基础版	ack.pro.small
MetaData	object	元数据。
ACKOne	object	ACK One Fleet 元数据
GitOps	object	ACK One GitOps 元数据
Enabled	boolean	是否启用 GitOps。取值 true：启用 false：禁用	true
HAEnabled	boolean	是否启用 GitOps 高可用。取值 true：启用 false：禁用	true
PublicAccessEnabled	boolean	是否启用 ArgoCD 控制台公网域名解析。取值： true：启用。 false：禁用。	true
AccessControlList	array	公网访问 ACL 控制列表。仅当 PublicAccessEnabled 为 true 时有效。
AccessControl	string	公网访问 ACL 控制列表。仅当 PublicAccessEnabled 为 true 时有效。	["192.168.0.0/16"]
WorkFlow	object	ACK One 工作流元数据
ArgoWorkflow	object	ACK One 工作流元数据
Enabled	boolean	是否启用工作流配置。取值 true：启用 false：禁用	true
ServerEnabled	string	是否启用 Argo Server UI。取值 true：启用 false：禁用	true
PublicAccessEnabled	boolean	是否启用 Argo Workflow 控制台公网域名解析。取值： true：启用。 false：禁用。	true
AccessControlList	array	公网访问 ACL 控制列表。仅当 PublicAccessEnabled 为 true 时有效。
AccessControl	string	公网访问 ACL 控制列表。仅当 PublicAccessEnabled 为 true 时有效。	["192.168.0.0/16"]
ResourceGroupID	string	资源组 ID。	rg-2nnnd0b6q37***
Tags	array<object>	标签列表。
Tag	object	标签。
Key	string	标签的键。	user_resource
Value	string	标签的值。	gfggfwq-697
Network	object	集群的网络配置。
VpcId	string	VPC 的 ID。	vpc-f8ziib1019r9o0hdv2***
VSwitches	array	vSwitch 列表。
VSwitche	string	交换机 ID	["vsw-f8zubs2z9x1cjnzk29***"]
SecurityGroupIDs	array	关联的安全组 ID。
SecurityGroupID	string	关联的安全组 ID。	["sg-f8zubs2z9x1cj***"]
IPStack	string	支持的 IP 版本 ipv4 支持 ipv4 ipv6 支持 ipv6 dual 同时支持 ipv4 和 ipv6	ipv4
ClusterDomain	string	集群域名。	cluster.local
ApiServer	object	apiserver 信息。
EnabledPublic	boolean	是否开启公网 API Server 访问端点 true 开启公网访问端点 false 未开启公网访问端点	true
LoadBalancerId	string	负载均衡实例 id。	lb-hp3ioqbfeq37h13rwe***
ApiServerEipId	string	EIP 实例 ID。	eip-abc****
MeshConfig	object	服务网格(ASM)配置
EnableMesh	boolean	是否启用服务网格(ASM) true 启用 false 未启用	false
MeshId	string	服务网格(ASM)实例 ID	cb09fda0dc2f94a8397c76638c7ecf***
LogConfig	object	日志配置信息。
EnableLog	boolean	是否启用审计日志配置 true 启用 false 未启用	false
LogProject	string	日志服务 LogProject 的名称。	k8s-log-abc
LogStoreTTL	string	日志存储天数	7
Conditions	array<object>	集群删除条件信息列表
Condition	object	集群删除条件信息对象
Type	string	删除条件类型	DeletionProtection
Status	string	删除条件状态，取值 True 不能删除 False 允许删除 Unknow 未知	True
Reason	string	删除条件原因	Successful
Message	string	删除条件错误信息	Successful
WorkflowConfig	object	工作流集群配置信息
ArgoServerEnabled	boolean	是否启用 Argo Server UI。取值 true：启用 false：禁用	true
WorkflowScheduleMode	string	工作流调度模式。取值 cost-optimized：成本优先 stock-optimized：库存优先	cost-optimized
PriceLimit	string	工作流负载价格限制。WorkflowScheduleMode 取值为 cost-optimized 时生效。	0.08
WorkflowUnits	array<object>	集群工作流地域配置列表。
WorkflowUnit	object	集群工作流地域配置。
RegionId	string	地域 ID。	cn-beijing
VpcId	string	VPC 的 ID。	vpc-f8zukabbkv5aw7zkm****
VSwitches	array<object>	集群工作流交换机列表。
VSwitch	object	集群工作流交换机。
VswitchId	string	交换机 ID。	vsw-wz9sf0hsuizl7bxnj****
ZoneId	string	可用区 ID。	cn-hangzhou-e

示例

正常返回示例

JSON格式

{
  "RequestId": "52C1B7DF-96C1-5214-97B6-1B0859FEAFE5",
  "Cluster": {
    "Endpoints": {
      "IntranetApiServerEndpoint": "https://172.16.6.**:6443",
      "PublicApiServerEndpoint": "https://123.57.21.***:6443"
    },
    "ClusterInfo": {
      "Profile": "Default",
      "CreationTime": "2022-03-23T06:22:28Z",
      "UpdateTime": "2022-03-21T02:51:35.542Z",
      "ErrorMessage": "The specified product does not exist.",
      "Version": "1.22.3-aliyun.1",
      "State": "running",
      "ClusterId": "cb09fda0dc2f94a8397c76638c7ecf***",
      "Name": "ackone-heyuan",
      "RegionId": "cn-beijing",
      "ClusterSpec": "ack.pro.small ",
      "MetaData": {
        "ACKOne": {
          "GitOps": {
            "Enabled": true,
            "HAEnabled": true,
            "PublicAccessEnabled": true,
            "AccessControlList": [
              "[\"192.168.0.0/16\"]"
            ]
          },
          "WorkFlow": {
            "ArgoWorkflow": {
              "Enabled": true,
              "ServerEnabled": "true",
              "PublicAccessEnabled": true,
              "AccessControlList": [
                "[\"192.168.0.0/16\"]\n"
              ]
            }
          }
        }
      },
      "ResourceGroupID": "rg-2nnnd0b6q37***",
      "Tags": [
        {
          "Key": "user_resource",
          "Value": "gfggfwq-697"
        }
      ]
    },
    "Network": {
      "VpcId": "vpc-f8ziib1019r9o0hdv2***",
      "VSwitches": [
        "[\"vsw-f8zubs2z9x1cjnzk29***\"]"
      ],
      "SecurityGroupIDs": [
        "[\"sg-f8zubs2z9x1cj***\"]"
      ],
      "IPStack": "ipv4",
      "ClusterDomain": "cluster.local"
    },
    "ApiServer": {
      "EnabledPublic": true,
      "LoadBalancerId": "lb-hp3ioqbfeq37h13rwe***",
      "ApiServerEipId": "eip-abc****"
    },
    "MeshConfig": {
      "EnableMesh": false,
      "MeshId": "cb09fda0dc2f94a8397c76638c7ecf***\n"
    },
    "LogConfig": {
      "EnableLog": false,
      "LogProject": "k8s-log-abc",
      "LogStoreTTL": "7"
    },
    "Conditions": [
      {
        "Type": "DeletionProtection",
        "Status": "True",
        "Reason": "Successful",
        "Message": "Successful"
      }
    ],
    "WorkflowConfig": {
      "ArgoServerEnabled": true,
      "WorkflowScheduleMode": "cost-optimized",
      "PriceLimit": "0.08",
      "WorkflowUnits": [
        {
          "RegionId": "cn-beijing",
          "VpcId": "vpc-f8zukabbkv5aw7zkm****",
          "VSwitches": [
            {
              "VswitchId": "vsw-wz9sf0hsuizl7bxnj****",
              "ZoneId": "cn-hangzhou-e"
            }
          ]
        }
      ]
    }
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	Cluster.NotFound	Cluster Not Found	主控实例不存在

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

变更历史

变更时间	变更内容概要	操作
2024-05-13	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-04-17	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-11-27	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-10-18	OpenAPI 错误码发生变更	查看变更详情
2021-12-30	新增 OpenAPI	查看变更详情