Help Center/ Image Management Service/ API Reference/ Native OpenStack APIs/ Image (Native OpenStack APIs)/ Querying Image Details (Native OpenStack API v1.1 - Abandoned and Not Recommended)
Updated on 2024-06-25 GMT+08:00
View PDF
Share

Querying Image Details (Native OpenStack API v1.1 - Abandoned and Not Recommended)

Function

This API is used to query details of images.

This API has been discarded. The image query API (Querying Images (Native OpenStack API)) is recommended.

Windows images can no longer be queried.

URI

GET /v1.1/images/detail

Request

Request parameters

Parameters name, container_format, disk_format, status, size_min, size_max, and changes-since can be used to filter the query result.

Parameter

Mandatory

Type

Description

name

No

String

Specifies the image name. For detailed description, see Image Attributes.

container_format

No

String

Image container type

disk_format

No

String

Image file format

status

No

String

Image status

size_min

No

String

Minimum size of the image

size_max

No

String

Maximum size of the image

changes-since

No

String

Last update time

Example Request

Querying image details

GET https://{Endpoint}/v1.1/images/detail?disk_format=qcow2

Response

  • Response parameters

    Parameter

    Type

    Description

    status

    String

    Image status

    virtual_size

    Integer

    Virtual size of an image

    name

    String

    Specifies the image name. For detailed description, see Image Attributes.

    deleted

    Boolean

    Whether an image has been deleted

    container_format

    String

    Image container type

    created_at

    String

    Time when an image was created

    disk_format

    String

    Image file type

    updated_at

    String

    Time when an image was updated

    properties

    Object

    Image attribute

    owner

    String

    Tenant to which an image belongs

    protected

    Boolean

    Whether an image is protected

    min_ram

    Integer

    Minimum memory (MB) required for running an image

    checksum

    String

    Image verification sum. This parameter is available after an image file is uploaded.

    min_disk

    Integer

    Minimum disk capacity (GB) required for running the image

    is_public

    Boolean

    Whether an image is a public one

    deleted_at

    String

    Time when an image was deleted

    id

    String

    Image UUID

    size

    Integer

    Image size. This parameter is available after an image file is uploaded.
  • Example response 
    HTTP/1.1 200 OK
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
    		 
    Content-Type: application/json; charset=UTF-8
Content-Length: 495
X-Openstack-Request-Id: req-68327dda-8078-41fe-b091-01a09ec073da
Date: Mon, 23 May 2016 02:32:28 GMT
{
    "images": [
        {
            "status": "active",
            "deleted_at": null,
            "name": "cirros",
            "deleted": false,
            "container_format": "bare",
            "created_at": "2016-05-22T06:04:20.425843",
            "disk_format": "qcow2",
            "updated_at": "2016-05-22T06:04:22.719791",
            "min_disk": 0,
            "protected": false,
            "id": "3c3d1d01-b48a-4639-8a88-08be3b9b5d78",
            "min_ram": 0,
            "checksum": "64d7c1cd2b6f60c92c14662941cb7913",
            "owner": "23f4cb75768d4febb39542ef6fe169f3",
            "is_public": true,
            "virtual_size": null,
            "properties": {
            },
            "size": 13167616
        }
    ]
}

Returned Values

  • Normal

    200

  • Abnormal

    Returned Values

    Description

    400 Bad Request

    Request error.

    401 Unauthorized

    Authentication failed.

    403 Forbidden

    You do not have the rights to perform the operation.

    404 Not Found

    The requested resource was not found.

    500 Internal Server Error

    Internal service error.

    503 Service Unavailable

    The service is unavailable.