4 description: Swagger OpenAPI document for the INF O2 Services
6 title: INF O2 Services API
9 - name: O2IMS-InfrastructureInventory
10 description: O2 IMS Inventory related operations.
11 - name: O2IMS-InfrastructureMonitoring
12 description: O2 IMS Monitoring related operations.
18 /o2ims-infrastructureInventory/api_versions:
21 - O2IMS-InfrastructureInventory
22 operationId: Get Inventory Version
27 /o2ims-infrastructureInventory/v1:
30 - O2IMS-InfrastructureInventory
31 operationId: Get Ocloud Information
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/:
63 - O2IMS-InfrastructureInventory
64 operationId: Get Ocloud Information
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:
96 - O2IMS-InfrastructureInventory
97 operationId: Get Inventory API version
102 /o2ims-infrastructureInventory/v1/deploymentManagers:
105 - O2IMS-InfrastructureInventory
106 operationId: Get Deployment Manager List
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}:
149 - O2IMS-InfrastructureInventory
150 operationId: Get Deployment Manager Information
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:
192 - O2IMS-InfrastructureInventory
193 operationId: Get Resource Pool List
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}:
236 - O2IMS-InfrastructureInventory
237 operationId: Get Resource Pool Information
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:
274 - O2IMS-InfrastructureInventory
275 operationId: Get Resource List
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}:
325 - O2IMS-InfrastructureInventory
326 operationId: Get Resource Information
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:
368 - O2IMS-InfrastructureInventory
369 operationId: Get Resource Type List
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}:
412 - O2IMS-InfrastructureInventory
413 operationId: Get Resource Type Information
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:
450 - O2IMS-InfrastructureInventory
451 operationId: Get Subscription List
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'
493 - O2IMS-InfrastructureInventory
494 operationId: Create a Subscription
500 $ref: '#/definitions/SubscriptionCreateDto'
505 $ref: '#/definitions/SubscriptionGetDto'
506 /o2ims-infrastructureInventory/v1/subscriptions/{subscriptionID}:
509 - O2IMS-InfrastructureInventory
510 operationId: Get Subscription Information
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
546 - O2IMS-InfrastructureInventory
547 operationId: Delete a Subscription
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: Get Alarm Subscription List
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 Information
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 an Alarm Subscription
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 Event Record List
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 Alarm Event Record Information
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 Monitoring API version
779 example: f078a1d3-56df-46c2-88a2-dd659aa3f6bd
780 description: Identifier for the containing O-Cloud.
783 example: 10a07219-4201-4b3e-a52d-81ab6a755d8a
784 description: Identifier of the O-Cloud instance. Globally unique across O-Cloud instances.
787 example: 10a07219-4201-4b3e-a52d-81ab6a755d8a
788 description: Identifier of the O-Cloud instance. Globally unique across O-Cloud instances.(Specification)
791 example: 95b818b8-b315-4d9f-af37-b82c492101f1
792 description: Human readable name of the O-Cloud.
796 description: Human readable description of the O-Cloud.
799 example: https://128.224.115.51:30205
800 description: The fully qualified URI root to all services provided by the O2ims interface
804 description: These are unspecified (not standardized) properties (keys) which are tailored by the vendor to extend the information provided about the O-Cloud.
805 x-mask: "{oCloudId,globalCloudId,globalcloudId,name,description,serviceUri}"
813 description: Resource type ID
825 $ref: '#/definitions/AlarmDictionaryDto'
828 x-mask: "{resourceTypeId,name,description,model,vendor,version}"
834 alarmDictionaryVersion:
836 alarmDictionarySchemaVersion:
842 managementInterfaceId:
849 $ref: '#/definitions/AlarmDefinitionDto'
863 proposedRepairActions:
867 managementInterfaceId:
871 alarmAdditionalFields:
880 example: f078a1d3-56df-46c2-88a2-dd659aa3f6bd
881 description: Identifier for the Resource Pool in the O-Cloud instance.
885 description: This identifier is copied from the O-Cloud Id assigned by the SMO during the O-Cloud deployment.
889 description: Human readable name of the resource pool.
892 example: A Resource Pool
893 description: Human readable description of the resource pool.
896 example: f078a1d3-56df-46c2-88a2-dd659aa3f6bd
897 description: Identifier for the containing O-Cloud.
901 description: Information about the geographical location of the resource pool as detected by the O-Cloud.
905 description: List of metadata key-value pairs used to associate meaningful metadata to the related resource pool.
906 x-mask: "{resourcePoolId,oCloudId,globalLocationId,name,description}"
914 description: Resource ID
928 x-mask: "{resourceId,resourcePoolId,resourceTypeId,description,parentId}"
936 description: Resource ID
953 $ref: '#/definitions/ResourceGetDto1'
954 x-mask: "{resourceId,resourcePoolId,resourceTypeId,description,parentId}"
962 description: Resource ID
979 $ref: '#/definitions/ResourceGetDto0'
980 x-mask: "{resourceId,resourcePoolId,resourceTypeId,description,parentId}"
988 description: Resource ID
1002 x-mask: "{resourceId,resourcePoolId,resourceTypeId,description,parentId}"
1003 DeploymentManagerListDto:
1006 - deploymentManagerId
1008 deploymentManagerId:
1010 description: Deployment manager ID
1021 description: "Profile support list, use default for the return endpoint"
1026 x-mask: "{deploymentManagerId,name,description,oCloudId,serviceUri,profileSupportList}"
1027 DeploymentManagerGetDto:
1030 - deploymentManagerId
1032 deploymentManagerId:
1034 description: Deployment manager ID
1044 $ref: '#/definitions/DeploymentManagerExtensions'
1045 x-mask: "{deploymentManagerId,name,description,oCloudId,serviceUri,extensions,profileName,profileData}"
1046 DeploymentManagerExtensions:
1052 $ref: '#/definitions/DeploymentManagerGetDtoProfile'
1053 DeploymentManagerGetDtoProfile:
1056 cluster_api_endpoint:
1066 helmcli_host_with_port:
1074 SubscriptionCreateDto:
1081 description: Subscription callback address
1082 consumerSubscriptionId:
1093 description: Subscription ID
1096 consumerSubscriptionId:
1100 x-mask: "{subscriptionId,callback}"
1104 - alarmEventRecordId
1108 example: f078a1d3-56df-46c2-88a2-dd659aa3f6bd
1109 description: Alarm Event Record ID
1130 alarmAcknowledgeTime:
1139 AlarmSubscriptionCreateDto:
1146 description: Alarm Subscription callback address
1147 consumerSubscriptionId:
1151 AlarmSubscriptionGetDto:
1154 - alarmSubscriptionId
1156 alarmSubscriptionId:
1158 description: Alarm Subscription ID
1161 consumerSubscriptionId:
1165 x-mask: "{alarmSubscriptionId,callback}"
1168 description: When a mask can't be parsed
1170 description: When any error occurs on mask
1172 description: Default error handler
1174 description: notfound handler
1175 BadRequestException:
1176 description: Return a custom message and 400 status code
1178 description: Return a custom message and 404 status code
1180 description: Return a custom message and 405 status code
1181 InternalServerError:
1182 description: Return a custom message and 500 status code
1184 description: Return a custom message and 500 status code