diff --git a/doc/api-site/api-ref/src/wadls/clustering-api/src/v1/clustering-api.wadl b/doc/api-site/api-ref/src/wadls/clustering-api/src/v1/clustering-api.wadl
index 99326f7d2..7af3928cb 100644
--- a/doc/api-site/api-ref/src/wadls/clustering-api/src/v1/clustering-api.wadl
+++ b/doc/api-site/api-ref/src/wadls/clustering-api/src/v1/clustering-api.wadl
@@ -1406,62 +1406,107 @@
Lists events.
-
-
-
- ID of an object for which the events are to be listed. An object here can be a cluster, a node, a policy etc.
-
-
-
-
- Filter the events by object names.
-
-
-
-
-
- The type of objects for which the events are listed. The type here can be CLUSTER
, NODE
,
- PROFILE
, POLICY
etc.
-
- Filters the event list by the specified resource_status. You can use this filter multiple times to filter by multiple
- resource statuses:
- IN_PROGRESS
, COMPLETE
or FAILED
.
-
-
-
-
-
- A list of key-value pairs for filtering the events returned.
-
-
-
-
- Sorts the event list by: resource_type
or created_at
.
-
-
-
-
- The sort direction of the event list. Which is asc
(ascending) or desc
(descending).
-
-
+
- Limits the number of events that appear on a page to this value. The typical pattern of limit and marker is to make an
- initial limited request and then to use the ID of the last event from the response as the marker parameter in a subsequent
- limited request.
+ Limits the number of events that appear on a page to this value.
+ The typical pattern of limit
and marker
+ is to make an initial limited request and then to use the ID of
+ the last event from the response as the marker
+ parameter in a subsequent limited request.
- Specifies the ID of the last-seen event. The typical pattern of limit and marker is to make an initial limited request and
- then to use the ID of the last event from the response as the marker parameter in a subsequent limited request.
+ Specifies the ID of the last-seen event. The typical pattern of
+ limit
and marker
is to make an initial
+ limited request and then to use the ID of the last event from the
+ response as the marker parameter in a subsequent limited request.
+
+
+
+ Sorts the event list by: timestamp
, obj_type
+
, obj_name
, user
, action
+
.
+
+
+
+
+
+
+ The sort direction of the event list. Valid values include
+ asc
(ascending) or desc
(descending).
+ Default is asc
.
+
+
+
+
+
+
+ Whether events related to all tenants should be returned.
+ Default is False
+
+
+
+
+
+
+ Whether deleted events should be returned as well.
+ Default is False
+
+
+
+
+
+
+ A list of key-value pairs for filtering the events returned.
+ The key can be one of:
+
+
+
+
+ obj_id
ID of an object for which the
+ events are to be listed. An object here can be a
+ cluster, a node, a policy etc. This key can appear
+ more than once.
+
+
+
+
+ obj_type
Type of an object for which the
+ events are to be listed. The type here can be one of
+ CLUSTER
, NODE
, POLICY
+
etc. This key can appear more than once.
+
+
+
+
+ obj_name
Name of an object for which the
+ events are to be listed. This key can appear more than
+ once.
+
+
+
+
+ cluster_id
ID of the cluster an event is
+ related to. This key can appear more than once.
+
+
+
+
+ action
ID of the action to which an event
+ is related. This key can appear more than once.
+
+
+
+
+
@@ -1479,7 +1524,11 @@
- A dictionary that contains the fields of an event such as TIMESTAMP
, LEVEL
.
+
+ A map named event
that contains the details of an event
+ such as TIMESTAMP
, LEVEL
etc.
+
+
@@ -1592,6 +1641,11 @@
+
+ A list named actions
that contains all records that
+ meet the criteria. Each record is a map that provides detailed data
+ about an action.
+
@@ -1604,7 +1658,8 @@
- A dictionary that contains the fields of an action such as id
, action
.
+ A map named action
that contains the fields of an action
+ such as id
, action
etc.
diff --git a/doc/api-site/api-ref/src/wadls/clustering-api/src/v1/samples/event_get_resp.json b/doc/api-site/api-ref/src/wadls/clustering-api/src/v1/samples/event_get_resp.json
new file mode 100644
index 000000000..94ed6134a
--- /dev/null
+++ b/doc/api-site/api-ref/src/wadls/clustering-api/src/v1/samples/event_get_resp.json
@@ -0,0 +1,17 @@
+{
+ "event": {
+ "action": "create",
+ "cluster_id": null,
+ "deleted_time": null,
+ "id": "2d255b9c-8f36-41a2-a137-c0175ccc29c3",
+ "level": "20",
+ "obj_id": "0df0931b-e251-4f2e-8719-4ebfda3627ba",
+ "obj_name": "node009",
+ "obj_type": "NODE",
+ "project": "6e18cc2bdbeb48a5b3cad2dc499f6804",
+ "status": "CREATING",
+ "status_reason": "Initializing",
+ "timestamp": "2015-03-05T08:53:15.000000",
+ "user": "a21ded6060534d99840658a777c2af5a"
+ }
+}
diff --git a/doc/api-site/api-ref/src/wadls/clustering-api/src/v1/samples/event_list_resp.json b/doc/api-site/api-ref/src/wadls/clustering-api/src/v1/samples/event_list_resp.json
index 7a9ccec12..0d55ce43e 100644
--- a/doc/api-site/api-ref/src/wadls/clustering-api/src/v1/samples/event_list_resp.json
+++ b/doc/api-site/api-ref/src/wadls/clustering-api/src/v1/samples/event_list_resp.json
@@ -1,22 +1,19 @@
{
"events": [
{
- "obj_name": "node-002",
- "timestamp": "2014-07-23T08:10:22Z",
- "obj_id": "3c7faa4040-a110-2ecf-a92c-0474bfdf73",
+ "action": "create",
+ "cluster_id": null,
+ "deleted_time": null,
+ "id": "2d255b9c-8f36-41a2-a137-c0175ccc29c3",
+ "level": "20",
+ "obj_id": "0df0931b-e251-4f2e-8719-4ebfda3627ba",
+ "obj_name": "node009",
"obj_type": "NODE",
- "level": "ERROR",
- "status": "ERROR",
- "status_reason": "Failed contacting Heat service endpoint",
- },
- {
- "obj_name": "test_cluster",
- "timestamp": "2014-07-23T08:14:47Z",
- "obj_id": "474bfdf0-a450-46ec-a78a-0c7faa404073",
- "obj_type": "CLUSTER",
- "level": "ERROR",
- "status": "ERROR",
- "status_reason": "Only 2 nodes were ACTIVE before timeout",
- },
+ "project": "6e18cc2bdbeb48a5b3cad2dc499f6804",
+ "status": "CREATING",
+ "status_reason": "Initializing",
+ "timestamp": "2015-03-05T08:53:15.000000",
+ "user": "a21ded6060534d99840658a777c2af5a"
+ }
]
}