AI 助理
文档备案控制台
官方文档
首页

ListClusters - 查询集群列表

更新时间：
复制 MD 格式
产品详情
我的收藏

查询用户账号中在每个地域拥有的所有集群的列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ehpc:ListClusters

list

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
ClusterIds

array

否

待查询集群 ID。N 的取值范围：0～20。

string

否

集群 ID。

ehpc-cn-wulanchabu-llsu******
ClusterNames

array

否

待查询的集群名称列表。N 的取值范围：0～20。

string

否

集群名称。

slurm22.05.8-cluster-20240802

PageNumber

integer

否

列表的页码，默认值为 1。

1
PageSize

integer

否

分页查询时设置的每页行数。 取值范围：10~100。 默认值：10。

10

返回参数

名称

类型

描述

示例值

object

返回参数集合。

TotalCount

integer

列表条目总数。

2
RequestId

string

请求 ID。

04F0F334-1335-436C-A1D7-6C044FE73368
PageNumber

string

当前页码。

1
PageSize

integer

本页条数。

10
EhpcVersionStatistics

object

V1Count

integer

V2Count

integer

Clusters

array<object>

集群详细信息。

array<object>

集群信息。

ClusterId

string

集群 ID。

ehpc-hz-VMKe******
ClusterName

string

集群名称。

slurm22.05.8-cluster-20240227
ClusterDescription

string

集群描述。

Demo
ClusterCreateTime

string

集群的创建时间。以 ISO 8601 为标准，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mmZ。更多信息，请参见ISO 8601。

2024-08-06T12:43:01.000Z
ClusterModifyTime

string

集群的修改时间。以 ISO 8601 为标准，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mmZ。更多信息，请参见ISO 8601。

2024-08-06T12:43:01.000Z
ClusterCategory

string

集群系列，取值范围：

  • Standard

  • Serverless

Standard
ClusterStatus

string

集群状态。取值范围：

  • uninit：安装中。

  • creating：创建中。

  • initing：初始化中。

  • running：运行中。

  • releasing：释放中。

  • stopping：停止中。

  • stopped：已停止。

  • exception：异常。

  • pending：待配置。

running
ClusterVpcId

string

集群使用的专有网络 VPC ID。

vpc-m5efjevmclc0xdmys****

ClusterVSwitchId

string

集群使用的虚拟交换机 ID。

vsw-f8za5p0mwzgdu3wgx****

SecurityGroupId

string

集群使用的安全组 ID。

sg-bp13n61xsydodfyg****

ClusterCustomConfiguration

object

集群使用的后处理脚本。

Script

string

集群后处理脚本的链接。

https://xxxxx
Args

string

集群后处理脚本的参数。

demo
MaxCount

integer

集群可管理的计算节点数量。

500
MaxCoreCount

integer

集群可管理的计算节点总核数。

10000
DeletionProtection

boolean

集群是否开启删除保护。取值范围：

  • true：启动删除保护。

  • false：不启用删除保护。

true
ResourceGroupId

string

资源组 ID。

rg-acfmxazb4ph****
Manager

object

集群管理节点配置。

Scheduler

object

调度器服务配置信息。

Type

string

调度器类型。

SLURM
Version

string

调度器版本。

22.05.8

DirectoryService

object

域账号服务配置信息。

Type

string

域账号类型。

NIS
Version

string

域账号版本。

2.31

DNS

object

域名解析服务配置信息。

Type

string

域名解析类型。

NIS
Version

string

域名解析版本。

2.31
EhpcVersion

string

E-HPC 产品集群的版本。

2.0.0
Nodes

object

集群的节点数量信息。

RunningCounts

integer

运行中的计算节点数量。

1
AbnormalCounts

integer

异常的计算节点数量。

0
CreatingCounts

integer

创建中的计算节点数量。

0
Users

object

集群的用户属性信息。

SudoCounts

integer

管理员用户数量。

2
NormalCounts

integer

普通用户数量。

2
AdditionalPackages

array<object>

集群安装的软件信息。

object

软件信息详情。

Name

string

软件名称。

gromacs
Version

string

软件版本。

2024.1
Addons

array<object>

集群自定义服务组件信息。

array<object>

自定义服务组件详情。

Name

string

自定义服务组件的名称。

Login
Version

string

自定义服务组件的版本。

1.0
Label

string

自定义服务组件标签。

Logon node
AddonId

string

