DescribeHpcClusters

Last Updated At: 2026-08-03 00:05:05

1. Interface Description

Interface request domain name: cvm.api3.convergecloud.com.

Query High-Performance Cluster Information

Default interface request rate limit: 20 times per second.

Interface update time: 2023-12-12 03:54:51.

The interface is both signature verification and authentication.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: DescribeHpcClusters
Version Yes No String Public parameter, The value of this interface: 2017-03-12
Region No No String Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface
HpcClusterIds No No Array of String High-performance computing cluster ID array.
Example: ["hpc-p64fdfa9"]
Name No No String Name of high-performance computing cluster.
Example: MyCluster
Zone No No String Availability zone.
Example: ap-region1-2
Offset No No Uint64 Offset, 0 by default.
Example: 0
Limit No No Uint64 Current request volume, 20 by default.
Example: 20

3. Output Parameters

Parameter name Type Description
HpcClusterSet Array of HpcClusterInfo High-performance computing cluster information.
Example:View
TotalCount Uint64 Total number of high-performance computing clusters.
Example: 1
RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

4. Error Code

The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

Error Code Description
InvalidZone.MismatchRegion The specified zone does not exist.
InternalError Internal error