查询超节点的所有子节点 - ListHyperinstanceServers

功能介绍

查询指定超节点下的所有节点实例列表接口用于获取用户名下指定超节点所有Lite Server实例的详细信息。该接口适用于以下场景：用户需要查看其指定超节点下的所有Lite Server实例的状态、配置等信息，以便进行资源管理。使用该接口的前提条件是用户已登录且具有查询指定超节点下的所有节点实例列表接口的权限。调用此接口后，系统将返回指定超节点下所有Lite Server实例的列表，包括实例ID、名称、状态、创建时间等信息。若用户无权限或未登录，接口将返回相应的错误信息。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：用户项目ID。获取方法请参见获取项目ID和名称。约束限制：不涉及。取值范围：1~64个字符，只能由字母、数字和中划线组成。默认取值：不涉及。
id	是	String	参数解释：Lite Server超节点实例ID。约束限制：^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$。取值范围：不涉及。默认取值：不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数
参数	参数类型	描述
current	Integer	参数解释：当前页数。取值范围：1 - 2097152
data	Array of ServerResponse objects	参数解释：Lite Server实例列表，列表中的每个元素为一个ServerResponse对象，包含实例的详细信息。
pages	Integer	参数解释：总的页数。取值范围：1 - 2097152
size	Integer	参数解释：每一页的数量，单位为条。设置查询时每页返回的最大实例数量，此值将直接影响到返回数据的量。调整此值可以优化查询性能或提高单次请求的信息量。取值范围：1 - 1024
total	Long	参数解释：总的记录数量，单位为条。表示当前查询条件下，满足条件的实例总数。此字段用于用户了解数据的整体规模。取值范围：1 - 2147483647

表3 ServerResponse
参数	参数类型	描述
create_at	Long	参数解释：创建时间，Unix时间戳，单位为毫秒。取值范围：不涉及。
update_at	Long	参数解释：更新时间，Unix时间戳，单位为毫秒。取值范围：不涉及。
charging_mode	String	参数解释：计费模式。取值范围： POST_PAID：按需（后付费） PRE_PAID：包周期（预付费）
cloud_server	CloudServer object	参数解释：云服务信息。
flavor	String	参数解释：实例规格名称。取值范围：1~128个字符。
id	String	参数解释：实例ID。取值范围：UUID格式，格式为xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx，其中x为十六进制数字。
key_pair_name	String	参数解释：密钥对名称。取值范围：由字母、数字、中划线、下划线和点号组成，长度1~64个字符。
name	String	参数解释：实例名称。取值范围：由字母、数字、中划线、下划线和点号组成，长度1~64个字符。
order_id	String	参数解释：订单ID，创建包周期的LiteServer服务器时返回该参数。取值范围：由字母和数字组成，长度1~64个字符。
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。取值范围：UUID格式，格式为xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx，其中x为十六进制数字。
endpoints	Array of EndpointsRes objects	参数解释：服务器私有IP信息，列表中的每个元素为一个EndpointsRes对象，包含访问途径和私有IP地址等信息。
volumes	Array of ServerVolume objects	参数解释：挂载硬盘信息，列表中的每个元素为一个ServerVolume对象，包含硬盘大小、类型和EVS盘信息等。
image	ServerImageResponse object	参数解释：服务器镜像信息。
category	String	参数解释：服务器归属类型。取值范围： HPS：超节点服务器 SPOD：整柜服务器 SERVER：单台服务器
server_hps	ServerHpsInfo object	参数解释：服务器归属超节点信息。
subnet_id	String	参数解释：实例所在子网的ID。取值范围：UUID格式，格式为xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx，其中x为十六进制数字。

表4 CloudServer
参数	参数类型	描述
id	String	参数解释：服务器资源id，或超节点子节点id。取值范围：UUID格式，格式为xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx，其中x为十六进制数字。
type	String	参数解释：Lite Server服务器类型。取值范围： BMS：裸金属服务器 ECS：弹性云服务器 HPS：超节点服务器
hps_id	String	参数解释：服务器所属的超节点资源id。取值范围：UUID格式，格式为xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx，其中x为十六进制数字。
hps_ecs_id	String	参数解释：超节点子节点对应服务器资源id。取值范围：UUID格式，格式为xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx，其中x为十六进制数字。

