"Fossies" - the Fresh Open Source Software Archive

Member "cinder-13.0.7/api-ref/source/v3/messages.inc" (4 Oct 2019, 2528 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 "messages.inc" see the Fossies "Dox" file reference documentation.

    1 .. -*- rst -*-
    2 
    3 Messages
    4 ========
    5 
    6 Lists all, shows, and deletes messages. These are error messages generated by
    7 failed operations as a way to find out what happened when an asynchronous
    8 operation failed.
    9 
   10 
   11 Delete message
   12 ~~~~~~~~~~~~~~
   13 
   14 .. rest_method::  DELETE /v3/{project_id}/messages/{message_id}
   15 
   16 Deletes a message.
   17 
   18 Response codes
   19 --------------
   20 
   21 .. rest_status_code:: success ../status.yaml
   22 
   23    - 202
   24 
   25 .. rest_status_code:: error ../status.yaml
   26 
   27    - 400
   28    - 404
   29 
   30 
   31 Request
   32 -------
   33 
   34 .. rest_parameters:: parameters.yaml
   35 
   36    - project_id: project_id_path
   37    - message_id: message_id
   38 
   39 
   40 Show message details
   41 ~~~~~~~~~~~~~~~~~~~~
   42 
   43 .. rest_method::  GET /v3/{project_id}/messages/{message_id}
   44 
   45 Shows details for a message.
   46 
   47 
   48 Response codes
   49 --------------
   50 
   51 .. rest_status_code:: success ../status.yaml
   52 
   53    - 200
   54 
   55 .. rest_status_code:: error ../status.yaml
   56 
   57    - 400
   58    - 404
   59 
   60 
   61 Request
   62 -------
   63 
   64 .. rest_parameters:: parameters.yaml
   65 
   66    - project_id: project_id_path
   67    - message_id: message_id
   68 
   69 
   70 Response Parameters
   71 -------------------
   72 
   73 .. rest_parameters:: parameters.yaml
   74 
   75    - message: user_message
   76    - request_id: request_id
   77    - links: links_5
   78    - message_level: message_level
   79    - event_id: event_id
   80    - created_at: created_at
   81    - guaranteed_until: guaranteed_until
   82    - resource_uuid: resource_uuid
   83    - id: id_8
   84    - resource_type: resource_type
   85    - user_message: user_message
   86 
   87 Response Example
   88 ----------------
   89 
   90 .. literalinclude:: ./samples/messages-show-response.json
   91    :language: javascript
   92 
   93 
   94 List messages
   95 ~~~~~~~~~~~~~
   96 
   97 .. rest_method::  GET /v3/{project_id}/messages
   98 
   99 Lists all messages, since v3.31 if non-admin users
  100 specify invalid filters in the url, API will return bad request.
  101 
  102 
  103 Response codes
  104 --------------
  105 
  106 .. rest_status_code:: success ../status.yaml
  107 
  108    - 200
  109 
  110 .. rest_status_code:: error ../status.yaml
  111 
  112    - 400
  113 
  114 
  115 Request
  116 -------
  117 
  118 .. rest_parameters:: parameters.yaml
  119 
  120    - project_id: project_id_path
  121    - sort: sort
  122    - limit: limit
  123    - offset: offset
  124    - marker: marker
  125 
  126 Response Parameters
  127 -------------------
  128 
  129 .. rest_parameters:: parameters.yaml
  130 
  131    - messages: user_messages
  132    - request_id: request_id
  133    - links: links_5
  134    - message_level: message_level
  135    - event_id: event_id
  136    - created_at: created_at
  137    - guaranteed_until: guaranteed_until
  138    - resource_uuid: resource_uuid
  139    - id: id_8
  140    - resource_type: resource_type
  141    - user_message: user_message
  142 
  143 Response Example
  144 ----------------
  145 
  146 .. literalinclude:: ./samples/messages-list-response.json
  147    :language: javascript