Use DescribeImageFromFamily to query the most recent image from an image family - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Queries the latest available image in a specified image family.

Operation description

If no available image exists in the specified image family, the response is empty.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:DescribeImageFromFamily

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the image. You can call DescribeRegions to query the most recent region list.	cn-hangzhou
ImageFamily	string	Yes	The name of the image family. Custom images, public images, community images, and shared images all support image families. For more information, see Image family overview.	hangzhou-daily-update

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Image	object	The image information.
CreationTime	string	The time when the image was created. The time follows the ISO 8601 standard in UTC.	2018-01-10T01:01:10Z
Status	string	The status of the image. Valid values: UnAvailable: unavailable Available: available Creating: being created CreateFailed: failed to be created	Available
ImageFamily	string	The image family.	testImageFamily
Progress	string	The image creation progress, in percent.	100
IsCopied	boolean	Indicates whether the image is a copy of another image.	false
IsSupportIoOptimized	boolean	Indicates whether the image can be used on I/O optimized instances.	true
ImageOwnerAlias	string	The alias of the image owner. Valid values: system: public image. self: your custom image. others: public image of another user. marketplace: Alibaba Cloud Marketplace image.	self
IsSupportCloudinit	boolean	Indicates whether cloud-init is supported.	true
ImageVersion	string	The image version.	2
Usage	string	The type of resource to which the image is associated. Valid values: instance: one or more ECS instances have been created from the image. none: no ECS instances have been created from the image.	none
IsSelfShared	string	Indicates whether the custom image has been shared with other users.	true
Description	string	The description of the image.	testDescription
Size	integer	The size of the image. Unit: GiB.	80
Platform	string	The operating system platform.	Aliyun
ImageName	string	The name of the image.	testImageName
OSName	string	The China-locale display name of the operating system.	Alibaba Cloud Linux 2.1903
ImageId	string	The image ID.	m-bp1g7004ksh0oeuc****
OSType	string	The type of the operating system. Valid values: windows linux	linux
IsSubscribed	boolean	Indicates whether you have subscribed to the Terms of Service for the image product that corresponds to the product code.	false
ProductCode	string	The product code of the Alibaba Cloud Marketplace image.	jxsc00****
Architecture	string	The system architecture type of the image. Valid values: i386 x86_64	x86_64
DiskDeviceMappings	object
DiskDeviceMapping	array<object>	The mappings between disks and snapshots in the image.
	object
Type	string	The type of the image.	custom
ImportOSSBucket	string	The OSS bucket that contains the imported image.	testEcsImport
SnapshotId	string	The snapshot ID.	s-bp17ot2q7x72ggtw****
ImportOSSObject	string	The OSS object that corresponds to the imported image.	imageImport
Size	string	The size of the disk. Unit: GiB.	80
Device	string	The device information of the disk, such as /dev/xvdb. Note This parameter will be deprecated. To ensure compatibility, do not use this parameter.	/dev/xvdb
Format	string	The format of the image.	qcow2
Tags	object
Tag	array<object>	The tag key-value pairs of the image.
	object
TagValue	string	The tag value of the custom image.	TestValue
TagKey	string	The tag key of the custom image.	TestKey

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Image": {
    "CreationTime": "2018-01-10T01:01:10Z",
    "Status": "Available",
    "ImageFamily": "testImageFamily",
    "Progress": "100",
    "IsCopied": false,
    "IsSupportIoOptimized": true,
    "ImageOwnerAlias": "self",
    "IsSupportCloudinit": true,
    "ImageVersion": "2",
    "Usage": "none",
    "IsSelfShared": "true",
    "Description": "testDescription",
    "Size": 80,
    "Platform": "Aliyun",
    "ImageName": "testImageName",
    "OSName": "Alibaba Cloud Linux 2.1903",
    "ImageId": "m-bp1g7004ksh0oeuc****",
    "OSType": "linux",
    "IsSubscribed": false,
    "ProductCode": "jxsc00****",
    "Architecture": "x86_64",
    "DiskDeviceMappings": {
      "DiskDeviceMapping": [
        {
          "Type": "custom",
          "ImportOSSBucket": "testEcsImport",
          "SnapshotId": "s-bp17ot2q7x72ggtw****",
          "ImportOSSObject": "imageImport",
          "Size": "80",
          "Device": "/dev/xvdb",
          "Format": "qcow2"
        }
      ]
    },
    "Tags": {
      "Tag": [
        {
          "TagValue": "TestValue",
          "TagKey": "TestKey"
        }
      ]
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	InvalidUser.Unauthorized	The user is not authorized.
404	InvalidRegionId.NotFound	The RegionId provided does not exist.	The specified region does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.