Call the DescribeHpcClusters operation to query the list of HPC clusters that meet the specified conditions with detailed information.

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

The table below lists only the request parameters specific to this operation and some common parameters. For more information, refer to Common parameters.

Action string required Sample value: DescribeHpcClusters

The action that you want to perform. Value: DescribeHpcClusters.

Version string required Sample value: 2020-04-01

The version of the API. Valid value: 2020-04-01.

ClientToken string Optional Sample value: 333456899ff****

The ClientToken is used to ensure the request idempotency. You can use the client to automatically generate a token, but you must make sure that the token is unique among different requests. This prevents repeated actions due to multiple client retries when the call of the API action times out or an internal server error occurs.

Value: Only ASCII characters are supported. The length is no more than 64 ASCII characters.

HpcClusterIds.N string[] Optional Sample value: HpcClusterIds.1=hpcCluster-ybo1y364wkf80o0m****&HpcClusterIds.2=hpcCluster-ybn3a2zyiib1wzr2****

The HPC cluster ID.

Argument - N: specifies the serial number of the HPC cluster.

Separate multiple IDs with ampersands (&).

MaxResults integer Optional Sample value: 10

The number of entries returned on each page in a pagination query.

Maximum value: 100

Default value: 10

Name string Optional Sample value: hpcCluster-01

Query by filtering the HPC cluster name.

NextToken string Optional Sample value: --

Pagination token marking the query position. Omit this parameter for initial API requests. In the next query, set the NextToken parameter to the value returned by the previous API call.

ProjectName string Optional Sample value: project_a

The project to which the resource belongs. A resource can only belong to one project.

Only letters, digits, underscores (_), hyphens (-), and dots (.) are allowed.

The length is limited to 64 characters.

TagFilters.N.Key string[] Optional Sample value: TagFilters.1.Key=k1

The specified tag key when querying resources based on tags.

Argument - N: specifies the serial number of the tag key. Valid range: 1–10.

Separate multiple tag keys with ampersands (&).

Tag keys must be unique.

TagFilters.N.Values.N string[] Optional Sample value: TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2

The specified tag value when querying resources based on tags.

The first N: specifies the serial number of the tag key. Value range: 1–10.

The second N: specifies the serial number of the tag value. Value range: 1–3. You can query up to three tag values of the same tag key.

Separate multiple tag values with ampersands (&).

tip

To pass in this parameter, pass in TagFilters.N.Key first.

If you do not pass in the TagFilters.N.Key parameter, all tag values corresponding to the same tag key are queried.

If you specify an empty string, you query tags with an empty tag value.

ZoneId string Optional Sample value: cn-beijing-a

The ID of the availability zone where the HPC cluster is deployed.

You can call the DescribeZones operation to query the availability zones in the same region.

Response parameters

Only the response parameters specific to this operation are listed below. For more information, refer to the response structure.

HpcClusters object[] Sample value: --

Information about HPC clusters that meet the conditions.

ProjectName string Sample value: project_a

The name of the project to which the resource belongs.

Tags object[] Sample value: --

The information of tags associated with resources.

Key string Sample value: k1

The tag key of the resource.

Value string Sample value: v1

The tag value of the resource.

CreatedAt string Sample value: 2024-07-26T21:55:12+08:00

The creation time. Format: RFC3339.

Description string Sample value: HPC cluster for testing.

The description of the HPC cluster.

HpcClusterId string Sample value: hpcCluster-ybo1y364wkf80o0m****

The HPC cluster ID.

Name string Sample value: hpcCluster-01

The name of the HPC cluster.

UpdatedAt string Sample value: 2024-07-26T21:55:12+08:00

The update time. Format: RFC3339.

VpcId string Sample value: vpc-3qd85471bl7nk7prml024****

VPC ID.

ZoneId string Sample value: cn-beijing-a

The ID of the availability zone where the HPC cluster is deployed.

NextToken string Sample value: bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq******

The query credentials value returned by this call. If null is returned, this page is the last page.

Sample request

Sample response

Error codes

To learn more error codes, see Common error codes.

Elastic Compute Service