Updated on 2024-03-01 GMT+08:00

Querying an Image Schema (Native OpenStack API)

Function

This API is used to query the image schema, which allows you to view image attributes and their data types.

URI

GET /v2/schemas/image

Request

Request parameters

None

Example Request

Querying an image schema

GET https://{Endpoint}/v2/schemas/image

Response

  • Response parameters

    Parameter

    Type

    Description

    additionalProperties

    Object

    Specifies the additional attributes.

    For details, see Table 1.

    name

    String

    Specifies the schema name.

    links

    Array of objects

    Specifies the URL for accessing the schema.

    For details, see Table 2.

    properties

    Object

    Describes basic image attributes, including the type and usage of each attribute.

    For details about the parameters, see Image Attributes.

    Table 1 Data structure description of the additionalProperties field

    Parameter

    Type

    Description

    type

    String

    Type

    Table 2 Data structure description of the links field

    Parameter

    Type

    Description

    href

    String

    Specifies the domain name.

    rel

    String

    Specifies the domain name description.

  • Example response
    STATUS CODE 200
      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
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    {
        "additionalProperties": {
            "type": "string"
        },
        "name": "image",
        "links": [
            {
                "href": "{self}",
                "rel": "self"
            },
            {
                "href": "{file}",
                "rel": "enclosure"
            },
            {
                "href": "{schema}",
                "rel": "describedby"
            }
        ],
        "properties": {
            "status": {
                "enum": [
                    "queued",
                    "saving",
                    "active",
                    "killed",
                    "deleted",
                    "pending_delete"
                ],
                "type": "string",
                "description": "Status of the image (READ-ONLY)"
            },
            "tags": {
                "items": {
                    "type": "string",
                    "maxLength": 255
                },
                "type": "array",
                "description": "List of strings related to the image"
            },
            "kernel_id": {
                "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$",
                "type": "string",
                "description": "ID of image stored in Glance that should be used as the kernel when booting an AMI-style image.",
                "is_base": false
            },
            "container_format": {
                "enum": [
                    "ami",
                    "ari",
                    "aki",
                    "bare",
                    "ovf",
                    "ova"
                ],
                "type": "string",
                "description": "Format of the container"
            },
            "min_ram": {
                "type": "integer",
                "description": "Amount of ram (in MB) required to boot image."
            },
            "ramdisk_id": {
                "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$",
                "type": "string",
                "description": "ID of image stored in Glance that should be used as the ramdisk when booting an AMI-style image.",
                "is_base": false
            },
            "locations": {
                "items": {
                    "required": [
                        "url",
                        "metadata"
                    ],
                    "type": "object",
                    "properties": {
                        "url": {
                            "type": "string",
                            "maxLength": 255
                        },
                        "metadata": {
                            "type": "object"
                        }
                    }
                },
                "type": "array",
                "description": "A set of URLs to access the image file kept in external store"
            },
            "visibility": {
                "enum": [
                    "public",
                    "private"
                ],
                "type": "string",
                "description": "Scope of image accessibility"
            },
            "updated_at": {
                "type": "string",
                "description": "Date and time of the last image modification (READ-ONLY)"
            },
            "owner": {
                "type": "string",
                "description": "Owner of the image",
                "maxLength": 255
            },
            "file": {
                "type": "string",
                "description": "(READ-ONLY)"
            },
            "min_disk": {
                "type": "integer",
                "description": "Amount of disk space (in GB) required to boot image."
            },
            "virtual_size": {
                "type": "integer",
                "description": "Virtual size of image in bytes (READ-ONLY)"
            },
            "id": {
                "pattern": "^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$",
                "type": "string",
                "description": "An identifier for the image"
            },
            "size": {
                "type": "integer",
                "description": "Size of image file in bytes (READ-ONLY)"
            },
            "instance_uuid": {
                "type": "string",
                "description": "ID of instance used to create this image.",
                "is_base": false
            },
            "os_distro": {
                "type": "string",
                "description": "Common name of operating system distribution as specified in http://docs.openstack.org/trunk/openstack-compute/admin/content/adding-images.html",
                "is_base": false
            },
            "name": {
                "type": "string",
                "description": "Descriptive name for the image",
                "maxLength": 255
            },
            "checksum": {
                "type": "string",
                "description": "md5 hash of image contents. (READ-ONLY)",
                "maxLength": 32
            },
            "created_at": {
                "type": "string",
                "description": "Date and time of image registration (READ-ONLY)"
            },
            "disk_format": {
                "enum": [
                    "ami",
                    "ari",
                    "aki",
                    "vhd",
                    "vmdk",
                    "raw",
                    "qcow2",
                    "vdi",
                    "iso"
                ],
                "type": "string",
                "description": "Format of the disk"
            },
            "os_version": {
                "type": "string",
                "description": "Operating system version as specified by the distributor",
                "is_base": false
            },
            "protected": {
                "type": "boolean",
                "description": "If true, image will not be deletable."
            },
            "architecture": {
                "type": "string",
                "description": "Operating system architecture as specified in http://docs.openstack.org/trunk/openstack-compute/admin/content/adding-images.html",
                "is_base": false
            },
            "direct_url": {
                "type": "string",
                "description": "URL to access the image file kept in external store (READ-ONLY)"
            },
            "self": {
                "type": "string",
                "description": "(READ-ONLY)"
            },
            "schema": {
                "type": "string",
                "description": "(READ-ONLY)"
            }
        }
    }
    

Returned Values

  • Normal

    200

  • Abnormal

    Returned Value

    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.