1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. SPDX-License-Identifier: CC-BY-4.0
3 .. Copyright (C) 2021 Wind River Systems, Inc.
5 INF O2 Services API 1.0.0
6 =============================
15 Swagger OpenAPI document for the INF O2 Services
24 http(s)://<OAM IP>:30205/
30 DMS LCM related operations.
36 POST ``/o2dms/v1/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeployment``
37 -------------------------------------------------------------------------------
47 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
48 :widths: 20, 15, 10, 10, 10, 20, 30
50 deploymentManagerID | path | Yes | string | | | ID of the deployment manager
60 .. code-block:: javascript
62 X-Fields: An optional fields mask
66 .. _d_1cdf8e618b9847878bed90d4897e6b3a:
73 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
74 :widths: 20, 10, 15, 15, 30, 25
76 description | No | string | | |
77 descriptorId | No | string | | |
78 name | No | string | | |
79 parentDeploymentId | No | string | | |
81 .. code-block:: javascript
84 "description": "somestring",
85 "descriptorId": "somestring",
87 "parentDeploymentId": "somestring"
99 Type: :ref:`NfDeploymentCreateRespDto <d_c00d46ffd3e149e2989d2a5264585581>`
103 .. code-block:: javascript
119 POST ``/o2dms/v1/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeploymentDescriptor``
120 -----------------------------------------------------------------------------------------
130 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
131 :widths: 20, 15, 10, 10, 10, 20, 30
133 deploymentManagerID | path | Yes | string | | | ID of the deployment manager
143 .. code-block:: javascript
145 X-Fields: An optional fields mask
149 .. _d_1583b74cb6544a428fadd82cb4ff4b3b:
156 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
157 :widths: 20, 10, 15, 15, 30, 25
159 artifactName | No | string | | |
160 artifactRepoUrl | No | string | | |
161 description | No | string | | |
162 inputParams | No | string | | |
163 name | No | string | | |
164 outputParams | No | string | | |
166 .. code-block:: javascript
169 "artifactName": "somestring",
170 "artifactRepoUrl": "somestring",
171 "description": "somestring",
172 "inputParams": "somestring",
173 "name": "somestring",
174 "outputParams": "somestring"
186 Type: :ref:`NfDeploymentDescriptorCreateRespDto <d_67c3fe14b244e803ad34a57f27b4bb4e>`
190 .. code-block:: javascript
206 DELETE ``/o2dms/v1/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeployment/{nfDeploymentId}``
207 --------------------------------------------------------------------------------------------------
217 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
218 :widths: 20, 15, 10, 10, 10, 20, 30
220 nfDeploymentId | path | Yes | string | | | ID of the NfDeployment
221 deploymentManagerID | path | Yes | string | | | ID of the deployment manager
247 DELETE ``/o2dms/v1/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeploymentDescriptor/{nfDeploymentDescriptorId}``
248 ----------------------------------------------------------------------------------------------------------------------
258 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
259 :widths: 20, 15, 10, 10, 10, 20, 30
261 nfDeploymentDescriptorId | path | Yes | string | | | ID of the NfDeploymentDescriptor
262 deploymentManagerID | path | Yes | string | | | ID of the deployment manager
275 NfDeploymentDescriptor deleted
288 GET ``/o2dms/v1/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeployment/{nfDeploymentId}``
289 -----------------------------------------------------------------------------------------------
299 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
300 :widths: 20, 15, 10, 10, 10, 20, 30
302 nfDeploymentId | path | Yes | string | | | ID of the NfDeployment
303 deploymentManagerID | path | Yes | string | | | ID of the deployment manager
313 .. code-block:: javascript
315 X-Fields: An optional fields mask
327 Type: :ref:`NfDeploymentGetDto <d_e28dc7c38126e125615678304c7a9508>`
331 .. code-block:: javascript
334 "description": "somestring",
335 "descriptorId": "somestring",
337 "name": "somestring",
338 "parentDeploymentId": "somestring",
352 GET ``/o2dms/v1/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeploymentDescriptor/{nfDeploymentDescriptorId}``
353 -------------------------------------------------------------------------------------------------------------------
363 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
364 :widths: 20, 15, 10, 10, 10, 20, 30
366 nfDeploymentDescriptorId | path | Yes | string | | | ID of the NfDeploymentDescriptor
367 deploymentManagerID | path | Yes | string | | | ID of the deployment manager
377 .. code-block:: javascript
379 X-Fields: An optional fields mask
391 Type: :ref:`NfDeploymentDescriptorGetDto <d_5bdce8ac307530aa532cc25654cd5b07>`
395 .. code-block:: javascript
398 "artifactName": "somestring",
399 "artifactRepoUrl": "somestring",
400 "description": "somestring",
402 "inputParams": "somestring",
403 "name": "somestring",
404 "outputParams": "somestring"
417 GET ``/o2dms/v1/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeployment``
418 ------------------------------------------------------------------------------
428 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
429 :widths: 20, 15, 10, 10, 10, 20, 30
431 deploymentManagerID | path | Yes | string | | | ID of the deployment manager
441 .. code-block:: javascript
443 X-Fields: An optional fields mask
455 Type: array of :ref:`NfDeploymentGetDto <d_e28dc7c38126e125615678304c7a9508>`
460 .. code-block:: javascript
464 "description": "somestring",
465 "descriptorId": "somestring",
467 "name": "somestring",
468 "parentDeploymentId": "somestring",
472 "description": "somestring",
473 "descriptorId": "somestring",
475 "name": "somestring",
476 "parentDeploymentId": "somestring",
491 GET ``/o2dms/v1/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeploymentDescriptor``
492 ----------------------------------------------------------------------------------------
502 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
503 :widths: 20, 15, 10, 10, 10, 20, 30
505 deploymentManagerID | path | Yes | string | | | ID of the deployment manager
515 .. code-block:: javascript
517 X-Fields: An optional fields mask
529 Type: array of :ref:`NfDeploymentDescriptorGetDto <d_5bdce8ac307530aa532cc25654cd5b07>`
534 .. code-block:: javascript
538 "artifactName": "somestring",
539 "artifactRepoUrl": "somestring",
540 "description": "somestring",
542 "inputParams": "somestring",
543 "name": "somestring",
544 "outputParams": "somestring"
547 "artifactName": "somestring",
548 "artifactRepoUrl": "somestring",
549 "description": "somestring",
551 "inputParams": "somestring",
552 "name": "somestring",
553 "outputParams": "somestring"
567 GET ``/o2dms/v1/{deploymentManagerID}``
568 ---------------------------------------
578 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
579 :widths: 20, 15, 10, 10, 10, 20, 30
581 deploymentManagerID | path | Yes | string | | | ID of the deployment manager
591 .. code-block:: javascript
593 X-Fields: An optional fields mask
605 Type: :ref:`DmsGetDto <d_086ee84f2c2cf010478bfc73a87b5e80>`
609 .. code-block:: javascript
612 "capabilities": "somestring",
613 "capacity": "somestring",
614 "deploymentManagerId": "somestring",
615 "description": "somestring",
616 "name": "somestring",
617 "supportedLocations": "somestring"
623 Deployment manager not found
630 PUT ``/o2dms/v1/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeployment/{nfDeploymentId}``
631 -----------------------------------------------------------------------------------------------
641 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
642 :widths: 20, 15, 10, 10, 10, 20, 30
644 nfDeploymentId | path | Yes | string | | | ID of the NfDeployment
645 deploymentManagerID | path | Yes | string | | | ID of the deployment manager
653 .. _d_1a0e59d24d7db279637f186c203d883d:
660 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
661 :widths: 20, 10, 15, 15, 30, 25
663 description | No | string | | |
664 name | No | string | | |
665 parentDeploymentId | No | string | | |
667 .. code-block:: javascript
670 "description": "somestring",
671 "name": "somestring",
672 "parentDeploymentId": "somestring"
688 PUT ``/o2dms/v1/{deploymentManagerID}/O2dms_DeploymentLifecycle/NfDeploymentDescriptor/{nfDeploymentDescriptorId}``
689 -------------------------------------------------------------------------------------------------------------------
699 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
700 :widths: 20, 15, 10, 10, 10, 20, 30
702 nfDeploymentDescriptorId | path | Yes | string | | | ID of the NfDeploymentDescriptor
703 deploymentManagerID | path | Yes | string | | | ID of the deployment manager
711 .. _d_5a6ee319c7ac35eac173da7d57136a98:
718 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
719 :widths: 20, 10, 15, 15, 30, 25
721 artifactName | No | string | | |
722 artifactRepoUrl | No | string | | |
723 description | No | string | | |
724 inputParams | No | string | | |
725 name | No | string | | |
726 outputParams | No | string | | |
728 .. code-block:: javascript
731 "artifactName": "somestring",
732 "artifactRepoUrl": "somestring",
733 "description": "somestring",
734 "inputParams": "somestring",
735 "name": "somestring",
736 "outputParams": "somestring"
755 IMS Inventory related operations.
761 POST ``/o2ims_infrastructureInventory/v1/subscriptions``
762 --------------------------------------------------------
775 .. code-block:: javascript
777 X-Fields: An optional fields mask
781 .. _d_0fff8519707c32c34f86d6ac19fad342:
788 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
789 :widths: 20, 10, 15, 15, 30, 25
791 callback | Yes | string | | | Subscription callback address
792 consumerSubscriptionId | No | string | | |
793 filter | No | string | | |
795 .. code-block:: javascript
798 "callback": "somestring",
799 "consumerSubscriptionId": "somestring",
800 "filter": "somestring"
812 Type: :ref:`SubscriptionCreatedRespDto <d_4397329931bf78862bc91387dbdb86c4>`
816 .. code-block:: javascript
819 "subscriptionId": "somestring"
826 DELETE ``/o2ims_infrastructureInventory/v1/subscriptions/{subscriptionID}``
827 ---------------------------------------------------------------------------
837 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
838 :widths: 20, 15, 10, 10, 10, 20, 30
840 subscriptionID | path | Yes | string | | | ID of the subscription
859 Subscription not found
866 GET ``/o2ims_infrastructureInventory/v1/deploymentManagers/{deploymentManagerID}``
867 ----------------------------------------------------------------------------------
877 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
878 :widths: 20, 15, 10, 10, 10, 20, 30
880 deploymentManagerID | path | Yes | string | | | ID of the deployment manager
890 .. code-block:: javascript
892 X-Fields: An optional fields mask
904 Type: :ref:`DeploymentManagerGetDto <d_e936cc219a004ab92ac027b2690bdd5e>`
908 .. code-block:: javascript
911 "capabilities": "somestring",
912 "capacity": "somestring",
913 "deploymentManagementServiceEndpoint": "somestring",
914 "deploymentManagerId": "somestring",
915 "description": "somestring",
916 "name": "somestring",
917 "supportedLocations": "somestring"
923 Deployment manager not found
930 GET ``/o2ims_infrastructureInventory/v1/resourcePools/{resourcePoolID}/resources/{resourceID}``
931 -----------------------------------------------------------------------------------------------
941 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
942 :widths: 20, 15, 10, 10, 10, 20, 30
944 resourceID | path | Yes | string | | | ID of the resource
945 resourcePoolID | path | Yes | string | | | ID of the resource pool
955 .. code-block:: javascript
957 X-Fields: An optional fields mask
969 Type: :ref:`ResourceGetDto2 <d_958dd46196a624722ba9ea3ea4d27e38>`
973 .. code-block:: javascript
980 "description": "somestring",
981 "elements": "somestring",
982 "name": "somestring",
983 "parentId": "somestring",
984 "resourceId": "somestring",
985 "resourcePoolId": "somestring",
986 "resourceTypeId": "somestring"
989 "description": "somestring",
990 "elements": "somestring",
991 "name": "somestring",
992 "parentId": "somestring",
993 "resourceId": "somestring",
994 "resourcePoolId": "somestring",
995 "resourceTypeId": "somestring"
998 "description": "somestring",
999 "elements": "somestring",
1000 "name": "somestring",
1001 "parentId": "somestring",
1002 "resourceId": "somestring",
1003 "resourcePoolId": "somestring",
1004 "resourceTypeId": "somestring"
1009 "description": "somestring",
1010 "elements": "somestring",
1011 "name": "somestring",
1012 "parentId": "somestring",
1013 "resourceId": "somestring",
1014 "resourcePoolId": "somestring",
1015 "resourceTypeId": "somestring"
1018 "description": "somestring",
1019 "elements": "somestring",
1020 "name": "somestring",
1021 "parentId": "somestring",
1022 "resourceId": "somestring",
1023 "resourcePoolId": "somestring",
1024 "resourceTypeId": "somestring"
1027 "description": "somestring",
1028 "elements": "somestring",
1029 "name": "somestring",
1030 "parentId": "somestring",
1031 "resourceId": "somestring",
1032 "resourcePoolId": "somestring",
1033 "resourceTypeId": "somestring"
1036 "description": "somestring",
1037 "elements": "somestring",
1038 "name": "somestring",
1039 "parentId": "somestring",
1040 "resourceId": "somestring",
1041 "resourcePoolId": "somestring",
1042 "resourceTypeId": "somestring"
1055 GET ``/o2ims_infrastructureInventory/v1/resourcePools/{resourcePoolID}``
1056 ------------------------------------------------------------------------
1066 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1067 :widths: 20, 15, 10, 10, 10, 20, 30
1069 resourcePoolID | path | Yes | string | | | ID of the resource pool
1079 .. code-block:: javascript
1081 X-Fields: An optional fields mask
1093 Type: :ref:`ResourcePoolGetDto <d_296e5d50362a85c0b8843dfe38965ce9>`
1097 .. code-block:: javascript
1100 "description": "somestring",
1101 "globalLocationId": "somestring",
1102 "location": "somestring",
1103 "name": "somestring",
1104 "resourcePoolId": "somestring"
1110 Resource pool not found
1117 GET ``/o2ims_infrastructureInventory/v1/resourceTypes/{resourceTypeID}``
1118 ------------------------------------------------------------------------
1128 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1129 :widths: 20, 15, 10, 10, 10, 20, 30
1131 resourceTypeID | path | Yes | string | | | ID of the resource type
1141 .. code-block:: javascript
1143 X-Fields: An optional fields mask
1155 Type: :ref:`ResourceTypeGetDto <d_fb92075f954e3895d1435d4e523666fa>`
1159 .. code-block:: javascript
1162 "description": "somestring",
1163 "name": "somestring",
1164 "resourceTypeId": "somestring",
1165 "vendor": "somestring",
1166 "version": "somestring"
1172 Resource type not found
1179 GET ``/o2ims_infrastructureInventory/v1/subscriptions/{subscriptionID}``
1180 ------------------------------------------------------------------------
1190 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1191 :widths: 20, 15, 10, 10, 10, 20, 30
1193 subscriptionID | path | Yes | string | | | ID of the subscription
1203 .. code-block:: javascript
1205 X-Fields: An optional fields mask
1217 Type: :ref:`SubscriptionGetDto <d_90e532f740e7ec8e9d71fad08513c388>`
1221 .. code-block:: javascript
1224 "callback": "somestring",
1225 "consumerSubscriptionId": "somestring",
1226 "filter": "somestring",
1227 "subscriptionId": "somestring"
1233 Subscription not found
1240 GET ``/o2ims_infrastructureInventory/v1/subscriptions``
1241 -------------------------------------------------------
1254 .. code-block:: javascript
1256 X-Fields: An optional fields mask
1268 Type: array of :ref:`SubscriptionGetDto <d_90e532f740e7ec8e9d71fad08513c388>`
1273 .. code-block:: javascript
1277 "callback": "somestring",
1278 "consumerSubscriptionId": "somestring",
1279 "filter": "somestring",
1280 "subscriptionId": "somestring"
1283 "callback": "somestring",
1284 "consumerSubscriptionId": "somestring",
1285 "filter": "somestring",
1286 "subscriptionId": "somestring"
1294 GET ``/o2ims_infrastructureInventory/v1/deploymentManagers``
1295 ------------------------------------------------------------
1308 .. code-block:: javascript
1310 X-Fields: An optional fields mask
1322 Type: array of :ref:`DeploymentManagerGetDto <d_e936cc219a004ab92ac027b2690bdd5e>`
1327 .. code-block:: javascript
1331 "capabilities": "somestring",
1332 "capacity": "somestring",
1333 "deploymentManagementServiceEndpoint": "somestring",
1334 "deploymentManagerId": "somestring",
1335 "description": "somestring",
1336 "name": "somestring",
1337 "supportedLocations": "somestring"
1340 "capabilities": "somestring",
1341 "capacity": "somestring",
1342 "deploymentManagementServiceEndpoint": "somestring",
1343 "deploymentManagerId": "somestring",
1344 "description": "somestring",
1345 "name": "somestring",
1346 "supportedLocations": "somestring"
1354 GET ``/o2ims_infrastructureInventory/v1/``
1355 ------------------------------------------
1368 .. code-block:: javascript
1370 X-Fields: An optional fields mask
1382 Type: :ref:`OcloudDto <d_24d46c2729680edc54e60b2dfbea8ebf>`
1386 .. code-block:: javascript
1389 "description": "somestring",
1390 "globalCloudId": "somestring",
1391 "infrastructureManagementServiceEndpoint": "somestring",
1392 "name": "somestring",
1393 "oCloudId": "somestring"
1406 GET ``/o2ims_infrastructureInventory/v1/resourcePools``
1407 -------------------------------------------------------
1420 .. code-block:: javascript
1422 X-Fields: An optional fields mask
1434 Type: array of :ref:`ResourcePoolGetDto <d_296e5d50362a85c0b8843dfe38965ce9>`
1439 .. code-block:: javascript
1443 "description": "somestring",
1444 "globalLocationId": "somestring",
1445 "location": "somestring",
1446 "name": "somestring",
1447 "resourcePoolId": "somestring"
1450 "description": "somestring",
1451 "globalLocationId": "somestring",
1452 "location": "somestring",
1453 "name": "somestring",
1454 "resourcePoolId": "somestring"
1462 GET ``/o2ims_infrastructureInventory/v1/resourceTypes``
1463 -------------------------------------------------------
1476 .. code-block:: javascript
1478 X-Fields: An optional fields mask
1490 Type: array of :ref:`ResourceTypeGetDto <d_fb92075f954e3895d1435d4e523666fa>`
1495 .. code-block:: javascript
1499 "description": "somestring",
1500 "name": "somestring",
1501 "resourceTypeId": "somestring",
1502 "vendor": "somestring",
1503 "version": "somestring"
1506 "description": "somestring",
1507 "name": "somestring",
1508 "resourceTypeId": "somestring",
1509 "vendor": "somestring",
1510 "version": "somestring"
1518 GET ``/o2ims_infrastructureInventory/v1/resourcePools/{resourcePoolID}/resources``
1519 ----------------------------------------------------------------------------------
1529 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1530 :widths: 20, 15, 10, 10, 10, 20, 30
1532 parentId | query | No | string | | | filter parentId
1533 resourceTypeName | query | No | string | | | filter resource type
1534 resourcePoolID | path | Yes | string | | | ID of the resource pool
1544 .. code-block:: javascript
1546 X-Fields: An optional fields mask
1558 Type: array of :ref:`ResourceListDto <d_942ff02bfe350c7d2a7f3faabf5d77d1>`
1563 .. code-block:: javascript
1567 "description": "somestring",
1568 "name": "somestring",
1569 "parentId": "somestring",
1570 "resourceId": "somestring",
1571 "resourcePoolId": "somestring",
1572 "resourceTypeId": "somestring"
1575 "description": "somestring",
1576 "name": "somestring",
1577 "parentId": "somestring",
1578 "resourceId": "somestring",
1579 "resourcePoolId": "somestring",
1580 "resourceTypeId": "somestring"
1591 Provision related operations.
1597 POST ``/provision/v1/smo-endpoint``
1598 -----------------------------------
1611 .. code-block:: javascript
1613 X-Fields: An optional fields mask
1617 .. _d_18b723a8578a1c0bdb13e962c902ad94:
1624 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1625 :widths: 20, 10, 15, 15, 30, 25
1627 endpoint | Yes | string | | | Configuration SMO callback address
1629 .. code-block:: javascript
1632 "endpoint": "somestring"
1644 Type: :ref:`SmoEndpointCreatedRespDto <d_36a34be9221cecc9bf82d276b9266961>`
1648 .. code-block:: javascript
1658 DELETE ``/provision/v1/smo-endpoint/{configurationID}``
1659 -------------------------------------------------------
1669 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1670 :widths: 20, 15, 10, 10, 10, 20, 30
1672 configurationID | path | Yes | string | | | ID of the SMO endpoint configuration
1685 Configuration deleted
1691 SMO Endpoint configuration not found
1698 GET ``/provision/v1/smo-endpoint/{configurationID}``
1699 ----------------------------------------------------
1709 :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description"
1710 :widths: 20, 15, 10, 10, 10, 20, 30
1712 configurationID | path | Yes | string | | | ID of the SMO endpoint configuration
1722 .. code-block:: javascript
1724 X-Fields: An optional fields mask
1736 Type: :ref:`SmoEndpointGetDto <d_a6b61d9695be919cc22b2e700eeb7e27>`
1740 .. code-block:: javascript
1743 "comments": "somestring",
1744 "endpoint": "somestring",
1746 "status": "somestring"
1752 SMO Endpoint configuration not found
1759 GET ``/provision/v1/smo-endpoint``
1760 ----------------------------------
1773 .. code-block:: javascript
1775 X-Fields: An optional fields mask
1787 Type: array of :ref:`SmoEndpointGetDto <d_a6b61d9695be919cc22b2e700eeb7e27>`
1792 .. code-block:: javascript
1796 "comments": "somestring",
1797 "endpoint": "somestring",
1799 "status": "somestring"
1802 "comments": "somestring",
1803 "endpoint": "somestring",
1805 "status": "somestring"
1815 .. _d_e936cc219a004ab92ac027b2690bdd5e:
1817 DeploymentManagerGetDto Model Structure
1818 ---------------------------------------
1822 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1823 :widths: 20, 10, 15, 15, 30, 25
1825 capabilities | No | string | | |
1826 capacity | No | string | | |
1827 deploymentManagementServiceEndpoint | No | string | | |
1828 deploymentManagerId | Yes | string | | | Deployment manager ID
1829 description | No | string | | |
1830 name | No | string | | |
1831 supportedLocations | No | string | | |
1833 .. _d_086ee84f2c2cf010478bfc73a87b5e80:
1835 DmsGetDto Model Structure
1836 -------------------------
1840 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1841 :widths: 20, 10, 15, 15, 30, 25
1843 capabilities | No | string | | |
1844 capacity | No | string | | |
1845 deploymentManagerId | Yes | string | | | Deployment manager ID
1846 description | No | string | | |
1847 name | No | string | | |
1848 supportedLocations | No | string | | |
1850 .. _d_1cdf8e618b9847878bed90d4897e6b4a:
1852 NfDeploymentCreateDto Model Structure
1853 -------------------------------------
1857 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1858 :widths: 20, 10, 15, 15, 30, 25
1860 description | No | string | | |
1861 descriptorId | No | string | | |
1862 name | No | string | | |
1863 parentDeploymentId | No | string | | |
1865 .. _d_c00d46ffd3e149e2989d2a5264585581:
1867 NfDeploymentCreateRespDto Model Structure
1868 -----------------------------------------
1872 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1873 :widths: 20, 10, 15, 15, 30, 25
1875 id | Yes | string | | | NfDeployment ID
1877 .. _d_1583b74cb6544a428fadd82cb4ff4b4b:
1879 NfDeploymentDescriptorCreateDto Model Structure
1880 -----------------------------------------------
1884 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1885 :widths: 20, 10, 15, 15, 30, 25
1887 artifactName | No | string | | |
1888 artifactRepoUrl | No | string | | |
1889 description | No | string | | |
1890 inputParams | No | string | | |
1891 name | No | string | | |
1892 outputParams | No | string | | |
1894 .. _d_67c3fe14b244e803ad34a57f27b4bb4e:
1896 NfDeploymentDescriptorCreateRespDto Model Structure
1897 ---------------------------------------------------
1901 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1902 :widths: 20, 10, 15, 15, 30, 25
1904 id | Yes | string | | | NfDeploymentDescriptor ID
1906 .. _d_5bdce8ac307530aa532cc25654cd5b07:
1908 NfDeploymentDescriptorGetDto Model Structure
1909 --------------------------------------------
1913 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1914 :widths: 20, 10, 15, 15, 30, 25
1916 artifactName | No | string | | |
1917 artifactRepoUrl | No | string | | |
1918 description | No | string | | |
1919 id | Yes | string | | | NfDeploymentDescriptor ID
1920 inputParams | No | string | | |
1921 name | No | string | | |
1922 outputParams | No | string | | |
1924 .. _d_5a6ee319c7ac35eac173da7d57136a99:
1926 NfDeploymentDescriptorUpdateDto Model Structure
1927 -----------------------------------------------
1931 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1932 :widths: 20, 10, 15, 15, 30, 25
1934 artifactName | No | string | | |
1935 artifactRepoUrl | No | string | | |
1936 description | No | string | | |
1937 inputParams | No | string | | |
1938 name | No | string | | |
1939 outputParams | No | string | | |
1941 .. _d_e28dc7c38126e125615678304c7a9508:
1943 NfDeploymentGetDto Model Structure
1944 ----------------------------------
1948 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1949 :widths: 20, 10, 15, 15, 30, 25
1951 description | No | string | | |
1952 descriptorId | No | string | | |
1953 id | Yes | string | | | NfDeployment ID
1954 name | No | string | | |
1955 parentDeploymentId | No | string | | |
1956 status | No | integer | | |
1958 .. _d_1a0e59d24d7db279637f186c203d884d:
1960 NfDeploymentUpdateDto Model Structure
1961 -------------------------------------
1965 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1966 :widths: 20, 10, 15, 15, 30, 25
1968 description | No | string | | |
1969 name | No | string | | |
1970 parentDeploymentId | No | string | | |
1972 .. _d_24d46c2729680edc54e60b2dfbea8ebf:
1974 OcloudDto Model Structure
1975 -------------------------
1979 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1980 :widths: 20, 10, 15, 15, 30, 25
1982 description | No | string | | |
1983 globalCloudId | No | string | | |
1984 infrastructureManagementServiceEndpoint | No | string | | |
1985 name | No | string | | |
1986 oCloudId | Yes | string | | |
1988 .. _d_6d49595cea3e0fa957a06fb11bda4897:
1990 ResourceGetDto0 Model Structure
1991 -------------------------------
1995 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
1996 :widths: 20, 10, 15, 15, 30, 25
1998 description | No | string | | |
1999 elements | No | string | | |
2000 name | No | string | | |
2001 parentId | No | string | | |
2002 resourceId | Yes | string | | | Resource ID
2003 resourcePoolId | No | string | | |
2004 resourceTypeId | No | string | | |
2006 .. _d_bb8426c45d4d19dc6128fbb298c7bb4d:
2008 ResourceGetDto1 Model Structure
2009 -------------------------------
2013 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2014 :widths: 20, 10, 15, 15, 30, 25
2016 children | No | array of :ref:`ResourceGetDto0 <d_6d49595cea3e0fa957a06fb11bda4897>` | | |
2017 description | No | string | | |
2018 elements | No | string | | |
2019 name | No | string | | |
2020 parentId | No | string | | |
2021 resourceId | Yes | string | | | Resource ID
2022 resourcePoolId | No | string | | |
2023 resourceTypeId | No | string | | |
2025 .. _d_958dd46196a624722ba9ea3ea4d27e38:
2027 ResourceGetDto2 Model Structure
2028 -------------------------------
2032 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2033 :widths: 20, 10, 15, 15, 30, 25
2035 children | No | array of :ref:`ResourceGetDto1 <d_bb8426c45d4d19dc6128fbb298c7bb4d>` | | |
2036 description | No | string | | |
2037 elements | No | string | | |
2038 name | No | string | | |
2039 parentId | No | string | | |
2040 resourceId | Yes | string | | | Resource ID
2041 resourcePoolId | No | string | | |
2042 resourceTypeId | No | string | | |
2044 .. _d_942ff02bfe350c7d2a7f3faabf5d77d1:
2046 ResourceListDto Model Structure
2047 -------------------------------
2051 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2052 :widths: 20, 10, 15, 15, 30, 25
2054 description | No | string | | |
2055 name | No | string | | |
2056 parentId | No | string | | |
2057 resourceId | Yes | string | | | Resource ID
2058 resourcePoolId | No | string | | |
2059 resourceTypeId | No | string | | |
2061 .. _d_296e5d50362a85c0b8843dfe38965ce9:
2063 ResourcePoolGetDto Model Structure
2064 ----------------------------------
2068 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2069 :widths: 20, 10, 15, 15, 30, 25
2071 description | No | string | | |
2072 globalLocationId | No | string | | |
2073 location | No | string | | |
2074 name | No | string | | |
2075 resourcePoolId | Yes | string | | | Resource pool ID
2077 .. _d_fb92075f954e3895d1435d4e523666fa:
2079 ResourceTypeGetDto Model Structure
2080 ----------------------------------
2084 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2085 :widths: 20, 10, 15, 15, 30, 25
2087 description | No | string | | |
2088 name | No | string | | |
2089 resourceTypeId | Yes | string | | | Resource type ID
2090 vendor | No | string | | |
2091 version | No | string | | |
2093 .. _d_18b723a8578a1c0bdb13e962c902ad95:
2095 SmoEndpointCreateDto Model Structure
2096 ------------------------------------
2100 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2101 :widths: 20, 10, 15, 15, 30, 25
2103 endpoint | Yes | string | | | Configuration SMO callback address
2105 .. _d_36a34be9221cecc9bf82d276b9266961:
2107 SmoEndpointCreatedRespDto Model Structure
2108 -----------------------------------------
2112 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2113 :widths: 20, 10, 15, 15, 30, 25
2115 id | Yes | string | | | SMO Endpoint Configuration ID
2117 .. _d_a6b61d9695be919cc22b2e700eeb7e27:
2119 SmoEndpointGetDto Model Structure
2120 ---------------------------------
2124 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2125 :widths: 20, 10, 15, 15, 30, 25
2127 comments | No | string | | |
2128 endpoint | No | string | | |
2129 id | Yes | string | | | SMO Endpoint Configuration ID
2130 status | No | string | | |
2132 .. _d_0fff8519707c32c34f86d6ac19fad343:
2134 SubscriptionCreateDto Model Structure
2135 -------------------------------------
2139 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2140 :widths: 20, 10, 15, 15, 30, 25
2142 callback | Yes | string | | | Subscription callback address
2143 consumerSubscriptionId | No | string | | |
2144 filter | No | string | | |
2146 .. _d_4397329931bf78862bc91387dbdb86c4:
2148 SubscriptionCreatedRespDto Model Structure
2149 ------------------------------------------
2153 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2154 :widths: 20, 10, 15, 15, 30, 25
2156 subscriptionId | Yes | string | | | Subscription ID
2158 .. _d_90e532f740e7ec8e9d71fad08513c388:
2160 SubscriptionGetDto Model Structure
2161 ----------------------------------
2165 :header: "Name", "Required", "Type", "Format", "Properties", "Description"
2166 :widths: 20, 10, 15, 15, 30, 25
2168 callback | No | string | | |
2169 consumerSubscriptionId | No | string | | |
2170 filter | No | string | | |
2171 subscriptionId | Yes | string | | | Subscription ID