自定义服务组件 ID。

Login-1.0-W2g****

Description

string

自定义服务组件描述。

Logon node, mainly used for connecting to the E-HPC cluster environment and submitting user tasks.
Status

string

自定义服务组件状态。

Running

ServicesSpec

array<object>

组件服务配置信息。

object

服务配置详情。

ServiceName

string

服务名称。

Web Portal

ServiceAccessType

string

服务访问类型。

URL
ServiceAccessUrl

string

服务访问 Url。

https://47.96.xx.xx:12008

ResourcesSpec

object

组件资源配置信息。

EipInstanceId

string

弹性公网 IP ID。

eip-bp1vi9124tbx1g3kr****

EcsInstanceId

string

组件实例 ID。

i-bp1bg85d2q6laic8****
ClusterUsedCoreTime

number

集群已用核时信息。

1000
ClusterMode

string

集群的部署类型。可能值：

  • Integrated：公共云

  • Hybrid：混合云

  • Custom：自定义集群

Integrated
ClusterCredentials

array

集群登录凭证的类型。取值范围：

  • password：使用密码登录集群。

  • keypair：使用密钥对登录集群。

string

凭证类型。

password

示例

正常返回示例

JSON格式

{
  "TotalCount": 2,
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "PageNumber": "1",
  "PageSize": 10,
  "EhpcVersionStatistics": {
    "V1Count": 0,
    "V2Count": 0
  },
  "Clusters": [
    {
      "ClusterId": "ehpc-hz-VMKe******",
      "ClusterName": "slurm22.05.8-cluster-20240227",
      "ClusterDescription": "Demo",
      "ClusterCreateTime": "2024-08-06T12:43:01.000Z",
      "ClusterModifyTime": "2024-08-06T12:43:01.000Z",
      "ClusterCategory": "Standard",
      "ClusterStatus": "running",
      "ClusterVpcId": "vpc-m5efjevmclc0xdmys****\n",
      "ClusterVSwitchId": "vsw-f8za5p0mwzgdu3wgx****\n",
      "SecurityGroupId": "sg-bp13n61xsydodfyg****\n",
      "ClusterCustomConfiguration": {
        "Script": "https://xxxxx",
        "Args": "demo"
      },
      "MaxCount": 500,
      "MaxCoreCount": 10000,
      "DeletionProtection": true,
      "ResourceGroupId": "rg-acfmxazb4ph****",
      "Manager": {
        "Scheduler": {
          "Type": "SLURM",
          "Version": "22.05.8\n"
        },
        "DirectoryService": {
          "Type": "NIS",
          "Version": "2.31\n"
        },
        "DNS": {
          "Type": "NIS",
          "Version": "2.31"
        }
      },
      "EhpcVersion": "2.0.0",
      "Nodes": {
        "RunningCounts": 1,
        "AbnormalCounts": 0,
        "CreatingCounts": 0
      },
      "Users": {
        "SudoCounts": 2,
        "NormalCounts": 2
      },
      "AdditionalPackages": [
        {
          "Name": "gromacs",
          "Version": "2024.1"
        }
      ],
      "Addons": [
        {
          "Name": "Login",
          "Version": "1.0",
          "Label": "Logon node",
          "AddonId": "Login-1.0-W2g****\n",
          "Description": "Logon node, mainly used for connecting to the E-HPC cluster environment and submitting user tasks.",
          "Status": "Running\n",
          "ServicesSpec": [
            {
              "ServiceName": "Web Portal\n",
              "ServiceAccessType": "URL",
              "ServiceAccessUrl": "https://47.96.xx.xx:12008\n"
            }
          ],
          "ResourcesSpec": {
            "EipInstanceId": "eip-bp1vi9124tbx1g3kr****\n",
            "EcsInstanceId": "i-bp1bg85d2q6laic8****"
          }
        }
      ],
      "ClusterUsedCoreTime": 1000,
      "ClusterMode": "Integrated",
      "ClusterCredentials": [
        "password"
      ]
    }
  ]
}

错误码

HTTP status code

错误码

错误信息

描述
503 ServiceUnavailable The request has failed due to a temporary failure of the server 请求失败，服务暂时不可用
407 NotAuthorized You are not authorized by RAM for this request. 此请求未获得RAM授权

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。

上一篇：ListInstalledSoftwares - 查询集群已安装软件下一篇：ListAvailableImages - 查询可用镜像列表