全部产品
Search
文档中心

轻量应用服务器:ListImages - 获取镜像列表

更新时间:May 23, 2024

查询指定地域下一个或多个镜像信息。

接口说明

您可以查询指定地域下一个或多个镜像信息,包括镜像的 ID、镜像名称、镜像类型等。

QPS 限制

本接口的单用户 QPS 限制为 10 次/分钟。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
swas-open:ListImagesRead
  • 全部资源
    *

请求参数

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

地域 ID。您可以调用 ListRegions 查询轻量应用服务器的可用地域。

cn-hangzhou
ImageIdsstring

镜像 ID。取值可以由一个或多个镜像 ID 组成一个 JSON 数组。格式为["xxx", "yyy", … "zzz"]。支持最多 50 个 ID,用半角逗号字符隔开。

["fe9c66133a9d4688872869726b52****", "794c230fd3e64ea19f83f4d7a0ad****"]
ImageTypestring

镜像类型。取值范围:

  • system:系统镜像
  • app:应用镜像
  • custom:自定义镜像
system

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

20758A-585D-4A41-A9B2-28DA8F4F534F
Imagesobject []

镜像信息组成的数组。

ImageTypestring

镜像类型。可能值:

  • system:系统镜像
  • app:应用镜像
  • custom:自定义镜像
app
Descriptionstring

描述信息。

WordPress是博客和内容管理网站的工具平台,借助第三方开发的模板、插件,用户可实现多样化的个性化功能。该镜像基于CentOS 7.3 64位操作系统。
ImageNamestring

镜像名称。

WordPress-4.8.1
ImageIdstring

镜像 ID。

794c230fd3e64ea19f83f4d7a0ad****
Platformstring

镜像所使用的操作系统类型。可能值:

  • Linux:Linux 系统

  • Windows:Windows 系统

Linux

示例

正常返回示例

JSON格式

{
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "Images": [
    {
      "ImageType": "app",
      "Description": "WordPress是博客和内容管理网站的工具平台,借助第三方开发的模板、插件,用户可实现多样化的个性化功能。该镜像基于CentOS 7.3 64位操作系统。",
      "ImageName": "WordPress-4.8.1",
      "ImageId": "794c230fd3e64ea19f83f4d7a0ad****",
      "Platform": "Linux"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400InvalidImageType.ValueNotSupportedThe specified parameter ImageType is invalid.指定的镜像类型不合法。
403InvalidParamThe specified parameter value is invalid.参数非法。
500InternalErrorAn error occurred while processing your request.内部错误,请重试。如果多次尝试失败,请提交工单。

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

变更历史

变更时间变更内容概要操作
2023-09-18OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:500