DescribeHubClusterDetails - Container Service for Kubernetes

Describes the details of an ACK One fleet.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

adcp:DescribeHubClusterDetails

get

*Cluster

acs:adcp:{#regionId}:{#accountId}:cluster/{#ClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The fleet ID.	c676decda7b8148d69a9aba751877****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	52C1B7DF-96C1-5214-97B6-1B0859FEAFE5
Cluster	object	The details of the cluster.
Endpoints	object	The endpoints of the cluster.
IntranetApiServerEndpoint	string	The internal endpoint of the API server.	https://172.16.6.**:6443
PublicApiServerEndpoint	string	The public endpoint of the API server.	https://123.57.21.***:6443
ClusterInfo	object	The details of the cluster.
Profile	string	The configurations of the cluster.	Default
CreationTime	string	The time when the cluster was created.	2022-03-23T06:22:28Z
UpdateTime	string	The time when the cluster was last updated.	2022-03-21T02:51:35.542Z
ErrorMessage	string	The error message returned if the cluster fails to be created.	The specified product does not exist.
Version	string	The version of the cluster.	1.22.3-aliyun.1
State	string	The status of the cluster. Valid values: initial: The cluster is being initialized. failed: The cluster failed to be created. running: The cluster is running. inactive: The cluster is pending activation. deleting: The cluster is being deleted. delete_failed: The cluster failed to be deleted. deleted: The cluster is deleted.	running
ClusterId	string	The fleet ID.	cb09fda0dc2f94a8397c76638c7ecf***
Name	string	The name of the cluster.	ackone-heyuan
RegionId	string	The ID of the region where the cluster resides.	cn-beijing
ClusterSpec	string	The specification of the cluster. ack.pro.small: Basic Edition	ack.pro.small
MetaData	object	The metadata.
ACKOne	object	The metadata of the ACK One fleet.
GitOps	object	The metadata of ACK One GitOps.
Enabled	boolean	Indicates whether GitOps is enabled. Valid values: true: GitOps is enabled. false: GitOps is disabled.	true
HAEnabled	boolean	Indicates whether high availability (HA) is enabled for GitOps. Valid values: true: HA is enabled. false: HA is disabled.	true
PublicAccessEnabled	boolean	Indicates whether public domain name resolution is enabled for the ArgoCD console. Valid values: true: Public domain name resolution is enabled. false: Public domain name resolution is disabled.	true
AccessControlList	array	The access control list (ACL) for public network access. This parameter is valid only when PublicAccessEnabled is set to true.
	string	The ACL for public network access. This parameter is valid only when PublicAccessEnabled is set to true.	["192.168.0.0/16"]
WorkFlow	object	The metadata of the ACK One workflow.
ArgoWorkflow	object	The metadata of the ACK One workflow.
Enabled	boolean	Indicates whether the workflow configuration is enabled. Valid values: true: The workflow configuration is enabled. false: The workflow configuration is disabled.	true
ServerEnabled	string	Indicates whether the Argo Server UI is enabled. Valid values: true: The Argo Server UI is enabled. false: The Argo Server UI is disabled.	true
PublicAccessEnabled	boolean	Indicates whether public domain name resolution is enabled for the Argo Workflow console. Valid values: true: Public domain name resolution is enabled. false: Public domain name resolution is disabled.	true
AccessControlList	array	The ACL for public network access. This parameter is valid only when PublicAccessEnabled is set to true.
	string	The ACL for public network access. This parameter is valid only when PublicAccessEnabled is set to true.	["192.168.0.0/16"]
ResourceGroupID	string	The resource group ID.	rg-2nnnd0b6q37***
Tags	array<object>	The list of tags.
	object	The tag.
Key	string	The key of the tag.	user_resource
Value	string	The value of the tag.	gfggfwq-697
Network	object	The network configurations of the cluster.
VpcId	string	The ID of the VPC.	vpc-f8ziib1019r9o0hdv2***
VSwitches	array	The list of vSwitches.
	string	The vSwitch ID.	["vsw-f8zubs2z9x1cjnzk29***"]
SecurityGroupIDs	array	The IDs of the associated security groups.
	string	The ID of the associated security group.	["sg-f8zubs2z9x1cj***"]
IPStack	string	The IP version that is supported. Valid values: ipv4: IPv4 ipv6: IPv6 dual: IPv4 and IPv6	ipv4
ClusterDomain	string	The domain name of the cluster.	cluster.local
ApiServer	object	The information about the API server.
EnabledPublic	boolean	Indicates whether the public endpoint of the API server is enabled. Valid values: true: The public endpoint is enabled. false: The public endpoint is disabled.	true
LoadBalancerId	string	The ID of the Server Load Balancer (SLB) instance.	lb-hp3ioqbfeq37h13rwe***
ApiServerEipId	string	The EIP ID.	eip-abc****
MeshConfig	object	The configurations of the Service Mesh (ASM) instance.
EnableMesh	boolean	Indicates whether Service Mesh (ASM) is enabled. Valid values: true: ASM is enabled. false: ASM is disabled.	false
MeshId	string	The ID of the Service Mesh (ASM) instance.	cb09fda0dc2f94a8397c76638c7ecf***
LogConfig	object	The log configurations.
EnableLog	boolean	Indicates whether the audit log feature is enabled. Valid values: true: The audit log feature is enabled. false: The audit log feature is disabled.	false
LogProject	string	The name of the Simple Log Service project.	k8s-log-abc
LogStoreTTL	string	The number of days that logs are stored.	7
Conditions	array<object>	The list of conditions for cluster deletion.
	object	The condition for cluster deletion.
Type	string	The type of the condition.	DeletionProtection
Status	string	The status of the condition. Valid values: True: The cluster cannot be deleted. False: The cluster can be deleted. Unknown: The status is unknown.	True
Reason	string	The reason for the condition.	Successful
Message	string	The error message associated with the deletion condition.	Successful
WorkflowConfig	object	The configurations of the workflow cluster.
ArgoServerEnabled	boolean	Indicates whether the Argo Server UI is enabled. Valid values: true: The Argo Server UI is enabled. false: The Argo Server UI is disabled.	true
WorkflowScheduleMode	string	The scheduling mode of the workflow. Valid values: cost-optimized: cost-prioritized stock-optimized: inventory-prioritized	cost-optimized
PriceLimit	string	The price limit for the workflow payload. This parameter is valid only when WorkflowScheduleMode is set to cost-optimized.	0.08
WorkflowUnits	array<object>	The list of region-specific configurations for the workflow cluster.
	object	The region-specific configuration for the workflow cluster.
RegionId	string	The region ID.	cn-beijing
VpcId	string	The ID of the VPC.	vpc-f8zukabbkv5aw7zkm****
VSwitches	array<object>	The list of vSwitches for the workflow cluster.
	object	The vSwitch for the workflow cluster.
VswitchId	string	The vSwitch ID.	vsw-wz9sf0hsuizl7bxnj****
ZoneId	string	The zone ID.	cn-hangzhou-e

Examples

Success response

JSON format

{
  "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"
            }
          ]
        }
      ]
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Cluster.NotFound	Cluster Not Found	The master instance does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.