文档中心>API 中心>云服务器>其他接口>查询高性能集群信息

查询高性能集群信息

最近更新时间:2025-03-20 11:09:19

我的收藏

1. 接口描述

接口请求域名: cvm.tencentcloudapi.com 。

查询高性能集群信息

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeHpcClusters。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
HpcClusterIds.N Array of String 高性能计算集群ID数组。
示例值:["hpc-p64fdfa9"]
Name String 高性能计算集群名称。
示例值:MyCluster
Zone String 可用区。
示例值:ap-guangzhou-2
Offset Integer 偏移量, 默认值0。
示例值:0
Limit Integer 本次请求量, 默认值20。
示例值:20
HpcClusterType String 高性能计算集群类型。
示例值:CDC/CHC/STANDARD
HpcClusterBusinessId String 高性能计算集群对应的业务场景标识,当前只支持CDC。
示例值:例如cdc场景:cluster-iu5gustw,其他场景暂不支持。
InstanceType String 高性能计算集群实例类型
示例值:HCCPNV4ane.58XLARGE1929
Filters.N Array of Filter
  • tag-key
  • 按照【标签键】进行过滤。

    类型:String

    必选:否

  • tag-value
  • 按照【标签值】进行过滤。

    类型:String

    必选:否

  • tag:tag-key
  • 按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。

    类型:String

    必选:否

    每次请求的Filters的上限为10,Filter.Values的上限为5。
    示例值:[{"Name": "tag-key","Values": ["myTag"]}]

    3. 输出参数

    参数名称 类型 描述
    HpcClusterSet Array of HpcClusterInfo 高性能计算集群信息。
    示例值:[{"HpcClusterId":"hpc-jtynq57p","Name":"test","Remark":"test","CvmQuotaTotal":100,"Zone":"ap-guangzhou-2","CurrentNum":0,"InstanceIds":[],"CreateTime":"2023-04-20T06:25:58Z"}]
    TotalCount Integer 高性能计算集群总数。
    示例值:1
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询高性能集群信息

    查询高性能集群信息

    输入示例

    复制
    复制成功
    GET https://cvm.tencentcloudapi.com/?Action=DescribeHpcClusters
    &Zone=ap-guangzhou-3
    &Offset=0
    &Limit=20
    &<公共请求参数>

    输出示例

    复制
    复制成功
    {
        "Response": {
            "HpcClusterSet": [
                {
                    "HpcClusterId": "hpc-dc4gcarp",
                    "Name": "test_33311",
                    "Remark": "remark 1",
                    "CvmQuotaTotal": 50,
                    "Zone": "ap-guangzhou-3",
                    "CurrentNum": 0,
                    "InstanceIds": [],
                    "HpcClusterNetMode": 30,
                    "CreateTime": "2020-06-02T07:55:05Z",
                    "Tags": [
                        {
                            "Key": "tag_key",
                            "Value": "tag_value"
                        }
                    ]
                },
                {
                    "HpcClusterId": "hpc-p64fdfa9",
                    "Name": "test_333333",
                    "Remark": "remark 2",
                    "CvmQuotaTotal": 50,
                    "Zone": "ap-guangzhou-3",
                    "CurrentNum": 0,
                    "InstanceIds": [],
                    "HpcClusterNetMode": 30,
                    "CreateTime": "2020-06-02T07:51:58Z",
                    "Tags": [
                        {
                            "Key": "tag_key",
                            "Value": "tag_value"
                        }
                    ]
                }
            ],
            "TotalCount": 2,
            "RequestId": "5834f1a5-cd9c-449d-acba-df1803a8583e"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    InvalidZone.MismatchRegion 指定的zone不存在。
    UnsupportedOperation.InvalidZone 该可用区不可售卖。

    如果遇到产品相关问题,您可咨询 在线客服 寻求帮助。

    可通过正文划词反馈文档内容问题,我们会快速处理并更新文档内容。