"Fossies" - the Fresh Open Source Software Archive

Member "glance-19.0.0/api-ref/source/v2/images-parameters.yaml" (16 Oct 2019, 19159 Bytes) of package /linux/misc/openstack/glance-19.0.0.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) Ansible YAML source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the last Fossies "Diffs" side-by-side code changes report for "images-parameters.yaml": 16.0.1_vs_18.0.0.

    1 # variables in header
    2 Content-Length:
    3   description: |
    4     The length of the body in octets (8-bit bytes)
    5   in: header
    6   required: true
    7   type: string
    8 Content-Md5:
    9   description: |
   10     The MD5 checksum of the body.
   11   in: header
   12   required: true
   13   type: string
   14 Content-Range:
   15   description: |
   16     The content range of image data. For details, see
   17     `Hypertext Transfer Protocol (HTTP/1.1): Range Requests
   18     <http://tools.ietf.org/html/rfc7233>`_.
   19   in: header
   20   required: false
   21   type: string
   22 Content-Type-data:
   23   description: |
   24     The media type descriptor for the request body.  Use
   25     ``application/octet-stream``
   26   in: header
   27   required: true
   28   type: string
   29 Content-Type-data-response:
   30   description: |
   31     The media type descriptor of the response body, namely
   32     ``application/octet-stream``
   33   in: header
   34   required: true
   35   type: string
   36 Content-Type-json:
   37   description: |
   38     The media type descriptor for the request body.  Use
   39     ``application/json``.
   40   in: header
   41   required: true
   42   type: string
   43 Content-Type-patch:
   44   description: |
   45     The media type descriptor for the request body.  Use
   46     ``application/openstack-images-v2.1-json-patch``.  (You can also use
   47     ``application/openstack-images-v2.0-json-patch``, but keep in mind that
   48     it's deprecated.)
   49   in: header
   50   required: true
   51   type: string
   52 import-header:
   53   description: |
   54     A comma separated list of import method identifiers.  Included
   55     only if image import is enabled in your cloud.  *Since Image API v2.6*
   56   in: header
   57   required: false
   58   type: string
   59 Location:
   60   description: |
   61     The URL to access the image file from the
   62     external store.
   63   in: header
   64   required: true
   65   type: string
   66 Range:
   67   description: |
   68     The range of image data requested. Note that multi range requests are
   69     not supported. For details, see
   70     `Hypertext Transfer Protocol (HTTP/1.1): Range Requests
   71     <http://tools.ietf.org/html/rfc7233>`_.
   72   in: header
   73   required: false
   74   type: string
   75 store-header:
   76   description: |
   77     A store identifier to upload or import image data.  Should only be included
   78     when making a request to a cloud that supports multiple backing stores. Use
   79     the :ref:`Store Discovery <store-discovery-call>` call to determine an
   80     appropriate store identifier. Simply omit this header to use the default
   81     store. *(Since Image API v2.8)*
   82   in: header
   83   required: false
   84   type: string
   85 stores-header:
   86   description: |
   87     A comma separated list of available store identifiers.  If this header
   88     is missing the cloud does not support multiple backend stores.
   89   in: header
   90   required: false
   91   type: string
   92 
   93 # variables in path
   94 image_id-in-path:
   95   description: |
   96     The UUID of the image.
   97   in: path
   98   required: true
   99   type: string
  100 member_id-in-path:
  101   description: |
  102     The ID of the image member. An image member is usually the project (also
  103     called the "tenant") with whom the image is shared.
  104   in: path
  105   required: true
  106   type: string
  107 tag-in-path:
  108   description: |
  109     The image tag.  A tag is limited to 255 chars in length.  You may wish
  110     to use characters that can easily be written in a URL.
  111   in: path
  112   required: true
  113   type: string
  114 
  115 # variables in query
  116 created_at-in-query:
  117   description: |
  118     Specify a *comparison filter* based on the date and time when the resource
  119     was created.  (See :ref:`Time Comparison Filters <v2-comparison-ops>`).
  120 
  121     The date and time stamp format is `ISO 8601
  122     <https://en.wikipedia.org/wiki/ISO_8601>`_:
  123 
  124     ::
  125 
  126        CCYY-MM-DDThh:mm:ss±hh:mm
  127 
  128     The ``±hh:mm`` value, if included, is the time zone as an offset
  129     from UTC.
  130 
  131     For example, ``2015-08-27T09:49:58-05:00``.
  132 
  133     If you omit the time zone, the UTC time zone is assumed.
  134   in: query
  135   required: false
  136   type: string
  137 limit:
  138   description: |
  139     Requests a page size of items. Returns a number of items up to a limit
  140     value. Use the ``limit`` parameter to make an initial limited request and
  141     use the ID of the last-seen item from the response as the ``marker``
  142     parameter value in a subsequent limited request.
  143   in: query
  144   required: false
  145   type: integer
  146 marker:
  147   description: |
  148     The ID of the last-seen item. Use the ``limit`` parameter to make an
  149     initial limited request and use the ID of the last-seen item from the
  150     response as the ``marker`` parameter value in a subsequent limited request.
  151   in: query
  152   required: false
  153   type: string
  154 member_status-in-query:
  155   description: |
  156     Filters the response by a member status.  A valid value is ``accepted``,
  157     ``pending``, ``rejected``, or ``all``.  Default is ``accepted``.
  158   in: query
  159   required: false
  160   type: string
  161 name-in-query:
  162   description: |
  163     Filters the response by a name, as a string.  A valid value is the name of
  164     an image.
  165   in: query
  166   required: false
  167   type: string
  168 os_hidden-in-query:
  169   description: |
  170     When ``true``, filters the response to display only "hidden" images.  By
  171     default, "hidden" images are not included in the image-list response.
  172     *(Since Image API v2.7)*
  173   in: query
  174   required: false
  175   type: boolean
  176 owner-in-query:
  177   description: |
  178     Filters the response by a project (also called a "tenant") ID.  Shows only
  179     images that are shared with you by the specified owner.
  180   in: query
  181   required: false
  182   type: string
  183 protected-in-query:
  184   description: |
  185     Filters the response by the 'protected' image property.  A valid value is
  186     one of 'true', 'false' (must be all lowercase).  Any other value will
  187     result in a 400 response.
  188   in: query
  189   required: false
  190   type: boolean
  191 size_max:
  192   description: |
  193     Filters the response by a maximum image size, in
  194     bytes.
  195   in: query
  196   required: false
  197   type: string
  198 size_min:
  199   description: |
  200     Filters the response by a minimum image size, in
  201     bytes.
  202   in: query
  203   required: false
  204   type: string
  205 sort:
  206   description: |
  207     Sorts the response by one or more attribute and sort direction
  208     combinations. You can also set multiple sort keys and directions.
  209     Default direction is ``desc``.
  210 
  211     Use the comma (``,``) character to separate multiple values. For
  212     example:
  213 
  214     .. code-block:: none
  215 
  216        GET /v2/images?sort=name:asc,status:desc
  217   in: query
  218   required: false
  219   type: string
  220 sort_dir:
  221   description: |
  222     Sorts the response by a set of one or more sort
  223     direction and attribute (``sort_key``) combinations. A valid value
  224     for the sort direction is ``asc`` (ascending) or ``desc``
  225     (descending). If you omit the sort direction in a set, the default
  226     is ``desc``.
  227   in: query
  228   required: false
  229   type: string
  230 sort_key:
  231   description: |
  232     Sorts the response by an attribute, such as
  233     ``name``, ``id``, or ``updated_at``. Default is ``created_at``.
  234     The API uses the natural sorting direction of the ``sort_key``
  235     image attribute.
  236   in: query
  237   required: false
  238   type: string
  239 status-in-query:
  240   description: |
  241     Filters the response by an image status.
  242   in: query
  243   required: false
  244   type: integer
  245 tag-in-query:
  246   description: |
  247     Filters the response by the specified tag value.  May be repeated, but keep
  248     in mind that you're making a conjunctive query, so only images containing
  249     *all* the tags specified will appear in the response.
  250   in: query
  251   required: false
  252   type: string
  253 updated_at-in-query:
  254   description: |
  255     Specify a *comparison filter* based on the date and time when the resource
  256     was most recently modified.  (See :ref:`Time Comparison Filters
  257     <v2-comparison-ops>`).
  258 
  259     The date and time stamp format is `ISO 8601
  260     <https://en.wikipedia.org/wiki/ISO_8601>`_:
  261 
  262     ::
  263 
  264        CCYY-MM-DDThh:mm:ss±hh:mm
  265 
  266     The ``±hh:mm`` value, if included, is the time zone as an offset
  267     from UTC.
  268 
  269     For example, ``2015-08-27T09:49:58-05:00``.
  270 
  271     If you omit the time zone, the UTC time zone is assumed.
  272   in: query
  273   required: false
  274   type: string
  275 visibility-in-query:
  276   description: |
  277     Filters the response by an image visibility value.  A valid value is
  278     ``public``, ``private``, ``community``, or ``shared``.  (Note that if you
  279     filter on ``shared``, the images included in the response will only be
  280     those where your member status is ``accepted`` unless you explicitly
  281     include a ``member_status`` filter in the request.)  If you omit this
  282     parameter, the response shows ``public``, ``private``, and those ``shared``
  283     images with a member status of ``accepted``.
  284   in: query
  285   required: false
  286   type: string
  287 
  288 # variables in body
  289 checksum:
  290   description: |
  291     Hash that is used over the image data. The Image
  292     service uses this value for verification.  The value might be
  293     ``null`` (JSON null data type).
  294   in: body
  295   required: true
  296   type: string
  297 container_format:
  298   description: |
  299     |container_format_description|
  300   in: body
  301   required: true
  302   type: enum
  303 container_format-in-request:
  304   description: |
  305     |container_format_description|
  306   in: body
  307   required: false
  308   type: enum
  309 created_at:
  310   description: |
  311     The date and time when the resource was created.
  312 
  313     The date and time stamp format is `ISO 8601
  314     <https://en.wikipedia.org/wiki/ISO_8601>`_:
  315 
  316     ::
  317 
  318        CCYY-MM-DDThh:mm:ss±hh:mm
  319 
  320     For example, ``2015-08-27T09:49:58-05:00``.
  321 
  322     The ``±hh:mm`` value, if included, is the time zone as an offset
  323     from UTC.
  324   in: body
  325   required: true
  326   type: string
  327 direct_url:
  328   description: |
  329     The URL to access the image file kept in external store.  *It is present
  330     only if the* ``show_image_direct_url`` *option is* ``true`` *in the Image
  331     service's configuration file.*  **Because it presents a security risk, this
  332     option is disabled by default.**
  333   in: body
  334   required: false
  335   type: string
  336 disk_format:
  337   description: |
  338     |disk_format_description|
  339   in: body
  340   required: true
  341   type: enum
  342 disk_format-in-request:
  343   description: |
  344     |disk_format_description|
  345   in: body
  346   required: false
  347   type: enum
  348 file:
  349   description: |
  350     The URL for the virtual machine image file.
  351   in: body
  352   required: true
  353   type: string
  354 first:
  355   description: |
  356     The URI for the first page of response.
  357   in: body
  358   required: true
  359   type: string
  360 id:
  361   description: |
  362     A unique, user-defined image UUID, in the format:
  363 
  364     ::
  365 
  366        nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn
  367 
  368     Where **n** is a hexadecimal digit from 0 to f, or F.
  369 
  370     For example:
  371 
  372     ::
  373 
  374        b2173dd3-7ad6-4362-baa6-a68bce3565cb
  375 
  376     If you omit this value, the API generates a UUID for the image.
  377   in: body
  378   required: true
  379   type: string
  380 id-in-request:
  381   description: |
  382     A unique, user-defined image UUID, in the format:
  383 
  384     ::
  385 
  386        nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn
  387 
  388     Where **n** is a hexadecimal digit from 0 to f, or F.
  389 
  390     For example:
  391 
  392     ::
  393 
  394        b2173dd3-7ad6-4362-baa6-a68bce3565cb
  395 
  396     If you omit this value, the API generates a UUID for the image.  If you
  397     specify a value that has already been assigned, the request fails with
  398     a ``409`` response code.
  399   in: body
  400   required: false
  401   type: string
  402 image_id-in-body:
  403   description: |
  404     The UUID of the image.
  405   in: body
  406   required: true
  407   type: string
  408 images:
  409   description: |
  410     A list of *image* objects, as described by the :ref:`Images Schema
  411     <images-schema>`.
  412   in: body
  413   required: true
  414   type: array
  415 import-methods:
  416   description: |
  417     A JSON object containing a ``value`` element, which is an array of
  418     string identifiers indicating what import methods are available in
  419     the cloud in which the call is made.  This list may be empty.
  420   in: body
  421   required: true
  422   type: object
  423 locations:
  424   description: |
  425     A list of objects, each of which describes an image location.  Each object
  426     contains a ``url`` key, whose value is a URL specifying a location, and a
  427     ``metadata`` key, whose value is a dict of key:value pairs containing
  428     information appropriate to the use of whatever external store is indicated
  429     by the URL.  *This list appears only if the* ``show_multiple_locations``
  430     *option is set to* ``true`` *in the Image service's configuration file.*
  431     **Because it presents a security risk, this option is disabled by
  432     default.**
  433   in: body
  434   required: false
  435   type: array
  436 member_id:
  437   description: |
  438     The ID of the image member. An image member is usually a project (also
  439     called the "tenant") with whom the image is shared.
  440   in: body
  441   required: true
  442   type: string
  443 member_status:
  444   description: |
  445     The status of this image member.  Value is one of ``pending``,
  446     ``accepted``, ``rejected``.
  447   in: body
  448   required: true
  449   type: string
  450 members:
  451   description: |
  452     A list of *member* objects, as described by the :ref:`Image Members Schema
  453     <image-members-schema>`. Each *member* object describes a member with whom
  454     this image is being shared.
  455   in: body
  456   required: true
  457   type: array
  458 method-in-request:
  459   description: |
  460     A JSON object indicating what import method you wish to use to import
  461     your image.  The content of this JSON object is another JSON object
  462     with a ``name`` field whose value is the identifier for the import
  463     method.
  464   in: body
  465   required: true
  466   type: object
  467 min_disk:
  468   description: |
  469     Amount of disk space in GB that is required to boot the image.
  470     The value might be ``null`` (JSON null data type).
  471   in: body
  472   required: true
  473   type: integer
  474 min_disk-in-request:
  475   description: |
  476     Amount of disk space in GB that is required to boot the image.
  477   in: body
  478   required: false
  479   type: integer
  480 min_ram:
  481   description: |
  482     Amount of RAM in MB that is required to boot the image.
  483     The value might be ``null`` (JSON null data type).
  484   in: body
  485   required: true
  486   type: integer
  487 min_ram-in-request:
  488   description: |
  489     Amount of RAM in MB that is required to boot the image.
  490   in: body
  491   required: false
  492   type: integer
  493 name:
  494   description: |
  495     The name of the image.  Value might be ``null`` (JSON null data type).
  496   in: body
  497   required: true
  498   type: string
  499 name-in-request:
  500   description: |
  501     The name of the image.
  502   in: body
  503   required: false
  504   type: string
  505 next:
  506   description: |
  507     The URI for the next page of response.  Will not be present on the last
  508     page of the response.
  509   in: body
  510   required: true
  511   type: string
  512 os_hash_algo:
  513   description: |
  514     The algorithm used to compute a secure hash of the image data for this
  515     image.  The result of the computation is displayed as the value of the
  516     ``os_hash_value`` property.  The value might be ``null`` (JSON null
  517     data type).  The algorithm used is chosen by the cloud operator; it
  518     may not be configured by end users.  *(Since Image API v2.7)*
  519   in: body
  520   required: true
  521   type: string
  522 os_hash_value:
  523   description: |
  524     The hexdigest of the secure hash of the image data computed using the
  525     algorithm whose name is the value of the ``os_hash_algo`` property.
  526     The value might be ``null`` (JSON null data type) if data has not
  527     yet been associated with this image, or if the image was created using
  528     a version of the Image Service API prior to version 2.7.
  529     *(Since Image API v2.7)*
  530   in: body
  531   required: true
  532   type: string
  533 os_hidden:
  534   description: |
  535     This field controls whether an image is displayed in the default
  536     image-list response.  A "hidden" image is out of date somehow (for
  537     example, it may not have the latest updates applied) and hence should
  538     not be a user's first choice, but it's not deleted because it may be
  539     needed for server rebuilds.  By hiding it from the default image list,
  540     it's easier for end users to find and use a more up-to-date version of
  541     this image.  *(Since Image API v2.7)*
  542   in: body
  543   required: true
  544   type: boolean
  545 owner:
  546   description: |
  547     An identifier for the owner of the image, usually the project (also
  548     called the "tenant") ID.
  549     The value might be ``null`` (JSON null data type).
  550   in: body
  551   required: true
  552   type: string
  553 protected:
  554   description: |
  555     A boolean value that must be ``false`` or the image cannot be deleted.
  556   in: body
  557   required: true
  558   type: boolean
  559 protected-in-request:
  560   description: |
  561     Image protection for deletion. Valid value is ``true`` or ``false``.
  562     Default is ``false``.
  563   in: body
  564   required: false
  565   type: boolean
  566 schema-image:
  567   description: |
  568     The URL for the schema describing a virtual machine image.
  569   in: body
  570   required: true
  571   type: string
  572 schema-images:
  573   description: |
  574     The URL for the schema describing a list of images.
  575   in: body
  576   required: true
  577   type: string
  578 schema-member:
  579   description: |
  580     The URL for the schema describing an image member.
  581   in: body
  582   required: true
  583   type: string
  584 schema-members:
  585   description: |
  586     The URL for the schema describing an image member list.
  587   in: body
  588   required: true
  589   type: string
  590 self:
  591   description: |
  592     The URL for the virtual machine image.
  593   in: body
  594   required: true
  595   type: string
  596 size:
  597   description: |
  598     The size of the image data, in bytes.  The value
  599     might be ``null`` (JSON null data type).
  600   in: body
  601   required: true
  602   type: integer
  603 status:
  604   description: |
  605     The image status.
  606   in: body
  607   required: true
  608   type: string
  609 tags:
  610   description: |
  611     List of tags for this image, possibly an empty list.
  612   in: body
  613   required: true
  614   type: array
  615 tags-in-request:
  616   description: |
  617     List of tags for this image.  Each tag is a string of at most 255 chars.
  618     The maximum number of tags allowed on an image is set by the operator.
  619   in: body
  620   required: false
  621   type: array
  622 updated_at:
  623   description: |
  624     The date and time when the resource was updated.
  625 
  626     The date and time stamp format is `ISO 8601
  627     <https://en.wikipedia.org/wiki/ISO_8601>`_:
  628 
  629     ::
  630 
  631        CCYY-MM-DDThh:mm:ss±hh:mm
  632 
  633     For example, ``2015-08-27T09:49:58-05:00``.
  634 
  635     The ``±hh:mm`` value, if included, is the time zone as an offset
  636     from UTC. In the previous example, the offset value is ``-05:00``.
  637 
  638     If the ``updated_at`` date and time stamp is not set, its value is
  639     ``null``.
  640   in: body
  641   required: true
  642   type: string
  643 url:
  644   description: |
  645     The URL to access the image file kept in external
  646     store.
  647   in: body
  648   required: true
  649   type: string
  650 value:
  651   description: |
  652     Value of image property used in add or replace
  653     operations expressed in JSON notation. For example, you must
  654     enclose strings in quotation marks, and you do not enclose numeric
  655     values in quotation marks.
  656   in: body
  657   required: true
  658   type: string
  659 virtual_size:
  660   description: |
  661     The virtual size of the image.  The value might
  662     be ``null`` (JSON null data type).
  663   in: body
  664   required: true
  665   type: integer
  666 visibility:
  667   description: |
  668     Image visibility, that is, the access permission for the image.
  669   in: body
  670   required: true
  671   type: string
  672 visibility-in-request:
  673   description: |
  674     Visibility for this image. Valid value is one of: ``public``, ``private``,
  675     ``shared``, or ``community``.
  676     At most sites, only an administrator can make an image ``public``.
  677     Some sites may restrict what users can make an image ``community``.
  678     Some sites may restrict what users can perform member operations on
  679     a ``shared`` image.
  680     *Since the Image API v2.5, the default value is ``shared``.*
  681   in: body
  682   required: false
  683   type: string