DescribeHpcClusters - 查询高性能计算集群详情列表--云服务器-火山引擎

文档中心

立即注册

导航

云服务器

DescribeHpcClusters - 查询高性能计算集群详情列表

最近更新时间：2025.02.14 18:03:57首次发布时间：2025.02.14 18:03:57

调用 DescribeHpcClusters 接口查询符合条件的高性能计算集群详情列表。

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	DescribeHpcClusters	要执行的操作，取值：DescribeHpcClusters。
Version	String	是	2020-04-01	API的版本，取值：2020-04-01。
AccountId	String	否	210005****	账号ID。
ClientToken	String	否	333456899ff****	保证请求幂等性。由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。取值：仅支持ASCII字符，且不能超过64个字符。
HpcClusterIds.N	Array of String	否	HpcClusterIds.1=hpcCluster-ybo1y364wkf80o0m**&HpcClusterIds.2=hpcCluster-ybn3a2zyiib1wzr2**	高性能计算集群ID。参数 - N：表示高性能计算集群的序号。多个ID之间用&分隔。
MaxResults	Integer	否	10	分页查询时设置的每页行数。最大值：100 默认值：10
Name	String	否	hpcCluster-01	根据高性能计算集群名称过滤查询。
NextToken	String	否	--	分页查询凭证，用于标记分页的位置，初次调用该接口时无需设置。下次查询时，取值为上一次API调用返回的`NextToken`参数值。
ZoneId	String	否	cn-beijing-a	高性能计算集群所属可用区ID。您可以调用DescribeZones查询一个地域下的可用区信息。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
HpcClusters	Array of Object	--	符合条件的高性能计算集群信息。
NextToken	String	bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq******	本次调用返回的查询凭证值，返回为空表示该页为末页。

请求示例

GET /?Action=DescribeHpcClusters&Version=2020-04-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: ecs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220518171951010211173098094C****",
        "Action": "DescribeHpcClusters",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {
        "NextToken": "",
        "HpcClusters": [
            {
                "HpcClusterId": "hpcCluster-ybo1y364wkf80o0m****",
                "Name": "hpcCluster-01",
                "VpcId": "vpc-3qd85471bl7nk7prml024****",
                "Description": "用于测试的HPC Cluster",
                "ZoneId": "cn-beijing-a",
                "CreatedAt": "2022-05-07T00:42:43+08:00",
                "UpdatedAt": "2022-05-07T15:17:21+08:00"
            },
            {
                "HpcClusterId": "hpcCluster-ybmta3h9gwkrkfjr****",
                "Name": "hpcCluster-02",
                "VpcId": "",
                "Description": "",
                "ZoneId": "cn-beijing-a",
                "CreatedAt": "2022-04-19T20:36:04+08:00",
                "UpdatedAt": "2022-04-24T16:09:55+08:00"
            }
        ]
    }
}