文档首页/ AI开发平台ModelArts/ API参考/ DevServer管理/ 查询用户所有超节点实例详情

更新时间：2025-08-19 GMT+08:00

查看PDF

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

功能介绍

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

接口约束

暂无约束。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/dev-servers/hyperinstance

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：用户项目ID。约束限制：获取方法请参见获取项目ID和名称。取值范围：不涉及。默认取值：不涉及。

表2 Query参数
参数	是否必选	参数类型	描述
sort_dir	否	String	参数解释：排序方式。约束限制：不涉及。取值范围：枚举值如下： - ASC升序。 - DESC降序。默认取值：不涉及。
sort_key	否	String	参数解释：排序字段。约束限制：不涉及。取值范围：枚举值如下： - createTime：默认值，创建时间。 - updateTime：更新时间。默认取值：不涉及。
limit	否	Integer	参数解释：每一页的数量。约束限制：不涉及。取值范围：[1,1024]。默认取值：10。
offset	否	Integer	参数解释：分页记录的起始位置偏移量。约束限制：不涉及。取值范围：[0,2147483647]。默认取值：不涉及。

请求参数

无

响应参数

状态码：200

表3 响应Header参数
参数	参数类型	描述
X-Request-Id	String	链路追踪编号

表4 响应Body参数
参数	参数类型	描述
current	Integer	参数解释：当前页数。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
data	Array of ServerHyperinstanceResponse objects	参数解释：DevServer超节点实例列表。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
pages	Integer	参数解释：总的页数。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
size	Integer	参数解释：每一页的数量。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
total	Long	参数解释：总的记录数量。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

表5 ServerHyperinstanceResponse
参数	参数类型	描述
create_at	Long	参数解释：创建时间。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
hps_cluster_id	String	参数解释：超节点集群网络ID。约束限制：不涉及。取值范围：^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$。默认取值：不涉及。
hps_id	String	参数解释：超节点ID。约束限制：不涉及。取值范围：^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$。默认取值：不涉及。
id	String	参数解释：DevServer超节点ID。约束限制：不涉及。取值范围：^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$。默认取值：不涉及。
name	String	参数解释：实例名称。约束限制：不涉及。取值范围：^[-_.a-zA-Z0-9]{1,64}$。默认取值：不涉及。
order_id	String	参数解释：订单ID。约束限制：不涉及。取值范围：^[a-zA-Z0-9]{1,64}$。默认取值：不涉及。
status	String	参数解释：超节点实例状态。约束限制：不涉及。取值范围： PROVISIONING：超节点的创建请求已被接受，但是仍在创建过程中； ACTIVE：超节点处于活动状态，其资源可被使用； ERROR：超节点创建失败； REIMAGING：超节点切换操作系统中； TERMINATING：资源释放中； TERMINATED：超节点资源已经被释放，其资源不再可用。默认取值：不涉及。
servers	Array of ServerResponse objects	参数解释：超节点子节点实例列表。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
update_at	Long	参数解释：创建时间。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

表6 ServerResponse
参数	参数类型	描述
create_at	Long	参数解释：创建时间。取值范围：不涉及。
update_at	Long	参数解释：更新时间。取值范围：不涉及。
charging_mode	String	参数解释：计费模式。取值范围： COMMON：同时支持包周期和按需 POST_PAID：按需模式 PRE_PAID：包周期
cloud_server	CloudServer object	参数解释：云服务信息。
endpoints_response	Array of Endpoints objects	参数解释：实例私有IP信息。
flavor	String	参数解释：实例规格名称。取值范围：^.{1,128}$。
id	String	参数解释：实例ID。取值范围：^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$。
key_pair_name	String	参数解释：密钥对名称。取值范围：^[-_.a-zA-Z0-9]{1,64}$。
name	String	参数解释：实例名称。取值范围：^[-_.a-zA-Z0-9]{1,64}$。
order_id	String	参数解释：订单ID。取值范围：^[a-zA-Z0-9]{1,64}$。
server_image_response	ServerImageResponse object	参数解释：实例镜像信息。取值范围：不涉及。
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: 重装操作系统失败
vpc_id	String	参数解释：实例所在虚拟私有云ID。取值范围：^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$。
endpoints	Array of EndpointsRes objects	参数解释：服务器私有IP信息。
image	ServerImageResponse object	参数解释：服务器镜像信息。
category	String	参数解释：服务器归属类型。取值范围： HPS：超节点服务器 SPOD：整柜服务器 SERVER：单台服务器
server_hps	ServerHpsInfo object	参数解释：服务器归属超节点信息。
subnet_id	String	参数解释：实例所在子网的ID。取值范围：^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$。

表7 CloudServer
参数	参数类型	描述
id	String	参数解释：服务器资源id，或超节点子节点id。取值范围：^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$。
type	String	参数解释：DevServer服务器类型。取值范围： BMS：裸金属服务器 ECS：弹性云服务器 HPS：超节点服务器
hps_id	String	参数解释：服务器所属的超节点资源id。取值范围：^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$。
hps_ecs_id	String	参数解释：超节点子节点对应服务器资源id。取值范围：^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$。

