GET /image/{uuid}
/image/{uuid}
UUID of the object to fetch
object name
List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
Default values are not set.
It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Avi Tenant Header
Avi Tenant Header UUID
The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.
Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.
OK
{
"_last_modified": "string",
"cloud_info_values": [
{
"cloud_data_values": [
{
"key": "string",
"values": [
"string"
]
}
],
"cloud_name": "string"
}
],
"controller_info": {
"build": {
"build_no": 0,
"date": "string",
"min_version": "string",
"patch_version": "string",
"product": "string",
"product_name": "string",
"remote_image_ref": "string",
"tag": "string",
"version": "string"
},
"hash": "string",
"patch": {
"patch_type": "string",
"reboot": false,
"reboot_list": [
{
"patch_version": "string",
"reboot": false
}
]
},
"path": "string"
},
"controller_patch_name": "string",
"controller_patch_ref": "string",
"duration": 0,
"end_time": "string",
"events": [
{
"nodes_events": [
{
"duration": 0,
"end_time": "string",
"ip": {
"addr": "string",
"type": "string"
},
"message": "string",
"start_time": "string",
"status": "string",
"sub_tasks": [
"string"
]
}
],
"sub_events": [
{
"duration": 0,
"end_time": "string",
"ip": {
"addr": "string",
"type": "string"
},
"message": "string",
"start_time": "string",
"status": "string",
"sub_tasks": [
"string"
]
}
],
"task_name": "string"
}
],
"fips_mode_transition_applicable": false,
"img_state": {
"last_changed_time": {
"secs": 0,
"usecs": 0
},
"reason": "string",
"state": "string"
},
"migrations": {
"api_version": "string",
"controller_host_min_free_disk_size": 0,
"controller_min_cores": 0,
"controller_min_docker_version": "string",
"controller_min_free_disk_size": 0,
"controller_min_memory": 0,
"controller_min_total_disk": 0,
"max_active_versions": 0,
"min_supported_api_version": "string",
"podman_controller_host_min_free_disk_size": 0,
"podman_se_host_min_free_disk_size": 0,
"rollback_controller_disk_space": 0,
"rollback_se_disk_space": 0,
"se_host_min_free_disk_size": 0,
"se_min_cores": 0,
"se_min_free_disk_size": 0,
"se_min_memory": 0,
"se_min_total_disk": 0,
"versions": [
"string"
]
},
"name": "string",
"progress": 0,
"se_info": {
"build": {
"build_no": 0,
"date": "string",
"min_version": "string",
"patch_version": "string",
"product": "string",
"product_name": "string",
"remote_image_ref": "string",
"tag": "string",
"version": "string"
},
"hash": "string",
"patch": {
"patch_type": "string",
"reboot": false,
"reboot_list": [
{
"patch_version": "string",
"reboot": false
}
]
},
"path": "string"
},
"se_patch_name": "string",
"se_patch_ref": "string",
"start_time": "string",
"tasks_completed": 0,
"tenant_ref": "string",
"total_tasks": 0,
"type": "string",
"uber_bundle": false,
"url": "string",
"uuid": "string"
}UNIX time since epoch in microseconds. Units(MICROSECONDS).
This field describes the cloud info specific to the base image. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
controller_info
Mandatory Controller patch name that is applied along with this base image. Field introduced in 18.2.10, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
It references the controller-patch associated with the Uber image. It is a reference to an object of type Image. Field introduced in 18.2.8, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Time taken to upload the image in seconds. Field introduced in 21.1.3. Unit is SEC. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
Image upload end time. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
Image events for image upload operation. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
Specifies whether FIPS mode can be enabled on this image. Field introduced in 30.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
img_state
migrations
Name of the image. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Image upload progress which holds value between 0-100. Allowed values are 0-100. Field introduced in 21.1.3. Unit is PERCENT. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
se_info
Mandatory ServiceEngine patch name that is applied along with this base image. Field introduced in 18.2.10, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
It references the Service Engine patch associated with the Uber Image. It is a reference to an object of type Image. Field introduced in 18.2.8, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Image upload start time. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
Completed set of tasks for Image upload. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
Tenant that this object belongs to. It is a reference to an object of type Tenant. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Total number of tasks for Image upload. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
Type of the image patch/system. Enum options - IMAGE_TYPE_PATCH, IMAGE_TYPE_SYSTEM, IMAGE_TYPE_MUST_CHECK. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
Status to check if the image is an uber bundle. Field introduced in 18.2.8, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url
UUID of the image. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
log in failed
curl -H 'Authorization: <value>' https://{api_host}/api/image/{uuid}