调用DescribeImages查询镜像的详细信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeImages

系统规定参数。取值：DescribeImages。
RegionId String 是 cn-hangzhou

地域ID。
MaxResults Integer 否 10

分页查询时每页行数。

最大值：100

默认值：10
NextToken String 否 caeba0bbb2be03f84eb48b699f0a4883

下一个查询开始的Token，NextToken为空表示没有下一个。
ImageType String 否 SYSTEM

镜像类型。取值范围：

  • SYSTEM：系统镜像
  • CUSTOM：自定义镜像
ImageStatus String 否 Available

镜像状态。取值范围：

  • Creating：创建中
  • Available：可用
  • CreateFailed：创建失败
ImageId.N RepeatList 否 m-gx2x1dhsmusr2****

镜像ID。可设置一个或多个。
GpuCategory Boolean 否 false

是否为GPU类型镜像。

返回数据

名称 类型 示例值 描述
Images Array of Image

镜像信息组成的集合。
CreationTime String 2018-01-10T01:01:10Z

镜像的创建时间。
DataDiskSize Integer 150

数据盘大小。单位：GiB。
Description String This is description.

镜像描述。
GpuCategory Boolean false

是否为GPU类型镜像。
ImageId String m-gx2x1dhsmusr2****

镜像ID。
ImageType String SYSTEM

镜像类型。可能值：

  • SYSTEM：系统镜像
  • CUSTOM：自定义镜像
Name String testImageName

镜像名称。
OsType String WINDOWS

操作系统类型。
Progress String 100%

镜像创建完成的进度。单位：%。
Size Integer 40

镜像大小。单位：GiB。
Status String Available

镜像状态。可能值：

  • Creating：创建中
  • Available：可用
  • CreateFailed：创建失败
NextToken String caeba0bbb2be03f84eb48b699f0a4883

下一个查询开始的Token，NextToken为空表示没有下一个。
RequestId String 4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB

请求ID。

示例

请求示例

https://ecd.cn-hangzhou.aliyuncs.com/?Action=DescribeImages
&MaxResults=10
&ImageId.1=m-gx2x1dhsmusr2****
&<公共请求参数>

正常返回示例

XML格式 

<DescribeImagesResponse>
      <RequestId>4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB</RequestId>
      <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
      <Images>
            <Status>Available</Status>
            <Progress>100%</Progress>
            <Description>This is description.</Description>
            <OsType>WINDOWS</OsType>
            <Size>40</Size>
            <GpuCategory>false</GpuCategory>
            <ImageId>m-gx2x1dhsmusr2****</ImageId>
            <CreationTime>2018-01-10T01:01:10Z</CreationTime>
            <DataDiskSize>150</DataDiskSize>
            <Name>testImageName</Name>
            <ImageType>SYSTEM</ImageType>
      </Images>
</DescribeImagesResponse>

JSON格式 

{
	"RequestId": "4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB",
	"NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
	"Images": [{
		"Status": "Available",
		"Progress": "100%",
		"Description": "This is description.",
		"OsType": "WINDOWS",
		"Size": "40",
		"GpuCategory": "false",
		"ImageId": "m-gx2x1dhsmusr2****",
		"CreationTime": "2018-01-10T01:01:10Z",
		"DataDiskSize": "150",
		"Name": "testImageName",
		"ImageType": "SYSTEM"
	}]
}

错误码

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