"Fossies" - the Fresh Open Source Software Archive

Member "cinder-13.0.7/api-ref/source/v3/snapshot-manage.inc" (4 Oct 2019, 3154 Bytes) of package /linux/misc/openstack/cinder-13.0.7.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 "snapshot-manage.inc" see the Fossies "Dox" file reference documentation and the last Fossies "Diffs" side-by-side code changes report: 14.0.2_vs_15.0.0.

    1 .. -*- rst -*-
    2 
    3 Snapshot manage extension (manageable_snapshots)
    4 ================================================
    5 
    6 Creates or lists snapshots by using existing storage instead of allocating new
    7 storage.
    8 
    9 
   10 Manage an existing snapshot
   11 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
   12 
   13 .. rest_method::  POST /v3/{project_id}/manageable_snapshots
   14 
   15 Creates a snapshot by using existing storage rather than allocating new
   16 storage.
   17 
   18 The caller must specify a reference to an existing storage volume
   19 in the ref parameter in the request. Although each storage driver
   20 might interpret this reference differently, the driver should
   21 accept a reference structure that contains either a source-id
   22 or source-name element, if possible.
   23 
   24 The API chooses the size of the snapshot by rounding up the size of
   25 the existing snapshot to the next gibibyte (GiB).
   26 
   27 
   28 Response codes
   29 --------------
   30 
   31 .. rest_status_code:: success ../status.yaml
   32 
   33    - 202
   34 
   35 
   36 Request
   37 -------
   38 
   39 .. rest_parameters:: parameters.yaml
   40 
   41    - project_id: project_id_path
   42    - snapshot: snapshot_1
   43    - description: description_4
   44    - metadata: metadata_7
   45    - name: name_5
   46    - ref: ref
   47    - volume_id: volume_id
   48 
   49 Request Example
   50 ---------------
   51 
   52 .. literalinclude:: ./samples/snapshot-manage-request.json
   53    :language: javascript
   54 
   55 
   56 
   57 List summary of snapshots available to manage
   58 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   59 
   60 .. rest_method::  GET /v3/{project_id}/manageable_snapshots
   61 
   62 Search a volume backend and list summary of snapshots which are available to
   63 manage.
   64 
   65 Response codes
   66 --------------
   67 
   68 .. rest_status_code:: success ../status.yaml
   69 
   70    - 200
   71 
   72 
   73 Request
   74 -------
   75 
   76 .. rest_parameters:: parameters.yaml
   77 
   78    - project_id: project_id_path
   79    - sort: sort
   80    - offset: offset
   81    - limit: limit
   82    - marker: marker
   83    - host: host_query
   84 
   85 
   86 Response
   87 --------
   88 
   89 .. rest_parameters:: parameters.yaml
   90 
   91    - manageable-snapshots: manageable-snapshots
   92    - source_reference: source_reference
   93    - safe_to_manage: safe_to_manage
   94    - reference: reference
   95    - source-name: source-name
   96    - size: size
   97 
   98 
   99 Response Example
  100 ----------------
  101 
  102 .. literalinclude:: ./samples/snapshot-manage-list-response.json
  103    :language: javascript
  104 
  105 
  106 
  107 List detail of snapshots available to manage
  108 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  109 
  110 .. rest_method::  GET /v3/{project_id}/manageable_snapshots/detail
  111 
  112 Search a volume backend and list detail of snapshots which are available to
  113 manage.
  114 
  115 
  116 Response codes
  117 --------------
  118 
  119 .. rest_status_code:: success ../status.yaml
  120 
  121    - 200
  122 
  123 
  124 Request
  125 -------
  126 
  127 .. rest_parameters:: parameters.yaml
  128 
  129    - project_id: project_id_path
  130    - sort: sort
  131    - offset: offset
  132    - limit: limit
  133    - marker: marker
  134    - host: host_query
  135 
  136 
  137 Response
  138 --------
  139 
  140 .. rest_parameters:: parameters.yaml
  141 
  142    - manageable-snapshots: manageable-snapshots
  143    - cinder_id: cinder_id
  144    - source_reference: source_reference
  145    - safe_to_manage: safe_to_manage
  146    - reason_not_safe: reason_not_safe
  147    - reference: reference
  148    - source-name: source-name
  149    - size: size
  150    - extra_info: extra_info
  151 
  152 
  153 Response Example
  154 ----------------
  155 
  156 .. literalinclude:: ./samples/snapshot-manage-list-detail-response.json
  157    :language: javascript