You can call this operation to query the details of images.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeImages

The operation that you want to perform. Set the value to DescribeImages.

RegionId String Yes cn-hangzhou

The region ID.

MaxResults Integer No 10

The number of entries to return on each page.

Maximum value: 100.

Default value: 10.

NextToken String No caeba0bbb2be03f84eb48b699f0a4883

The token used to start the next query. If this parameter is empty, all results are returned.

ImageType String No SYSTEM

The type of the image. Valid values:

  • SYSTEM: system image
  • CUSTOM: custom image
ImageStatus String No Available

The status of the image. Valid values:

  • Creating: The image is being created.
  • Available: The image is available.
  • CreateFailed: The image fails to be created.
ImageId.N RepeatList No m-gx2x1dhsmusr2****

The ID of image N. You can specify one or more image IDs.

GpuCategory Boolean No false

Specifies whether the image is a GPU-accelerated image.

Response parameters

Parameter Type Example Description
Images Array of Image

Details about the images.

CreationTime String 2018-01-10T01:01:10Z

The time when the image was created.

DataDiskSize Integer 150

The size of the data disk. Unit: GiB.

Description String This is description.

The description of the image.

GpuCategory Boolean false

Indicates whether the image is a GPU-accelerated image.

ImageId String m-gx2x1dhsmusr2****

The ID of the image.

ImageType String SYSTEM

The type of the image. Valid values:

  • SYSTEM: system image
  • CUSTOM: custom image
Name String testImageName

The name of the image.

OsType String WINDOWS

The type of the operating system.

Progress String 100%

The progress of image creation. Unit: percent (%).

Size Integer 40

The size of the image. Unit: GiB.

Status String Available

The status of the image. Valid values:

  • Creating: The image is being created.
  • Available: The image is available.
  • CreateFailed: The image fails to be created.
NextToken String caeba0bbb2be03f84eb48b699f0a4883

The token used to start the next query. If this parameter is empty, all results are returned.

RequestId String 4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB

The ID of the request.

Examples

Sample requests

https://ecd.cn-hangzhou.aliyuncs.com/?Action=DescribeImages
&MaxResults=10
&ImageId.1=m-gx2x1dhsmusr2****
&<Common request parameters>

Sample success responses

XML format

<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 format

{
	"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"
	}]
}

Error codes

For a list of error codes, visit the API Error Center.