"Fossies" - the Fresh Open Source Software Archive

Member "cinder-13.0.7/api-ref/source/v2/os-cgsnapshots-v2.inc" (4 Oct 2019, 3416 Bytes) of package /linux/misc/openstack/cinder-13.0.7.tar.gz:

    1 .. -*- rst -*-
    2 
    3 Consistency group snapshots
    4 ===========================
    5 
    6 Lists all, lists all with details, shows details for, creates, and
    7 deletes consistency group snapshots.
    8 
    9 
   10 Delete consistency group snapshot
   11 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   12 
   13 .. rest_method::  DELETE /v2/{project_id}/cgsnapshots/{cgsnapshot_id}
   14 
   15 Deletes a consistency group snapshot.
   16 
   17 Response codes
   18 --------------
   19 
   20 .. rest_status_code:: success ../status.yaml
   21 
   22    - 202
   23 
   24 Request
   25 -------
   26 
   27 .. rest_parameters:: parameters.yaml
   28 
   29    - project_id: project_id_path
   30    - cgsnapshot_id: cgsnapshot_id_1
   31 
   32 
   33 Show consistency group snapshot details
   34 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   35 
   36 .. rest_method::  GET /v2/{project_id}/cgsnapshots/{cgsnapshot_id}
   37 
   38 Shows details for a consistency group snapshot.
   39 
   40 Response codes
   41 --------------
   42 
   43 .. rest_status_code:: success ../status.yaml
   44 
   45    - 200
   46 
   47 Request
   48 -------
   49 
   50 .. rest_parameters:: parameters.yaml
   51 
   52    - project_id: project_id_path
   53    - cgsnapshot_id: cgsnapshot_id_1
   54 
   55 
   56 Response Parameters
   57 -------------------
   58 
   59 .. rest_parameters:: parameters.yaml
   60 
   61    - status: status
   62    - description: description
   63    - created_at: created_at
   64    - consistencygroup_id: consistencygroup_id
   65    - id: id
   66    - name: name
   67 
   68 Response Example
   69 ----------------
   70 
   71 .. literalinclude:: ./samples/cgsnapshots-show-response.json
   72    :language: javascript
   73 
   74 
   75 List consistency group snapshots with details
   76 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   77 
   78 .. rest_method::  GET /v2/{project_id}/cgsnapshots/detail
   79 
   80 Lists all consistency group snapshots with details.
   81 
   82 Response codes
   83 --------------
   84 
   85 .. rest_status_code:: success ../status.yaml
   86 
   87    - 200
   88 
   89 Request
   90 -------
   91 
   92 .. rest_parameters:: parameters.yaml
   93 
   94    - project_id: project_id_path
   95    - all_tenants: all-tenants
   96 
   97 
   98 Response Parameters
   99 -------------------
  100 
  101 .. rest_parameters:: parameters.yaml
  102 
  103    - status: status
  104    - description: description
  105    - created_at: created_at
  106    - consistencygroup_id: consistencygroup_id
  107    - id: id
  108    - name: name
  109 
  110 Response Example
  111 ----------------
  112 
  113 .. literalinclude:: ./samples/cgsnapshots-list-detailed-response.json
  114    :language: javascript
  115 
  116 List consistency group snapshots
  117 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  118 
  119 .. rest_method::  GET /v2/{project_id}/cgsnapshots
  120 
  121 Lists all consistency group snapshots.
  122 
  123 Response codes
  124 --------------
  125 
  126 .. rest_status_code:: success ../status.yaml
  127 
  128    - 200
  129 
  130 Request
  131 -------
  132 
  133 .. rest_parameters:: parameters.yaml
  134 
  135    - project_id: project_id_path
  136    - all_tenants: all-tenants
  137 
  138 
  139 Response Parameters
  140 -------------------
  141 
  142 .. rest_parameters:: parameters.yaml
  143 
  144    - id: id
  145    - name: name
  146 
  147 
  148 
  149 Response Example
  150 ----------------
  151 
  152 .. literalinclude:: ./samples/cgsnapshots-list-response.json
  153    :language: javascript
  154 
  155 
  156 Create consistency group snapshot
  157 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  158 
  159 .. rest_method::  POST /v2/{project_id}/cgsnapshots
  160 
  161 Creates a consistency group snapshot.
  162 
  163 Response codes
  164 --------------
  165 
  166 .. rest_status_code:: success ../status.yaml
  167 
  168    - 202
  169 
  170 Request
  171 -------
  172 
  173 .. rest_parameters:: parameters.yaml
  174 
  175    - name: name
  176    - project_id: project_id_path
  177 
  178 Request Example
  179 ---------------
  180 
  181 .. literalinclude:: ./samples/cgsnapshots-create-request.json
  182    :language: javascript
  183 
  184 Response Parameters
  185 -------------------
  186 
  187 .. rest_parameters:: parameters.yaml
  188 
  189    - status: status
  190    - description: description
  191    - created_at: created_at
  192    - consistencygroup_id: consistencygroup_id
  193    - id: id
  194    - name: name