You can call this operation to query available custom images that are newly created in a specific image family.
Operation description
Description
- This API operation only returns the available custom images that are newly created in the specified image family. Public images, Alibaba Cloud Marketplace images, community images, or shared images are not queried.
- If no available custom images exist in the specified image family, the response is empty.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ecs:DescribeImageFromFamily | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID of the image. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
| ImageFamily | string | Yes | The name of the image family. The name must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores (_), and hyphens (-). It must start with a letter and cannot start with http://, https://, acs:, or aliyun. | hangzhou-daily-update |
Response parameters
Examples
Sample success responses
JSONformat
{
"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. | The account you are currently using does not have permission. |
| 404 | InvalidRegionId.NotFound | The RegionId provided does not exist. | The specified region does not exist. |
For a list of error codes, visit the Service error codes.