4 description: Swagger OpenAPI document for the INF O2 Services
6 title: INF O2 Services API
9 - name: O2IMS_Inventory
10 description: IMS Inventory related operations.
11 - name: O2IMS_InfrastructureMonitoring
12 description: O2 IMS Monitoring related operations.
18 /o2ims-infrastructureInventory/api_versions:
22 operationId: get_inventory_version
27 /o2ims-infrastructureInventory/v1:
31 operationId: get_oclouds_list_router
33 - name: exclude_default
35 description: "Exclude showing all default fields, Set \"true\" to enable."
38 - name: exclude_fields
40 description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
45 description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
50 description: Set any value for show all fields. This value will cover "fields" and "all_fields".
57 $ref: '#/definitions/OcloudDto'
59 description: oCloud not found
60 /o2ims-infrastructureInventory/v1/:
64 operationId: get_oclouds_list_router
66 - name: exclude_default
68 description: "Exclude showing all default fields, Set \"true\" to enable."
71 - name: exclude_fields
73 description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
78 description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
83 description: Set any value for show all fields. This value will cover "fields" and "all_fields".
90 $ref: '#/definitions/OcloudDto'
92 description: oCloud not found
93 /o2ims-infrastructureInventory/v1/api_versions:
97 operationId: get_version_router
102 /o2ims-infrastructureInventory/v1/deploymentManagers:
106 operationId: get_deployment_managers_list_router
110 description: Filter of the query.
113 - name: exclude_default
115 description: "Exclude showing all default fields, Set \"true\" to enable."
118 - name: exclude_fields
120 description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
125 description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
130 description: Set any value for show all fields. This value will cover "fields" and "all_fields".
133 - name: nextpage_opaque_marker
135 description: "Page number of the results to fetch. Default: 1"
145 $ref: '#/definitions/DeploymentManagerListDto'
146 /o2ims-infrastructureInventory/v1/deploymentManagers/{deploymentManagerID}:
150 operationId: Get deployment manager
152 - name: exclude_default
154 description: "Exclude showing all default fields, Set \"true\" to enable."
157 - name: exclude_fields
159 description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
164 description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
169 description: Set any value for show all fields. This value will cover "fields" and "all_fields".
174 description: "DMS profile: value supports \"native_k8sapi\""
177 - name: deploymentManagerID
179 description: ID of the deployment manager
186 $ref: '#/definitions/DeploymentManagerGetDto'
188 description: Deployment manager not found
189 /o2ims-infrastructureInventory/v1/resourcePools:
193 operationId: get_resource_pools_list_router
197 description: Filter of the query.
200 - name: exclude_default
202 description: "Exclude showing all default fields, Set \"true\" to enable."
205 - name: exclude_fields
207 description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
212 description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
217 description: Set any value for show all fields. This value will cover "fields" and "all_fields".
220 - name: nextpage_opaque_marker
222 description: "Page number of the results to fetch. Default: 1"
232 $ref: '#/definitions/ResourcePoolGetDto'
233 /o2ims-infrastructureInventory/v1/resourcePools/{resourcePoolID}:
237 operationId: Get resource pool
239 - name: exclude_default
241 description: "Exclude showing all default fields, Set \"true\" to enable."
244 - name: exclude_fields
246 description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
251 description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
256 description: Set any value for show all fields. This value will cover "fields" and "all_fields".
259 - name: resourcePoolID
261 description: ID of the resource pool
268 $ref: '#/definitions/ResourcePoolGetDto'
270 description: Resource pool not found
271 /o2ims-infrastructureInventory/v1/resourcePools/{resourcePoolID}/resources:
275 operationId: get_resources_list_router
279 description: Filter of the query.
282 - name: exclude_default
284 description: "Exclude showing all default fields, Set \"true\" to enable."
287 - name: exclude_fields
289 description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
294 description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
299 description: Set any value for show all fields. This value will cover "fields" and "all_fields".
302 - name: nextpage_opaque_marker
304 description: "Page number of the results to fetch. Default: 1"
308 - name: resourcePoolID
310 description: ID of the resource pool
319 $ref: '#/definitions/ResourceListDto'
321 description: Resource pool not found
322 /o2ims-infrastructureInventory/v1/resourcePools/{resourcePoolID}/resources/{resourceID}:
326 operationId: Get resource
328 - name: exclude_default
330 description: "Exclude showing all default fields, Set \"true\" to enable."
333 - name: exclude_fields
335 description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
340 description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
345 description: Set any value for show all fields. This value will cover "fields" and "all_fields".
350 description: ID of the resource
353 - name: resourcePoolID
355 description: ID of the resource pool
362 $ref: '#/definitions/ResourceGetDto2'
364 description: Resource not found
365 /o2ims-infrastructureInventory/v1/resourceTypes:
369 operationId: get_resource_types_list_router
373 description: Filter of the query.
376 - name: exclude_default
378 description: "Exclude showing all default fields, Set \"true\" to enable."
381 - name: exclude_fields
383 description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
388 description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
393 description: Set any value for show all fields. This value will cover "fields" and "all_fields".
396 - name: nextpage_opaque_marker
398 description: "Page number of the results to fetch. Default: 1"
408 $ref: '#/definitions/ResourceTypeGetDto'
409 /o2ims-infrastructureInventory/v1/resourceTypes/{resourceTypeID}:
413 operationId: Get resource type
415 - name: exclude_default
417 description: "Exclude showing all default fields, Set \"true\" to enable."
420 - name: exclude_fields
422 description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
427 description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
432 description: Set any value for show all fields. This value will cover "fields" and "all_fields".
435 - name: resourceTypeID
437 description: ID of the resource type
444 $ref: '#/definitions/ResourceTypeGetDto'
446 description: Resource type not found
447 /o2ims-infrastructureInventory/v1/subscriptions:
451 operationId: List subscriptions
455 description: Filter of the query.
458 - name: exclude_default
460 description: "Exclude showing all default fields, Set \"true\" to enable."
463 - name: exclude_fields
465 description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
470 description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
475 description: Set any value for show all fields. This value will cover "fields" and "all_fields".
478 - name: nextpage_opaque_marker
480 description: "Page number of the results to fetch. Default: 1"
490 $ref: '#/definitions/SubscriptionGetDto'
494 operationId: Create a subscription
500 $ref: '#/definitions/SubscriptionCreateDto'
505 $ref: '#/definitions/SubscriptionGetDto'
506 /o2ims-infrastructureInventory/v1/subscriptions/{subscriptionID}:
510 operationId: Get subscription by ID
512 - name: subscriptionID
514 description: ID of the subscription
517 - name: exclude_default
519 description: "Exclude showing all default fields, Set \"true\" to enable."
522 - name: exclude_fields
524 description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
529 description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
534 description: Set any value for show all fields. This value will cover "fields" and "all_fields".
541 $ref: '#/definitions/SubscriptionGetDto'
543 description: Subscription not found
547 operationId: Delete subscription by ID
549 - name: subscriptionID
551 description: ID of the subscription
556 description: Subscription deleted
558 description: Subscription not found
559 /o2ims-infrastructureMonitoring/api_versions:
562 - O2IMS_InfrastructureMonitoring
563 operationId: get_monitoring_version
568 /o2ims-infrastructureMonitoring/v1/alarmSubscriptions:
571 - O2IMS_InfrastructureMonitoring
572 operationId: List alarm subscriptions
576 description: Filter of the query.
579 - name: exclude_default
581 description: "Exclude showing all default fields, Set \"true\" to enable."
584 - name: exclude_fields
586 description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
591 description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
596 description: Set any value for show all fields. This value will cover "fields" and "all_fields".
599 - name: nextpage_opaque_marker
601 description: "Page number of the results to fetch. Default: 1"
611 $ref: '#/definitions/AlarmSubscriptionGetDto'
614 - O2IMS_InfrastructureMonitoring
615 operationId: Create a alarm subscription
621 $ref: '#/definitions/AlarmSubscriptionCreateDto'
626 $ref: '#/definitions/AlarmSubscriptionGetDto'
627 /o2ims-infrastructureMonitoring/v1/alarmSubscriptions/{alarmSubscriptionID}:
630 - O2IMS_InfrastructureMonitoring
631 operationId: Get Alarm Subscription by ID
633 - name: alarmSubscriptionID
635 description: ID of the Alarm Subscription
638 - name: exclude_default
640 description: "Exclude showing all default fields, Set \"true\" to enable."
643 - name: exclude_fields
645 description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
650 description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
655 description: Set any value for show all fields. This value will cover "fields" and "all_fields".
662 $ref: '#/definitions/AlarmSubscriptionGetDto'
664 description: Alarm Subscription not found
667 - O2IMS_InfrastructureMonitoring
668 operationId: Delete subscription by ID
670 - name: alarmSubscriptionID
672 description: ID of the Alarm Subscription
677 description: Subscription deleted
679 description: Alarm Subscription not found
680 /o2ims-infrastructureMonitoring/v1/alarms:
683 - O2IMS_InfrastructureMonitoring
684 operationId: get_alarm_list_router
688 description: Filter of the query.
691 - name: exclude_default
693 description: "Exclude showing all default fields, Set \"true\" to enable."
696 - name: exclude_fields
698 description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
703 description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
708 description: Set any value for show all fields. This value will cover "fields" and "all_fields".
711 - name: nextpage_opaque_marker
713 description: "Page number of the results to fetch. Default: 1"
723 $ref: '#/definitions/AlarmGetDto'
724 /o2ims-infrastructureMonitoring/v1/alarms/{alarmEventRecordId}:
727 - O2IMS_InfrastructureMonitoring
728 operationId: Get AlarmEventRecord
730 - name: exclude_default
732 description: "Exclude showing all default fields, Set \"true\" to enable."
735 - name: exclude_fields
737 description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
742 description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
747 description: Set any value for show all fields. This value will cover "fields" and "all_fields".
750 - name: alarmEventRecordId
752 description: ID of the alarm event record
759 $ref: '#/definitions/AlarmGetDto'
761 description: Alarm Event Record not found
762 /o2ims-infrastructureMonitoring/v1/api_versions:
765 - O2IMS_InfrastructureMonitoring
766 operationId: get_version_router
791 x-mask: "{oCloudId,globalCloudId,globalcloudId,name,description,serviceUri}"
799 description: Resource type ID
811 $ref: '#/definitions/AlarmDictionaryDto'
814 x-mask: "{resourceTypeId,name,description,model,vendor,version}"
820 alarmDictionaryVersion:
822 alarmDictionarySchemaVersion:
828 managementInterfaceId:
835 $ref: '#/definitions/AlarmDefinitionDto'
849 proposedRepairActions:
853 managementInterfaceId:
857 alarmAdditionalFields:
866 description: Resource pool ID
879 x-mask: "{resourcePoolId,oCloudId,globalLocationId,name,description}"
887 description: Resource ID
901 x-mask: "{resourceId,resourcePoolId,resourceTypeId,description,parentId}"
909 description: Resource ID
926 $ref: '#/definitions/ResourceGetDto1'
927 x-mask: "{resourceId,resourcePoolId,resourceTypeId,description,parentId}"
935 description: Resource ID
952 $ref: '#/definitions/ResourceGetDto0'
953 x-mask: "{resourceId,resourcePoolId,resourceTypeId,description,parentId}"
961 description: Resource ID
975 x-mask: "{resourceId,resourcePoolId,resourceTypeId,description,parentId}"
976 DeploymentManagerListDto:
979 - deploymentManagerId
983 description: Deployment manager ID
994 description: "Profile support list, use default for the return endpoint"
999 x-mask: "{deploymentManagerId,name,description,oCloudId,serviceUri,profileSupportList}"
1000 DeploymentManagerGetDto:
1003 - deploymentManagerId
1005 deploymentManagerId:
1007 description: Deployment manager ID
1017 $ref: '#/definitions/DeploymentManagerExtensions'
1018 x-mask: "{deploymentManagerId,name,description,oCloudId,serviceUri,extensions,profileName,profileData}"
1019 DeploymentManagerExtensions:
1025 $ref: '#/definitions/DeploymentManagerGetDtoProfile'
1026 DeploymentManagerGetDtoProfile:
1029 cluster_api_endpoint:
1039 helmcli_host_with_port:
1047 SubscriptionCreateDto:
1054 description: Subscription callback address
1055 consumerSubscriptionId:
1066 description: Subscription ID
1069 consumerSubscriptionId:
1073 x-mask: "{subscriptionId,callback}"
1077 - alarmEventRecordId
1081 description: Alarm Event Record ID
1102 alarmAcknowledgeTime:
1111 AlarmSubscriptionCreateDto:
1118 description: Alarm Subscription callback address
1119 consumerSubscriptionId:
1123 AlarmSubscriptionGetDto:
1126 - alarmSubscriptionId
1128 alarmSubscriptionId:
1130 description: Alarm Subscription ID
1133 consumerSubscriptionId:
1137 x-mask: "{alarmSubscriptionId,callback}"
1140 description: When a mask can't be parsed
1142 description: When any error occurs on mask
1144 description: Default error handler
1146 description: notfound handler
1147 BadRequestException:
1148 description: Return a custom message and 400 status code
1150 description: Return a custom message and 404 status code
1152 description: Return a custom message and 405 status code
1153 InternalServerError:
1154 description: Return a custom message and 500 status code
1156 description: Return a custom message and 500 status code