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