文档首页/ AI科学计算服务/ API参考/ API/ 系统管理/ 计算集群管理/ 获取计算集群列表 - ListComputingCluster
更新时间:2025-12-26 GMT+08:00
分享

获取计算集群列表 - ListComputingCluster

功能介绍

获取计算集群列表。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。

URI

GET /v1/{project_id}/system/computing-clusters

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,您可以从获取项目ID中获取。

约束限制:

不涉及

取值范围:

仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

参数解释:

限制量,单次查询总量。

约束限制:

不涉及

取值范围:

1-1000

默认取值:

100

offset

否

Integer

参数解释:

偏移量,查询起始偏移。

约束限制:

不涉及

取值范围:

0-100000000

默认取值:

0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token。

Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。

约束限制:

不涉及

取值范围:

长度为[1-32768]个字符。

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

clusters

Array of ComputingClusterRsp objects

参数解释:

计算集群列表。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

count

Integer

参数解释:

计算集群总数。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表5 ComputingClusterRsp

参数

参数类型

描述

id

String

参数解释:

已绑定的集群ID。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

name

String

参数解释:

计算集群名称。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

version

String

参数解释:

计算集群版本。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

flavor

String

参数解释:

计算集群规格。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

category

String

参数解释:

计算集群类别。

约束限制:

不涉及

取值范围:

  • CCE:CCE Standard集群

  • Turbo:CCE turbo集群

默认取值:

不涉及

status

String

参数解释:

计算集群绑定状态,

约束限制:

不涉及

取值范围:

  • RUNNING:集群可用

  • INSTALL_FAILED:绑定失败

  • UNINSTALL_FAILED:解绑失败

  • INSTALLING:绑定中

  • UNINSTALLING:解绑中

默认取值:

不涉及

active_nodes_number

Integer

参数解释:

计算集群可用节点数。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

total_nodes_number

Integer

参数解释:

计算集群总节点数。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

create_time

String

参数解释:

计算集群绑定时间。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

cce_create_time

String

参数解释:

cce集群创建时间。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

cce_status

String

参数解释:

cce集群绑态。

约束限制:

不涉及

取值范围:

  • Available:可用,表示集群处于正常状态。

  • Unavailable:不可用,表示集群异常,需手动删除。

  • ScalingUp:扩容中,表示集群正处于扩容过程中。

  • ScalingDown:缩容中,表示集群正处于缩容过程中。

  • Creating:创建中,表示集群正处于创建过程中。

  • Deleting:删除中,表示集群正处于删除过程中。

  • Upgrading:升级中,表示集群正处于升级过程中。

  • Resizing:规格变更中,表示集群正处于变更规格中。

  • ResizeFailed:规格变更异常,表示集群变更规格异常。

  • RollingBack:回滚中,表示集群正处于回滚过程中。

  • RollbackFailed:回滚异常,表示集群回滚异常。

  • Hibernating:休眠中,表示集群正处于休眠过程中。

  • Hibernation:已休眠,表示集群正处于休眠状态。

  • Freezing:冻结中,表示集群正处于冻结过程中。

  • Frozen:已冻结,表示集群正处于冻结状态。

  • UnFreezing:解冻中,表示集群正处于解冻过程中。

  • Awaking:唤醒中,表示集群正处于从休眠状态唤醒的过程中。

  • Empty:集群无任何资源(已废弃)。

  • Error:错误,表示集群资源异常,可尝试手动删除。

默认取值:

不涉及

cce_id

String

参数解释:

cce集群ID。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

billing_mode

String

参数解释:

计费模式。

约束限制:

不涉及

取值范围:

  • prepaid:包周期模式

  • postpaid:按需模式

默认取值:

不涉及

请求示例

获取计算集群列表,查询起始偏移为0,单次查询总量为10。

https://{endpoint}/v1/{project_id}/system/computing-clusters

响应示例

状态码:200

OK

{
  "count" : 1,
  "clusters" : [ {
    "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1",
    "name" : "cce_cluster_name",
    "version" : 1.25,
    "category" : "CCE",
    "flavor" : "cce.s1.small",
    "cce_status" : "Available",
    "cce_id" : "afdccb56-5bb6-11eb-8a0d-fa163e3dddwa",
    "status" : "Running",
    "active_nodes_number" : 1,
    "total_nodes_number" : 1,
    "create_time" : "2024-01-01T14:25:50Z",
    "cce_create_time" : "2025-03-31T11:56:14Z",
    "billing_mode" : "postpaid"
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

相关文档