查询Lite Server镜像列表 - ListDevServerImages
功能介绍
查询Lite Server镜像列表接口用于获取系统中所有可用的Lite Server镜像信息。该接口适用于以下场景：当用户需要了解可用的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/images
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释：用户项目ID。获取方法请参见获取项目ID和名称。 约束限制：1 - 64字符，字母、数字和中划线。 取值范围：不涉及。 默认取值：不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
server_type |
否 |
String |
参数解释：server_type。 约束限制：不涉及。 取值范围：
默认取值：不涉及。 |
|
flavor_name |
否 |
String |
参数解释：规格名称。 约束限制：^.{1,128}$。 取值范围：不涉及。 默认取值：不涉及。 |
请求参数
无
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
current |
Integer |
参数解释：当前页数。 取值范围：不涉及。 |
|
data |
Array of ServerImageResponse objects |
参数解释：Lite Server镜像列表。 |
|
pages |
Integer |
参数解释：总的页数。 取值范围：不涉及。 |
|
size |
Integer |
参数解释：每一页的数量。 取值范围：不涉及。 |
|
total |
Long |
参数解释：总的记录数量。 取值范围：不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
arch |
String |
参数解释：服务器镜像架构类型。 取值范围：
|
|
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 |
参数解释：服务器类型。 取值范围：
|
|
status |
String |
参数解释：服务器镜像状态。 取值范围：
|
请求示例
GET http://{endpoint}/v1/{project_id}/dev-servers/images
响应示例
状态码：200
OK
{
"current" : 1,
"data" : [ {
"arch" : "ARM",
"image_id" : "d7811cdb-b0c6-44fe-9931-1f3b2b6ef477",
"name" : "ModelArts_Lite Server-Euler2.8_aarch64_CPU-20220913175531",
"server_type" : "ECS",
"status" : "ACTIVE"
}, {
"arch" : "X86",
"image_id" : "83f4aa72-53ec-4806-85b5-3f84082ba964",
"name" : "ModelArts_Lite Server-custom_x86_64_NPU-20230207093857",
"server_type" : "ECS",
"status" : "ACTIVE"
} ],
"pages" : 1,
"size" : 2,
"total" : 21
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。