表8 Endpoints
参数	参数类型	描述
allowed_access_ips	Array of strings	参数解释：允许通过SSH协议访问Notebook的公网IP地址白名单列表。默认情况下，所有IP都可以访问。配置指定IP后，则仅允许指定IP所在的客户端访问。约束限制：不涉及。取值范围：0 - 1024个IP地址默认取值：不涉及。
dev_service	String	参数解释：支持的服务。取值范围： NOTEBOOK：可以通过https协议访问Notebook SSH：可以通过SSH协议远程连接Notebook
extensions	Map<String,String>	参数解释：通过应用专属URL直接打开应用进入远程开发模式。包含应用的各种扩展配置。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
ssh_keys	Array of strings	参数解释：SSH密钥对名称列表。允许设置多个密钥对实现同时对SSH实例的访问。约束限制：不涉及。取值范围：0 - 1024个密钥对默认取值：不涉及。

表9 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地址。取值范围：不涉及。

**表10** ServerImageResponse
参数	参数类型	描述
arch	String	参数解释：服务器镜像架构类型。取值范围： ARM X86
image_id	String	参数解释：服务器镜像ID。取值范围：^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$。
name	String	参数解释：服务器镜像名称。表示服务器镜像的名称。约束限制：不涉及。取值范围：1 - 256字符默认取值：不涉及。
server_type	String	参数解释：服务器类型。取值范围： BMS：裸金属服务器 ECS：弹性云服务器 HPS：超节点服务器
status	String	参数解释：服务器镜像状态。取值范围： ACTIVE INACTIVE

**表11** ServerHpsInfo
参数	参数类型	描述
id	String	参数解释：DevServer超节点实例id。取值范围：^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$。
name	String	参数解释：DevServer超节点名称。取值范围：^[-_.a-zA-Z0-9]{1,64}$。

状态码：400

**表12** 响应Header参数
参数	参数类型	描述
X-Request-Id	String	链路追踪编号

**表13** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：ModelArts错误码。取值范围：不涉及。
error_msg	String	参数解释：具体错误信息。取值范围：不涉及。

状态码：401

**表14** 响应Header参数
参数	参数类型	描述
X-Request-Id	String	链路追踪编号

**表15** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：ModelArts错误码。取值范围：不涉及。
error_msg	String	参数解释：具体错误信息。取值范围：不涉及。

状态码：403

**表16** 响应Header参数
参数	参数类型	描述
X-Request-Id	String	链路追踪编号

**表17** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：ModelArts错误码。取值范围：不涉及。
error_msg	String	参数解释：具体错误信息。取值范围：不涉及。

状态码：500

**表18** 响应Header参数
参数	参数类型	描述
X-Request-Id	String	链路追踪编号

**表19** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：ModelArts错误码。取值范围：不涉及。
error_msg	String	参数解释：具体错误信息。取值范围：不涉及。

请求示例

GET https://{endpoint}/v1/{project_id}/dev-servers/hyperinstance

响应示例

状态码：200

{
  "current" : 0,
  "data" : [ {
    "create_at" : 1731055875839,
    "hps_cluster_id" : "42669b79-da2f-4482-ad40-22f50442c9e7",
    "hps_id" : "33806b62-1c7b-4781-8d2c-411a042b86b8",
    "id" : "b4beacb6-4380-448c-a218-daa82cf03f5d",
    "name" : "devserver-hps",
    "order_id" : "CS2411081650G9B6Z",
    "servers" : [ {
      "charging_mode" : "PRE_PAID",
      "cloud_server" : {
        "hps_id" : "33806b62-1c7b-4781-8d2c-411a042b86b8",
        "id" : "50208d41-749e-4bce-95a9-47a850925d4e",
        "type" : "HPS"
      },
      "create_at" : 1731055875840,
      "endpoints" : [ {
        "service" : "SSH",
        "uri" : "10.1.0.98"
      } ],
      "flavor" : "kat3ne-8.48xlarge.8.800t.matrix",
      "id" : "278d70a9-2049-450a-bf6d-db02fe9f6634",
      "image" : {
        "image_id" : "86496e41-87c4-4779-9007-4f8f5c2a208f"
      },
      "key_pair_name" : "KeyPair-hps",
      "name" : "devserver-hps-1",
      "order_id" : "CS2411081650G9B6Z",
      "server_hps" : {
        "id" : "b4beacb6-4380-448c-a218-daa82cf03f5d",
        "name" : "devserver-hps"
      },
      "status" : "RUNNING",
      "update_at" : 1731209918651,
      "vpc_id" : "7980ccf4-44d0-42cc-a844-42e035379a38"
    } ],
    "status" : "ACTIVE",
    "update_at" : 1731209918651
  } ],
  "pages" : 1,
  "size" : 10,
  "total" : 1
}

状态码

状态码	描述
200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
500	Server Internal Error

错误码

请参见错误码。

父主题： DevServer管理

上一篇：切换DevServer超节点服务器操作系统镜像

下一篇：删除DevServer超节点实例

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消