表5 EndpointsRes
参数	参数类型	描述
dev_service	String	参数解释：访问Notebook的途径。取值范围：枚举类型，取值如下： NOTEBOOK：可以通过https协议访问Notebook。 SSH：可以通过SSH协议远程连接Notebook。
service	String	参数解释：访问Notebook的途径。与dev_service的区别：service用于响应中标识访问方式，dev_service用于请求中指定服务类型。取值范围：枚举类型，取值如下： NOTEBOOK：可以通过https协议访问Notebook。 SSH：可以通过SSH协议远程连接Notebook。
uri	String	参数解释：实例的访问URI，格式为私有IP地址。取值范围：不涉及。
key_pair_names	Array of strings	参数解释：SSH密钥对名称列表，允许设置多个密钥对实现同时对SSH实例的访问。取值范围：不涉及。
extensions	Map<String,String>	参数解释：通过应用专属URL直接打开应用进入远程开发模式。包含应用的各种扩展配置。key表示扩展配置名称，value表示扩展配置值。

表6 ServerVolume
参数	参数类型	描述
size	Integer	参数解释：EVS盘大小，单位GB。表示分配给系统盘的存储空间大小。取值范围：100 - 1024
type	String	参数解释：存储类型。表示系统盘或数据盘。取值范围： ROOT：系统盘 DATA：数据盘
evs_type	String	参数解释：EVS盘类型。表示EVS盘的存储类型。取值范围： ESSD：极速型SSD云硬盘 GPSSD：通用型SSD云硬盘 SAS：高IO云硬盘 SATA：普通IO云硬盘 SSD：超高IO云硬盘
evs_id	String	参数解释：EVS盘的ID。取值范围：UUID格式，格式为xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx，其中x为十六进制数字。

表7 ServerImageResponse
参数	参数类型	描述
arch	String	参数解释：服务器镜像架构类型。取值范围： ARM：ARM架构，适用于移动端和嵌入式场景 X86：X86架构，适用于通用计算场景
image_id	String	参数解释：服务器镜像ID。取值范围：UUID格式，格式为xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx，其中x为十六进制数字。
name	String	参数解释：服务器镜像名称。表示服务器镜像的名称。取值范围：1 - 256字符
server_type	String	参数解释：服务器类型。取值范围： BMS：裸金属服务器 ECS：弹性云服务器 HPS：超节点服务器
status	String	参数解释：服务器镜像状态。取值范围： ACTIVE：镜像可用 INACTIVE：镜像不可用

表8 ServerHpsInfo
参数	参数类型	描述
id	String	参数解释：Lite Server超节点实例id。取值范围：UUID格式，格式为xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx，其中x为十六进制数字。
name	String	参数解释：Lite Server超节点名称。取值范围：由字母、数字、中划线、下划线和点号组成，长度1~64个字符。

请求示例

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

响应示例

状态码：200

{
  "current" : 1,
  "data" : [ {
    "create_at" : 1785427152,
    "update_at" : 1785427152,
    "charging_mode" : "PRE_PAID",
    "cloud_server" : {
      "id" : "a9779885-3299-4bd7-8b4c-8a7e101859e8",
      "type" : "ECS"
    },
    "endpoints" : [ {
      "service" : "SSH",
      "uri" : "xxx.xxx.xxx.xxx",
      "extensions" : {
        "xxxx" : "xxxx"
      },
      "key_pair_names" : [ "KeyPair_123", "KeyPair_124" ]
    } ],
    "flavor" : "modelarts.vm.cpu.2u",
    "id" : "a9779885-3299-4bd7-8b4c-8a7e101859e7",
    "key_pair_name" : "KeyPair_123",
    "name" : "liteserver-123",
    "order_id" : "CS26070709223100A"
  } ],
  "pages" : 1,
  "size" : 10,
  "total" : 1
}

状态码

状态码	描述
200	参数解释：查询到的server列表。默认取值：不涉及。

错误码

请参见错误码。

父主题： 轻量算力节点

上一篇：查询超节点Operation详情 - GetHyperinstanceOperation

下一篇：删除hyperinstance-group - DeleteHyperinstanceGroup