文档首页/魔坊（ModelArts）模型训推平台/SDK参考/Lite Server生命周期管理/查询用户所有超节点实例详情
更新时间：2025-12-04 GMT+08:00
查看PDF
分享

查询用户所有超节点实例详情

示例代码

在ModelArts Notebook平台，Session鉴权无需输入鉴权参数。其它平台的Session鉴权请参见Session鉴权。

from modelarts.server_mgmt import ServerManagement
from modelarts.session import Session

ServerManagement.get_hps_list(session = Session())

参数说明

表1 路径参数

参数

是否必选

参数类型

描述

session

是

Class

管理与Lite Server的交互,提供project_id

表2 Query参数

参数

是否必选

参数类型

描述

owner

否

String

实例归属的用户ID，长度为32位小写字母、数字，在大账号/有admin权限场景下生效，值通常为当前登录用户ID。

sort_dir

否

String

排序方式。枚举值如下：

  • ASC升序。
  • DESC降序。

sort_key

否

String

排序字段，枚举值如下：

  • createTime：默认值，创建时间。
  • updateTime：更新时间。

limit

否

Integer

每一页的数量。

offset

否

Integer

分页记录的起始位置偏移量。

表3 响应Body参数

参数

参数类型

描述

current

Integer

当前页数。

data

Array of ServerResponse objects

Lite Server实例列表。

pages

Integer

总的页数。

size

Integer

每一页的数量。

total

Long

总的记录数量。

表4 ServerResponse

参数

参数类型

描述

create_at

Long

创建时间。

hps_cluster_id

String

超节点集群ID

hps_id

String

超节点实例ID

id

String

实例ID。

name

String

实例名称。

order_id

String

订单ID。

status

String

实例状态。

  • CREATE_FAILED: 创建失败；
  • CREATING: 创建中；
  • DELETED: 已删除；
  • DELETE_FAILED: 删除失败；
  • DELETING: 删除中；
  • ERROR: 错误；
  • RUNNING: 运行中；
  • STARTING: 启动中；
  • START_FAILED: 启动失败；
  • STOPPED: 已停止；
  • STOPPING: 停止中；
  • STOP_FAILED: 停止失败：
  • REBOOTING: 重启中：
  • REBOOT_FAILED: 重启失败；
  • CHANGINGOS: 切换操作系统中：
  • CHANGINGOS_FAILED: 切换操作系统失败：
  • REINSTALLINGOS: 重装操作系统中：
  • REINSTALLINGOS_FAILED。重装操作系统失败。

cloud_server

CloudServer object

云服务信息。

endpoints_response

Array of Endpoints objects

实例私有IP信息。

flavor

String

实例规格名称。

id

String

实例ID。

key_pair_name

String

密钥对名称。

name

String

实例名称。

order_id

String

订单ID。

server_image_response

ServerImageResponse object

实例镜像信息。

vpc_id

String

实例所在虚拟私有云ID。

endpoints

Array of EndpointsRes objects

服务器的私有IP信息。

image

ServerImageResponse object

服务器镜像信息。

category

String

服务器归属类型。

  • HPS：超节点服务器
  • SPOD：整柜服务器
  • SERVER：单台服务器

server_hps

ServerHpsInfo object

服务器归属超节点信息。

subnet_id

String

实例所在子网的ID。

server_hps

ServerHpsInfo object

服务器归属超节点信息。

subnet_id

String

实例所在子网的ID。

表5 CloudServer

参数

参数类型

描述

id

String

服务器资源id。

type

String

Lite Server服务器类型。枚举值如下：

  • BMS：裸金属服务器
  • ECS：弹性云服务器
  • HPS：超节点服务器

hps_id

String

服务器所属的超节点资源id。

表6 Endpoints

参数

参数类型

描述

allowed_access_ips

Array of strings

允许通过SSH协议访问Notebook的公网IP地址白名单列表，默认都可以访问。当配置指定IP后，则仅允许IP所在的客户端实现对Notebook的访问。

dev_service

String

支持的服务，枚举值如下：

  • NOTEBOOK：可以通过https协议访问Notebook
  • SSH：可以通过SSH协议远程连接Notebook
  • AI_FLOW
  • MA_STUDIO
  • TENSOR_BOARD
  • WEB_IDE

extensions

Map<String,String>

通过应用专属URL直接打开应用进入远程开发模式。

ssh_keys

Array of strings

SSH密钥对名称列表，允许设置多个密钥对实现同时对SSH实例的访问。

表7 EndpointsRes

参数

参数类型

描述

allowed_access_ips

Array of strings

允许通过SSH协议访问Notebook的公网IP地址白名单列表，默认都可以访问。当配置指定IP后，则仅允许IP所在的客户端实现对Notebook的访问。

dev_service

String

访问Notebook的途径，枚举值如下：

  • NOTEBOOK：可以通过https协议访问Notebook。
  • SSH：可以通过SSH协议远程连接Notebook。

ssh_keys

Array of strings

SSH密钥对名称列表，允许设置多个密钥对实现同时对SSH实例的访问。

service

String

访问Notebook的途径，枚举值如下：

  • NOTEBOOK：可以通过https协议访问Notebook。
  • SSH：可以通过SSH协议远程连接Notebook。

uri

String

实例私有IP地址。

表8 ServerImageResponse

参数

参数类型

描述

arch

String

服务器镜像架构类型。

  • ARM
  • X86

image_id

String

服务器镜像ID。

name

String

服务器镜像名称。

server_type

String

服务器类型。枚举值如下：

  • BMS：裸金属服务器
  • ECS：弹性云服务器
表9 ServerHpsInfo

参数

参数类型

描述

id

String

Lite Server超节点实例id。

name

String

Lite Server超节点名称。