DescribeCluster API Reference for ACK Edge Clusters - ENS

Operation description

up to 100 times per second per account.

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

ens:DescribeCluster

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	No	The cluster ID.	c8f0377146d104687ac562eef9403****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
Clusters	array<object>	An array that consists of the information about clusters.
	object	Information about a cluster.
Name	string	The cluster name.	vc-a622bb**
ClusterId	string	The cluster ID.	c8f0377146d104687ac562eef9403****
CurrentVersion	string	The version of the cluster.	1.18.8
NextVersion	string	The next version of the cluster.	1.20.8
Status	string	The health status of the instance. Valid values: healthy unhealthy Valid values: healthy : healthy unhealthy : unhealthy	healthy

Examples

Success response

JSON format

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "Clusters": [
    {
      "Name": "vc-a622bb**",
      "ClusterId": "c8f0377146d104687ac562eef9403****",
      "CurrentVersion": "1.18.8",
      "NextVersion": "1.20.8",
      "Status": "healthy"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	BadRequest	Invalid request parameters
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.
500	InternalServerError	Internal service error

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.