DescribeManagedClusters - Container Service for Kubernetes

Queries the list of member clusters in an ACK One fleet instance.

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

list

*All Resource

*

None

Request parameters

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

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	BDA85C7A-FC81-56C4-9BC2-9112EE970059
Clusters	array<object>	The list of clusters.
	array<object>	The details of the cluster.
Cluster	object	The information about the cluster.
Name	string	The name of the cluster.	ackone-heyuan
ClusterID	string	The cluster ID.	c2f41fd4599454a9c9ad8b3daafe8****
Region	string	The region ID of the cluster.	cn-hangzhou
State	string	The state of the member 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
ClusterType	string	The type of the cluster.	One
Created	string	The time when the cluster was created.	2022-03-23T06:22:28Z
Updated	string	The time when the cluster was last updated.	2022-03-23T06:22:28Z
InitVersion	string	The initial version of the cluster.	1.20.4-aliyun.1
CurrentVersion	string	The current version of the cluster.	1.22.3-aliyun.1
ResourceGroupId	string	The resource group ID.	rg-acfmx7o7ewy****
VpcID	string	The VPC ID.	vpc-bp1fhizs9fxuvit06****
VSwitchID	string	The virtual switch ID.	vsw-m5e0pbkgmhvzecf7e****
Profile	string	The cluster profile.	Default
ClusterSpec	string	The specification of the cluster. `ack.pro.small` indicates the Basic Edition.	ack.pro.small
Status	object	The state of the member cluster in the fleet.
State	string	The state of the member cluster in the fleet. Valid values: `Installing`: The cluster is being added to the fleet. `Successed`: The cluster is added to the fleet. `Failed`: The cluster failed to be added to the fleet. `Deleting`: The cluster is being removed from the fleet. `Deleted`: The cluster is removed from the fleet.	Successed
Message	string	The status message.	SUCCESS
MeshStatus	object	The state of the member cluster in the service mesh.
InMesh	boolean	Indicates whether the member cluster is in the service mesh. Valid values: `true`: The member cluster is in the service mesh instance. `false`: The member cluster is not in the service mesh instance.	true

Examples

Success response

JSON format

{
  "RequestId": "BDA85C7A-FC81-56C4-9BC2-9112EE970059",
  "Clusters": [
    {
      "Cluster": {
        "Name": "ackone-heyuan",
        "ClusterID": "c2f41fd4599454a9c9ad8b3daafe8****",
        "Region": "cn-hangzhou",
        "State": "running",
        "ClusterType": "One",
        "Created": "2022-03-23T06:22:28Z",
        "Updated": "2022-03-23T06:22:28Z",
        "InitVersion": "1.20.4-aliyun.1",
        "CurrentVersion": "1.22.3-aliyun.1",
        "ResourceGroupId": "rg-acfmx7o7ewy****",
        "VpcID": "vpc-bp1fhizs9fxuvit06****",
        "VSwitchID": "vsw-m5e0pbkgmhvzecf7e****",
        "Profile": "Default",
        "ClusterSpec": "ack.pro.small"
      },
      "Status": {
        "State": "Successed",
        "Message": "SUCCESS"
      },
      "MeshStatus": {
        "InMesh": true
      }
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.