DescribeImageInfos - 查询可以使用的镜像资源

更新时间:
复制 MD 格式

查询可以使用的镜像资源。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ens:DescribeImageInfos

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

OsType

string

系统类型,仅支持传单个类型。不传值,默认查询全部。 取值:

  • Linux

  • windows

治理实测中,传入 linux 或 Linux 均返回空列表,而省略该参数可返回 OSType 为 linux 的镜像;依赖该筛选条件前请核对实际返回结果。

linux

返回参数

名称

类型

描述

示例值

object

Code

integer

返回码。

0

Images

object

Image

array<object>

镜像信息集合。

array<object>

图片信息列表。

Description

string

镜像描述信息。

centos_6_08_64_20G_alibase_2017****

ImageId

string

镜像 ID。

centos_6_08_64_20G_alibase_2017****

ImageSize

string

镜像大小,单位:GiB。

20

ImageVersion

string

镜像版本。

6.8

OSName

string

镜像类型。 取值:centosdebianubuntuwindows

centos

OSType

string

系统类型。

linux

ComputeType

string

镜像计算类型。取值:

  • ens_vm:X86 计算

  • arm_vm:ARM 计算

  • bare_metal:X86 裸机

  • pcfarm:异构计算

枚举值:

  • ens_vm :

    X86 计算

  • arm_vm :

    ARM 计算

  • bare_metal :

    X86 裸机

  • pcfarm :

    异构计算

ens_vm

DiskDeviceMappings

object

DiskDeviceMapping

array<object>

镜像下包含云盘和快照的映射关系。

object

镜像下包含云盘和快照的映射关系。

Type

string

磁盘类型。 系统盘:Sysem,数据盘:Data。

Data

Size

string

镜像大小,单位:GB。

100

Format

string

镜像格式。

raw qcow2

imageId

string

镜像 ID。

i-test

RegionId

string

地区 ID。

cn-wulanchabu

ImageOwnerAlias

string

镜像所有者别名。

system

RequestId

string

请求 ID。

5568A08C-10A9-47F3-902F-647298B463FB

示例

正常返回示例

JSON格式

{
  "Code": 0,
  "Images": {
    "Image": [
      {
        "Description": "centos_6_08_64_20G_alibase_2017****",
        "ImageId": "centos_6_08_64_20G_alibase_2017****",
        "ImageSize": "20",
        "ImageVersion": "6.8",
        "OSName": "centos",
        "OSType": "linux",
        "ComputeType": "ens_vm",
        "DiskDeviceMappings": {
          "DiskDeviceMapping": [
            {
              "Type": "Data",
              "Size": "100",
              "Format": "raw\nqcow2",
              "imageId": "i-test"
            }
          ]
        },
        "RegionId": "cn-wulanchabu",
        "ImageOwnerAlias": "system"
      }
    ]
  },
  "RequestId": "5568A08C-10A9-47F3-902F-647298B463FB"
}

错误码

HTTP status code

错误码

错误信息

描述

400 MissingParameter The input parameter domainName that is mandatory for processing this request is not supplied.
400 InstanceIdNotFound The input parameter instancdId that is not found. 指定的实例ID不存在。
400 NoPermission Permission denied.
400 CallInterface Call Interface Happen Error. 接口调用出错。
400 InvalidParameter.%s The specified field %s invalid. Please check it again.

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

变更历史

更多信息,参考变更详情