All Products
Search
Document Center

:DescribeCluster

Last Updated:Nov 18, 2024

Queries Container Service for Kubernetes (ACK) edge clusters.

Operation description

  • You can call this operation up to 100 times per second per account.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ens:DescribeClusterget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdstringNo

The cluster ID.

c8f0377146d104687ac562eef9403****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

CEF72CEB-54B6-4AE8-B225-F876FF7BA984
Clustersarray<object>

An array that consists of the information about clusters.

Clustersobject

Information about a cluster.

Namestring

The cluster name.

vc-a622bb**
ClusterIdstring

The cluster ID.

c8f0377146d104687ac562eef9403****
CurrentVersionstring

The version of the cluster.

1.18.8
NextVersionstring

The next version of the cluster.

1.20.8
Statusstring

The health status of the instance.

Valid values:

  • healthy
  • unhealthy
healthy

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError message
400BadRequest
400NoPermissionPermission denied.
400InvalidParameter.%sThe specified field %s invalid. Please check it again.
500InternalServerError

For a list of error codes, visit the Service error codes.