Gitiles
Code Review Sign In
gerrit.nordix.org / onap / so / aa60635864b19e2790a0515ec398ba48be2bb75d / . / docs / api / apis / consumed-apis.rst
blob: 0ef69c4da18b413ac9896af295886f1745abf48f [file] [log] [blame]
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]1.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
3.. Copyright 2018 Huawei Technologies Co., Ltd.
4
Rene_Robertaa606352019-08-22 16:57:27 +0200[diff] [blame^]5API consumed by SO
6==================
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]7
seshukmd836ec02019-01-18 14:10:05 +0530[diff] [blame]8.. image:: ../../images/SO_1.png
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]9
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]10
11SDC Client API
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]12--------------
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]13
14Get List of Existing Catalog Assets
15+++++++++++++++++++++++++++++++++++
16
17+--------------------+--------------------------+
18|Interface Definition|Description |
19+====================+==========================+
20|URI |sdc/v1/catalog/{assetType}|
21+--------------------+--------------------------+
22|Operation Type |GET |
23+--------------------+--------------------------+
24
25Request Parameters:
26
27+-------------------+---------+-----------+-------+-------------------------------------------------------------+
28|Attribute |Qualifier|Cardinality|Content|Description |
29+===================+=========+===========+=======+=============================================================+
30|assetType |M |1 |String |The requested asset type.valid values are resources/services.|
31+-------------------+---------+-----------+-------+-------------------------------------------------------------+
32|service-type |M |1 |String |Service Type |
33+-------------------+---------+-----------+-------+-------------------------------------------------------------+
34|service-instance-id|M |1 |String |Service Instance ID |
35+-------------------+---------+-----------+-------+-------------------------------------------------------------+
36
37Request Headers:
38
39+-------------------+---------+-----------------------------------------------------------------------------------------+
40|Header Name |Qualifier|Description |
41+===================+=========+=========================================================================================+
42|X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
43+-------------------+---------+-----------------------------------------------------------------------------------------+
44|X-ECOMP-InstanceID |Y |Instance ID |
45+-------------------+---------+-----------------------------------------------------------------------------------------+
46|Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
47+-------------------+---------+-----------------------------------------------------------------------------------------+
48|Authorization |Y |Base64 encoded username:password |
49+-------------------+---------+-----------------------------------------------------------------------------------------+
50
51Response:
52
53+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
54|Attribute |Qualifier|Cardinality|Content|Description |
55+==================+=========+===========+=======+======================================================================================+
56|uuid |M |1 |String |Global Asset Version Identifier: UUID generated by SDC per each version of the asset. |
57+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
58|invariantUUID |M |1 |String |UUID generated by SDC per each asset. |
59+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
60|name |M |1 |String |The name of the asset |
61+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
62|version |M |1 |String |The asset version in SDC catalog. |
63+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
64|toscaModelURL |M |1 |String |Relative asset’s URL. Should be used in REST GET API to download the asset’s CSAR. |
65+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
66|category |M |1 |String |Category of the asset. |
67+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
68|subcategory |M |1 |String |Sub-category of the asset |
69+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
70|resourceType |M |1 |String |The type of resource.resource types are VF, VL, CP, VFC, VFCMT, PNF. |
71+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
72|lifecycleState |M |1 |String |The lifecycle state of the asset |
73+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
74|lastUpdaterUserId |M |1 |String |UserID of the SDC designer who was the last to update the asset for this major version|
75+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
76
77Get Specific Asset Detailed Metadata
78++++++++++++++++++++++++++++++++++++
79
80+--------------------+-------------------------------------------+
81|Interface Definition|Description |
82+====================+===========================================+
83|URI |/sdc/v1/catalog/{assetType}/{uuid}/metadata|
84+--------------------+-------------------------------------------+
85|Operation Type |GET |
86+--------------------+-------------------------------------------+
87
88Request Parameters:
89
90+-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
91|Attribute |Qualifier|Cardinality|Content|Description |
92+===================+=========+===========+=======+=====================================================================================+
93|assetType |M |1 |String |The requested asset type.valid values are resources/services. |
94+-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
95|uuid |M |1 |String |Global Asset Version Identifier: UUID generated by SDC per each version of the asset.|
96+-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
97
98Request Headers:
99
100+-------------------+---------+-----------------------------------------------------------------------------------------+
101|Header Name |Qualifier|Description |
102+===================+=========+=========================================================================================+
103|X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
104+-------------------+---------+-----------------------------------------------------------------------------------------+
105|X-ECOMP-InstanceID |Y |Instance ID |
106+-------------------+---------+-----------------------------------------------------------------------------------------+
107|Accept |N |Determines the format of the body of the response. Valid values are : “application/json”|
108+-------------------+---------+-----------------------------------------------------------------------------------------+
109|Authorization |Y |Base64 encoded username:password |
110+-------------------+---------+-----------------------------------------------------------------------------------------+
111
112Response:
113
114+--------------------+---------+-------+--------------------------------------------------------------------------------------+
115|Attribute |Qualifier|Content|Description |
116+====================+=========+=======+======================================================================================+
117|uuid |M |String |Global Asset Version Identifier: UUID generated by SDC per each version of the asset. |
118+--------------------+---------+-------+--------------------------------------------------------------------------------------+
119|invariantUUID |M |String |UUID generated by SDC per each asset. |
120+--------------------+---------+-------+--------------------------------------------------------------------------------------+
121|name |M |String |The name of the asset |
122+--------------------+---------+-------+--------------------------------------------------------------------------------------+
123|version |M |String |The asset version in SDC catalog. |
124+--------------------+---------+-------+--------------------------------------------------------------------------------------+
125|toscaModelURL |M |String |Relative asset’s URL. Should be used in REST GET API to download the asset’s CSAR. |
126+--------------------+---------+-------+--------------------------------------------------------------------------------------+
127|description |M |String |Short description of the resource |
128+--------------------+---------+-------+--------------------------------------------------------------------------------------+
129|lastUpdaterUserId |M |String |UserID of the SDC designer who was the last to update the asset for this major version|
130+--------------------+---------+-------+--------------------------------------------------------------------------------------+
131|lastUpdaterFullName |M |String |UserID of the SDC designer who was the last to update the asset for this major version|
132+--------------------+---------+-------+--------------------------------------------------------------------------------------+
133|category |M |String |Category of the asset |
134+--------------------+---------+-------+--------------------------------------------------------------------------------------+
135|subCategory |M |String |Sub-category of the asset. |
136+--------------------+---------+-------+--------------------------------------------------------------------------------------+
137|toscaResourceName |M |String |The full name of the asset |
138+--------------------+---------+-------+--------------------------------------------------------------------------------------+
139|resourceType |M |String |The type of resource. |
140+--------------------+---------+-------+--------------------------------------------------------------------------------------+
141|lifecycleState |M |String |The lifecycle state of the asset |
142+--------------------+---------+-------+--------------------------------------------------------------------------------------+
143|resources |N |Object |Category of the asset |
144+--------------------+---------+-------+--------------------------------------------------------------------------------------+
145|artifacts |M |Object |Category of the asset |
146+--------------------+---------+-------+--------------------------------------------------------------------------------------+
147
148Resource Object:
149
150+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]151|Attribute |Qualifier|Content|Description |
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]152+=====================+=========+=======+===================================================================================================================+
153|resourceInstanceName |M |String |Logical Resource Instance Name.Unique Identifier of the instance of the specific resource in the service context.|
154+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
155|resourceName |M |String |Resource Name |
156+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
157|resourceInvariantUUID|M |String |The invariant UUID of the resource |
158+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
159|resourceVersion |M |String |Resource Version |
160+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
161|resoucreType |M |String |Resource Type |
162+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
163|resourceUUID |M |String |Global UUID of the resource that specific artifact belongs to |
164+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
165|artifacts |M |Object |Array of resource instance deployment artifacts. |
166+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
167
168Artifact Metadata Object:
169
170+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
171|Attribute |Qualifier|Content |Description |
172+=====================+=========+========+===================================================================================================================+
173|artifactName |M |String |Artifact File name |
174+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
175|artifactLabel |M |String |Identifier of the artifact within the VF / Service. |
176+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
177|artifactType |M |String |Artifact Type |
178+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
179|artifactGroupType |M |String |Whether the artifact is informational or deployment. |
180+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
181|artifactURL |M |String |Relative artifact’s URL. |
182+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
183|artifactDescription |M |String |Artifact Description |
184+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
185|artifactTimeout |N |Integer |Artifact Description |
186+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
187|artifactChecksum |M |String |Base-64 encoded MD5 checksum of the artifact’s payload. |
188+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
189|artifactUUID |M |String |Global UUID generated by SDC each time when artifact payload is updated. |
190+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
191|artifactVersion |M |String |Service Version |
192+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
193|generatedFromUUID |N |String |This attribute will be sent only in the case of an artifact generated on basis of other artifact |
194+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
195
196Download (CSAR of) Specific Asset
197+++++++++++++++++++++++++++++++++
198
199+--------------------+-----------------------------------------------------------+
200|Interface Definition|Description |
201+====================+===========================================================+
202|URI |/sdc/v1/catalog/{assetType}/{uuid}/artifacts/{artifactUUID}|
203+--------------------+-----------------------------------------------------------+
204|Operation Type |GET |
205+--------------------+-----------------------------------------------------------+
206
207Request Parameters:
208
209+-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
210|Attribute |Qualifier|Cardinality|Content|Description |
211+===================+=========+===========+=======+=====================================================================================+
212|assetType |M |1 |String |The requested asset type.valid values are resources/services. |
213+-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
214|Uuid |M |1 |String |The uuid of the asset as published in the metadata |
215+-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
216|artifactUUID |M |1 |String |The artifactUUID of the asset as published in the metadata |
217+-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
218
219Response:
220
221+--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+
222|Header name |Qualifier|Description |
223+====================+=========+==========================================================================================================================+
224|Content-Type |M |Specifies the downloaded payload format as “ arbitrary data in binary format” .Valid value is : application/octet-stream |
225+--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+
226|Content-Length |M |Streamed artifact payload size |
227+--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+
228|Content-Disposition |M |Specifies the name of file to store the downloaded artifact’s payload ( RFC 2183) . |
229+--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+
230
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]231
232Inventory APIs
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]233--------------
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]234
235create or update an existing service-instance
236+++++++++++++++++++++++++++++++++++++++++++++
237
238+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
239|Interface Definition|Description |
240+====================+====================================================================================================================================================================+
241|URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}|
242+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
243|Operation Type |PUT |
244+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
245
246Request Parameters:
247
248+-------------------+---------+-----------+-------+-----------------------+
249|Attribute |Qualifier|Cardinality|Content|Description |
250+===================+=========+===========+=======+=======================+
251|global-customer-id |M |1 |String |Global Customer ID |
252+-------------------+---------+-----------+-------+-----------------------+
253|service-type |M |1 |String |Service Type |
254+-------------------+---------+-----------+-------+-----------------------+
255|service-instance-id|M |1 |String |Service Instance ID |
256+-------------------+---------+-----------+-------+-----------------------+
257
258Response:
259
260+---------+---------+-----------+-------+-------------------+
261|Attribute|Qualifier|Cardinality|Content|Description |
262+---------+---------+-----------+-------+-------------------+
263|HTTP code|M |1 |Integer|HTTP response code |
264+---------+---------+-----------+-------+-------------------+
265
266delete an existing service-instance
267+++++++++++++++++++++++++++++++++++
268
269+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
270|Interface Definition|Description |
271+====================+====================================================================================================================================================================+
272|URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}|
273+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
274|Operation Type |DELETE |
275+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
276
277Request Parameters:
278
279+-------------------+---------+-----------+-------+-----------------------+
280|Attribute |Qualifier|Cardinality|Content|Description |
281+===================+=========+===========+=======+=======================+
282|global-customer-id |M |1 |String |Global Customer ID |
283+-------------------+---------+-----------+-------+-----------------------+
284|service-type |M |1 |String |Service Type |
285+-------------------+---------+-----------+-------+-----------------------+
286|service-instance-id|M |1 |String |Service Instance ID |
287+-------------------+---------+-----------+-------+-----------------------+
288
289Response:
290
291+---------+---------+-----------+-------+-------------------+
292|Attribute|Qualifier|Cardinality|Content|Description |
293+---------+---------+-----------+-------+-------------------+
294|HTTP code|M |1 |Integer|HTTP response code |
295+---------+---------+-----------+-------+-------------------+
296
297get service-instances
298+++++++++++++++++++++
299
300+--------------------+-----------------------------------------------------------------------------------------------------------------------------+
301|Interface Definition|Description |
302+====================+=============================================================================================================================+
303|URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances|
304+--------------------+-----------------------------------------------------------------------------------------------------------------------------+
305|Operation Type |GET |
306+--------------------+-----------------------------------------------------------------------------------------------------------------------------+
307
308Request Parameters:
309
310+-------------------+---------+-----------+-------+-----------------------+
311|Attribute |Qualifier|Cardinality|Content|Description |
312+===================+=========+===========+=======+=======================+
313|global-customer-id |M |1 |String |Global Customer ID |
314+-------------------+---------+-----------+-------+-----------------------+
315|service-type |M |1 |String |Service Type |
316+-------------------+---------+-----------+-------+-----------------------+
317|subscriber-name |O |1 |String |Subscriber name |
318+-------------------+---------+-----------+-------+-----------------------+
319|subscriber-type |O |1 |String |Subscriber type |
320+-------------------+---------+-----------+-------+-----------------------+
321
322Response:
323
324+-----------------+---------+-----------+----------------+-------------------+
325|Attribute |Qualifier|Cardinality|Content |Description |
326+-----------------+---------+-----------+----------------+-------------------+
327|service-instances|M |1 |ServiceInstances|Service Instances |
328+-----------------+---------+-----------+----------------+-------------------+
329
330get service-instance
331++++++++++++++++++++
332
333+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
334|Interface Definition|Description |
335+====================+====================================================================================================================================================================+
336|URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}|
337+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
338|Operation Type |GET |
339+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
340
341Request Parameters:
342
343+-------------------+---------+-----------+-------+-----------------------+
344|Attribute |Qualifier|Cardinality|Content|Description |
345+===================+=========+===========+=======+=======================+
346|global-customer-id |M |1 |String |Global Customer ID |
347+-------------------+---------+-----------+-------+-----------------------+
348|service-type |M |1 |String |Service Type |
349+-------------------+---------+-----------+-------+-----------------------+
350|service-instance-id|M |1 |String |Service instance ID |
351+-------------------+---------+-----------+-------+-----------------------+
352
353Response:
354
355+-----------------+---------+-----------+----------------+-------------------+
356|Attribute |Qualifier|Cardinality|Content |Description |
357+-----------------+---------+-----------+----------------+-------------------+
358|service-instance |M |1 |ServiceInstance |Service Instance |
359+-----------------+---------+-----------+----------------+-------------------+
360
361see node definition for valid relationships
362+++++++++++++++++++++++++++++++++++++++++++
363
364+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
365|Interface Definition|Description |
366+====================+===================================================================================================================================================================================================+
367|URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship|
368+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
369|Operation Type |PUT |
370+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
371
372Request Parameters:
373
374+-------------------+---------+-----------+-------+-----------------------+
375|Attribute |Qualifier|Cardinality|Content|Description |
376+===================+=========+===========+=======+=======================+
377|global-customer-id |M |1 |String |Global Customer ID |
378+-------------------+---------+-----------+-------+-----------------------+
379|service-type |M |1 |String |Service Type |
380+-------------------+---------+-----------+-------+-----------------------+
381|service-instance-id|M |1 |String |Service instance ID |
382+-------------------+---------+-----------+-------+-----------------------+
383
384Response:
385
386+---------+---------+-----------+-------+-------------------+
387|Attribute|Qualifier|Cardinality|Content|Description |
388+---------+---------+-----------+-------+-------------------+
389|HTTP code|M |1 |Integer|HTTP response code |
390+---------+---------+-----------+-------+-------------------+
391
392delete an existing relationship
393+++++++++++++++++++++++++++++++
394
395+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
396|Interface Definition|Description |
397+====================+===================================================================================================================================================================================================+
398|URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship|
399+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
400|Operation Type |DELETE |
401+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
402
403Request Parameters:
404
405+-------------------+---------+-----------+-------+-----------------------+
406|Attribute |Qualifier|Cardinality|Content|Description |
407+===================+=========+===========+=======+=======================+
408|global-customer-id |M |1 |String |Global Customer ID |
409+-------------------+---------+-----------+-------+-----------------------+
410|service-type |M |1 |String |Service Type |
411+-------------------+---------+-----------+-------+-----------------------+
412|service-instance-id|M |1 |String |Service instance ID |
413+-------------------+---------+-----------+-------+-----------------------+
414
415Response:
416
417+---------+---------+-----------+-------+-------------------+
418|Attribute|Qualifier|Cardinality|Content|Description |
419+---------+---------+-----------+-------+-------------------+
420|HTTP code|M |1 |Integer|HTTP response code |
421+---------+---------+-----------+-------+-------------------+
422
423
424VFC APIs
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]425--------
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]426
427Create NS
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]428+++++++++
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]429
430+--------------------+-------------------+
431|Interface Definition|Description |
432+====================+===================+
433|URI |/ns |
434+--------------------+-------------------+
435|Operation Type |POST |
436+--------------------+-------------------+
437|Content-Type |application/json |
438+--------------------+-------------------+
439
440Request Parameters:
441
442+-------------------+---------+-----------+-------+-----------------------+
443|Attribute |Qualifier|Cardinality|Content|Description |
444+===================+=========+===========+=======+=======================+
445|context |M |1 |Object |Context |
446+-------------------+---------+-----------+-------+-----------------------+
447|csarId |M |1 |String |csarId |
448+-------------------+---------+-----------+-------+-----------------------+
449|nsName |M |1 |String |Name of the NS |
450+-------------------+---------+-----------+-------+-----------------------+
451|description |M |1 |String |description |
452+-------------------+---------+-----------+-------+-----------------------+
453
454Response:
455
456+-----------------+---------+-----------+----------------+-------------------+
457|Attribute |Qualifier|Cardinality|Content |Description |
458+-----------------+---------+-----------+----------------+-------------------+
459|nsInstanceId |M |1 |String |nsInstanceId |
460+-----------------+---------+-----------+----------------+-------------------+
461
462Get NS
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]463++++++
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]464
465+--------------------+-------------------+
466|Interface Definition|Description |
467+====================+===================+
468|URI |/ns |
469+--------------------+-------------------+
470|Operation Type |GET |
471+--------------------+-------------------+
472|Content-Type |application/json |
473+--------------------+-------------------+
474
475Response:
476
477+-----------------+---------+-----------+----------------+-------------------+
478|Attribute |Qualifier|Cardinality|Content |Description |
479+-----------------+---------+-----------+----------------+-------------------+
480|nsInstanceId |M |1 |String |nsInstanceId |
481+-----------------+---------+-----------+----------------+-------------------+
482|nsName |M |1 |String |The name of ns |
483+-----------------+---------+-----------+----------------+-------------------+
484|description |M |1 |String |description |
485+-----------------+---------+-----------+----------------+-------------------+
486|nsdId |M |1 |String |ID of ns |
487+-----------------+---------+-----------+----------------+-------------------+
488|vnfInfo |M |1 |Array |Vnf information |
489+-----------------+---------+-----------+----------------+-------------------+
490|vlInfo |M |1 |Array |vl information |
491+-----------------+---------+-----------+----------------+-------------------+
492|vnffgInfo |M |1 |Array |vnffg information |
493+-----------------+---------+-----------+----------------+-------------------+
494|nsState |M |1 |String |state of ns |
495+-----------------+---------+-----------+----------------+-------------------+
496
497vnfInfo Object:
498
499+-----------------+---------+-----------+----------------+-------------------+
500|Attribute |Qualifier|Cardinality|Content |Description |
501+-----------------+---------+-----------+----------------+-------------------+
502|vnfInstanceId |M |1 |String |vnfInstanceId |
503+-----------------+---------+-----------+----------------+-------------------+
504|vnfInstanceName |M |1 |String |vnfInstanceName |
505+-----------------+---------+-----------+----------------+-------------------+
506|vnfdId |M |1 |String |vnfdId |
507+-----------------+---------+-----------+----------------+-------------------+
508
509vlInfo Object:
510
511+----------------------+---------+-----------+----------------+-------------------+
512|Attribute |Qualifier|Cardinality|Content |Description |
513+----------------------+---------+-----------+----------------+-------------------+
514|vlInstanceId |M |1 |String |vlInstanceId |
515+----------------------+---------+-----------+----------------+-------------------+
516|vlInstanceName |M |1 |String |vlInstanceName |
517+----------------------+---------+-----------+----------------+-------------------+
518|vldId |M |1 |String |vldId |
519+----------------------+---------+-----------+----------------+-------------------+
520|relatedCpInstanceId |M |1 |Array |relatedCpInstanceId|
521+----------------------+---------+-----------+----------------+-------------------+
522
523relatedCpInstanceId Array:
524
525+----------------------+---------+-----------+----------------+-------------------+
526|Attribute |Qualifier|Cardinality|Content |Description |
527+----------------------+---------+-----------+----------------+-------------------+
528|cpInstanceId |M |1 |String |cpInstanceId |
529+----------------------+---------+-----------+----------------+-------------------+
530|cpInstanceName |M |1 |String |cpInstanceName |
531+----------------------+---------+-----------+----------------+-------------------+
532|cpdId |M |1 |String |cpdId |
533+----------------------+---------+-----------+----------------+-------------------+
534
535vnffgInfo Array:
536
537+----------------------+---------+-----------+----------------+-------------------+
538|Attribute |Qualifier|Cardinality|Content |Description |
539+----------------------+---------+-----------+----------------+-------------------+
540|vnffgInstanceId |M |1 |String |vnffgInstanceId |
541+----------------------+---------+-----------+----------------+-------------------+
542|vnfId |M |1 |String |vnfId |
543+----------------------+---------+-----------+----------------+-------------------+
544|pnfId |M |1 |String |pnfId |
545+----------------------+---------+-----------+----------------+-------------------+
546|virtualLinkId |M |1 |Array |virtualLinkId |
547+----------------------+---------+-----------+----------------+-------------------+
548|cpId |M |1 |Array |cpId |
549+----------------------+---------+-----------+----------------+-------------------+
550|nfp |M |1 |Array |nfp |
551+----------------------+---------+-----------+----------------+-------------------+
552
553Instantiate NS
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]554++++++++++++++
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]555
556+--------------------+-------------------------------------+
557|Interface Definition|Description |
558+====================+=====================================+
559|URI |/ns/{nsInstanceId}/Instantiate |
560+--------------------+-------------------------------------+
561|Operation Type |POST |
562+--------------------+-------------------------------------+
563|Content-Type |application/json |
564+--------------------+-------------------------------------+
565
566Request Parameters:
567
568+----------------------+---------+-----------+-------+-----------------------+
569|Attribute |Qualifier|Cardinality|Content|Description |
570+======================+=========+===========+=======+=======================+
571|LocationConstraints |M |1 |Array |LocationConstraints |
572+----------------------+---------+-----------+-------+-----------------------+
573|additionalParamForNs |M |1 |String |additionalParamForNs |
574+----------------------+---------+-----------+-------+-----------------------+
575|nsInstanceId |M |1 |String |nsInstanceId |
576+----------------------+---------+-----------+-------+-----------------------+
577
578LocationConstraints Array:
579
580+----------------------+---------+-----------+-------+-----------------------+
581|Attribute |Qualifier|Cardinality|Content|Description |
582+======================+=========+===========+=======+=======================+
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]583|vnfProfileId |M |1 |String |vnfProfileId |
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]584+----------------------+---------+-----------+-------+-----------------------+
585|vimid |M |1 |String |vimid |
586+----------------------+---------+-----------+-------+-----------------------+
587
588Response:
589
590+--------------+---------+-----------+-------+-----------------------+
591|Attribute |Qualifier|Cardinality|Content|Description |
592+==============+=========+===========+=======+=======================+
593|jobId |M |1 |String |jobId |
594+--------------+---------+-----------+-------+-----------------------+
595
596Terminate NS
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]597++++++++++++
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]598
599+--------------------+-------------------------------------+
600|Interface Definition|Description |
601+====================+=====================================+
602|URI |/ns/{ns_instance_id}/terminate |
603+--------------------+-------------------------------------+
604|Operation Type |POST |
605+--------------------+-------------------------------------+
606|Content-Type |application/json |
607+--------------------+-------------------------------------+
608
609Request Parameters:
610
611+----------------------------+---------+-----------+-------+-----------------------------+
612|Attribute |Qualifier|Cardinality|Content|Description |
613+============================+=========+===========+=======+=============================+
614|terminationType |M |1 |String |terminationType |
615+----------------------------+---------+-----------+-------+-----------------------------+
616|gracefulTerminationTimeout |M |1 |String |gracefulTerminationTimeout |
617+----------------------------+---------+-----------+-------+-----------------------------+
618|nsInstanceId |M |1 |String |nsInstanceId |
619+----------------------------+---------+-----------+-------+-----------------------------+
620
621Response:
622
623+--------------+---------+-----------+-------+-----------------------+
624|Attribute |Qualifier|Cardinality|Content|Description |
625+==============+=========+===========+=======+=======================+
626|jobId |M |1 |String |jobId |
627+--------------+---------+-----------+-------+-----------------------+
628
629Delete NS
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]630+++++++++
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]631
632+--------------------+-------------------------------------+
633|Interface Definition|Description |
634+====================+=====================================+
635|URI |/ns/{ns_instance_id} |
636+--------------------+-------------------------------------+
637|Operation Type |DELETE |
638+--------------------+-------------------------------------+
639
640Request Parameters:
641
642+----------------------------+---------+-----------+-------+-----------------------------+
643|Attribute |Qualifier|Cardinality|Content|Description |
644+============================+=========+===========+=======+=============================+
645|nsInstanceId |M |1 |String |nsInstanceId |
646+----------------------------+---------+-----------+-------+-----------------------------+
647
648MultiVIM API
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]649------------
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]650Get token
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]651+++++++++
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]652
653https://developer.openstack.org/api-ref/identity/v3/#password-authentication-with-unscoped-authorization
654
655+--------------------+-----------------------------------------------------------------------------------------------+
656|Interface Definition|Description |
657+====================+===============================================================================================+
658|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/identity/v3/auth/tokens |
659+--------------------+-----------------------------------------------------------------------------------------------+
660|Operation Type |POST |
661+--------------------+-----------------------------------------------------------------------------------------------+
662|Content-Type |application/json |
663+--------------------+-----------------------------------------------------------------------------------------------+
664
665Request Body:
666
667+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
668|Attribute |Qualifier|Cardinality|Content |Description |
669+================+=========+===========+==========================+================================================================================================================================================+
670|nocatalog |O |1 |string |The authentication response excludes the service catalog. By default, the response includes the service catalog. |
671+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
672|name |O |1 |string |The user name. Required if you do not specify the ID of the user. If you specify the user name, you must also specify the domain, by ID or name.|
673+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
674|auth |M |1 |object |An auth object. |
675+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
676|user |M |1 |object |A user object. |
677+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
678|scope |O |1 |string |The authorization scope, including either a project or a domain |
679+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
680|password |M |1 |object |The password object, contains the authentication information. |
681+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
682|id |O |1 |string |The ID of the user. Required if you do not specify the user name. |
683+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
684|identity |M |1 |object |An identity object. |
685+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
686|methods |M |1 |array |The authentication method. For password authentication, specify password. |
687+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
688
689Response:
690
691+-------------------------+------------------+--------------------------------------------------------------------------+
692|Attribute |Content |Description |
693+=========================+==================+==========================================================================+
694|X-Subject-Token |String |The authentication token. |
695+-------------------------+------------------+--------------------------------------------------------------------------+
696|domain |object |A domain object, containing: |
697+-------------------------+------------------+--------------------------------------------------------------------------+
698|region_id |String |The ID of the region that contains the service endpoint. |
699+-------------------------+------------------+--------------------------------------------------------------------------+
700|methods |array |The authentication method. For password authentication, specify password. |
701+-------------------------+------------------+--------------------------------------------------------------------------+
702|roles |array |A list of role objects, each containing: |
703+-------------------------+------------------+--------------------------------------------------------------------------+
704|url |String |The endpoint URL. |
705+-------------------------+------------------+--------------------------------------------------------------------------+
706|region |String |The geographic location of the service endpoint. |
707+-------------------------+------------------+--------------------------------------------------------------------------+
708|token |object |A token object. |
709+-------------------------+------------------+--------------------------------------------------------------------------+
710|expires_at |String |The date and time when the token expires. |
711+-------------------------+------------------+--------------------------------------------------------------------------+
712|project |object |A project object, containing: |
713+-------------------------+------------------+--------------------------------------------------------------------------+
714|issued_at |String |The date and time when the token was issued. |
715+-------------------------+------------------+--------------------------------------------------------------------------+
716|catalog |array |A catalog object. |
717+-------------------------+------------------+--------------------------------------------------------------------------+
718|extras |object |A set of metadata key and value pairs, if any. |
719+-------------------------+------------------+--------------------------------------------------------------------------+
720|user |object |A user object. |
721+-------------------------+------------------+--------------------------------------------------------------------------+
722|audit_ids |array |A list of one or two audit IDs. |
723+-------------------------+------------------+--------------------------------------------------------------------------+
724|interface |String |The interface type, which describes the visibility of the endpoint. |
725+-------------------------+------------------+--------------------------------------------------------------------------+
726|endpoints |array |A list of endpoint objects. |
727+-------------------------+------------------+--------------------------------------------------------------------------+
728|type |String |The endpoint type. |
729+-------------------------+------------------+--------------------------------------------------------------------------+
730|id |String |The ID of the user. Required if you do not specify the user name. |
731+-------------------------+------------------+--------------------------------------------------------------------------+
732|name |String |The user name. |
733+-------------------------+------------------+--------------------------------------------------------------------------+
734
735Create stack
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]736++++++++++++
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]737
738https://developer.openstack.org/api-ref/orchestration/v1/#create-stack
739
740+--------------------+-----------------------------------------------------------------------------------------------+
741|Interface Definition|Description |
742+====================+===============================================================================================+
743|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/heat/v1/{tenant-id}/stacks |
744+--------------------+-----------------------------------------------------------------------------------------------+
745|Operation Type |POST |
746+--------------------+-----------------------------------------------------------------------------------------------+
747|Content-Type |application/json |
748+--------------------+-----------------------------------------------------------------------------------------------+
749
750Request Body:
751
752+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
753|Attribute |Qualifier|Cardinality|Content |Description |
754+==================+=========+===========+==========================+=================================================================================================+
755|tenant_id |M |1 |string |The UUID of the tenant. A tenant is also known as a project. |
756+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
757|disable_rollback |O |1 |boolean |Enables or disables deletion of all stack resources when stack creation fails. |
758+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
759|environment |O |1 |object |A JSON environment for the stack. |
760+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
761|files |O |1 |object |Supplies the contents of files referenced in the template or the environment. |
762+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
763|parameters |O |1 |object |Supplies arguments for parameters defined in the stack template. |
764+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
765|stack_name |M |1 |string |A name for the stack. |
766+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
767|tags |O |1 |string |One or more simple string tags to associate with the stack. |
768+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
769|template |O |1 |object |The stack template on which to perform the operation. |
770+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
771|template_url |O |1 |string |A URI to the location containing the stack template on which to perform the operation. |
772+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
773|timeout_mins |O |1 |integer |The timeout for stack creation in minutes. |
774+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
775
776Response:
777
778+-------------------------+------------------+--------------------------------------------------------------------------+
779|Attribute |Content |Description |
780+=========================+==================+==========================================================================+
781|location |String |For asynchronous resource operations. |
782+-------------------------+------------------+--------------------------------------------------------------------------+
783|X-Openstack-Reqeuest-Id |object |A domain object, containing: |
784+-------------------------+------------------+--------------------------------------------------------------------------+
785|stack |String |The ID of the region that contains the service endpoint. |
786+-------------------------+------------------+--------------------------------------------------------------------------+
787|id |String |The authentication method. For password authentication, specify password. |
788+-------------------------+------------------+--------------------------------------------------------------------------+
789|links |String |The authentication method. For password authentication, specify password. |
790+-------------------------+------------------+--------------------------------------------------------------------------+
791
792Get stack
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]793+++++++++
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]794
795https://developer.openstack.org/api-ref/orchestration/v1/#show-stack-details
796
797+--------------------+-----------------------------------------------------------------------------------------------------------------------+
798|Interface Definition|Description |
799+====================+=======================================================================================================================+
800|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/heat/v1/{tenant-id}/stacks/{stack-name}/{stack-id} |
801+--------------------+-----------------------------------------------------------------------------------------------------------------------+
802|Operation Type |GET |
803+--------------------+-----------------------------------------------------------------------------------------------------------------------+
804|Content-Type |application/json |
805+--------------------+-----------------------------------------------------------------------------------------------------------------------+
806
807Request Body:
808
809+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
810|Attribute |Qualifier|Cardinality|Content |Description |
811+==================+=========+===========+==========================+=================================================================================================+
812|tenant_id |M |1 |string |The UUID of the tenant. A tenant is also known as a project. |
813+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
814|stack_name |M |1 |string |The name of a stack. |
815+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
816|stack_id |M |1 |string |The UUID of the stack. |
817+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
818|resolve_outputs |O |1 |boolean |A boolean indicating whether the outputs section of a stack should be resolved. |
819+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
820
821Response:
822
823+-------------------------+------------------+------------------------------------------------------------------------------+
824|Attribute |Content |Description |
825+=========================+==================+==============================================================================+
826|X-Openstack-Reqeuest-Id |String |A unique ID for tracking service request. |
827+-------------------------+------------------+------------------------------------------------------------------------------+
828|stack |Object |The stack object. |
829+-------------------------+------------------+------------------------------------------------------------------------------+
830|capabilities |array |List of stack capabilities for stack. |
831+-------------------------+------------------+------------------------------------------------------------------------------+
832|creation_time |String |The date and time when the resource was created. |
833+-------------------------+------------------+------------------------------------------------------------------------------+
834|deletion_time |String |The date and time when the resource was (soft-) deleted. |
835+-------------------------+------------------+------------------------------------------------------------------------------+
836|description |String |The description of the stack resource. |
837+-------------------------+------------------+------------------------------------------------------------------------------+
838|disable_rollback |boolean |Whether deletion of all stack resources when stack creation fails is enabled. |
839+-------------------------+------------------+------------------------------------------------------------------------------+
840|id |String |The UUID of the stack. |
841+-------------------------+------------------+------------------------------------------------------------------------------+
842|links |array |A list of URLs for the stack. |
843+-------------------------+------------------+------------------------------------------------------------------------------+
844|notification_topics |array |List of notification topics for stack. |
845+-------------------------+------------------+------------------------------------------------------------------------------+
846|outputs |array |A list of stack outputs. |
847+-------------------------+------------------+------------------------------------------------------------------------------+
848|parameters |object | A group of key-value pairs |
849+-------------------------+------------------+------------------------------------------------------------------------------+
850|parent |String |The stack ID of the parent stack, if this is a nested stack. |
851+-------------------------+------------------+------------------------------------------------------------------------------+
852|stack_name |String |A name for the stack. |
853+-------------------------+------------------+------------------------------------------------------------------------------+
854|stack_owner |String |The owner of the stack. |
855+-------------------------+------------------+------------------------------------------------------------------------------+
856|stack_status |String |The status of the stack. |
857+-------------------------+------------------+------------------------------------------------------------------------------+
858|stack_status_reason |String |The reason for the current status of the stack. |
859+-------------------------+------------------+------------------------------------------------------------------------------+
860|stack_user_project_id |String |The project UUID of the stack user. |
861+-------------------------+------------------+------------------------------------------------------------------------------+
862|tags |array |The stack tags. |
863+-------------------------+------------------+------------------------------------------------------------------------------+
864|template_description |String |The description of the stack template. |
865+-------------------------+------------------+------------------------------------------------------------------------------+
866|timeout_mins |integer |The timeout for stack creation in minutes. |
867+-------------------------+------------------+------------------------------------------------------------------------------+
868|updated_time |String |The date and time when the object was updated. |
869+-------------------------+------------------+------------------------------------------------------------------------------+
870
871Delete stack
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]872++++++++++++
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]873
874https://developer.openstack.org/api-ref/orchestration/v1/#show-stack-details
875
876+--------------------+-----------------------------------------------------------------------------------------------------------------------+
877|Interface Definition|Description |
878+====================+=======================================================================================================================+
879|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/heat/v1/{tenant-id}/stacks/{stack-name}/{stack-id} |
880+--------------------+-----------------------------------------------------------------------------------------------------------------------+
881|Operation Type |DELETE |
882+--------------------+-----------------------------------------------------------------------------------------------------------------------+
883|Content-Type |application/json |
884+--------------------+-----------------------------------------------------------------------------------------------------------------------+
885
886Request Body:
887
888+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
889|Attribute |Qualifier|Cardinality|Content |Description |
890+==================+=========+===========+==========================+=================================================================================================+
891|tenant_id |M |1 |string |The UUID of the tenant. A tenant is also known as a project. |
892+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
893|stack_name |M |1 |string |The name of a stack. |
894+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
895|stack_id |M |1 |string |The UUID of the stack. |
896+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
897
898Create server
899+++++++++++++
900
901https://developer.openstack.org/api-ref/compute/#create-server
902
903+--------------------+-----------------------------------------------------------------------------------------------------------------------+
904|Interface Definition|Description |
905+====================+=======================================================================================================================+
906|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.37/{tenant_id}/servers |
907+--------------------+-----------------------------------------------------------------------------------------------------------------------+
908|Operation Type |POST |
909+--------------------+-----------------------------------------------------------------------------------------------------------------------+
910|Content-Type |application/json |
911+--------------------+-----------------------------------------------------------------------------------------------------------------------+
912
913Request Body:
914
915+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
916|Attribute |Qualifier|Cardinality|Content |Description |
917+================================================+=========+===========+==========================+=================================================================================================+
918|server |M |1 |object |A server object. |
919+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
920|name |M |1 |string |The server name. |
921+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
922|flavorRef |M |1 |string |The flavor reference, as an ID (including a UUID) or full URL |
923+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
924|imageRef |M |1 |string |The UUID of the image to use for your server instance |
925+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
926|security_groups |O |1 |array |One or more security groups. |
927+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
928|metadata |O |1 |object |Metadata key and value pairs. |
929+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
930|accessIPv4 |O |1 |string |IPv4 address that should be used to access this server. |
931+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
932|accessIPv6 |O |1 |string |IPv6 address that should be used to access this server. |
933+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
934|adminPass |O |1 |string |The administrative password of the server. |
935+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
936|user_data |O |1 |string |Configuration information or scripts to use upon launch. |
937+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
938|availability_zone |O |1 |string |The availability zone from which to launch the server. |
939+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
940|networks |M |1 |object |A networks object. |
941+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
942|networks.uuid |O |1 |string |To provision the server instance with a NIC for a network |
943+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
944|networks.port |O |1 |string |To provision the server instance with a NIC for an already existing port |
945+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
946|networks.fixed_ip |O |1 |string |A fixed IPv4 address for the NIC |
947+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
948|networks.tag |O |1 |string |A device role tag that can be applied to a network interface. |
949+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
950|personality |O |1 |array |The file path and contents, text only, to inject into the server at launch. |
951+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
952|block_device_mapping_v2 |O |1 |array |Enables fine grained control of the block device mapping for an instance. |
953+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
954|block_device_mapping_v2.device_name |M |1 |string |A path to the device for the volume that you want to use to boot the server. |
955+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
956|block_device_mapping_v2.source_type |M |1 |string |The source type of the volume. |
957+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
958|block_device_mapping_v2.destination_type |O |1 |string |Defines where the volume comes from. |
959+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
960|block_device_mapping_v2.delete_on_termination |O |1 |string |To delete the boot volume when the server is destroyed, specify true. |
961+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
962|block_device_mapping_v2.guest_format |M |1 |string |Specifies the guest server disk file system format, such as ephemeral or swap. |
963+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
964|block_device_mapping_v2.boot_index |M |1 |string |Defines the order in which a hypervisor tries devices |
965+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
966|block_device_mapping_v2.uuid |O |1 |string |This is the uuid of source resource. |
967+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
968|block_device_mapping_v2.tag |O |1 |string |A device role tag that can be applied to a block device. |
969+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
970|block_device_mapping_v2.disk_bus |O |1 |string |Disk bus type, some hypervisors (currently only libvirt) support specify this parameter |
971+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
972|config_drive |O |1 |boolean |Indicates whether a configuration drive enables metadata injection. |
973+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
974|key_name |O |1 |string |Key pair name. |
975+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
976|os:scheduler_hints |O |1 |object |The dictionary of data to send to the scheduler. |
977+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
978|OS-DCF:diskConfig |O |1 |string |Controls how the API partitions the disk when you create, rebuild, or resize servers. |
979+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
980|description |O |1 |string |A free form description of the server. |
981+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
982|tags |O |1 |array |A list of tags. |
983+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
984
985Response:
986
987+-------------------------+------------------+------------------------------------------------------------------------------+
988|Attribute |Content |Description |
989+=========================+==================+==============================================================================+
990|Location |String |The location URL of the server. |
991+-------------------------+------------------+------------------------------------------------------------------------------+
992|server |object |A server object. |
993+-------------------------+------------------+------------------------------------------------------------------------------+
994|id |String |The UUID of the server. |
995+-------------------------+------------------+------------------------------------------------------------------------------+
996|links |array |Links to the resources in question. |
997+-------------------------+------------------+------------------------------------------------------------------------------+
998|OS-DCF:diskConfig |String |Disk configuration. |
999+-------------------------+------------------+------------------------------------------------------------------------------+
1000|security_groups |array |One or more security groups objects. |
1001+-------------------------+------------------+------------------------------------------------------------------------------+
1002|security_groups.name |String |The security group name. |
1003+-------------------------+------------------+------------------------------------------------------------------------------+
1004|adminPass |String |The administrative password for the server. |
1005+-------------------------+------------------+------------------------------------------------------------------------------+
1006
1007Delete server
1008+++++++++++++
1009
1010https://developer.openstack.org/api-ref/compute/#delete-server
1011
1012+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1013|Interface Definition|Description |
1014+====================+=======================================================================================================================+
1015|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/servers/{server_id} |
1016+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1017|Operation Type |DELETE |
1018+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1019|Content-Type |application/json |
1020+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1021
1022Request Body:
1023
1024+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1025|Attribute |Qualifier|Cardinality|Content |Description |
1026+==================+=========+===========+==========================+=================================================================================================+
1027|server_id |M |1 |string |The UUID of the server. |
1028+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1029
1030Create Keypair
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]1031++++++++++++++
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]1032
1033https://developer.openstack.org/api-ref/compute/#create-or-import-keypair
1034
1035+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1036|Interface Definition|Description |
1037+====================+=======================================================================================================================+
1038|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/os-keypairs |
1039+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1040|Operation Type |POST |
1041+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1042|Content-Type |application/json |
1043+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1044
1045Request Body:
1046
1047+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1048|Attribute |Qualifier|Cardinality|Content |Description |
1049+==================+=========+===========+==========================+=================================================================================================+
1050|keypair |M |1 |Object |Keypair object |
1051+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1052|name |M |1 |string |A name for the keypair which will be used to reference it later. |
1053+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1054|public_key |O |1 |string |The public ssh key to import. If you omit this value, a keypair is generated for you. |
1055+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1056|type |O |1 |string |The type of the keypair. |
1057+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1058|user_id |O |1 |string |The user_id for a keypair. |
1059+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1060
1061Response:
1062
1063+-----------------+------------------+------------------------------------------------------------------------------+
1064|Attribute |Content |Description |
1065+=================+==================+==============================================================================+
1066|keypair |object |Keypair object |
1067+-----------------+------------------+------------------------------------------------------------------------------+
1068|name |String |A name for the keypair which will be used to reference it later. |
1069+-----------------+------------------+------------------------------------------------------------------------------+
1070|public_key |String |The keypair public key. |
1071+-----------------+------------------+------------------------------------------------------------------------------+
1072|fingerprint |String |The fingerprint for the keypair. |
1073+-----------------+------------------+------------------------------------------------------------------------------+
1074|user_id |String |The user_id for a keypair. |
1075+-----------------+------------------+------------------------------------------------------------------------------+
1076|private_key |String |If you do not provide a public key on create |
1077+-----------------+------------------+------------------------------------------------------------------------------+
1078|type |String |The type of the keypair. |
1079+-----------------+------------------+------------------------------------------------------------------------------+
1080
1081Delete Keypair
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]1082++++++++++++++
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]1083
1084https://developer.openstack.org/api-ref/compute/#delete-keypair
1085
1086+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1087|Interface Definition|Description |
1088+====================+=======================================================================================================================+
1089|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/os-keypairs/{keypair-id} |
1090+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1091|Operation Type |DELETE |
1092+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1093|Content-Type |application/json |
1094+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1095
1096Request Body:
1097
1098+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1099|Attribute |Qualifier|Cardinality|Content |Description |
1100+==================+=========+===========+==========================+=================================================================================================+
1101|keypair_name |M |1 |String |The keypair name. |
1102+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1103|user_id |O |1 |String |This allows administrative users to operate key-pairs of specified user ID. |
1104+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1105
1106Create Network
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]1107++++++++++++++
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]1108
1109https://developer.openstack.org/api-ref/network/v2/?expanded=create-network-detail#create-network
1110
1111+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1112|Interface Definition|Description |
1113+====================+=======================================================================================================================+
1114|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/networks |
1115+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1116|Operation Type |POST |
1117+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1118|Content-Type |application/json |
1119+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1120
1121Request Body:
1122
1123+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1124|Attribute |Qualifier|Cardinality|Content |Description |
1125+============================+=========+===========+==========================+=================================================================================================+
1126|network |M |1 |Object |A network object. |
1127+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1128|admin_state_up |O |1 |boolean |The administrative state of the network, which is up (true) or down (false). |
1129+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1130|dns_domain |O |1 |string |A valid DNS domain. |
1131+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1132|mtu |O |1 |integer |The maximum transmission unit (MTU) value to address fragmentation. |
1133+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1134|name |O |1 |string |Human-readable name of the network. |
1135+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1136|port_security_enabled |O |1 |boolean |The port security status of the network. |
1137+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1138|project_id |O |1 |string |The ID of the project that owns the resource. |
1139+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1140|provider:network_type |O |1 |string |The type of physical network that this network should be mapped to. |
1141+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1142|provider:physical_network |O |1 |string |The physical network where this network should be implemented. |
1143+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1144|provider:segmentation_id |O |1 |integer |The ID of the isolated segment on the physical network. |
1145+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1146|qos_policy_id |O |1 |string |The ID of the QoS policy. |
1147+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1148|router:external |O |1 |boolean |Indicates whether this network can provide floating IPs via a router. |
1149+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1150|segments |O |1 |array |A list of provider segment objects. |
1151+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1152|shared |O |1 |boolean |Indicates whether this network is shared across all tenants. |
1153+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1154|tenant_id |O |1 |string |The ID of the project that owns the resource. |
1155+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1156|vlan_transparent |O |1 |boolean |Indicates the VLAN transparency mode of the network, |
1157+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1158|description |O |1 |string |A human-readable description for the resource. |
1159+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1160|is_default |O |1 |boolean |The network is default or not. |
1161+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1162|availability_zone_hints |O |1 |array |The availability zone candidate for the network. |
1163+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1164
1165Response:
1166
1167+-----------------------------+------------------+------------------------------------------------------------------------------+
1168|Attribute |Content |Description |
1169+=============================+==================+==============================================================================+
1170|network |object |A network object. |
1171+-----------------------------+------------------+------------------------------------------------------------------------------+
1172|admin_state_up |boolean |The administrative state of the network, which is up (true) or down (false). |
1173+-----------------------------+------------------+------------------------------------------------------------------------------+
1174|availability_zone_hints |array |The availability zone candidate for the network. |
1175+-----------------------------+------------------+------------------------------------------------------------------------------+
1176|availability_zones |array |The availability zone for the network. |
1177+-----------------------------+------------------+------------------------------------------------------------------------------+
1178|created_at |String |Time at which the resource has been created (in UTC ISO8601 format). |
1179+-----------------------------+------------------+------------------------------------------------------------------------------+
1180|dns_domain |String |A valid DNS domain. |
1181+-----------------------------+------------------+------------------------------------------------------------------------------+
1182|id |String |The ID of the network. |
1183+-----------------------------+------------------+------------------------------------------------------------------------------+
1184|ipv4_address_scope |String |The ID of the IPv4 address scope that the network is associated with. |
1185+-----------------------------+------------------+------------------------------------------------------------------------------+
1186|ipv6_address_scope |String |The ID of the IPv6 address scope that the network is associated with. |
1187+-----------------------------+------------------+------------------------------------------------------------------------------+
1188|mtu |integer |The maximum transmission unit (MTU) value to address fragmentation. |
1189+-----------------------------+------------------+------------------------------------------------------------------------------+
1190|name |String |Human-readable name of the network. |
1191+-----------------------------+------------------+------------------------------------------------------------------------------+
1192|port_security_enabled |boolean |The port security status of the network. |
1193+-----------------------------+------------------+------------------------------------------------------------------------------+
1194|project_id |String |The ID of the project. |
1195+-----------------------------+------------------+------------------------------------------------------------------------------+
1196|provider:network_type |String |The type of physical network that this network is mapped to. |
1197+-----------------------------+------------------+------------------------------------------------------------------------------+
1198|provider:physical_network |String |The physical network where this network is implemented. |
1199+-----------------------------+------------------+------------------------------------------------------------------------------+
1200|provider:segmentation_id |integer |The ID of the isolated segment on the physical network. |
1201+-----------------------------+------------------+------------------------------------------------------------------------------+
1202|qos_policy_id |String |The ID of the QoS policy. |
1203+-----------------------------+------------------+------------------------------------------------------------------------------+
1204|revision_number |integer |The revision number of the resource. |
1205+-----------------------------+------------------+------------------------------------------------------------------------------+
1206|router:external |boolean |Indicates whether this network can provide floating IPs via a router. |
1207+-----------------------------+------------------+------------------------------------------------------------------------------+
1208|segments |array |A list of provider segment objects. |
1209+-----------------------------+------------------+------------------------------------------------------------------------------+
1210|shared |boolean |Indicates whether this network is shared across all tenants. |
1211+-----------------------------+------------------+------------------------------------------------------------------------------+
1212|status |String |The network status. Values are ACTIVE, DOWN, BUILD or ERROR. |
1213+-----------------------------+------------------+------------------------------------------------------------------------------+
1214|subnets |array |The associated subnets. |
1215+-----------------------------+------------------+------------------------------------------------------------------------------+
1216|tenant_id |String |The ID of the project. |
1217+-----------------------------+------------------+------------------------------------------------------------------------------+
1218|updated_at |String |Time at which the resource has been updated (in UTC ISO8601 format). |
1219+-----------------------------+------------------+------------------------------------------------------------------------------+
1220|vlan_transparent |boolean |Indicates the VLAN transparency mode of the network. |
1221+-----------------------------+------------------+------------------------------------------------------------------------------+
1222|description |String |A human-readable description for the resource. |
1223+-----------------------------+------------------+------------------------------------------------------------------------------+
1224|is_default |boolean |The network is default pool or not. |
1225+-----------------------------+------------------+------------------------------------------------------------------------------+
1226
1227Delete Network
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]1228++++++++++++++
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]1229
1230https://developer.openstack.org/api-ref/network/v2/?expanded=create-network-detail#delete-network
1231
1232+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1233|Interface Definition|Description |
1234+====================+=======================================================================================================================+
1235|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/networks/{network-id} |
1236+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1237|Operation Type |DELETE |
1238+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1239|Content-Type |application/json |
1240+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1241
1242Request Body:
1243
1244+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
1245|Attribute |Qualifier|Cardinality|Content |Description |
1246+============================+=========+===========+==========================+==============================================================+
1247|network_id |M |1 |String |The ID of the network. |
1248+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
1249
1250Create Subnet
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]1251+++++++++++++
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]1252
1253https://developer.openstack.org/api-ref/network/v2/?expanded=create-network-detail,create-subnet-detail#create-subnet
1254
1255+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1256|Interface Definition|Description |
1257+====================+=======================================================================================================================+
1258|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/subnets |
1259+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1260|Operation Type |POST |
1261+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1262|Content-Type |application/json |
1263+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1264
1265Request Body:
1266
1267+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1268|Attribute |Qualifier|Cardinality|Content |Description |
1269+============================+=========+===========+==========================+=================================================================================================+
1270|subnet |M |1 |string |A subnet object. |
1271+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1272|tenant_id |O |1 |string |The ID of the project that owns the resource. |
1273+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1274|project_id |O |1 |string |The ID of the project that owns the resource. |
1275+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1276|name |O |1 |string |Human-readable name of the resource. |
1277+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1278|enable_dhcp |O |1 |boolean |Indicates whether dhcp is enabled or disabled for the subnet. |
1279+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1280|network_id |M |1 |string |The ID of the network to which the subnet belongs. |
1281+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1282|dns_nameservers |O |1 |array |List of dns name servers associated with the subnet. |
1283+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1284|allocation_pools |O |1 |array |Allocation pools with start and end IP addresses for this subnet. |
1285+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1286|host_routes |O |1 |array |Additional routes for the subnet. |
1287+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1288|ip_version |M |1 |integer |The IP protocol version. Value is 4 or 6. |
1289+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1290|gateway_ip |O |1 |string |Gateway IP of this subnet. |
1291+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1292|cidr |M |1 |string |The CIDR of the subnet. |
1293+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1294|description |O |1 |string |A human-readable description for the resource. |
1295+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1296|ipv6_address_mode |O |1 |string |The IPv6 address modes specifies mechanisms for assigning IP addresses. |
1297+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1298|ipv6_ra_mode |O |1 |string |The IPv6 router advertisement specifies whether the networking service |
1299+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1300|segment_id |O |1 |string |The ID of a network segment the subnet is associated with. |
1301+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1302|subnetpool_id |O |1 |string |The ID of the subnet pool associated with the subnet. |
1303+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1304|use_default_subnetpool |O |1 |boolean |Whether to allocate this subnet from the default subnet pool. |
1305+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1306|service_types |O |1 |array |The service types associated with the subnet. |
1307+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1308
1309Response:
1310
1311+-----------------------------+------------------+------------------------------------------------------------------------------+
1312|Attribute |Content |Description |
1313+=============================+==================+==============================================================================+
1314|subnet |string |A subnet object. |
1315+-----------------------------+------------------+------------------------------------------------------------------------------+
1316|id |string |The ID of the subnet. |
1317+-----------------------------+------------------+------------------------------------------------------------------------------+
1318|tenant_id |string |The ID of the project. |
1319+-----------------------------+------------------+------------------------------------------------------------------------------+
1320|project_id |string |The ID of the project. |
1321+-----------------------------+------------------+------------------------------------------------------------------------------+
1322|name |String |Human-readable name of the resource. |
1323+-----------------------------+------------------+------------------------------------------------------------------------------+
1324|enable_dhcp |boolean |Indicates whether dhcp is enabled or disabled for the subnet. |
1325+-----------------------------+------------------+------------------------------------------------------------------------------+
1326|network_id |String |The ID of the network to which the subnet belongs. |
1327+-----------------------------+------------------+------------------------------------------------------------------------------+
1328|dns_nameservers |array |List of dns name servers associated with the subnet. |
1329+-----------------------------+------------------+------------------------------------------------------------------------------+
1330|allocation_pools |array |Allocation pools with start and end IP addresses for this subnet. |
1331+-----------------------------+------------------+------------------------------------------------------------------------------+
1332|host_routes |array |Additional routes for the subnet. |
1333+-----------------------------+------------------+------------------------------------------------------------------------------+
1334|ip_version |integer |The IP protocol version. Value is 4 or 6. |
1335+-----------------------------+------------------+------------------------------------------------------------------------------+
1336|gateway_ip |string |Gateway IP of this subnet. |
1337+-----------------------------+------------------+------------------------------------------------------------------------------+
1338|cidr |string |The CIDR of the subnet. |
1339+-----------------------------+------------------+------------------------------------------------------------------------------+
1340|created_at |string |Time at which the subnet has been created. |
1341+-----------------------------+------------------+------------------------------------------------------------------------------+
1342|description |string |A human-readable description for the resource. |
1343+-----------------------------+------------------+------------------------------------------------------------------------------+
1344|ipv6_address_mode |string |The IPv6 address modes specifies mechanisms for assigning IP addresses. |
1345+-----------------------------+------------------+------------------------------------------------------------------------------+
1346|ipv6_ra_mode |string |The IPv6 router advertisement specifies whether the networking service |
1347+-----------------------------+------------------+------------------------------------------------------------------------------+
1348|revision_number |integer |The revision number of the resource. |
1349+-----------------------------+------------------+------------------------------------------------------------------------------+
1350|service_types |string |The service types associated with the subnet. |
1351+-----------------------------+------------------+------------------------------------------------------------------------------+
1352|subnetpool_id |string |The ID of the subnet pool associated with the subnet. |
1353+-----------------------------+------------------+------------------------------------------------------------------------------+
1354|segment_id |string |The ID of a network segment the subnet is associated with. |
1355+-----------------------------+------------------+------------------------------------------------------------------------------+
1356|updated_at |string |Time at which the subnet has been updated. |
1357+-----------------------------+------------------+------------------------------------------------------------------------------+
1358
1359Delete Subnet
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]1360+++++++++++++
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]1361
1362https://developer.openstack.org/api-ref/networking/v2/?expanded=create-network-detail,delete-subnet-detail#delete-subnet
1363
1364+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1365|Interface Definition|Description |
1366+====================+=======================================================================================================================+
1367|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/subnets/{subnet-id} |
1368+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1369|Operation Type |DELETE |
1370+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1371|Content-Type |application/json |
1372+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1373
1374Request Body:
1375
1376+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
1377|Attribute |Qualifier|Cardinality|Content |Description |
1378+============================+=========+===========+==========================+==============================================================+
1379|subnet_id |M |1 |String |The ID of the subnet. |
1380+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
1381
1382Create Port
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]1383+++++++++++
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]1384
1385https://developer.openstack.org/api-ref/networking/v2/#create-port
1386
1387+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1388|Interface Definition|Description |
1389+====================+=======================================================================================================================+
1390|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/ports |
1391+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1392|Operation Type |POST |
1393+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1394|Content-Type |application/json |
1395+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1396
1397Request Body:
1398
1399+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1400|Attribute |Qualifier|Cardinality|Content |Description |
1401+============================+=========+===========+==========================+=================================================================================================+
1402|port |M |1 |object |A port object. |
1403+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1404|admin_state_up |O |1 |boolean |The administrative state of the resource. |
1405+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1406|allowed_address_pairs |O |1 |array |A set of zero or more allowed address pairs. |
1407+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1408|binding:host_id |O |1 |string |The ID of the host where the port resides. |
1409+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1410|binding:profile |O |1 |string |A dictionary that enables the application running on the specific host |
1411+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1412|binding:vnic_type |O |1 |string |The type of vNIC which this port should be attached to. |
1413+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1414|description |O |1 |string |A human-readable description for the resource. |
1415+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1416|device_id |O |1 |string |The ID of the device that uses this port. |
1417+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1418|device_owner |O |1 |string |The entity type that uses this port. |
1419+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1420|dns_domain |O |1 |string |A valid DNS domain. |
1421+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1422|dns_name |O |1 |string |A valid DNS name. |
1423+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1424|extra_dhcp_opts |O |1 |array |A set of zero or more extra DHCP option pairs. |
1425+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1426|fixed_ips |O |1 |array |The IP addresses for the port. |
1427+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1428|mac_address |O |1 |string |The MAC address of the port. |
1429+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1430|name |O |1 |string |Human-readable name of the resource. |
1431+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1432|network_id |M |1 |string |The ID of the attached network. |
1433+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1434|port_security_enabled |O |1 |boolean |The port security status. |
1435+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1436|project_id |O |1 |string |The ID of the project that owns the resource. |
1437+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1438|qos_policy_id |O |1 |string |QoS policy associated with the port. |
1439+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1440|security_groups |O |1 |array |The IDs of security groups applied to the port. |
1441+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1442|tenant_id |O |1 |string |The ID of the project that owns the resource. |
1443+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
1444
1445Response:
1446
1447+-----------------------------+------------------+------------------------------------------------------------------------------+
1448|Attribute |Content |Description |
1449+=============================+==================+==============================================================================+
1450|port |object |A port object. |
1451+-----------------------------+------------------+------------------------------------------------------------------------------+
1452|admin_state_up |boolean |The administrative state of the resource. |
1453+-----------------------------+------------------+------------------------------------------------------------------------------+
1454|allowed_address_pairs |array |A set of zero or more allowed address pairs. |
1455+-----------------------------+------------------+------------------------------------------------------------------------------+
1456|binding:host_id |string |The ID of the host where the port resides. |
1457+-----------------------------+------------------+------------------------------------------------------------------------------+
1458|binding:profile |String |A dictionary that enables the application running on the specific host |
1459+-----------------------------+------------------+------------------------------------------------------------------------------+
1460|binding:vif_details |object |A dictionary which contains additional information on the port. |
1461+-----------------------------+------------------+------------------------------------------------------------------------------+
1462|binding:vif_type |String |The type of which mechanism is used for the port. |
1463+-----------------------------+------------------+------------------------------------------------------------------------------+
1464|binding:vnic_type |string |The type of vNIC which this port should be attached to. |
1465+-----------------------------+------------------+------------------------------------------------------------------------------+
1466|created_at |string |Time at which port has been created. |
1467+-----------------------------+------------------+------------------------------------------------------------------------------+
1468|data_plane_status |string |Status of the underlying data plane of a port. |
1469+-----------------------------+------------------+------------------------------------------------------------------------------+
1470|description |string |A human-readable description for the resource. |
1471+-----------------------------+------------------+------------------------------------------------------------------------------+
1472|device_id |string |The ID of the device that uses this port. |
1473+-----------------------------+------------------+------------------------------------------------------------------------------+
1474|device_owner |string |The entity type that uses this port. |
1475+-----------------------------+------------------+------------------------------------------------------------------------------+
1476|dns_assignment |object |Data assigned to a port by the Networking internal DNS |
1477+-----------------------------+------------------+------------------------------------------------------------------------------+
1478|dns_domain |string |A valid DNS domain. |
1479+-----------------------------+------------------+------------------------------------------------------------------------------+
1480|dns_name |string |A valid DNS name. |
1481+-----------------------------+------------------+------------------------------------------------------------------------------+
1482|extra_dhcp_opts |array |A set of zero or more extra DHCP option pairs. |
1483+-----------------------------+------------------+------------------------------------------------------------------------------+
1484|fixed_ips |array |The IP addresses for the port. |
1485+-----------------------------+------------------+------------------------------------------------------------------------------+
1486|id |string |The ID of the resource. |
1487+-----------------------------+------------------+------------------------------------------------------------------------------+
1488|ip_allocation |string |Indicates when ports use either deferred, immediate or no IP allocation (none)|
1489+-----------------------------+------------------+------------------------------------------------------------------------------+
1490|mac_address |string |The MAC address of the port. |
1491+-----------------------------+------------------+------------------------------------------------------------------------------+
1492|name |string |Human-readable name of the resource. |
1493+-----------------------------+------------------+------------------------------------------------------------------------------+
1494|network_id |string |The ID of the attached network. |
1495+-----------------------------+------------------+------------------------------------------------------------------------------+
1496|port_security_enabled |boolean |The port security status. |
1497+-----------------------------+------------------+------------------------------------------------------------------------------+
1498|project_id |string |The ID of the project. |
1499+-----------------------------+------------------+------------------------------------------------------------------------------+
1500|revision_number |integer |The revision number of the resource. |
1501+-----------------------------+------------------+------------------------------------------------------------------------------+
1502|qos_policy_id |string |The ID of the QoS policy associated with the port. |
1503+-----------------------------+------------------+------------------------------------------------------------------------------+
1504|security_groups |array |The IDs of security groups applied to the port. |
1505+-----------------------------+------------------+------------------------------------------------------------------------------+
1506|status |string |The port status. Values are ACTIVE, DOWN, BUILD and ERROR. |
1507+-----------------------------+------------------+------------------------------------------------------------------------------+
1508|tenant_id |string |The ID of the project. |
1509+-----------------------------+------------------+------------------------------------------------------------------------------+
1510|updated_at |string |Time at which port has been updated. |
1511+-----------------------------+------------------+------------------------------------------------------------------------------+
1512
1513Delete Port
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]1514+++++++++++
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]1515
1516https://developer.openstack.org/api-ref/network/v2/#delete-port
1517
1518+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1519|Interface Definition|Description |
1520+====================+=======================================================================================================================+
1521|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/ports/{port-id} |
1522+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1523|Operation Type |DELETE |
1524+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1525|Content-Type |application/json |
1526+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1527
1528Request Body:
1529
1530+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
1531|Attribute |Qualifier|Cardinality|Content |Description |
1532+============================+=========+===========+==========================+==============================================================+
1533|port_id |M |1 |String |The ID of the port. |
1534+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
1535
1536Create Security Group
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]1537+++++++++++++++++++++
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]1538
1539https://developer.openstack.org/api-ref/network/v2/#create-security-group
1540
1541+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1542|Interface Definition|Description |
1543+====================+=======================================================================================================================+
1544|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-groups |
1545+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1546|Operation Type |POST |
1547+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1548|Content-Type |application/json |
1549+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1550
1551Request Body:
1552
1553+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
1554|Attribute |Qualifier|Cardinality|Content |Description |
1555+============================+=========+===========+==========================+==============================================================+
1556|security_group |M |1 |object |A security_group object. |
1557+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
1558|tenant_id |M |1 |string |The ID of the project. |
1559+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
1560|project_id |M |1 |string |The ID of the project. |
1561+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
1562|description |O |1 |string |A human-readable description for the resource. |
1563+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
1564|name |M |1 |string |Human-readable name of the resource. |
1565+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
1566
1567Response:
1568
1569+-----------------------------+------------------+------------------------------------------------------------------------------+
1570|Attribute |Content |Description |
1571+=============================+==================+==============================================================================+
1572|security_group |object |A security_group object. |
1573+-----------------------------+------------------+------------------------------------------------------------------------------+
1574|id |string |The ID of the security group. |
1575+-----------------------------+------------------+------------------------------------------------------------------------------+
1576|tenant_id |string |The ID of the project. |
1577+-----------------------------+------------------+------------------------------------------------------------------------------+
1578|project_id |string |The ID of the project. |
1579+-----------------------------+------------------+------------------------------------------------------------------------------+
1580|created_at |string |Time at which the resource has been created (in UTC ISO8601 format). |
1581+-----------------------------+------------------+------------------------------------------------------------------------------+
1582|updated_at |string |Time at which the resource has been updated (in UTC ISO8601 format). |
1583+-----------------------------+------------------+------------------------------------------------------------------------------+
1584|revision_number |integer |The revision number of the resource. |
1585+-----------------------------+------------------+------------------------------------------------------------------------------+
1586|name |string |Human-readable name of the resource. |
1587+-----------------------------+------------------+------------------------------------------------------------------------------+
1588|description |string |A human-readable description for the resource. |
1589+-----------------------------+------------------+------------------------------------------------------------------------------+
1590|security_group_rules |array |A list of security_group_rule objects. |
1591+-----------------------------+------------------+------------------------------------------------------------------------------+
1592
1593Delete security group
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]1594+++++++++++++++++++++
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]1595
1596https://developer.openstack.org/api-ref/network/v2/#delete-security-group
1597
1598+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1599|Interface Definition|Description |
1600+====================+=======================================================================================================================+
1601|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-groups/{security-group-id} |
1602+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1603|Operation Type |DELETE |
1604+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1605|Content-Type |application/json |
1606+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1607
1608Request Body:
1609
1610+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
1611|Attribute |Qualifier|Cardinality|Content |Description |
1612+============================+=========+===========+==========================+==============================================================+
1613|security_group_id |M |1 |String |The ID of the security group. |
1614+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
1615
1616Create Security Group Rule
1617++++++++++++++++++++++++++
1618
1619https://developer.openstack.org/api-ref/network/v2/#create-security-group-rule
1620
1621+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1622|Interface Definition|Description |
1623+====================+=======================================================================================================================+
1624|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-group-rules |
1625+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1626|Operation Type |POST |
1627+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1628|Content-Type |application/json |
1629+--------------------+-----------------------------------------------------------------------------------------------------------------------+
1630
1631Request Body:
1632
1633+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
1634|Attribute |Qualifier|Cardinality|Content |Description |
1635+============================+=========+===========+==========================+================================================================================================+
1636|security_group_rule |M |1 |object |A security_group_rule object. |
1637+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
1638|remote_group_id |O |1 |string |The remote group UUID to associate with this security group rule. |
1639+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
1640|direction |M |1 |string |Ingress or egress, which is the direction in which the metering rule is applied. |
1641+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
1642|protocol |M |1 |string |The IP protocol can be represented by a string, an integer, or null. |
1643+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
1644|ethertype |O |1 |string |Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress rules. |
1645+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
1646|port_range_max |O |1 |integer |The maximum port number in the range that is matched by the security group rule. |
1647+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
1648|security_group_id |M |1 |string |The security group ID to associate with this security group rule. |
1649+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
1650|port_range_min |O |1 |integer |The minimum port number in the range that is matched by the security group rule. |
1651+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
1652|remote_ip_prefix |M |1 |string |The remote IP prefix to associate with this metering rule packet. |
1653+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
1654|description |O |1 |string |A human-readable description for the resource. Default is an empty string. |
1655+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
1656
1657Response:
1658
1659+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
1660|Attribute |Content |Description |
1661+=============================+==================+=================================================================================================+
1662|security_group_rule |object |A security_group_rule object. |
1663+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
1664|remote_group_id |string |The remote group UUID to associate with this security group rule. |
1665+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
1666|direction |string |Ingress or egress, which is the direction in which the metering rule is applied. |
1667+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
1668|protocol |string |The IP protocol can be represented by a string, an integer, or null. |
1669+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
1670|ethertype |string |Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress rules. |
1671+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
1672|port_range_max |integer |The maximum port number in the range that is matched by the security group rule. |
1673+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
1674|security_group_id |string |The security group ID to associate with this security group rule. |
1675+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
1676|tenant_id |string |The ID of the project. |
1677+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
1678|project_id |string |The ID of the project. |
1679+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
1680|port_range_min |integer |The minimum port number in the range that is matched by the security group rule. |
1681+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
1682|remote_ip_prefix |string |The remote IP prefix to associate with this metering rule packet. |
1683+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
1684|revision_number |integer |The revision number of the resource. |
1685+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
1686|id |string |The ID of the security group rule. |
1687+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
1688|description |string |A human-readable description for the resource. |
1689+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
1690
1691Delete security group
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]1692+++++++++++++++++++++
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]1693
1694https://developer.openstack.org/api-ref/networking/v2/#delete-security-group-rule
1695
1696+--------------------+---------------------------------------------------------------------------------------------------------------------------------+
1697|Interface Definition|Description |
1698+====================+=================================================================================================================================+
1699|URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-group-rules/{security-group-rule-id} |
1700+--------------------+---------------------------------------------------------------------------------------------------------------------------------+
1701|Operation Type |DELETE |
1702+--------------------+---------------------------------------------------------------------------------------------------------------------------------+
1703|Content-Type |application/json |
1704+--------------------+---------------------------------------------------------------------------------------------------------------------------------+
1705
1706Request Body:
1707
1708+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
1709|Attribute |Qualifier|Cardinality|Content |Description |
1710+============================+=========+===========+==========================+==============================================================+
1711|security_group_rule_id |M |1 |String |The ID of the security group rule. |
1712+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
1713
1714Policy API
1715----------
1716
1717Create a dictionary item
1718++++++++++++++++++++++++
1719
1720+--------------------+--------------------------+
1721|Interface Definition|Description |
1722+====================+==========================+
1723|URI |/createDictionaryItem |
1724+--------------------+--------------------------+
1725|Operation Type |PUT |
1726+--------------------+--------------------------+
1727
1728Request Parameters:
1729
1730+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1731|Attribute |Qualifier|Cardinality|Content|Description |
1732+===================+=========+===========+=======+=============================================================+
1733|dictionory |M |1 |String | |
1734+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1735|dictionaryJson |M |1 |String | |
1736+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1737|dictionaryType |M |1 |String | |
1738+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1739|requestId |M |1 |String | |
1740+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1741
1742Request Headers:
1743
1744+-------------------+---------+-----------------------------------------------------------------------------------------+
1745|Header Name |Qualifier|Description |
1746+===================+=========+=========================================================================================+
1747|ClientAuth |Y |encoded client authentication details |
1748+-------------------+---------+-----------------------------------------------------------------------------------------+
1749|X-ECOMP-RequestID |N |Request ID to track the requests |
1750+-------------------+---------+-----------------------------------------------------------------------------------------+
1751|Environment |Y |execution environments |
1752+-------------------+---------+-----------------------------------------------------------------------------------------+
1753|Authorization |Y |Base64 encoded username:password |
1754+-------------------+---------+-----------------------------------------------------------------------------------------+
1755
1756HTTP Response Code:
1757
1758+------------------+---------------------+
1759|HTTP CODE |Description |
1760+==================+=====================+
1761|200 |successful |
1762+------------------+---------------------+
1763|400 |Invalid Request |
1764+------------------+---------------------+
1765|401 |Unauthorized |
1766+------------------+---------------------+
1767|500 |Error |
1768+------------------+---------------------+
1769
1770Create Policy
1771+++++++++++++
1772
1773+--------------------+--------------------------+
1774|Interface Definition|Description |
1775+====================+==========================+
1776|URI |/createPolicy |
1777+--------------------+--------------------------+
1778|Operation Type |PUT |
1779+--------------------+--------------------------+
1780
1781Request Parameters:
1782
1783+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1784|Attribute |Qualifier|Cardinality|Content|Description |
1785+===================+=========+===========+=======+=============================================================+
1786|attributes |M |1 |Object |set of attributes in key value pair |
1787+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1788|configBody |M |1 |String | |
1789+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1790|configBodyType |M |1 |String | |
1791+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1792|configName |M |1 |String | |
1793+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1794|ecompName |M |1 |String | |
1795+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1796|policyClass |M |1 |String | |
1797+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1798|policyConfigType |M |1 |String | |
1799+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1800|policyDescription |M |1 |String | |
1801+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1802|policyName |M |1 |String | |
1803+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1804|requestID |M |1 |String |request ID |
1805+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1806
1807Request Headers:
1808
1809+-------------------+---------+-----------------------------------------------------------------------------------------+
1810|Header Name |Qualifier|Description |
1811+===================+=========+=========================================================================================+
1812|ClientAuth |Y |encoded client authentication details |
1813+-------------------+---------+-----------------------------------------------------------------------------------------+
1814|X-ECOMP-RequestID |N |Request ID to track the requests |
1815+-------------------+---------+-----------------------------------------------------------------------------------------+
1816|Environment |Y |execution environments |
1817+-------------------+---------+-----------------------------------------------------------------------------------------+
1818|Authorization |Y |Base64 encoded username:password |
1819+-------------------+---------+-----------------------------------------------------------------------------------------+
1820
1821HTTP Response Code:
1822
1823+------------------+---------------------+
1824|HTTP CODE |Description |
1825+==================+=====================+
1826|200 |successful |
1827+------------------+---------------------+
1828|400 |Invalid Request |
1829+------------------+---------------------+
1830|401 |Unauthorized |
1831+------------------+---------------------+
1832|500 |Error |
1833+------------------+---------------------+
1834
1835Delete Policy
1836+++++++++++++
1837
1838+--------------------+--------------------------+
1839|Interface Definition|Description |
1840+====================+==========================+
1841|URI |/deletePolicy |
1842+--------------------+--------------------------+
1843|Operation Type |DELETE |
1844+--------------------+--------------------------+
1845
1846Request Parameters:
1847
1848+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1849|Attribute |Qualifier|Cardinality|Content|Description |
1850+===================+=========+===========+=======+=============================================================+
1851|deleteCondition |M |1 |String | |
1852+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1853|pdpGroup |M |1 |String | |
1854+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1855|policyComponent |M |1 |String | |
1856+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1857|policyName |M |1 |String | |
1858+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1859|policyType |M |1 |String | |
1860+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1861|requestID |M |1 |String |request ID |
1862+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1863
1864Request Headers:
1865
1866+-------------------+---------+-----------------------------------------------------------------------------------------+
1867|Header Name |Qualifier|Description |
1868+===================+=========+=========================================================================================+
1869|ClientAuth |Y |encoded client authentication details |
1870+-------------------+---------+-----------------------------------------------------------------------------------------+
1871|X-ECOMP-RequestID |N |Request ID to track the requests |
1872+-------------------+---------+-----------------------------------------------------------------------------------------+
1873|Environment |Y |execution environments |
1874+-------------------+---------+-----------------------------------------------------------------------------------------+
1875|Authorization |Y |Base64 encoded username:password |
1876+-------------------+---------+-----------------------------------------------------------------------------------------+
1877
1878HTTP Response Code:
1879
1880+------------------+---------------------+
1881|HTTP CODE |Description |
1882+==================+=====================+
1883|200 |successful |
1884+------------------+---------------------+
1885|400 |Invalid Request |
1886+------------------+---------------------+
1887|401 |Unauthorized |
1888+------------------+---------------------+
1889|500 |Error |
1890+------------------+---------------------+
1891
1892Get Configuration
1893+++++++++++++++++
1894
1895+--------------------+--------------------------+
1896|Interface Definition|Description |
1897+====================+==========================+
1898|URI |/getConfig |
1899+--------------------+--------------------------+
1900|Operation Type |POST |
1901+--------------------+--------------------------+
1902
1903Request Parameters:
1904
1905+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1906|Attribute |Qualifier|Cardinality|Content|Description |
1907+===================+=========+===========+=======+=============================================================+
1908|configAttributes |M |1 |String | |
1909+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1910|configName |M |1 |String | |
1911+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1912|ecompName |M |1 |String | |
1913+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1914|policyName |M |1 |String | |
1915+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1916|unique |M |1 |Boolean| |
1917+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1918|requestID |M |1 |String |request ID |
1919+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1920
1921Request Headers:
1922
1923+-------------------+---------+-----------------------------------------------------------------------------------------+
1924|Header Name |Qualifier|Description |
1925+===================+=========+=========================================================================================+
1926|ClientAuth |Y |encoded client authentication details |
1927+-------------------+---------+-----------------------------------------------------------------------------------------+
1928|X-ECOMP-RequestID |N |Request ID to track the requests |
1929+-------------------+---------+-----------------------------------------------------------------------------------------+
1930|Environment |Y |execution environments |
1931+-------------------+---------+-----------------------------------------------------------------------------------------+
1932|Authorization |Y |Base64 encoded username:password |
1933+-------------------+---------+-----------------------------------------------------------------------------------------+
1934
1935HTTP Response Code:
1936
1937+------------------+---------------------+
1938|HTTP CODE |Description |
1939+==================+=====================+
1940|200 |successful |
1941+------------------+---------------------+
1942|400 |Invalid Request |
1943+------------------+---------------------+
1944|401 |Unauthorized |
1945+------------------+---------------------+
1946|500 |Error |
1947+------------------+---------------------+
1948
1949Get Decision
1950++++++++++++
1951
1952+--------------------+--------------------------+
1953|Interface Definition|Description |
1954+====================+==========================+
1955|URI |/getDecision |
1956+--------------------+--------------------------+
1957|Operation Type |POST |
1958+--------------------+--------------------------+
1959
1960Request Parameters:
1961
1962+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1963|Attribute |Qualifier|Cardinality|Content|Description |
1964+===================+=========+===========+=======+=============================================================+
1965|decisionAttributes |M |1 |Object | |
1966+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1967|ecompComponentName |M |1 |String | |
1968+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1969|requestID |M |1 |String |request ID |
1970+-------------------+---------+-----------+-------+-------------------------------------------------------------+
1971
1972Request Headers:
1973
1974+-------------------+---------+-----------------------------------------------------------------------------------------+
1975|Header Name |Qualifier|Description |
1976+===================+=========+=========================================================================================+
1977|ClientAuth |Y |encoded client authentication details |
1978+-------------------+---------+-----------------------------------------------------------------------------------------+
1979|X-ECOMP-RequestID |N |Request ID to track the requests |
1980+-------------------+---------+-----------------------------------------------------------------------------------------+
1981|Environment |Y |execution environments |
1982+-------------------+---------+-----------------------------------------------------------------------------------------+
1983|Authorization |Y |Base64 encoded username:password |
1984+-------------------+---------+-----------------------------------------------------------------------------------------+
1985
1986HTTP Response Code:
1987
1988+------------------+---------------------+
1989|HTTP CODE |Description |
1990+==================+=====================+
1991|200 |successful |
1992+------------------+---------------------+
1993|400 |Invalid Request |
1994+------------------+---------------------+
1995|401 |Unauthorized |
1996+------------------+---------------------+
1997|500 |Error |
1998+------------------+---------------------+
1999
2000Response Parameters:
2001
2002+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2003|Attribute |Qualifier|Cardinality|Content|Description |
2004+===================+=========+===========+=======+=============================================================+
2005|decision |N |1 |String | |
2006+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2007|details |N |1 |String | |
2008+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2009
2010Get Dictionary Items
2011++++++++++++++++++++
2012
2013+--------------------+--------------------------+
2014|Interface Definition|Description |
2015+====================+==========================+
2016|URI |/getDictionaryItems |
2017+--------------------+--------------------------+
2018|Operation Type |POST |
2019+--------------------+--------------------------+
2020
2021Request Parameters:
2022
2023+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2024|Attribute |Qualifier|Cardinality|Content|Description |
2025+===================+=========+===========+=======+=============================================================+
2026|dictionary |N |1 |String | |
2027+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2028|dictionaryJson |N |1 |String | |
2029+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2030|dictionaryType |N |1 |String | |
2031+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2032|requestID |M |1 |String |request ID |
2033+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2034
2035Request Headers:
2036
2037+-------------------+---------+-----------------------------------------------------------------------------------------+
2038|Header Name |Qualifier|Description |
2039+===================+=========+=========================================================================================+
2040|ClientAuth |Y |encoded client authentication details |
2041+-------------------+---------+-----------------------------------------------------------------------------------------+
2042|X-ECOMP-RequestID |N |Request ID to track the requests |
2043+-------------------+---------+-----------------------------------------------------------------------------------------+
2044|Environment |Y |execution environments |
2045+-------------------+---------+-----------------------------------------------------------------------------------------+
2046|Authorization |Y |Base64 encoded username:password |
2047+-------------------+---------+-----------------------------------------------------------------------------------------+
2048
2049HTTP Response Code:
2050
2051+------------------+---------------------+
2052|HTTP CODE |Description |
2053+==================+=====================+
2054|200 |successful |
2055+------------------+---------------------+
2056|400 |Invalid Request |
2057+------------------+---------------------+
2058|401 |Unauthorized |
2059+------------------+---------------------+
2060|500 |Error |
2061+------------------+---------------------+
2062
2063Response Parameters:
2064
2065+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2066|Attribute |Qualifier|Cardinality|Content|Description |
2067+===================+=========+===========+=======+=============================================================+
2068|dictionaryData |N |1 |Object | |
2069+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2070|dictionaryJson |N |1 |Object | |
2071+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2072|responseCode |N |1 |Integer| |
2073+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2074|responseMessage |N |1 |Object | |
2075+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2076
2077Get Metrics
2078+++++++++++
2079
2080+--------------------+--------------------------+
2081|Interface Definition|Description |
2082+====================+==========================+
2083|URI |/getMetrics |
2084+--------------------+--------------------------+
2085|Operation Type |GET |
2086+--------------------+--------------------------+
2087
2088Request Headers:
2089
2090+-------------------+---------+-----------------------------------------------------------------------------------------+
2091|Header Name |Qualifier|Description |
2092+===================+=========+=========================================================================================+
2093|ClientAuth |Y |encoded client authentication details |
2094+-------------------+---------+-----------------------------------------------------------------------------------------+
2095|X-ECOMP-RequestID |N |Request ID to track the requests |
2096+-------------------+---------+-----------------------------------------------------------------------------------------+
2097|Environment |Y |execution environments |
2098+-------------------+---------+-----------------------------------------------------------------------------------------+
2099|Authorization |Y |Base64 encoded username:password |
2100+-------------------+---------+-----------------------------------------------------------------------------------------+
2101
2102HTTP Response Code:
2103
2104+------------------+---------------------+
2105|HTTP CODE |Description |
2106+==================+=====================+
2107|200 |successful |
2108+------------------+---------------------+
2109|400 |Invalid Request |
2110+------------------+---------------------+
2111|401 |Unauthorized |
2112+------------------+---------------------+
2113|500 |Error |
2114+------------------+---------------------+
2115
2116Response Parameters:
2117
2118+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2119|Attribute |Qualifier|Cardinality|Content|Description |
2120+===================+=========+===========+=======+=============================================================+
2121|metricsTotal |N |1 |Integer| |
2122+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2123|papMetrics |N |1 |Integer| |
2124+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2125|pdpMetrics |N |1 |Integer| |
2126+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2127|responseCode |N |1 |Object | |
2128+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2129|responseMessage |N |1 |String | |
2130+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2131
2132Get Notification
2133++++++++++++++++
2134
2135+--------------------+--------------------------+
2136|Interface Definition|Description |
2137+====================+==========================+
2138|URI |/getNotification |
2139+--------------------+--------------------------+
2140|Operation Type |POST |
2141+--------------------+--------------------------+
2142
2143Request Headers:
2144
2145+-------------------+---------+-----------------------------------------------------------------------------------------+
2146|Header Name |Qualifier|Description |
2147+===================+=========+=========================================================================================+
2148|ClientAuth |Y |encoded client authentication details |
2149+-------------------+---------+-----------------------------------------------------------------------------------------+
2150|X-ECOMP-RequestID |N |Request ID to track the requests |
2151+-------------------+---------+-----------------------------------------------------------------------------------------+
2152|Environment |Y |execution environments |
2153+-------------------+---------+-----------------------------------------------------------------------------------------+
2154|Authorization |Y |Base64 encoded username:password |
2155+-------------------+---------+-----------------------------------------------------------------------------------------+
2156
2157HTTP Response Code:
2158
2159+------------------+---------------------+
2160|HTTP CODE |Description |
2161+==================+=====================+
2162|200 |successful |
2163+------------------+---------------------+
2164|400 |Invalid Request |
2165+------------------+---------------------+
2166|401 |Unauthorized |
2167+------------------+---------------------+
2168|500 |Error |
2169+------------------+---------------------+
2170
2171Response Parameters:
2172
2173+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2174|Attribute |Qualifier|Cardinality|Content|Description |
2175+===================+=========+===========+=======+=============================================================+
2176|metricsTotal |N |1 |Integer| |
2177+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2178|papMetrics |N |1 |Integer| |
2179+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2180|pdpMetrics |N |1 |Integer| |
2181+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2182|responseCode |N |1 |Object | |
2183+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2184|responseMessage |N |1 |String | |
2185+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2186
2187List Configuration
2188++++++++++++++++++
2189
2190+--------------------+--------------------------+
2191|Interface Definition|Description |
2192+====================+==========================+
2193|URI |/listConfiguration |
2194+--------------------+--------------------------+
2195|Operation Type |POST |
2196+--------------------+--------------------------+
2197
2198Request Headers:
2199
2200+-------------------+---------+-----------------------------------------------------------------------------------------+
2201|Header Name |Qualifier|Description |
2202+===================+=========+=========================================================================================+
2203|ClientAuth |Y |encoded client authentication details |
2204+-------------------+---------+-----------------------------------------------------------------------------------------+
2205|X-ECOMP-RequestID |N |Request ID to track the requests |
2206+-------------------+---------+-----------------------------------------------------------------------------------------+
2207|Environment |Y |execution environments |
2208+-------------------+---------+-----------------------------------------------------------------------------------------+
2209|Authorization |Y |Base64 encoded username:password |
2210+-------------------+---------+-----------------------------------------------------------------------------------------+
2211
2212Request Parameters:
2213
2214+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2215|Attribute |Qualifier|Cardinality|Content|Description |
2216+===================+=========+===========+=======+=============================================================+
2217|configAttributes |N |1 |Object | |
2218+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2219|configName |N |1 |String | |
2220+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2221|ecompName |N |1 |String | |
2222+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2223|policyName |N |1 |String | |
2224+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2225|requestID |N |1 |String | |
2226+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2227|unique |N |1 |Boolean| |
2228+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2229
2230HTTP Response Code:
2231
2232+------------------+---------------------+
2233|HTTP CODE |Description |
2234+==================+=====================+
2235|200 |successful |
2236+------------------+---------------------+
2237|400 |Invalid Request |
2238+------------------+---------------------+
2239|401 |Unauthorized |
2240+------------------+---------------------+
2241|500 |Error |
2242+------------------+---------------------+
2243
2244Import policy
2245+++++++++++++
2246
2247+--------------------+--------------------------+
2248|Interface Definition|Description |
2249+====================+==========================+
2250|URI |/policyEngineImport |
2251+--------------------+--------------------------+
2252|Operation Type |POST |
2253+--------------------+--------------------------+
2254
2255Request Headers:
2256
2257+-------------------+---------+-----------------------------------------------------------------------------------------+
2258|Header Name |Qualifier|Description |
2259+===================+=========+=========================================================================================+
2260|ClientAuth |Y |encoded client authentication details |
2261+-------------------+---------+-----------------------------------------------------------------------------------------+
2262|X-ECOMP-RequestID |N |Request ID to track the requests |
2263+-------------------+---------+-----------------------------------------------------------------------------------------+
2264|Environment |Y |execution environments |
2265+-------------------+---------+-----------------------------------------------------------------------------------------+
2266|Authorization |Y |Base64 encoded username:password |
2267+-------------------+---------+-----------------------------------------------------------------------------------------+
2268
2269Request Parameters:
2270
2271+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2272|Attribute |Qualifier|Cardinality|Content|Description |
2273+===================+=========+===========+=======+=============================================================+
2274|importParameterJson|Y |1 |String | |
2275+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2276|file |Y |1 |File | |
2277+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2278
2279HTTP Response Code:
2280
2281+------------------+---------------------+
2282|HTTP CODE |Description |
2283+==================+=====================+
2284|200 |successful |
2285+------------------+---------------------+
2286|400 |Invalid Request |
2287+------------------+---------------------+
2288|401 |Unauthorized |
2289+------------------+---------------------+
2290|500 |Error |
2291+------------------+---------------------+
2292
2293Push Policy
2294+++++++++++
2295
2296+--------------------+--------------------------+
2297|Interface Definition|Description |
2298+====================+==========================+
2299|URI |/pushPolicy |
2300+--------------------+--------------------------+
2301|Operation Type |PUT |
2302+--------------------+--------------------------+
2303
2304Request Headers:
2305
2306+-------------------+---------+-----------------------------------------------------------------------------------------+
2307|Header Name |Qualifier|Description |
2308+===================+=========+=========================================================================================+
2309|ClientAuth |Y |encoded client authentication details |
2310+-------------------+---------+-----------------------------------------------------------------------------------------+
2311|X-ECOMP-RequestID |N |Request ID to track the requests |
2312+-------------------+---------+-----------------------------------------------------------------------------------------+
2313|Environment |Y |execution environments |
2314+-------------------+---------+-----------------------------------------------------------------------------------------+
2315|Authorization |Y |Base64 encoded username:password |
2316+-------------------+---------+-----------------------------------------------------------------------------------------+
2317
2318Request Parameters:
2319
2320+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2321|Attribute |Qualifier|Cardinality|Content|Description |
2322+===================+=========+===========+=======+=============================================================+
2323|pdpGroup |N |1 |String | |
2324+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2325|policyName |N |1 |String | |
2326+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2327|policyType |N |1 |String | |
2328+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2329
2330HTTP Response Code:
2331
2332+------------------+---------------------+
2333|HTTP CODE |Description |
2334+==================+=====================+
2335|200 |successful |
2336+------------------+---------------------+
2337|400 |Invalid Request |
2338+------------------+---------------------+
2339|401 |Unauthorized |
2340+------------------+---------------------+
2341|500 |Error |
2342+------------------+---------------------+
2343
2344Send Event
2345++++++++++
2346
2347+--------------------+--------------------------+
2348|Interface Definition|Description |
2349+====================+==========================+
2350|URI |/sendEvent |
2351+--------------------+--------------------------+
2352|Operation Type |POST |
2353+--------------------+--------------------------+
2354
2355Request Headers:
2356
2357+-------------------+---------+-----------------------------------------------------------------------------------------+
2358|Header Name |Qualifier|Description |
2359+===================+=========+=========================================================================================+
2360|ClientAuth |Y |encoded client authentication details |
2361+-------------------+---------+-----------------------------------------------------------------------------------------+
2362|X-ECOMP-RequestID |N |Request ID to track the requests |
2363+-------------------+---------+-----------------------------------------------------------------------------------------+
2364|Environment |Y |execution environments |
2365+-------------------+---------+-----------------------------------------------------------------------------------------+
2366|Authorization |Y |Base64 encoded username:password |
2367+-------------------+---------+-----------------------------------------------------------------------------------------+
2368
2369Request Parameters:
2370
2371+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2372|Attribute |Qualifier|Cardinality|Content|Description |
2373+===================+=========+===========+=======+=============================================================+
2374|eventAttributes |N |1 |Object | |
2375+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2376|requestID |N |1 |String | |
2377+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2378
2379HTTP Response Code:
2380
2381+------------------+---------------------+
2382|HTTP CODE |Description |
2383+==================+=====================+
2384|200 |successful |
2385+------------------+---------------------+
2386|400 |Invalid Request |
2387+------------------+---------------------+
2388|401 |Unauthorized |
2389+------------------+---------------------+
2390|500 |Error |
2391+------------------+---------------------+
2392
2393Send Heartbeat
2394++++++++++++++
2395
2396+--------------------+--------------------------+
2397|Interface Definition|Description |
2398+====================+==========================+
2399|URI |/sendEvent |
2400+--------------------+--------------------------+
2401|Operation Type |POST |
2402+--------------------+--------------------------+
2403
2404Request Headers:
2405
2406+-------------------+---------+-----------------------------------------------------------------------------------------+
2407|Header Name |Qualifier|Description |
2408+===================+=========+=========================================================================================+
2409|ClientAuth |Y |encoded client authentication details |
2410+-------------------+---------+-----------------------------------------------------------------------------------------+
2411|X-ECOMP-RequestID |N |Request ID to track the requests |
2412+-------------------+---------+-----------------------------------------------------------------------------------------+
2413|Environment |Y |execution environments |
2414+-------------------+---------+-----------------------------------------------------------------------------------------+
2415|Authorization |Y |Base64 encoded username:password |
2416+-------------------+---------+-----------------------------------------------------------------------------------------+
2417
2418Request Parameters:
2419
2420+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2421|Attribute |Qualifier|Cardinality|Content|Description |
2422+===================+=========+===========+=======+=============================================================+
2423|notificationTopic |Y |1 |String | |
2424+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2425
2426HTTP Response Code:
2427
2428+------------------+---------------------+
2429|HTTP CODE |Description |
2430+==================+=====================+
2431|200 |successful |
2432+------------------+---------------------+
2433|400 |Invalid Request |
2434+------------------+---------------------+
2435|401 |Unauthorized |
2436+------------------+---------------------+
2437|500 |Error |
2438+------------------+---------------------+
2439
2440Stop Notification
2441+++++++++++++++++
2442
2443+--------------------+--------------------------+
2444|Interface Definition|Description |
2445+====================+==========================+
2446|URI |/stopNotification |
2447+--------------------+--------------------------+
2448|Operation Type |POST |
2449+--------------------+--------------------------+
2450
2451Request Headers:
2452
2453+-------------------+---------+-----------------------------------------------------------------------------------------+
2454|Header Name |Qualifier|Description |
2455+===================+=========+=========================================================================================+
2456|ClientAuth |Y |encoded client authentication details |
2457+-------------------+---------+-----------------------------------------------------------------------------------------+
2458|X-ECOMP-RequestID |N |Request ID to track the requests |
2459+-------------------+---------+-----------------------------------------------------------------------------------------+
2460|Environment |Y |execution environments |
2461+-------------------+---------+-----------------------------------------------------------------------------------------+
2462|Authorization |Y |Base64 encoded username:password |
2463+-------------------+---------+-----------------------------------------------------------------------------------------+
2464
2465Request Parameters:
2466
2467+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2468|Attribute |Qualifier|Cardinality|Content|Description |
2469+===================+=========+===========+=======+=============================================================+
2470|notificationTopic |Y |1 |String | |
2471+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2472
2473HTTP Response Code:
2474
2475+------------------+---------------------+
2476|HTTP CODE |Description |
2477+==================+=====================+
2478|200 |successful |
2479+------------------+---------------------+
2480|400 |Invalid Request |
2481+------------------+---------------------+
2482|401 |Unauthorized |
2483+------------------+---------------------+
2484|500 |Error |
2485+------------------+---------------------+
2486
2487Update Dictionary
2488+++++++++++++++++
2489
2490+--------------------+--------------------------+
2491|Interface Definition|Description |
2492+====================+==========================+
2493|URI |/updateDictionaryItem |
2494+--------------------+--------------------------+
2495|Operation Type |PUT |
2496+--------------------+--------------------------+
2497
2498Request Headers:
2499
2500+-------------------+---------+-----------------------------------------------------------------------------------------+
2501|Header Name |Qualifier|Description |
2502+===================+=========+=========================================================================================+
2503|ClientAuth |Y |encoded client authentication details |
2504+-------------------+---------+-----------------------------------------------------------------------------------------+
2505|X-ECOMP-RequestID |N |Request ID to track the requests |
2506+-------------------+---------+-----------------------------------------------------------------------------------------+
2507|Environment |Y |execution environments |
2508+-------------------+---------+-----------------------------------------------------------------------------------------+
2509|Authorization |Y |Base64 encoded username:password |
2510+-------------------+---------+-----------------------------------------------------------------------------------------+
2511
2512Request Parameters:
2513
2514+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2515|Attribute |Qualifier|Cardinality|Content|Description |
2516+===================+=========+===========+=======+=============================================================+
2517|dictionary |N |1 |String | |
2518+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2519|dictionaryJson |N |1 |String | |
2520+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2521|dictionaryType |N |1 |String | |
2522+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2523|requestID |N |1 |String | |
2524+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2525
2526HTTP Response Code:
2527
2528+------------------+---------------------+
2529|HTTP CODE |Description |
2530+==================+=====================+
2531|200 |successful |
2532+------------------+---------------------+
2533|400 |Invalid Request |
2534+------------------+---------------------+
2535|401 |Unauthorized |
2536+------------------+---------------------+
2537|500 |Error |
2538+------------------+---------------------+
2539
2540Update Policy
2541+++++++++++++
2542
2543+--------------------+--------------------------+
2544|Interface Definition|Description |
2545+====================+==========================+
2546|URI |/updatePolicy |
2547+--------------------+--------------------------+
2548|Operation Type |PUT |
2549+--------------------+--------------------------+
2550
2551Request Headers:
2552
2553+-------------------+---------+-----------------------------------------------------------------------------------------+
2554|Header Name |Qualifier|Description |
2555+===================+=========+=========================================================================================+
2556|ClientAuth |Y |encoded client authentication details |
2557+-------------------+---------+-----------------------------------------------------------------------------------------+
2558|X-ECOMP-RequestID |N |Request ID to track the requests |
2559+-------------------+---------+-----------------------------------------------------------------------------------------+
2560|Environment |Y |execution environments |
2561+-------------------+---------+-----------------------------------------------------------------------------------------+
2562|Authorization |Y |Base64 encoded username:password |
2563+-------------------+---------+-----------------------------------------------------------------------------------------+
2564
2565Request Parameters:
2566
2567+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2568|Attribute |Qualifier|Cardinality|Content|Description |
2569+===================+=========+===========+=======+=============================================================+
2570|attributes |N |1 |Object | |
2571+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2572|configBody |N |1 |String | |
2573+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2574|configBodyType |N |1 |String | |
2575+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2576|configName |N |1 |String | |
2577+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2578|ecompName |N |1 |String | |
2579+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2580|policyClass |N |1 |String | |
2581+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2582|policyConfigType |N |1 |String | |
2583+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2584|policyDescription |N |1 |String | |
2585+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2586|policyName |N |1 |String | |
2587+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2588|requestID |N |1 |String | |
2589+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2590
2591HTTP Response Code:
2592
2593+------------------+---------------------+
2594|HTTP CODE |Description |
2595+==================+=====================+
2596|200 |successful |
2597+------------------+---------------------+
2598|400 |Invalid Request |
2599+------------------+---------------------+
2600|401 |Unauthorized |
2601+------------------+---------------------+
2602|500 |Error |
2603+------------------+---------------------+
2604
2605
2606OOF/HAS create update API
2607+++++++++++++++++++++++++
2608
2609+--------------------+--------------------------+
2610|Interface Definition|Description |
2611+====================+==========================+
2612|URI |/api/oof/v1/placement |
2613+--------------------+--------------------------+
2614|Operation Type |POST |
2615+--------------------+--------------------------+
2616
2617
2618Request Parameters:
2619
2620+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2621|Attribute |Required |Cardinality|Content|Description |
2622+===================+=========+===========+=======+=============================================================+
2623|requestInfo |Y |1 |Object |The content of the RequestInfo object. |
2624+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2625|placementInfo |Y |1 |Object |The Content of the PlacementInfo object. |
2626+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2627|licenseInfo |N |1 |Object |The Content of the LicenseInfo object. |
2628+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2629|serviceInfo |Y |1 |Object |The Content of the ServiceInfo object. |
2630+-------------------+---------+-----------+-------+-------------------------------------------------------------+
2631
2632
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]2633+-------------------+---------+-----------+---------------+--------------------------------------------------------------------------+
2634|Attribute |Required |Cardinality|Content |Description |
2635+===================+=========+===========+===============+==========================================================================+
2636|transactionId |Y |1 |String |A unique ID to track an ONAP transaction. |
2637+-------------------+---------+-----------+---------------+--------------------------------------------------------------------------+
2638|requestId |Y |1 |String |A unique ID to track multiple requests. |
2639+-------------------+---------+-----------+---------------+--------------------------------------------------------------------------+
2640|callbackUrl |Y |1 |String |The end point of a callback service where recommendations are posted. |
2641+-------------------+---------+-----------+---------------+--------------------------------------------------------------------------+
2642|callbackHeader |N |1 |String |The header information a client expecting in a async callback. |
2643+-------------------+---------+-----------+---------------+--------------------------------------------------------------------------+
2644|sourceId |Y |1 |String |The unique ID of a client making an optimization call. |
2645+-------------------+---------+-----------+---------------+--------------------------------------------------------------------------+
2646|requestType |Y |1 |String |The type of a request |
2647+-------------------+---------+-----------+---------------+--------------------------------------------------------------------------+
2648|numSolutions |N |1 |Integer |Expected number of solutions. |
2649+-------------------+---------+-----------+---------------+--------------------------------------------------------------------------+
2650|optimizers |Y |1..N |List of Strings|A list of optimization services. |
2651+-------------------+---------+-----------+---------------+--------------------------------------------------------------------------+
2652|timeout |N |1 |Integer |A tolerance window (in secs) for expecting solutions. Default is 600 secs.|
2653+-------------------+---------+-----------+---------------+--------------------------------------------------------------------------+
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]2654
2655
2656PlacementInfo Object
2657
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]2658+-------------------+---------+-----------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2659|Attribute |Required |Cardinality|Content |Description |
2660+===================+=========+===========+==============================+=======================================================================================================================================================================================================================================================================================================================================+
2661|requestParameters |C |1 |String |A JSON object conaining service and customer-specific data. A client or service designer is required to specify the parameters of interest for a given service and their location in the JSON blob through optimization query policies. This attribute is only required if a request contains service or customer-specific information.|
2662+-------------------+---------+-----------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2663|placementDemands |Y |1..N |List of PlacementDemand Object|The resource information for a placement service. |
2664+-------------------+---------+-----------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
2665|subscriberInfo |N |1 |Object |The information of a service subscriber. |
2666+-------------------+---------+-----------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]2667
2668PlacementDemand Object
2669
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]2670+-------------------+---------+-----------+----------------------------+-----------------------------------------------------------------------+
2671|Attribute |Required |Cardinality|Content |Description |
2672+===================+=========+===========+============================+=======================================================================+
2673|resourceModuleName |Y |1 |String |A resource name as defined in a service model. |
2674+-------------------+---------+-----------+----------------------------+-----------------------------------------------------------------------+
2675|serviceResourceId |Y |1 |String |A unique resource Id with a local scope between client and OOF. |
2676+-------------------+---------+-----------+----------------------------+-----------------------------------------------------------------------+
2677|tenantId |N |1 |String |A tenant Id as defined in the ordering system. |
2678+-------------------+---------+-----------+----------------------------+-----------------------------------------------------------------------+
2679|resourceModelInfo |Y |1 |Object |Resource model information as defined in SDC. |
2680+-------------------+---------+-----------+----------------------------+-----------------------------------------------------------------------+
2681|existingCandidates |N |1..N |List of Candidates Objects | The existing placement information of a resource. |
2682+-------------------+---------+-----------+----------------------------+-----------------------------------------------------------------------+
2683|excludedCandidates |N |1..N |List of Candidates Objects |Candidates that need to be excluded from solutions. |
2684+-------------------+---------+-----------+----------------------------+-----------------------------------------------------------------------+
2685|requiredCandidates |N |1..N |List of Candidates Objects |Candidates that must be included in solutions. |
2686+-------------------+---------+-----------+----------------------------+-----------------------------------------------------------------------+
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]2687
2688
2689SubscriberInfo Object
2690
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]2691+-----------------------+---------+-----------+-------+-----------------------------------------------------------------------------------+
2692|Attribute |Required |Cardinality|Content|Description |
2693+=======================+=========+===========+=======+===================================================================================+
2694|globalSubscriberId |Y |1 |String |An ID of a subscriber. |
2695+-----------------------+---------+-----------+-------+-----------------------------------------------------------------------------------+
2696|subscriberName |Y |1.N |String |The name of a subscriber. If the name is not known, the value must be 'unknown'. |
2697+-----------------------+---------+-----------+-------+-----------------------------------------------------------------------------------+
2698|subscriberCommonSiteId |N |1 |String |Id representing a subscriber location. |
2699+-----------------------+---------+-----------+-------+-----------------------------------------------------------------------------------+
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]2700
2701ModelMetaData Object
2702
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]2703+------------------------+---------+-----------+-------+-----------------------------------------------------------------------+
2704|Attribute |Required |Cardinality|Content|Description |
2705+========================+=========+===========+=======+=======================================================================+
2706|modelInvariantId |Y |1 |String |A model invariant Id as defined in a service model. |
2707+------------------------+---------+-----------+-------+-----------------------------------------------------------------------+
2708|modelVersionId |Y |1 |String |A unique model Id as defined in a service model. |
2709+------------------------+---------+-----------+-------+-----------------------------------------------------------------------+
2710|modelName |N |1 |String |A model name as defined in a service model. |
2711+------------------------+---------+-----------+-------+-----------------------------------------------------------------------+
2712|modelType |N |1 |String |A model type as defined in a service model. |
2713+------------------------+---------+-----------+-------+-----------------------------------------------------------------------+
2714|modelVersion |N |1 |String |A model version as defined in a service model. |
2715+------------------------+---------+-----------+-------+-----------------------------------------------------------------------+
2716|modelCustomizationName |N |1 |String |A model customization name as defined in a service model. |
2717+------------------------+---------+-----------+-------+-----------------------------------------------------------------------+
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]2718
2719
2720Candidates Object
2721
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]2722+-------------------+---------+-----------+-------+--------------------------------------------------------------------------------+
2723|Attribute |Required |Cardinality|Content|Description |
2724+===================+=========+===========+=======+================================================================================+
2725|identifierType |Y |1 |String |The type of a candidate. |
2726+-------------------+---------+-----------+-------+--------------------------------------------------------------------------------+
2727|identifiers |Y |1..N |List |A list of identifiers. |
2728+-------------------+---------+-----------+-------+--------------------------------------------------------------------------------+
Rene_Robertaa606352019-08-22 16:57:27 +0200[diff] [blame^]2729|cloudOwner |C |1 |String |The name of a cloud owner. Only required if identifierType is cloud_region_id. |
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]2730+-------------------+---------+-----------+-------+--------------------------------------------------------------------------------+
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]2731
2732
2733ServiceInfo Object
2734
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]2735+-------------------+---------+-----------+---------------------+-----------------------------------------------------------------------+
2736|Attribute |Required |Cardinality|Content |Description |
2737+===================+=========+===========+=====================+=======================================================================+
2738|serviceInstanceId |Y |1 |String |A service instance id associated with a request. |
2739+-------------------+---------+-----------+---------------------+-----------------------------------------------------------------------+
2740|modelInfo |Y |1 |ModelMetaData Object |A list of identifiers. |
2741+-------------------+---------+-----------+---------------------+-----------------------------------------------------------------------+
2742|serviceName |Y |1 |String |The name of a service |
2743+-------------------+---------+-----------+---------------------+-----------------------------------------------------------------------+
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]2744
2745LicenseInfo Object
2746
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]2747+-------------------+---------+-----------+------------------------------+-----------------------------------------------------------------------+
2748|Attribute |Required |Cardinality|Content |Description |
2749+===================+=========+===========+==============================+=======================================================================+
2750|licenseDemands |Y |1..N |List of LicenseDemands Object |A list of resources for license selection. |
2751+-------------------+---------+-----------+------------------------------+-----------------------------------------------------------------------+
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]2752
2753LicenseDemand Object
2754
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]2755+-------------------+---------+-----------+---------------------+-----------------------------------------------------------------------+
2756|Attribute |Required |Cardinality|Content |Description |
2757+===================+=========+===========+=====================+=======================================================================+
2758|resourceModuleName |Y |1 |String |A resource name as defined in a service model. |
2759+-------------------+---------+-----------+---------------------+-----------------------------------------------------------------------+
2760|serviceResourceId |Y |1 |String |A unique resource Id with a local scope between client and OOF. |
2761+-------------------+---------+-----------+---------------------+-----------------------------------------------------------------------+
2762|resourceModelInfo |Y |1 |ModelMetaData Object |Resource model information as defined in a service model. |
2763+-------------------+---------+-----------+---------------------+-----------------------------------------------------------------------+
2764|existingLicenses |N |1 |LicenseModel Object |Existing license information assigned to a resource. |
2765+-------------------+---------+-----------+---------------------+-----------------------------------------------------------------------+
seshukmeab83ce2019-01-10 07:15:01 +0100[diff] [blame]2766
2767LicenseModel Object
2768
2769+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
2770|Attribute |Required |Cardinality|Content|Description |
2771+===================+=========+===========+=======+=======================================================================+
2772|entitlementPoolUUID|Y |1..N |List |Entitlement pool UUIDs associated with a resource. |
2773+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
2774|licenseKeyGroupUUID|Y |1..N |List |License key groups associated with a resource. |
2775+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
2776
2777
2778Response Body
2779
2780+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
2781|Attribute |Required |Cardinality|Content|Description |
2782+===================+=========+===========+=======+=======================================================================+
2783|requestId |Y |1 |String |A unique Id for an ONAP transaction. |
2784+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
2785|transactionId |Y |1 |String |A unique ID to track multiple requests associated with a transaction. |
2786+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
2787|statusMessage |N |1 |String |Reasoning if a requestStatus is failed. |
2788+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+
2789|requestStatus |Y |1 |String |The status of a request. |
k.kazak1acd44e2019-07-26 17:04:59 +0200[diff] [blame]2790+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+