# 查询用户所有Lite Server实例列表 - ListDevServers #### 功能介绍 查询用户所有Lite Server实例列表接口用于获取用户名下所有Lite Server实例的详细信息。该接口适用于以下场景：用户需要查看其所有Lite Server实例的状态、配置等信息，以便进行资源管理和监控。使用该接口的前提条件是用户已登录且具有查看Lite Server实例的权限。调用此接口后，系统将返回用户名下所有Lite Server实例的列表，包括实例ID、名称、状态、创建时间等信息。若用户无权限或未登录，接口将返回相应的错误信息。 #### 接口约束 暂无约束。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ModelArts/doc?api=ListDevServers)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-modelarts/modelarts_03_0138.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v1/{project_id}/dev-servers 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释** ：用户项目ID。获取方法请参见[获取项目ID和名称](https://support.huaweicloud.com/api-modelarts/modelarts_03_0147.html)。 **约束限制**：不涉及。 **取值范围**：1 - 64字符，字母、数字和中划线。 **默认取值**：不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | owner | 否 | String | **参数解释**：实例归属的用户ID。 **约束限制**：仅在大账号或有admin权限场景下生效，值通常为当前登录用户ID。 **取值范围**：1 - 64字符，小写字母、数字和中划线。 **默认取值**：不涉及。 | | sort_dir | 否 | String | **参数解释**：排序方式。 **约束限制**：不涉及。 **取值范围**： - ASC：升序排序 - DESC：降序排序 **默认取值**：ASC。 | | sort_key | 否 | String | **参数解释**：排序字段。 **约束限制**：不涉及。 **取值范围**： - createTime：创建时间 - updateTime：更新时间 **默认取值**：createTime。 | | limit | 否 | Integer | **参数解释**：每一页的数量，单位为条。 **约束限制**：不涉及。 **取值范围**：0 - 1024条 **默认取值**：10。 | | offset | 否 | Integer | **参数解释**：分页记录的起始位置偏移量。 **约束限制**：不涉及。 **取值范围**：0 - 2147483647 **默认取值**：0。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应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 | 表4ServerResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | create_at | Long | **参数解释**：创建时间，Unix时间戳，单位为毫秒。 **取值范围**：不涉及。 | | update_at | Long | **参数解释**：更新时间，Unix时间戳，单位为毫秒。 **取值范围**：不涉及。 | | charging_mode | String | **参数解释**：计费模式。 **取值范围**： - POST_PAID：按需（后付费） - PRE_PAID：包周期（预付费） | | cloud_server | [CloudServer] object | **参数解释**：云服务信息。 | | endpoints_response | Array of [Endpoints] objects | **参数解释**：实例私有IP信息，列表中的每个元素为一个Endpoints对象，包含支持的服务类型和访问方式等信息。 | | 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为十六进制数字。 | 表5CloudServer | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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为十六进制数字。 | 表6Endpoints | 参数 | 参数类型 | 描述 | |:---|:---|:---| | dev_service | String | **参数解释**：支持的服务。与EndpointsRes中dev_service的区别：此处dev_service用于请求中指定服务类型，EndpointsRes中dev_service用于响应中标识访问方式。 **取值范围**： - NOTEBOOK：可以通过https协议访问Notebook - SSH：可以通过SSH协议远程连接Notebook | | extensions | Map\ | **参数解释**：通过应用专属URL直接打开应用进入远程开发模式。包含应用的各种扩展配置。key表示扩展配置名称，value表示扩展配置值。 | | ssh_keys | Array of strings | **参数解释**：SSH密钥对名称列表，最多可包含1024个密钥对。允许设置多个密钥对实现同时对SSH实例的访问。 | 表7EndpointsRes | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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实例的访问。 **取值范围**：不涉及。 | 表8ServerVolume | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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为十六进制数字。 | 表9ServerImageResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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：镜像不可用 | 表10ServerHpsInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 ``` #### 响应示例 **状态码：200** ``` { "current" : 0, "data" : [ { "charging_mode" : "POST_PAID", "cloud_server" : { "id" : "eb8b4e32-afc9-4f71-8372-1f55f3d7ab28", "type" : "ECS" }, "create_at" : 1699352013484, "endpoints" : [ { "service" : "SSH", "uri" : "xxx.xxx.xxx.xxx" } ], "flavor" : "Si2.large.4", "id" : "c65c4f27-f791-452b-9098-a2726fa2e922", "image" : { "arch" : "X86", "image_id" : "c90fb553-2cdb-4b81-b56a-ef68812c6cf7", "name" : "Ubuntu18.04_x86_64_CPU", "server_type" : "ECS" }, "name" : "EI-evs-01", "status" : "RUNNING", "update_at" : 1699352058465, "vpc_id" : "05982b48-a70f-43a1-a2b0-1fe36a236172" }, { "charging_mode" : "POST_PAID", "cloud_server" : { "type" : "ECS" }, "create_at" : 1699348284990, "flavor" : "Si2.large.4", "id" : "62383738-e52a-450a-9f84-f9e705402be8", "image" : { "arch" : "X86", "image_id" : "c90fb553-2cdb-4b81-b56a-ef68812c6cf7", "name" : "Ubuntu18.04_x86_64_CPU", "server_type" : "ECS" }, "name" : "EI-evs-1107", "status" : "CREATING", "update_at" : 1699348285077 } ], "pages" : 1, "size" : 2, "total" : 2 } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-modelarts/modelarts_03_0095.html)。