DescribeCluster - Platform For AI - Alibaba Cloud Documentation Center

Queries the details of a cluster.

Operation description

Queries the details of a specified 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

eflo:DescribeCluster

get

*Cluster

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

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The cluster ID.	i119982311660892626523

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	887FA855-89F4-5DB3-B305-C5879EC480E6
CreateTime	string	The time when the cluster was created.	2022-06-08T07:05:11Z
NodeCount	integer	The number of nodes.	2
NodeGroupCount	integer	The number of node groups.	2
UpdateTime	string	The time when the cluster was last updated.	2022-08-23T06:36:17.000Z
ClusterDescription	string	The description of the cluster.	测试集群
OperatingState	string	The state of the cluster.	running
Components	array<object>	The component information.
	object
ComponentType	string	The type of the component. Valid values: ARMS : ARMS monitoring ACKEdge : ACK edge cluster	ACKEdge
ComponentId	string	The component ID.	i149549021660892626529
ClusterId	string	The cluster ID.	i116913051662373010974
ClusterName	string	The name of the cluster.	Eflo-YJ-Test-Cluster
TaskId	string	The task ID.	i152609221670466904596
ClusterType	string	The type of the cluster.	AckEdgePro
ResourceGroupId	string	The resource group ID.	rg-aek2k3rqlvv6ytq
VpcId	string	The ID of the virtual private cloud (VPC).	vpc-0jlkqysom5dmcviymep3f
HpnZone	string	The zone of the cluster.	A2
ComputingIpVersion	string	The IP version of the computing network.	IPv4
OpenEniJumboFrame	string	The jumbo frame setting for the network interface.	unsupported
Networks	object	The network information.
VpdId	string	The ID of the virtual private datacenter (VPD).	vpd-iqd7xunc
VSwitchId	string	The vSwitch ID.	vsw-0jlwrfecgcbflyosvo242
SecurityGroupId	string	The security group ID.	sg-0jlff84q4o3s58i7fkhy

Examples

Success response

JSON format

{
  "RequestId": "887FA855-89F4-5DB3-B305-C5879EC480E6",
  "CreateTime": "2022-06-08T07:05:11Z",
  "NodeCount": 2,
  "NodeGroupCount": 2,
  "UpdateTime": "2022-08-23T06:36:17.000Z",
  "ClusterDescription": "测试集群",
  "OperatingState": "running",
  "Components": [
    {
      "ComponentType": "ACKEdge",
      "ComponentId": "i149549021660892626529"
    }
  ],
  "ClusterId": "i116913051662373010974",
  "ClusterName": "Eflo-YJ-Test-Cluster",
  "TaskId": "i152609221670466904596",
  "ClusterType": "AckEdgePro",
  "ResourceGroupId": "rg-aek2k3rqlvv6ytq",
  "VpcId": "vpc-0jlkqysom5dmcviymep3f",
  "HpnZone": "A2",
  "ComputingIpVersion": "IPv4",
  "OpenEniJumboFrame": "unsupported",
  "Networks": {
    "VpdId": "vpd-iqd7xunc"
  },
  "VSwitchId": "vsw-0jlwrfecgcbflyosvo242",
  "SecurityGroupId": "sg-0jlff84q4o3s58i7fkhy"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.