aboutsummaryrefslogtreecommitdiffstats
path: root/docs/API.md
blob: bd2f26a918e451b9a331912e50c476402d363e6b (plain)
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
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
# DCAE Inventory API


<a name="overview"></a>
## Overview
DCAE Inventory is a web service that provides the following:

1. Real-time data on all DCAE services and their components
2. Comprehensive details on available DCAE service types


### Version information
*Version* : 3.0.0


### Contact information
*Contact Email* : dcae@lists.openecomp.org




<a name="paths"></a>
## Paths

<a name="dcaeservicetypestypenameput"></a>
### POST /dcae-service-types

#### Description
Inserts a new `DCAEServiceType` or updates an existing instance. Updates are only allowed if there are no running DCAE services of the requested type,


#### Parameters

|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Body**|**body**  <br>*required*||[DCAEServiceTypeRequest](#dcaeservicetyperequest)||


#### Responses

|HTTP Code|Description|Schema|
|---|---|---|
|**200**|Single `DCAEServiceType` object.|[DCAEServiceType](#dcaeservicetype)|
|**400**|Bad request provided.|[ApiResponseMessage](#apiresponsemessage)|
|**409**|Failed to update because there are still DCAE services of the requested type running.|[ApiResponseMessage](#apiresponsemessage)|


#### Consumes

* `application/json`


#### Produces

* `application/json`


<a name="dcaeservicetypesget"></a>
### GET /dcae-service-types

#### Description
Get a list of `DCAEServiceType` objects.


#### Parameters

|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Query**|**asdcResourceId**  <br>*optional*|Filter by associated asdc design resource id. Setting this to `NONE` will return instances that have asdc resource id set to null|string||
|**Query**|**asdcServiceId**  <br>*optional*|Filter by associated asdc design service id. Setting this to `NONE` will return instances that have asdc service id set to null|string||
|**Query**|**offset**  <br>*optional*|Query resultset offset used for pagination (zero-based)|integer(int32)||
|**Query**|**onlyActive**  <br>*optional*|If set to true, query returns only *active* DCAE service types. If set to false, then all DCAE service types are returned. Default is true|boolean|`"true"`|
|**Query**|**onlyLatest**  <br>*optional*|If set to true, query returns just the latest versions of DCAE service types. If set to false, then all versions are returned. Default is true|boolean|`"true"`|
|**Query**|**serviceId**  <br>*optional*|Filter by assocaited service id. Instances with service id null or empty is always returned.|string||
|**Query**|**serviceLocation**  <br>*optional*|Filter by associated service location. Instances with service location null or empty is always returned.|string||
|**Query**|**typeName**  <br>*optional*|Filter by service type name|string||
|**Query**|**vnfType**  <br>*optional*|Filter by associated vnf type. No wildcards, matches are explicit. This field is treated case insensitive.|string||
|**Query**|**owner**  <br>*optional*|Filter by owner name|string||
|**Query**|**application**  <br>*optional*|Filter by application name|string||
|**Query**|**component**  <br>*optional*|Filter by component name|string||


#### Responses

|HTTP Code|Description|Schema|
|---|---|---|
|**200**|List of `DCAEServiceType` objects|[InlineResponse200](#inlineresponse200)|


#### Consumes

* `application/json`
* `application/vnd.dcae.inventory.v1+json`


#### Produces

* `application/json`
* `application/vnd.dcae.inventory.v1+json`


<a name="dcaeservicetypestypeidget"></a>
### GET /dcae-service-types/{typeId}

#### Description
Get a `DCAEServiceType` object.


#### Parameters

|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Path**|**typeId**  <br>*required*||string||


#### Responses

|HTTP Code|Description|Schema|
|---|---|---|
|**200**|Single `DCAEServiceType` object|[DCAEServiceType](#dcaeservicetype)|
|**404**|Resource not found|[DCAEServiceType](#dcaeservicetype)|


#### Consumes

* `application/json`


#### Produces

* `application/json`


<a name="dcaeservicetypestypeiddelete"></a>
### DELETE /dcae-service-types/{typeId}

#### Description
Deactivates existing `DCAEServiceType` instances


#### Parameters

|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Path**|**typeId**  <br>*required*||string||


#### Responses

|HTTP Code|Description|Schema|
|---|---|---|
|**200**|`DCAEServiceType` has been deactivated|[ApiResponseMessage](#apiresponsemessage)|
|**404**|`DCAEServiceType` not found|[ApiResponseMessage](#apiresponsemessage)|
|**410**|`DCAEServiceType` already gone|[ApiResponseMessage](#apiresponsemessage)|


#### Consumes

* `application/vnd.dcae.inventory.v1+json`
* `application/json`


#### Produces

* `application/vnd.dcae.inventory.v1+json`
* `application/json`


<a name="dcaeservicesget"></a>
### GET /dcae-services

#### Description
Get a list of `DCAEService` objects.


#### Parameters

|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Query**|**componentType**  <br>*optional*|Use to filter by a specific DCAE service component type|string||
|**Query**|**created**  <br>*optional*|Use to filter by created time|string||
|**Query**|**offset**  <br>*optional*|Query resultset offset used for pagination (zero-based)|integer(int32)||
|**Query**|**shareable**  <br>*optional*|Use to filter by DCAE services that have shareable components or not|boolean||
|**Query**|**typeId**  <br>*optional*|DCAE service type name|string||
|**Query**|**vnfId**  <br>*optional*||string||
|**Query**|**vnfLocation**  <br>*optional*||string||
|**Query**|**vnfType**  <br>*optional*|Filter by associated vnf type. This field is treated case insensitive.|string||


#### Responses

|HTTP Code|Description|Schema|
|---|---|---|
|**200**|List of `DCAEService` objects|[InlineResponse2001](#inlineresponse2001)|


#### Consumes

* `application/json`
* `application/vnd.dcae.inventory.v1+json`


#### Produces

* `application/json`
* `application/vnd.dcae.inventory.v1+json`


<a name="dcaeservicesgroupbypropertynameget"></a>
### GET /dcae-services-groupby/{propertyName}

#### Description
Get a list of unique values for the given `propertyName`


#### Parameters

|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Path**|**propertyName**  <br>*required*|Property to find unique values. Restricted to `type`, `vnfType`, `vnfLocation`|string||


#### Responses

|HTTP Code|Description|Schema|
|---|---|---|
|**200**|List of unique property values|[DCAEServiceGroupByResults](#dcaeservicegroupbyresults)|


#### Consumes

* `application/json`
* `application/vnd.dcae.inventory.v1+json`


#### Produces

* `application/json`
* `application/vnd.dcae.inventory.v1+json`


<a name="dcaeservicesserviceidget"></a>
### GET /dcae-services/{serviceId}

#### Description
Get a `DCAEService` object.


#### Parameters

|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Path**|**serviceId**  <br>*required*||string||


#### Responses

|HTTP Code|Description|Schema|
|---|---|---|
|**200**|Single `DCAEService` object|[DCAEService](#dcaeservice)|
|**404**|DCAE service not found|[ApiResponseMessage](#apiresponsemessage)|


#### Consumes

* `application/json`
* `application/vnd.dcae.inventory.v1+json`


#### Produces

* `application/json`
* `application/vnd.dcae.inventory.v1+json`


<a name="dcaeservicesserviceidput"></a>
### PUT /dcae-services/{serviceId}

#### Description
Put a new or update an existing `DCAEService` object.


#### Parameters

|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Path**|**serviceId**  <br>*required*||string||
|**Body**|**body**  <br>*required*||[DCAEServiceRequest](#dcaeservicerequest)||


#### Responses

|HTTP Code|Description|Schema|
|---|---|---|
|**200**|Single `DCAEService` object|[DCAEService](#dcaeservice)|
|**422**|Bad request provided|[ApiResponseMessage](#apiresponsemessage)|


#### Consumes

* `application/json`
* `application/vnd.dcae.inventory.v1+json`


#### Produces

* `application/json`
* `application/vnd.dcae.inventory.v1+json`


<a name="dcaeservicesserviceiddelete"></a>
### DELETE /dcae-services/{serviceId}

#### Description
Remove an existing `DCAEService` object.


#### Parameters

|Type|Name|Description|Schema|Default|
|---|---|---|---|---|
|**Path**|**serviceId**  <br>*required*||string||


#### Responses

|HTTP Code|Description|Schema|
|---|---|---|
|**200**|DCAE service has been removed|No Content|
|**404**|Unknown DCAE service|[ApiResponseMessage](#apiresponsemessage)|


#### Consumes

* `application/vnd.dcae.inventory.v1+json`
* `application/json`


#### Produces

* `application/json`
* `application/vnd.dcae.inventory.v1+json`




<a name="definitions"></a>
## Definitions

<a name="apiresponsemessage"></a>
### ApiResponseMessage

|Name|Description|Schema|
|---|---|---|
|**code**  <br>*optional*||integer(int32)|
|**message**  <br>*optional*||string|
|**type**  <br>*optional*||string|


<a name="dcaeservice"></a>
### DCAEService

|Name|Description|Schema|
|---|---|---|
|**components**  <br>*optional*||< [DCAEServiceComponent](#dcaeservicecomponent) > array|
|**created**  <br>*optional*||string(date-time)|
|**deploymentRef**  <br>*optional*|Reference to a Cloudify deployment|string|
|**modified**  <br>*optional*||string(date-time)|
|**selfLink**  <br>*optional*|Link.title is serviceId|[Link](#link)|
|**serviceId**  <br>*optional*||string|
|**typeLink**  <br>*optional*|Link.title is typeId|[Link](#link)|
|**vnfId**  <br>*optional*||string|
|**vnfLink**  <br>*optional*|Link.title is vnfId|[Link](#link)|
|**vnfLocation**  <br>*optional*|Location information of the associated VNF|string|
|**vnfType**  <br>*optional*||string|


<a name="dcaeservicecomponent"></a>
### DCAEServiceComponent

|Name|Description|Schema|
|---|---|---|
|**componentId**  <br>*required*|The id format is unique to the source|string|
|**componentLink**  <br>*required*|Link to the underlying resource of this component|[Link](#link)|
|**componentSource**  <br>*required*|Specifies the name of the underlying source service that is responsible for this components|enum (DMaaPController)|
|**componentType**  <br>*required*||string|
|**created**  <br>*required*||string(date-time)|
|**location**  <br>*optional*|Location information of the component|string|
|**modified**  <br>*required*||string(date-time)|
|**shareable**  <br>*required*|Used to determine if this component can be shared amongst different DCAE services|integer(int32)|
|**status**  <br>*optional*||string|


<a name="dcaeservicecomponentrequest"></a>
### DCAEServiceComponentRequest

|Name|Description|Schema|
|---|---|---|
|**componentId**  <br>*required*|The id format is unique to the source|string|
|**componentSource**  <br>*required*|Specifies the name of the underlying source service that is responsible for this components|enum (DMaaPController)|
|**componentType**  <br>*required*||string|
|**shareable**  <br>*required*|Used to determine if this component can be shared amongst different DCAE services|integer(int32)|


<a name="dcaeservicegroupbyresults"></a>
### DCAEServiceGroupByResults

|Name|Description|Schema|
|---|---|---|
|**propertyName**  <br>*optional*|Property name of DCAE service that the group by operation was performed on|string|
|**propertyValues**  <br>*optional*||< [DCAEServiceGroupByResultsPropertyValues](#dcaeservicegroupbyresultspropertyvalues) > array|


<a name="dcaeservicegroupbyresultspropertyvalues"></a>
### DCAEServiceGroupByResultsPropertyValues

|Name|Description|Schema|
|---|---|---|
|**count**  <br>*optional*||integer(int32)|
|**dcaeServiceQueryLink**  <br>*optional*|Link.title is the DCAE service property value. Following this link will provide a list of DCAE services that all have this property value.|[Link](#link)|
|**propertyValue**  <br>*optional*||string|


<a name="dcaeservicerequest"></a>
### DCAEServiceRequest

|Name|Description|Schema|
|---|---|---|
|**components**  <br>*required*|List of DCAE service components that this service is composed of|< [DCAEServiceComponentRequest](#dcaeservicecomponentrequest) > array|
|**deploymentRef**  <br>*optional*|Reference to a Cloudify deployment|string|
|**typeId**  <br>*required*|Id of the associated DCAE service type|string|
|**vnfId**  <br>*required*|Id of the associated VNF that this service is monitoring|string|
|**vnfLocation**  <br>*required*|Location identifier of the associated VNF that this service is monitoring|string|
|**vnfType**  <br>*required*|The type of the associated VNF that this service is monitoring|string|


<a name="dcaeservicetype"></a>
### DCAEServiceType

|Name|Description|Schema|
|---|---|---|
|**asdcResourceId**  <br>*optional*|Id of vf/vnf instance this DCAE service type is associated with. Value source is from ASDC's notification event's field `resourceInvariantUUID`.|string|
|**asdcServiceId**  <br>*optional*|Id of service this DCAE service type is associated with. Value source is from ASDC's notification event's field `serviceInvariantUUID`.|string|
|**asdcServiceURL**  <br>*optional*|URL to the ASDC service model|string|
|**blueprintTemplate**  <br>*required*|String representation of a Cloudify blueprint with unbound variables|string|
|**created**  <br>*required*|Created timestamp for this DCAE service type in epoch time|string(date-time)|
|**deactivated**  <br>*optional*|Deactivated timestamp for this DCAE service type in epoch time|string(date-time)|
|**owner**  <br>*required*||string|
|**application**  <br>*optional*||string|
|**component**  <br>*optional*||string|
|**selfLink**  <br>*required*|Link to self where the Link.title is typeName|[Link](#link)|
|**serviceIds**  <br>*optional*|List of service ids that are used to associate with DCAE service type. DCAE service types with this property as null or empty means them apply for every service id.|< string > array|
|**serviceLocations**  <br>*optional*|List of service locations that are used to associate with DCAE service type. DCAE service types with this property as null or empty means them apply for every service location.|< string > array|
|**typeId**  <br>*required*|Unique identifier for this DCAE service type|string|
|**typeName**  <br>*required*|Descriptive name for this DCAE service type|string|
|**typeVersion**  <br>*required*|Version number for this DCAE service type|integer(int32)|
|**vnfTypes**  <br>*optional*||< string > array|


<a name="dcaeservicetyperequest"></a>
### DCAEServiceTypeRequest

|Name|Description|Schema|
|---|---|---|
|**asdcResourceId**  <br>*optional*|Id of vf/vnf instance this DCAE service type is associated with. Value source is from ASDC's notification event's field `resourceInvariantUUID`.|string|
|**asdcServiceId**  <br>*optional*|Id of service this DCAE service type is associated with. Value source is from ASDC's notification event's field `serviceInvariantUUID`.|string|
|**asdcServiceURL**  <br>*optional*|URL to the ASDC service model|string|
|**blueprintTemplate**  <br>*required*|String representation of a Cloudify blueprint with unbound variables|string|
|**owner**  <br>*required*||string|
|**application**  <br>*optional*||string|
|**component**  <br>*optional*||string|
|**serviceIds**  <br>*optional*|List of service ids that are used to associate with DCAE service type. DCAE service types with this property as null or empty means them apply for every service id.|< string > array|
|**serviceLocations**  <br>*optional*|List of service locations that are used to associate with DCAE service type. DCAE service types with this property as null or empty means them apply for every service location.|< string > array|
|**typeName**  <br>*required*|Descriptive name for this DCAE service type|string|
|**typeVersion**  <br>*required*|Version number for this DCAE service type|integer(int32)|
|**vnfTypes**  <br>*optional*||< string > array|


<a name="inlineresponse200"></a>
### InlineResponse200

|Name|Description|Schema|
|---|---|---|
|**items**  <br>*optional*||< [DCAEServiceType](#dcaeservicetype) > array|
|**links**  <br>*optional*||[InlineResponse200Links](#inlineresponse200links)|
|**totalCount**  <br>*optional*||integer(int32)|


<a name="inlineresponse2001"></a>
### InlineResponse2001

|Name|Description|Schema|
|---|---|---|
|**items**  <br>*optional*||< [DCAEService](#dcaeservice) > array|
|**links**  <br>*optional*||[InlineResponse200Links](#inlineresponse200links)|
|**totalCount**  <br>*optional*||integer(int32)|


<a name="inlineresponse200links"></a>
### InlineResponse200Links
Pagination links


|Name|Description|Schema|
|---|---|---|
|**nextLink**  <br>*optional*||[Link](#link)|
|**previousLink**  <br>*optional*||[Link](#link)|


<a name="link"></a>
### Link

|Name|Description|Schema|
|---|---|---|
|**params**  <br>*optional*||< string, string > map|
|**rel**  <br>*optional*||string|
|**rels**  <br>*optional*||< string > array|
|**title**  <br>*optional*||string|
|**type**  <br>*optional*||string|
|**uri**  <br>*optional*||string|
|**uriBuilder**  <br>*optional*||[UriBuilder](#uribuilder)|


<a name="uribuilder"></a>
### UriBuilder
*Type* : object