You can call this operation to query the available HPC clusters. Specified request parameters are used as filters with logical AND (&&) relations. The request parameters are not dependent on each other.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
RegionId String Yes cn-hangzhou

The region ID of the HPC cluster. You can call the DescribeRegions operation to query the latest region list.

Action String No DescribeHpcClusters

The operation that you want to perform. Set the value to DescribeHpcClusters.

ClientToken String No 123e4567-e89b-12d3-a456-426655440000

A client token. It is used to ensure the idempotency of requests. The value of this parameter is generated by the client and is unique among different requests. The value can only contain ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotency.

HpcClusterIds String No ["hpc-xxxxxxxxx", "hpc-yyyyyyyyy", … "hpc-zzzzzzzzz"]

The IDs of HPC clusters.

You can specify a JSON array containing up to 100 HPC cluster IDs. Separate multiple HPC cluster IDs with commas (,).

PageNumber Integer No 1

The number of the page to return.

Pages start from page 1.

Default value: 1.

PageSize Integer No 10

The number of entries to return per page.

Maximum value: 100.

Default value: 10.

Response parameters

Parameter Type Example Description
HpcClusters

The list of all available HPC clusters. The value is an array consisting of the information of each HPC cluster.

Description String FinanceDept

The description of a queried HPC cluster.

HpcClusterId String hpc-hpclusterid1

The ID of a queried HPC cluster.

Name String FinanceJoshua

The name of a queried HPC cluster.

PageNumber Integer 1

The page number of the returned page.

PageSize Integer 10

The number of entries returned per page.

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

The ID of the request.

TotalCount Integer 2

The total number of queried HPC clusters.

Examples

Sample requests

https://ecs.aliyuncs.com/?Action=DescribeHpcClusters
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

<DescribeHpcClustersResponse>
    <PageNumber>1</PageNumber>
    <TotalCount>2</TotalCount>
    <HpcClusters>
        <HpcCluster>
            <Name>chuatest1</Name>
            <Description>desc</Description>
            <HpcClusterId>hpc-l6ack54lcr2g17563***</HpcClusterId>
        </HpcCluster>
        <HpcCluster>
            <Name>chuatest2</Name>
            <Description>desc</Description>
            <HpcClusterId>hpc-l6aam7fivcfd21fun***</HpcClusterId>
        </HpcCluster>
    </HpcClusters>
    <PageSize>10</PageSize>
    <RequestId>168D82CE-F8A0-4200-AC5C-26FD94438423</RequestId>
</DescribeHpcClustersResponse>

JSON format

{
	"PageNumber":1,
	"TotalCount":2,
	"PageSize":10,
	"HpcClusters":{
		"HpcCluster":[
			{
				"Name":"chuatest1",
				"Description":"desc",
				"HpcClusterId":"hpc-l6ack54lcr2g17563***"
			},
			{
				"Name":"chuatest2",
				"Description":"desc",
				"HpcClusterId":"hpc-l6aam7fivcfd21fun***"
			}
		]
	},
	"RequestId":"382960A6-C535-4705-B6EA-8338466270C4"
}

Error codes

HTTP status code Error code Error message Description
400 InvalidRegionId.NotFound The specified parameter "RegionId" is not valid. The error message returned because the specified region ID does not exist. Check whether ECS is available in the region.
400 MissingParameter.HpcClusterId The input parameter HpcClusterId that is mandatory for processing this request is not supplied. The error message returned because the required HpcClusterId parameter is not specified.
400 InvalidHpcClusterIds.ExceedLimit The amount of specified specified hpc cluster ids exceeds the limit. The error message returned because the number of HPC cluster IDs exceeds the limit.
400 InvalidHpcClusterIds.Malformed The amount of specified specified hpc cluster ids is invalid. The error message returned because the HpcClusterIds parameter is not valid.
400 Invalid.Parameter Invalid parameters. The error message returned because the specified parameter is not valid.

For more information about error codes, see API Error Center.