Use DescribeHpcClusters to query HPC clusters - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Queries available High Performance Computing (HPC) clusters. Request parameters serve as filters. Filters are evaluated by using a logical AND. The parameters are independent of each other.

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

ecs:DescribeHpcClusters

get

*HpcCluster

acs:ecs:{#regionId}:{#accountId}:hpc/*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call DescribeRegions to query the most recent region list.	cn-hangzhou
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but make sure that the token is unique among different requests. The ClientToken value can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.	123e4567-e89b-12d3-a456-426655440000
RegionId	string	Yes	The region ID. You can call DescribeRegions to query the most recent region list.	cn-hangzhou
HpcClusterIds	string	No	The IDs of HPC clusters. The value can be a JSON array that consists of up to 100 HPC cluster IDs. Separate the IDs with commas (,).	["hpc-xxxxxxxxx", "hpc-yyyyyyyyy", … "hpc-zzzzzzzzz"]
PageNumber	integer	No	The page number of the HPC cluster list. Minimum value: 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page for a paged query. Maximum value: 100. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries per page.	10
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	The page number of the HPC cluster list.	1
TotalCount	integer	The total number of HPC clusters.	2
HpcClusters	object
HpcCluster	array<object>	An array of HpcCluster objects that contains information about the HPC clusters.
	object
HpcClusterId	string	The HPC cluster ID.	hpc-bp1a5zr3u7nq9cx****
Name	string	The name of the HPC cluster.	testName
Description	string	The description of the HPC cluster.	testDescription

Examples

Success response

JSON format

{
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "TotalCount": 2,
  "HpcClusters": {
    "HpcCluster": [
      {
        "HpcClusterId": "hpc-bp1a5zr3u7nq9cx****",
        "Name": "testName",
        "Description": "testDescription"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidRegionId.NotFound	The specified parameter "RegionId" is not valid.
400	MissingParameter.HpcClusterId	The input parameter HpcClusterId that is mandatory for processing this request is not supplied.	The HpcClusterId parameter is required.
400	InvalidHpcClusterIds.ExceedLimit	The amount of specified specified hpc cluster ids exceeds the limit.	The number of HPC cluster IDs specified in the HpcClusterIds value is out of range.
400	InvalidHpcClusterIds.Malformed	The amount of specified specified hpc cluster ids is invalid.	The number of HPC cluster IDs specified in the HpcClusterIds value is out of range.
400	Invalid.Parameter	Invalid parameters.	Invalid parameters.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.