ListAvailableImages - 查询可用镜像列表

获取E-HPC集群可用镜像列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ImageOwnerAliasstring

镜像来源。取值范围:

  • system:系统镜像。
  • self:自定义镜像。
  • others:共享镜像。
self
InstanceTypestring

指定查询的实例规格。

说明 如果不指定实例规格,则默认查询所有实例规格支持的镜像列表。更多信息,请参见 ECS 实例规格族
ecs.c7.large
IsPublicboolean

是否查询已发布的社区镜像。取值范围:

  • true:查询已发布的社区镜像。当您指定该参数值为true时,ImageOwnerAlias必须为others
  • false:查询除社区镜像的其他镜像类型,具体以ImageOwnerAlias参数值为准。

默认值:false。

true
HPCInterConnectstring

网络互联类型。

vpc
EnableHTboolean

是否开启超线程。

true
Schedulerobject

调度器详细信息。

Typestring

调度器类型。

SLURM
Versionstring

调度器版本。

22.05.8
DirectoryServiceobject

域账户服务详细信息。

Typestring

域账户类型。

NIS
Versionstring

域账户版本。

1.0
PageNumberinteger

当前页码。

1
PageSizeinteger

分页查询时设置的每页行数。 取值范围:1~50。 默认值:10。

1

返回参数

名称类型描述示例值
object

返回参数集合。

RequestIdstring

请求 ID。

04F0F334-1335-436C-A1D7-6C044FE73368
TotalCountstring

返回条目数量。

1
PageSizestring

每页行数。

20
PageNumberstring

当前页码。

  • 起始值为 1。
  • 默认值为 1。
1
Successboolean

执行命令并获取结果的过程是否成功。可能值:

  • true:成功。
  • false:失败。
true
Imagesarray<object>

镜像信息。

Imageobject

镜像信息。

ImageIdstring

镜像 ID。

centos_7_06_64_20G_alibase_2019071****
OSNameEnstring

操作系统的英文名称。

CentOS 7.9 64 bit
ImageOwnerAliasstring

镜像来源。可能值:

  • system:系统镜像。

  • self:自定义镜像。

  • others:共享镜像。

self
Descriptionstring

镜像描述。

ExampleDescription
Sizestring

镜像大小。单位:GiB

40
Platformstring

操作系统平台。可能值:

  • CentOS
  • windows
windows
OSNamestring

操作系统的中文名称。

CentOS 7.9 64位
Architecturestring

操作系统架构。可能值:

  • x86_64
  • arm64
x86_64
BootModestring

镜像的启动模式。可能值:

  • BIOS:BIOS 启动模式。
  • UEFI:UEFI 启动模式。
说明 您需要了解指定的镜像支持的启动模式,当通过该参数修改启动模式后,必须与镜像本身支持的启动模式匹配,实例才能正常启动。
BIOS
ImageNamestring

镜像名称。

CHESS5V5.0.27

示例

正常返回示例

JSON格式

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "TotalCount": "1",
  "PageSize": "20",
  "PageNumber": "1",
  "Success": true,
  "Images": [
    {
      "ImageId": "centos_7_06_64_20G_alibase_2019071****",
      "OSNameEn": "CentOS  7.9 64 bit",
      "ImageOwnerAlias": "self",
      "Description": "ExampleDescription",
      "Size": "40",
      "Platform": "windows",
      "OSName": "CentOS  7.9 64位",
      "Architecture": "x86_64",
      "BootMode": "BIOS",
      "ImageName": "CHESS5V5.0.27"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400InvalidParamsThe specified parameter %s is invalid.指定的参数 %s 无效。
500UnknownErrorAn unknown error occurred.未知错误
503ServiceUnavailableThe request has failed due to a temporary failure of the server请求失败,服务暂时不可用

访问错误中心查看更多错误码。