DescribeHpcClusters -

Queries available high performance computing (HPC) clusters. The request parameters are used as filters. Specified parameters have 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
Action	String	Yes	DescribeHpcClusters	The operation that you want to perform. Set the value to DescribeHpcClusters.
RegionId	String	Yes	cn-hangzhou	The region ID of the HPC cluster. You can call the DescribeRegions operation to query the most recent region list.
ClientToken	String	No	123e4567-e89b-12d3-a456-426655440000	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.
HpcClusterIds	String	No	["hpc-xxxxxxxxx", "hpc-yyyyyyyyy", ... "hpc-zzzzzzzzz"]	The IDs of HPC clusters. The value can be a JSON array that consists of up to 100 HPC cluster IDs. Separate the HPC cluster IDs with commas (,).
PageNumber	Integer	No	1	The page number. Pages start from page 1. Default value: 1.
PageSize	Integer	No	10	The number of entries per page. Valid values: 1 to 100. Default value: 10.

Response parameters

Parameter	Type	Example	Description
PageSize	Integer	10	The number of entries per page.
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	The ID of the request.
PageNumber	Integer	1	The page number.
TotalCount	Integer	2	The total number of queried HPC clusters.
HpcClusters	Array of HpcCluster		Details about the HPC clusters.
HpcCluster
HpcClusterId	String	hpc-bp1a5zr3u7nq9cx****	The ID of the HPC cluster.
Name	String	testName	The name of the HPC cluster.
Description	String	testDescription	The description of the HPC cluster.

Examples

Sample requests

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

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeHpcClustersResponse>
    <PageNumber>1</PageNumber>
    <TotalCount>2</TotalCount>
    <HpcClusters>
        <HpcCluster>
            <Name>chuatest1</Name>
            <Description>testDescription1</Description>
            <HpcClusterId>hpc-bp1a5zr3u7nq9cx****</HpcClusterId>
        </HpcCluster>
        <HpcCluster>
            <Name>chuatest2</Name>
            <Description>testDescription2</Description>
            <HpcClusterId>hpc-l6aam7fivcfd21fu****</HpcClusterId>
        </HpcCluster>
    </HpcClusters>
    <PageSize>10</PageSize>
    <RequestId>382960A6-C535-4705-B6EA-8338466270C4</RequestId>
</DescribeHpcClustersResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter.HpcClusterId	The input parameter HpcClusterId that is mandatory for processing this request is not supplied.	HpcClusterId is required.
400	InvalidHpcClusterIds.ExceedLimit	The amount of 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 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 parameter value.

For a list of error codes, see Service error codes.