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
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
|
# variables in path
accelerator_request_uuid:
description: |
The UUID of one accelerator request.
in: path
required: true
type: string
attribute_request_uuid:
description: |
The UUID of the attribute.
in: path
required: true
type: string
deployable_uuid:
description: |
The UUID of the deployable.
This must be a valid UUID otherwise API will return 400.
in: path
required: true
type: string
device_profile_name_or_uuid:
description: |
The name or uuid of the device_profile for your accelerator request.
in: path
required: true
type: string
min_version: 2.2
-H "OpenStack-API-Version: 2.2"
device_profile_uuid_v_21:
description: |
The uuid of the device_profile for your accelerator request.
This must be a valid uuid otherwise api will return 400.
in: path
required: true
type: string
device_uuid:
description: |
The UUID of the device.
This must be a valid UUID otherwise API will return 400.
in: path
required: true
type: string
# variables in query
attribute_request_depid:
description: |
ID of deployable associated with the attribute.
in: query
required: true
type: integer
device_filters:
description: |
A list of filter of ``FilterType`` to get device list by filter.
in: query
required: false
type: array
device_type:
description: |
The type of the device.
in: query
required: false
type: string
device_vendor:
description: |
The vendor ID of the device.
in: query
required: false
type: string
filters:
description: |
A list of FilterType(in json string format).
in: query
required: false
type: string
hostname:
description: |
The hostname of a compute node where the device locates.
in: query
required: false
type: string
# variables in body
attribute_deployable_id_req:
description: |
ID of deployable associated with the attribute.
in: body
required: true
type: integer
attribute_deployable_id_resp:
description: |
ID of deployable associated with the attribute.
in: body
required: true
type: integer
attribute_id_resp:
description: |
ID of the attribute.
in: body
required: true
type: integer
attribute_key_req:
description: |
The key of the attribute.
in: body
required: true
type: string
attribute_key_resp:
description: |
The key of the attribute.
in: body
required: true
type: string
attribute_uuid_resp:
description: |
The UUID of the attribute.
in: body
required: true
type: string
attribute_value_req:
description: |
The value of the attribute.
in: body
required: true
type: string
attribute_value_resp:
description: |
The value of the attribute.
in: body
required: true
type: string
attributes:
description: |
A list of ``attributes`` objects.
in: body
required: true
type: array
created:
description: |
The date and time when the resource was created. The date and time
stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_
::
CCYY-MM-DDThh:mm:ss±hh:mm
For example, ``2015-08-27T09:49:58-05:00``. The ``±hh:mm``
value, if included, is the time zone as an offset from UTC. In
the previous example, the offset value is ``-05:00``.
in: body
required: true
type: string
deployable_attributes_list:
description: |
A list of dictionaries (in json string format) representing attributes of
the deployable.
in: body
required: true
type: string
deployable_bitstream_id:
description: |
The UUID of the bitstream corresponding to the deployable.
in: body
required: true
type: string
deployable_device_id:
description: |
ID of device associated with the deployable.
in: body
required: true
type: integer
deployable_driver_name:
description: |
Name of the driver reported.
in: body
required: true
type: string
deployable_name:
description: |
Name of the deployable.
in: body
required: true
type: string
deployable_num_accelerators:
description: |
Number of accelerators spawned by this deployable.
in: body
required: true
type: integer
deployable_parent_id:
description: |
The parent_id refers to the id of the deployable's parent node.
in: body
required: true
type: string
deployable_root_id:
description: |
The root_id refers to the id of the deployable's root to
for nested tree.
in: body
required: true
type: string
deployable_rp_uuid:
description: |
UUID of the resource provider corresponding to this deployable.
in: body
required: true
type: string
deployable_uuid_resp:
description: |
The UUID of the deployable.
in: body
required: true
type: string
deployables:
description: |
This is a list of dictionaries, with each dictionary representing
a deployable object.
in: body
required: true
type: array
device_model_resp:
description: |
The model of the device.
in: body
required: true
type: string
device_prof_description_req:
description: |
A free form description of the device profile. Limited to 255 characters
in length.
type: string
in: body
required: false
device_prof_groups_req:
description: |
This is a list of dictionaries to describe requested accelerator resource
by users, where users use keys to describe the resource_classes or traits
and values to indicate its quantity or property. This is intentionally
similar to extra_specs in nova flavor, and uses the same keywords for
resources and traits. The key-value pair can either be a resource/trait
or a Cyborg property. Cyborg property is of the form
"accel:<key>": "<value>". The valid key-value pairs can be found
`below <https://opendev.org/openstack/cyborg-specs/src/branch/master/specs/train/implemented/device-profiles.rst#valid-accel-keys>`_.
in: body
required: true
type: a list of dictionaries
device_prof_groups_resp:
description: |
This is a list of dictionaries to describe returned accelerator resource
by users, where users use keys to describe the resource_classes or traits
and values to indicate its quantity or property. This is intentionally
similar to extra_specs in nova flavor, and uses the same keywords for
resources and traits. The key-value pair can either be a resource/trait
or a Cyborg property. Cyborg property is of the form
"accel:<key>": "<value>". The valid key-value pairs can be found
`below <https://opendev.org/openstack/cyborg-specs/src/branch/master/specs/train/implemented/device-profiles.rst#valid-accel-keys>`_.
in: body
required: true
type: a list of dictionaries
device_prof_name_req:
description: |
The display name of a device profile.
in: body
required: true
type: string
device_prof_name_resp:
description: |
The display name of a device profile.
in: body
required: true
type: string
device_profile:
description: |
A list of ``device profile`` objects.
in: body
required: true
type: array
device_profile_description_resp:
description: |
The display description of a device profile.
in: body
required: true
type: string
device_profile_name:
description: |
The display name of a device profile.
in: body
required: true
type: string
device_profile_uuid_resp:
description: |
The uuid of the device_profile.
in: body
required: true
type: string
device_profiles:
description: |
A list of ``device profiles`` objects.
in: body
required: true
type: array
device_rp_uuid_bind_unbind_req:
description: |
UUID of the target accelerator (resource provider) for bind or unbind of
one accelerator request.
in: body
required: true
type: string
device_status_resp:
description: |
The status of device. One of maintaining or enabled.
in: body
required: true
type: string
device_std_board_info_resp:
description: |
The standard board information of the device.
in: body
required: true
type: string
device_type_resp:
description: |
Type of the device.
in: body
required: true
type: string
device_uuid_resp:
description: |
The UUID of the device.
in: body
required: true
type: string
device_vendor_board_info_resp:
description: |
The vendor board information of the device.
in: body
required: true
type: string
device_vendor_resp:
description: |
The vendor of the device.
in: body
required: true
type: string
devices:
description: |
A list of ``devices`` objects.
in: body
required: true
type: array
hostname_bind_unbind_req:
description: |
The name of the target host for bind or unbind of one accelerator request.
in: body
required: true
type: string
hostname_resp:
description: |
The host name of the device.
in: body
required: true
type: string
instance_project_id_bind_unbind_req:
description: |
Project id of the target instance for bind or unbind of one accelerator request.
in: body
required: false
type: string
min_version: 2.1
instance_uuid_bind_unbind_req:
description: |
UUID of the target instance for bind or unbind of one accelerator request.
in: body
required: true
type: string
links:
description: |
Links to the resources in question.
in: body
required: true
type: array
updated:
description: |
The date and time when the resource was updated. The date and time
stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_
::
CCYY-MM-DDThh:mm:ss±hh:mm
For example, ``2015-08-27T09:49:58-05:00``. The ``±hh:mm``
value, if included, is the time zone as an offset from UTC. In
the previous example, the offset value is ``-05:00``.
in: body
required: true
type: string
|
