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
There is currently no authorization information disclosed in the API.
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
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. | 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.