"Fossies" - the Fresh Open Source Software Archive

Member "glance-24.1.0/api-ref/source/v2/discovery.inc" (8 Jun 2022, 3338 Bytes) of package /linux/misc/openstack/glance-24.1.0.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) fasm source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. For more information about "discovery.inc" see the Fossies "Dox" file reference documentation.

    1 .. -*- rst -*-
    2 
    3 Image Service Info (Discovery)
    4 ******************************
    5 
    6 General information
    7 ~~~~~~~~~~~~~~~~~~~
    8 
    9 These calls allow you to discover useful information about what
   10 services you may consume from a particular deployment of the
   11 OpenStack Image Service.
   12 
   13 
   14 .. _import-discovery-call:
   15 
   16 Import methods and values discovery
   17 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   18 
   19 .. rest_method::  GET /v2/info/import
   20 
   21 Returns information concerning the constraints around image import in
   22 the cloud in which the call is made, for example, supported container
   23 formats, supported disk formats, maximum image size, etc.  This call
   24 contains a ``import-methods`` field consisting of an array of string
   25 identifiers indicating what import methods are supported in the cloud
   26 in which the call is made.
   27 *(Since Image API v2.6)*
   28 
   29 .. note::
   30    In the Image API v2.6-2.8, this discovery call contains
   31    **only** the ``import-methods`` field.
   32 
   33 Normal response codes: 200
   34 
   35 Error response codes: 400, 401, 403
   36 
   37 
   38 Request
   39 -------
   40 
   41 There are no request parameters.
   42 
   43 This call does not allow a request body.
   44 
   45 
   46 Response Parameters
   47 -------------------
   48 
   49 .. rest_parameters:: images-parameters.yaml
   50 
   51    - import-methods: import-methods
   52 
   53 
   54 Response Example
   55 ----------------
   56 
   57 .. literalinclude:: samples/image-info-import-response.json
   58    :language: json
   59 
   60 
   61 .. _store-discovery-call:
   62 
   63 List stores
   64 ~~~~~~~~~~~
   65 
   66 .. rest_method::  GET /v2/info/stores
   67 
   68 A multiple store backend support is introduced in the Rocky release
   69 as a part of the EXPERIMENTAL Image API v2.8.
   70 
   71 .. note:: The Multi Store feature is introduced as EXPERIMENTAL in Rocky and
   72           its use in production systems is currently **not supported**.
   73           The feature is being finalized during the Train development
   74           cycle and is expected to be fully supported in Image API v2.9.
   75 
   76 In version 2.7 of the API, this call will return a 404 (Not Found).
   77 Use the :ref:`API versions call <versions-call>` to determine
   78 what API versions are available in your cloud.
   79 
   80 Normal response codes: 200
   81 
   82 Error response codes: 404
   83 
   84 
   85 Request
   86 -------
   87 
   88 There are no request parameters.
   89 
   90 This call does not allow a request body.
   91 
   92 
   93 Response Parameters
   94 -------------------
   95 
   96 .. rest_parameters:: discovery-parameters.yaml
   97 
   98    - stores: stores
   99 
  100 
  101 Response Example
  102 ----------------
  103 
  104 .. literalinclude:: samples/stores-list-response.json
  105    :language: json
  106 
  107 Quota usage
  108 ~~~~~~~~~~~
  109 
  110 .. rest_method:: GET /v2/info/usage
  111 
  112 The user's quota and current usage are displayed, if enabled by
  113 server-side configuration.
  114 
  115 Normal response codes: 200
  116 
  117 Request
  118 -------
  119 
  120 There are no request parameters.
  121 
  122 This call does not allow a request body.
  123 
  124 Response Example
  125 ----------------
  126 
  127 .. literalinclude:: samples/usage-response.json
  128    :language: json
  129 
  130 List stores detail
  131 ~~~~~~~~~~~~~~~~~~
  132 
  133 .. rest_method::  GET /v2/info/stores/detail
  134 
  135 Lists all the backend stores, with detail, accessible to admins,
  136 for non-admin user API will return bad request.
  137 
  138 Normal response codes: 200
  139 
  140 Error response codes: 403, 404
  141 
  142 
  143 Request
  144 -------
  145 
  146 There are no request parameters.
  147 
  148 This call does not allow a request body.
  149 
  150 
  151 Response Parameters
  152 -------------------
  153 
  154 .. rest_parameters:: discovery-parameters.yaml
  155 
  156    - stores: stores-detail
  157 
  158 
  159 Response Example
  160 ----------------
  161 
  162 .. literalinclude:: samples/stores-list-detail-response.json
  163    :language: json
  164