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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
|
.. -*- rst -*-
============
Log resource
============
The ``logging`` extension lists, creates, shows information for, and updates
log resource.
Resource timestamps
===================
The ``standard-attr-timestamp`` extension adds the ``created_at`` and
``updated_at`` attributes to all resources that have standard attributes.
List logs
=========
.. rest_method:: GET /v2.0/log/logs
Lists all log resources associated with your project.
.. include:: filtering-list.inc
The list might be empty.
Normal response codes: 200
Error response codes: 401
Request
-------
.. rest_parameters:: parameters.yaml
- id: id-query
- name: name-query
- description: description-query
- tenant_id: project_id-query
- project_id: project_id-query
- event: log_event-query
- revision_number: revision_number-query
- resource_type: resource_log_type-query
- resource_id: resource_log_id-query
- target_id: resource_target_log_id-query
- enabled: log_enabled-query
- sort_dir: sort_dir
- sort_key: log-sort_key
- fields: fields
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- logs: logs
- id: log_id
- name: name
- created_at: created_at_resource
- description: description
- tenant_id: project_id
- project_id: project_id
- event: log_event
- revision_number: revision_number
- resource_type: resource_log_type
- resource_id: resource_log_id
- target_id: resource_target_log_id
- updated_at: updated_at_resource
- enabled: log_enabled
Response Example
----------------
.. literalinclude:: samples/logs/log-list-response.json
:language: javascript
Create log
==========
.. rest_method:: POST /v2.0/log/logs
Creates a log resource.
Creates a log resource by using the configuration that you define in
the request object. A response object is returned. The object
contains a unique ID.
If the caller is not an administrative user, this call returns the
HTTP ``Forbidden (403)`` response code.
Users with an administrative role can create policies on behalf of
other projects by specifying a project ID that is different than
their own.
Normal response codes: 201
Error response codes: 400, 401, 403, 409
Request
-------
.. rest_parameters:: parameters.yaml
- log: log
- name: name-request
- description: description-request
- tenant_id: project_id-request
- project_id: project_id-request
- event: log_event-request
- resource_type: resource_log_type
- resource_id: resource_log_id-request
- target_id: resource_target_log_id-request
- enabled: log_enabled-request
Request Example
---------------
.. literalinclude:: samples/logs/log-create-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- log: log
- id: log_id
- name: name
- created_at: created_at_resource
- description: description
- tenant_id: project_id
- project_id: project_id
- event: log_event
- revision_number: revision_number
- resource_type: resource_log_type
- resource_id: resource_log_id
- target_id: resource_target_log_id
- updated_at: updated_at_resource
- enabled: log_enabled
Request Example
---------------
.. literalinclude:: samples/logs/log-create-response.json
:language: javascript
Show log
========
.. rest_method:: GET /v2.0/log/logs/{log_id}
Shows details log resource.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: 401, 404
Request
-------
.. rest_parameters:: parameters.yaml
- log_id: log_id-path
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- log: log
- id: log_id
- name: name
- created_at: created_at_resource
- description: description
- tenant_id: project_id
- project_id: project_id
- event: log_event
- revision_number: revision_number
- resource_type: resource_log_type
- resource_id: resource_log_id
- target_id: resource_target_log_id
- updated_at: updated_at_resource
- enabled: log_enabled
Response Example
----------------
.. literalinclude:: samples/logs/log-show-response.json
:language: javascript
Update log
==========
.. rest_method:: PUT /v2.0/log/logs/{log_id}
Updates a log resource.
Normal response codes: 200
Error response codes: 400, 401, 404, 412
Request
-------
.. rest_parameters:: parameters.yaml
- log_id: log_id-path
- log: log
- name: name-request
- description: description-request
- enabled: log_enabled-request-put
Request Example
---------------
.. literalinclude:: samples/logs/log-update-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- log: log
- id: log_id
- name: name
- created_at: created_at_resource
- description: description
- tenant_id: project_id
- project_id: project_id
- event: log_event
- revision_number: revision_number
- resource_type: resource_log_type
- resource_id: resource_log_id
- target_id: resource_target_log_id
- updated_at: updated_at_resource
- enabled: log_enabled
Response Example
----------------
.. literalinclude:: samples/logs/log-update-response.json
:language: javascript
Delete log
==========
.. rest_method:: DELETE /v2.0/log/logs/{log_id}
Deletes a log resource.
Normal response codes: 204
Error response codes: 400, 401, 404, 412
Request
-------
.. rest_parameters:: parameters.yaml
- log_id: log_id-path
Response
--------
There is no body content for the response of a successful DELETE request.
=================
Loggable resource
=================
List loggable resources
=======================
.. rest_method:: GET /v2.0/log/loggable-resources
Lists all resource log types are supporting.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: 401
Request
-------
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- loggable_resources: loggable_resources
- type: resource_log_type
Response Example
----------------
.. literalinclude:: samples/logs/loggable_resources-list-response.json
:language: javascript
|
