5 "/o2ims-infrastructureInventory/api_versions": {
9 "description": "Success"
12 "operationId": "get_inventory_version",
18 "/o2ims-infrastructureInventory/v1": {
22 "description": "Exclude showing all default fields, Set \"true\" to enable.",
23 "name": "exclude_default",
28 "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
29 "name": "exclude_fields",
34 "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
40 "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
48 "description": "oCloud not found"
51 "description": "Success",
53 "$ref": "#/definitions/OcloudDto"
57 "operationId": "get_oclouds_list_router",
63 "/o2ims-infrastructureInventory/v1/": {
67 "description": "Exclude showing all default fields, Set \"true\" to enable.",
68 "name": "exclude_default",
73 "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
74 "name": "exclude_fields",
79 "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
85 "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
93 "description": "oCloud not found"
96 "description": "Success",
98 "$ref": "#/definitions/OcloudDto"
102 "operationId": "get_oclouds_list_router",
108 "/o2ims-infrastructureInventory/v1/api_versions": {
112 "description": "Success"
115 "operationId": "get_version_router",
121 "/o2ims-infrastructureInventory/v1/deploymentManagers": {
125 "description": "Filter of the query.",
131 "description": "Exclude showing all default fields, Set \"true\" to enable.",
132 "name": "exclude_default",
137 "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
138 "name": "exclude_fields",
143 "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
149 "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
150 "name": "all_fields",
156 "description": "Page number of the results to fetch. Default: 1",
157 "name": "nextpage_opaque_marker",
164 "description": "Success",
168 "$ref": "#/definitions/DeploymentManagerListDto"
173 "operationId": "get_deployment_managers_list_router",
179 "/o2ims-infrastructureInventory/v1/deploymentManagers/{deploymentManagerID}": {
183 "description": "Exclude showing all default fields, Set \"true\" to enable.",
184 "name": "exclude_default",
189 "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
190 "name": "exclude_fields",
195 "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
201 "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
202 "name": "all_fields",
207 "description": "DMS profile: value supports \"native_k8sapi\"",
213 "description": "ID of the deployment manager",
214 "name": "deploymentManagerID",
222 "description": "Deployment manager not found"
225 "description": "Success",
227 "$ref": "#/definitions/DeploymentManagerGetDto"
231 "operationId": "Get deployment manager",
237 "/o2ims-infrastructureInventory/v1/resourcePools": {
241 "description": "Filter of the query.",
247 "description": "Exclude showing all default fields, Set \"true\" to enable.",
248 "name": "exclude_default",
253 "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
254 "name": "exclude_fields",
259 "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
265 "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
266 "name": "all_fields",
272 "description": "Page number of the results to fetch. Default: 1",
273 "name": "nextpage_opaque_marker",
280 "description": "Success",
284 "$ref": "#/definitions/ResourcePoolGetDto"
289 "operationId": "get_resource_pools_list_router",
295 "/o2ims-infrastructureInventory/v1/resourcePools/{resourcePoolID}": {
299 "description": "Exclude showing all default fields, Set \"true\" to enable.",
300 "name": "exclude_default",
305 "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
306 "name": "exclude_fields",
311 "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
317 "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
318 "name": "all_fields",
323 "description": "ID of the resource pool",
324 "name": "resourcePoolID",
332 "description": "Resource pool not found"
335 "description": "Success",
337 "$ref": "#/definitions/ResourcePoolGetDto"
341 "operationId": "Get resource pool",
347 "/o2ims-infrastructureInventory/v1/resourcePools/{resourcePoolID}/resources": {
351 "description": "Filter of the query.",
357 "description": "Exclude showing all default fields, Set \"true\" to enable.",
358 "name": "exclude_default",
363 "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
364 "name": "exclude_fields",
369 "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
375 "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
376 "name": "all_fields",
382 "description": "Page number of the results to fetch. Default: 1",
383 "name": "nextpage_opaque_marker",
388 "description": "ID of the resource pool",
389 "name": "resourcePoolID",
397 "description": "Resource pool not found"
400 "description": "Success",
404 "$ref": "#/definitions/ResourceListDto"
409 "operationId": "get_resources_list_router",
415 "/o2ims-infrastructureInventory/v1/resourcePools/{resourcePoolID}/resources/{resourceID}": {
419 "description": "Exclude showing all default fields, Set \"true\" to enable.",
420 "name": "exclude_default",
425 "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
426 "name": "exclude_fields",
431 "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
437 "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
438 "name": "all_fields",
443 "description": "ID of the resource",
444 "name": "resourceID",
450 "description": "ID of the resource pool",
451 "name": "resourcePoolID",
459 "description": "Resource not found"
462 "description": "Success",
464 "$ref": "#/definitions/ResourceGetDto2"
468 "operationId": "Get resource",
474 "/o2ims-infrastructureInventory/v1/resourceTypes": {
478 "description": "Filter of the query.",
484 "description": "Exclude showing all default fields, Set \"true\" to enable.",
485 "name": "exclude_default",
490 "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
491 "name": "exclude_fields",
496 "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
502 "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
503 "name": "all_fields",
509 "description": "Page number of the results to fetch. Default: 1",
510 "name": "nextpage_opaque_marker",
517 "description": "Success",
521 "$ref": "#/definitions/ResourceTypeGetDto"
526 "operationId": "get_resource_types_list_router",
532 "/o2ims-infrastructureInventory/v1/resourceTypes/{resourceTypeID}": {
536 "description": "Exclude showing all default fields, Set \"true\" to enable.",
537 "name": "exclude_default",
542 "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
543 "name": "exclude_fields",
548 "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
554 "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
555 "name": "all_fields",
560 "description": "ID of the resource type",
561 "name": "resourceTypeID",
569 "description": "Resource type not found"
572 "description": "Success",
574 "$ref": "#/definitions/ResourceTypeGetDto"
578 "operationId": "Get resource type",
584 "/o2ims-infrastructureInventory/v1/subscriptions": {
588 "description": "Success",
592 "$ref": "#/definitions/SubscriptionGetDto"
597 "operationId": "List subscriptions",
601 "description": "Filter of the query.",
607 "description": "Exclude showing all default fields, Set \"true\" to enable.",
608 "name": "exclude_default",
613 "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
614 "name": "exclude_fields",
619 "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
625 "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
626 "name": "all_fields",
632 "description": "Page number of the results to fetch. Default: 1",
633 "name": "nextpage_opaque_marker",
644 "description": "Success",
646 "$ref": "#/definitions/SubscriptionGetDto"
650 "operationId": "Create a subscription",
657 "$ref": "#/definitions/SubscriptionCreateDto"
666 "/o2ims-infrastructureInventory/v1/subscriptions/{subscriptionID}": {
670 "description": "ID of the subscription",
671 "name": "subscriptionID",
679 "description": "Subscription not found"
682 "description": "Success",
684 "$ref": "#/definitions/SubscriptionGetDto"
688 "operationId": "Get subscription by ID",
692 "description": "Exclude showing all default fields, Set \"true\" to enable.",
693 "name": "exclude_default",
698 "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
699 "name": "exclude_fields",
704 "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
710 "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
711 "name": "all_fields",
722 "description": "Subscription not found"
725 "description": "Subscription deleted"
728 "operationId": "Delete subscription by ID",
734 "/o2ims-infrastructureMonitoring/api_versions": {
738 "description": "Success"
741 "operationId": "get_monitoring_version",
743 "O2IMS_InfrastructureMonitoring"
747 "/o2ims-infrastructureMonitoring/v1/alarmSubscriptions": {
751 "description": "Success",
755 "$ref": "#/definitions/AlarmSubscriptionGetDto"
760 "operationId": "List alarm subscriptions",
764 "description": "Filter of the query.",
770 "description": "Exclude showing all default fields, Set \"true\" to enable.",
771 "name": "exclude_default",
776 "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
777 "name": "exclude_fields",
782 "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
788 "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
789 "name": "all_fields",
795 "description": "Page number of the results to fetch. Default: 1",
796 "name": "nextpage_opaque_marker",
801 "O2IMS_InfrastructureMonitoring"
807 "description": "Success",
809 "$ref": "#/definitions/AlarmSubscriptionGetDto"
813 "operationId": "Create a alarm subscription",
820 "$ref": "#/definitions/AlarmSubscriptionCreateDto"
825 "O2IMS_InfrastructureMonitoring"
829 "/o2ims-infrastructureMonitoring/v1/alarmSubscriptions/{alarmSubscriptionID}": {
833 "description": "ID of the Alarm Subscription",
834 "name": "alarmSubscriptionID",
842 "description": "Alarm Subscription not found"
845 "description": "Success",
847 "$ref": "#/definitions/AlarmSubscriptionGetDto"
851 "operationId": "Get Alarm Subscription by ID",
855 "description": "Exclude showing all default fields, Set \"true\" to enable.",
856 "name": "exclude_default",
861 "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
862 "name": "exclude_fields",
867 "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
873 "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
874 "name": "all_fields",
879 "O2IMS_InfrastructureMonitoring"
885 "description": "Alarm Subscription not found"
888 "description": "Subscription deleted"
891 "operationId": "Delete subscription by ID",
893 "O2IMS_InfrastructureMonitoring"
897 "/o2ims-infrastructureMonitoring/v1/alarms": {
901 "description": "Filter of the query.",
907 "description": "Exclude showing all default fields, Set \"true\" to enable.",
908 "name": "exclude_default",
913 "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
914 "name": "exclude_fields",
919 "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
925 "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
926 "name": "all_fields",
932 "description": "Page number of the results to fetch. Default: 1",
933 "name": "nextpage_opaque_marker",
940 "description": "Success",
944 "$ref": "#/definitions/AlarmGetDto"
949 "operationId": "get_alarm_list_router",
951 "O2IMS_InfrastructureMonitoring"
955 "/o2ims-infrastructureMonitoring/v1/alarms/{alarmEventRecordId}": {
959 "description": "Exclude showing all default fields, Set \"true\" to enable.",
960 "name": "exclude_default",
965 "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
966 "name": "exclude_fields",
971 "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
977 "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
978 "name": "all_fields",
983 "description": "ID of the alarm event record",
984 "name": "alarmEventRecordId",
992 "description": "Alarm Event Record not found"
995 "description": "Success",
997 "$ref": "#/definitions/AlarmGetDto"
1001 "operationId": "Get AlarmEventRecord",
1003 "O2IMS_InfrastructureMonitoring"
1007 "/o2ims-infrastructureMonitoring/v1/api_versions": {
1011 "description": "Success"
1014 "operationId": "get_version_router",
1016 "O2IMS_InfrastructureMonitoring"
1022 "title": "INF O2 Services API",
1024 "description": "Swagger OpenAPI document for the INF O2 Services"
1034 "name": "O2IMS_Inventory",
1035 "description": "IMS Inventory related operations."
1038 "name": "O2IMS_InfrastructureMonitoring",
1039 "description": "O2 IMS Monitoring related operations."
1070 "x-mask": "{oCloudId,globalCloudId,globalcloudId,name,description,serviceUri}",
1073 "ResourceTypeGetDto": {
1080 "description": "Resource type ID"
1097 "alarmDictionary": {
1098 "$ref": "#/definitions/AlarmDictionaryDto"
1104 "x-mask": "{resourceTypeId,name,description,model,vendor,version}",
1107 "AlarmDictionaryDto": {
1112 "alarmDictionaryVersion": {
1115 "alarmDictionarySchemaVersion": {
1124 "managementInterfaceId": {
1127 "pkNotificationField": {
1130 "alarmDefinition": {
1133 "$ref": "#/definitions/AlarmDefinitionDto"
1139 "AlarmDefinitionDto": {
1141 "alarmDefinitionId": {
1147 "alarmLastChange": {
1150 "alarmChangeType": {
1153 "alarmDescription": {
1156 "proposedRepairActions": {
1162 "managementInterfaceId": {
1165 "pkNotificationField": {
1168 "alarmAdditionalFields": {
1174 "ResourcePoolGetDto": {
1181 "description": "Resource pool ID"
1183 "globalLocationId": {
1202 "x-mask": "{resourcePoolId,oCloudId,globalLocationId,name,description}",
1205 "ResourceListDto": {
1212 "description": "Resource ID"
1233 "x-mask": "{resourceId,resourcePoolId,resourceTypeId,description,parentId}",
1236 "ResourceGetDto2": {
1243 "description": "Resource ID"
1266 "$ref": "#/definitions/ResourceGetDto1"
1270 "x-mask": "{resourceId,resourcePoolId,resourceTypeId,description,parentId}",
1273 "ResourceGetDto1": {
1280 "description": "Resource ID"
1303 "$ref": "#/definitions/ResourceGetDto0"
1307 "x-mask": "{resourceId,resourcePoolId,resourceTypeId,description,parentId}",
1310 "ResourceGetDto0": {
1317 "description": "Resource ID"
1338 "x-mask": "{resourceId,resourcePoolId,resourceTypeId,description,parentId}",
1341 "DeploymentManagerListDto": {
1343 "deploymentManagerId"
1346 "deploymentManagerId": {
1348 "description": "Deployment manager ID"
1362 "profileSupportList": {
1364 "description": "Profile support list, use default for the return endpoint",
1373 "x-mask": "{deploymentManagerId,name,description,oCloudId,serviceUri,profileSupportList}",
1376 "DeploymentManagerGetDto": {
1378 "deploymentManagerId"
1381 "deploymentManagerId": {
1383 "description": "Deployment manager ID"
1398 "$ref": "#/definitions/DeploymentManagerExtensions"
1401 "x-mask": "{deploymentManagerId,name,description,oCloudId,serviceUri,extensions,profileName,profileData}",
1404 "DeploymentManagerExtensions": {
1410 "$ref": "#/definitions/DeploymentManagerGetDtoProfile"
1415 "DeploymentManagerGetDtoProfile": {
1417 "cluster_api_endpoint": {
1420 "cluster_ca_cert": {
1426 "admin_client_cert": {
1429 "admin_client_key": {
1432 "helmcli_host_with_port": {
1435 "helmcli_username": {
1438 "helmcli_password": {
1441 "helmcli_kubeconfig": {
1447 "SubscriptionCreateDto": {
1454 "description": "Subscription callback address"
1456 "consumerSubscriptionId": {
1465 "SubscriptionGetDto": {
1472 "description": "Subscription ID"
1477 "consumerSubscriptionId": {
1484 "x-mask": "{subscriptionId,callback}",
1489 "alarmEventRecordId"
1492 "alarmEventRecordId": {
1494 "description": "Alarm Event Record ID"
1508 "alarmDefinitionId": {
1511 "alarmDefinitionID": {
1514 "probableCauseId": {
1517 "probableCauseID": {
1520 "alarmRaisedTime": {
1523 "alarmChangedTime": {
1526 "alarmAcknowledgeTime": {
1529 "alarmAcknowledged": {
1532 "perceivedSeverity": {
1541 "AlarmSubscriptionCreateDto": {
1548 "description": "Alarm Subscription callback address"
1550 "consumerSubscriptionId": {
1559 "AlarmSubscriptionGetDto": {
1561 "alarmSubscriptionId"
1564 "alarmSubscriptionId": {
1566 "description": "Alarm Subscription ID"
1571 "consumerSubscriptionId": {
1578 "x-mask": "{alarmSubscriptionId,callback}",
1584 "description": "When a mask can't be parsed"
1587 "description": "When any error occurs on mask"
1590 "description": "Default error handler"
1593 "description": "notfound handler"
1595 "BadRequestException": {
1596 "description": "Return a custom message and 400 status code"
1598 "NotFoundException": {
1599 "description": "Return a custom message and 404 status code"
1601 "MethodNotAllowed": {
1602 "description": "Return a custom message and 405 status code"
1604 "InternalServerError": {
1605 "description": "Return a custom message and 500 status code"
1608 "description": "Return a custom message and 500 status code"