91 | | |
92 | | == Reference == |
93 | | |
94 | | === Schema === |
95 | | |
96 | | ==== Request JSON ==== |
97 | | |
98 | | {{{ |
99 | | { |
100 | | "$schema": "http://json-schema.org/draft-03/schema#", |
101 | | "additionalProperties": false, |
102 | | "description": "Request Object for GENI Monitoring Collector API.", |
103 | | "id": "localhost:9000/schema/request#", |
104 | | "name": "request", |
105 | | "properties": { |
106 | | "$schema": { |
107 | | "default": "localhost:9000/schema/request#", |
108 | | "description": "The schema of this file.", |
109 | | "format": "uri", |
110 | | "required": false, |
111 | | "type": "string" |
112 | | }, |
113 | | "eventType": { |
114 | | "additionalProperties": false, |
115 | | "description": "Event types to search for. If this is missing, all of the requested events for target type are returned.", |
116 | | "items": { |
117 | | "description": "An array holding the GENI IDs of the request targets or a single element 'all'.", |
118 | | "required": true, |
119 | | "type": "string" |
120 | | }, |
121 | | "required": false, |
122 | | "type": "array" |
123 | | }, |
124 | | "obj": { |
125 | | "description": "Targets for this request.", |
126 | | "properties": { |
127 | | "id": { |
128 | | "description": "Array holding the GENI urns of the targets of the request.", |
129 | | "required": false, |
130 | | "type": "array" |
131 | | }, |
132 | | "type": { |
133 | | "description": "The type of objects being requested.", |
134 | | "required": true, |
135 | | "type": "string" |
136 | | } |
137 | | }, |
138 | | "required": true, |
139 | | "type": "object" |
140 | | }, |
141 | | "output": { |
142 | | "description": "Output style requested. Defaults to XML if not specified.", |
143 | | "enum": [ |
144 | | "json", |
145 | | "xml" |
146 | | ], |
147 | | "required": false |
148 | | }, |
149 | | "ts": { |
150 | | "description": "Timestamps for request", |
151 | | "properties": { |
152 | | "gte": { |
153 | | "description": "Timestamp for DATA requests indicating the start of the time range in either milliseconds or microseconds. Required for DATA requests.", |
154 | | "required": true, |
155 | | "type": "number" |
156 | | }, |
157 | | "lt": { |
158 | | "description": "Timestamp for DATA requests indicating the end of the time range in either milliseconds or microseconds. Required for DATA requests.", |
159 | | "required": true, |
160 | | "type": "number" |
161 | | }, |
162 | | "ts": { |
163 | | "description": "Timestamp for INFO requests in either milliseconds or microseconds. If missing, defaults to current time.", |
164 | | "required": false, |
165 | | "type": "number" |
166 | | } |
167 | | }, |
168 | | "required": true, |
169 | | "type": "object" |
170 | | } |
171 | | }, |
172 | | "type": "object" |
173 | | } |
174 | | }}} |