All Products
Search
Document Center

Elastic Compute Service:DescribeHpcClusters

Last Updated:Feb 04, 2024

Queries available high performance computing (HPC) clusters. You can specify multiple request parameters to be queried. Specified parameters have logical AND relations and are included in the filter conditions. 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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The IDs of HPC clusters. The value is a JSON array that consists of up to 100 HPC cluster IDs. Separate the HPC cluster IDs with commas (,).

cn-hangzhou
ClientTokenstringNo

The page number.

Pages start from page 1.

Default value: 1.

123e4567-e89b-12d3-a456-426655440000
HpcClusterIdsstringNo

The number of entries per page.

Maximum value: 100.

Default value: 10.

["hpc-xxxxxxxxx", "hpc-yyyyyyyyy", … "hpc-zzzzzzzzz"]
PageNumberintegerNo

The number of entries per page.

1
PageSizeintegerNo

The request ID.

10

Response parameters

ParameterTypeDescriptionExample
object
PageSizeinteger

The page number.

10
RequestIdstring

The total number of HPC clusters.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumberinteger

Details about the HPC clusters. The value is an array that consists of the information of each HPC cluster.

1
TotalCountinteger

The ID of the HPC cluster.

2
HpcClustersobject []

The name of the HPC cluster.

HpcClusterIdstring

The description of the HPC cluster.

hpc-bp1a5zr3u7nq9cx****

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400InvalidRegionId.NotFoundThe specified parameter "RegionId" is not valid.-
400MissingParameter.HpcClusterIdThe input parameter HpcClusterId that is mandatory for processing this request is not supplied.The HpcClusterId parameter is required.
400InvalidHpcClusterIds.ExceedLimitThe 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.
400InvalidHpcClusterIds.MalformedThe amount of specified specified hpc cluster ids is invalid.The number of HPC cluster IDs specified in the HpcClusterIds value is out of range.
400Invalid.ParameterInvalid parameters.Invalid parameters.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history