Fleet Instance Hub Cluster Query Overview - ACK One - Alibaba Cloud - Container Service for Kubernetes

Queries the Fleet instances in the Distributed Cloud Container Platform for Kubernetes (ACK One) cluster.

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:DescribeHubClusters

list

*Cluster

acs:adcp::{#accountId}:cluster/*

None

Request parameters

Parameter	Type	Required	Description	Example
Profile	string	No	The types of Fleet instances used in different scenarios. Valid values: `Default`: The Fleet instances suitable for standard scenarios. `XFlow`: The Fleet instance suitable for workflow scenarios. Default value: `Default`.	Default
ResourceGroupId	string	No	The resource group ID.	rg-aek3dinj3xkf***
Tag	array	No	The tags. You can specify up to 20 tags.
	Tag	No	The tag.

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	2D676EFC-8C04-5CCE-A08E-BB97D24B47E8
Clusters	array<object>	The information about clusters.
	array<object>	The cluster information.
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.	2021-11-05T10:25:48Z
UpdateTime	string	The time when the cluster was last modified.	2021-09-02T13:39:50Z
ErrorMessage	string	The error message that is returned if the cluster failed to be created.	Success
Version	string	The version of the cluster.	1.22.3-aliyun.1
State	string	The state 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 not activated. deleting: The cluster is being deleted. delete_failed: The cluster failed to be deleted. deleted: The cluster is deleted.	running
ClusterId	string	The cluster ID.	c2d3e0121ea214b438010502a8019****
Name	string	The cluster name.	ackone-heyuan
RegionId	string	The region ID.	cn-beijing
ClusterSpec	string	The specifications of the cluster. Only ack.pro.small may be returned.	ack.pro.small
ResourceGroupID	string	The resource group ID.	rg-dt6rk4xm1r6***
Tags	array<object>	The tags.
	object	The tag.
Key	string	The tag key.	headername
Value	string	The tag value.	release
Network	object	The network configurations of the cluster.
VpcId	string	The ID of the virtual private cloud (VPC) to which the cluster belongs.	vpc-2zeusrwi7c2mlww4a****
VSwitches	array	The IDs of vSwitches to which the cluster belongs.
	string	The vSwitch ID.	["vsw-2ze1h7tt2fgr1gxlx****"]
SecurityGroupIDs	array	The security group IDs.
	string	The security group ID.	["sg-2ze1h7tt2fgr****"]
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 is enabled for the API server. Valid values: true false	true
LoadBalancerId	string	The ID of the Server Load Balancer (SLB) instance that is associated with the cluster.	lb-bp1qyp4l6bscqxw69****
ApiServerEipId	string	The elastic IP address (EIP) ID.	eip-xxx
MeshConfig	object	The configurations of Alibaba Cloud Service Mesh (ASM).
EnableMesh	boolean	Indicates whether ASM is enabled. Valid values: true false	false
MeshId	string	The ASM instance ID.	c2d3e0121ea214b438010502a8019****
LogConfig	object	The logging configurations.
EnableLog	boolean	Indicates whether the audit logging feature is enabled. Valid values: true false	true
LogProject	string	The name of the project in Simple Log Service.	audit-log-abc
LogStoreTTL	string	The number of days that logs are retained by Simple Log Service.	7
Conditions	array<object>	The deletion conditions of the cluster.
	object	The details of the condition.
Type	string	The type of deletion condition.	DeletionProtection
Status	string	The state of the cluster that the deletion condition indicates. Valid values: True: The cluster cannot be deleted. False: The cluster can be deleted. Unknow: Whether the cluster can be deleted is unknown.	True
Reason	string	The reason for the deletion condition.	Successful
Message	string	The error message returned.	Successful!

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.