5 "/o2ims-infrastructureInventory/api_versions": {
9 "description": "Success"
12 "operationId": "Get Inventory Version",
14 "O2IMS-InfrastructureInventory"
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 Ocloud Information",
59 "O2IMS-InfrastructureInventory"
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 Ocloud Information",
104 "O2IMS-InfrastructureInventory"
108 "/o2ims-infrastructureInventory/v1/api_versions": {
112 "description": "Success"
115 "operationId": "Get Inventory API version",
117 "O2IMS-InfrastructureInventory"
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 Manager List",
175 "O2IMS-InfrastructureInventory"
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 Information",
233 "O2IMS-InfrastructureInventory"
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 Pool List",
291 "O2IMS-InfrastructureInventory"
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 Information",
343 "O2IMS-InfrastructureInventory"
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 Resource List",
411 "O2IMS-InfrastructureInventory"
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 Information",
470 "O2IMS-InfrastructureInventory"
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 Type List",
528 "O2IMS-InfrastructureInventory"
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 Information",
580 "O2IMS-InfrastructureInventory"
584 "/o2ims-infrastructureInventory/v1/subscriptions": {
588 "description": "Success",
590 "$ref": "#/definitions/SubscriptionGetDto"
594 "operationId": "Create a Subscription",
601 "$ref": "#/definitions/SubscriptionCreateDto"
606 "O2IMS-InfrastructureInventory"
612 "description": "Success",
616 "$ref": "#/definitions/SubscriptionGetDto"
621 "operationId": "Get Subscription List",
625 "description": "Filter of the query.",
631 "description": "Exclude showing all default fields, Set \"true\" to enable.",
632 "name": "exclude_default",
637 "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
638 "name": "exclude_fields",
643 "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
649 "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
650 "name": "all_fields",
656 "description": "Page number of the results to fetch. Default: 1",
657 "name": "nextpage_opaque_marker",
662 "O2IMS-InfrastructureInventory"
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 Information",
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",
716 "O2IMS-InfrastructureInventory"
722 "description": "Subscription not found"
725 "description": "Subscription deleted"
728 "operationId": "Delete a Subscription",
730 "O2IMS-InfrastructureInventory"
734 "/o2ims-infrastructureMonitoring/api_versions": {
738 "description": "Success"
741 "operationId": "Get Monitoring Version",
743 "O2IMS-InfrastructureMonitoring"
747 "/o2ims-infrastructureMonitoring/v1/alarmSubscriptions": {
751 "description": "Success",
753 "$ref": "#/definitions/AlarmSubscriptionGetDto"
757 "operationId": "Create a Alarm Subscription",
764 "$ref": "#/definitions/AlarmSubscriptionCreateDto"
769 "O2IMS-InfrastructureMonitoring"
775 "description": "Success",
779 "$ref": "#/definitions/AlarmSubscriptionGetDto"
784 "operationId": "Get Alarm Subscription List",
788 "description": "Filter of the query.",
794 "description": "Exclude showing all default fields, Set \"true\" to enable.",
795 "name": "exclude_default",
800 "description": "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\".",
801 "name": "exclude_fields",
806 "description": "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\".",
812 "description": "Set any value for show all fields. This value will cover \"fields\" and \"all_fields\".",
813 "name": "all_fields",
819 "description": "Page number of the results to fetch. Default: 1",
820 "name": "nextpage_opaque_marker",
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 Information",
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 an Alarm Subscription",
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 Event Record List",
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 Alarm Event Record Information",
1003 "O2IMS-InfrastructureMonitoring"
1007 "/o2ims-infrastructureMonitoring/v1/api_versions": {
1011 "description": "Success"
1014 "operationId": "Get Monitoring API version",
1016 "O2IMS-InfrastructureMonitoring"
1022 "title": "INF O2 Services API",
1024 "description": "Swagger OpenAPI document for the INF O2 Services"
1034 "name": "O2IMS-InfrastructureInventory",
1035 "description": "O2 IMS Inventory related operations."
1038 "name": "O2IMS-InfrastructureMonitoring",
1039 "description": "O2 IMS Monitoring related operations."
1050 "description": "Identifier for the containing O-Cloud.",
1051 "example": "f078a1d3-56df-46c2-88a2-dd659aa3f6bd"
1055 "description": "Identifier of the O-Cloud instance. Globally unique across O-Cloud instances.",
1056 "example": "10a07219-4201-4b3e-a52d-81ab6a755d8a"
1060 "description": "Identifier of the O-Cloud instance. Globally unique across O-Cloud instances.(Specification)",
1061 "example": "10a07219-4201-4b3e-a52d-81ab6a755d8a"
1065 "description": "Human readable name of the O-Cloud.",
1066 "example": "95b818b8-b315-4d9f-af37-b82c492101f1"
1070 "description": "Human readable description of the O-Cloud.",
1071 "example": "An ocloud"
1075 "description": "The fully qualified URI root to all services provided by the O2ims interface",
1076 "example": "https://128.224.115.51:30205"
1080 "description": "These are unspecified (not standardized) properties (keys) which are tailored by the vendor to extend the information provided about the O-Cloud.",
1084 "x-mask": "{oCloudId,globalCloudId,globalcloudId,name,description,serviceUri}",
1087 "ResourceTypeGetDto": {
1094 "description": "Resource type ID"
1111 "alarmDictionary": {
1112 "$ref": "#/definitions/AlarmDictionaryDto"
1118 "x-mask": "{resourceTypeId,name,description,model,vendor,version}",
1121 "AlarmDictionaryDto": {
1126 "alarmDictionaryVersion": {
1129 "alarmDictionarySchemaVersion": {
1138 "managementInterfaceId": {
1141 "pkNotificationField": {
1144 "alarmDefinition": {
1147 "$ref": "#/definitions/AlarmDefinitionDto"
1153 "AlarmDefinitionDto": {
1155 "alarmDefinitionId": {
1161 "alarmLastChange": {
1164 "alarmChangeType": {
1167 "alarmDescription": {
1170 "proposedRepairActions": {
1176 "managementInterfaceId": {
1179 "pkNotificationField": {
1182 "alarmAdditionalFields": {
1188 "ResourcePoolGetDto": {
1195 "description": "Identifier for the Resource Pool in the O-Cloud instance.",
1196 "example": "f078a1d3-56df-46c2-88a2-dd659aa3f6bd"
1198 "globalLocationId": {
1200 "description": "This identifier is copied from the O-Cloud Id assigned by the SMO during the O-Cloud deployment.",
1205 "description": "Human readable name of the resource pool.",
1206 "example": "RegionOne"
1210 "description": "Human readable description of the resource pool.",
1211 "example": "A Resource Pool"
1215 "description": "Identifier for the containing O-Cloud.",
1216 "example": "f078a1d3-56df-46c2-88a2-dd659aa3f6bd"
1220 "description": "Information about the geographical location of the resource pool as detected by the O-Cloud.",
1225 "description": "List of metadata key-value pairs used to associate meaningful metadata to the related resource pool.",
1229 "x-mask": "{resourcePoolId,oCloudId,globalLocationId,name,description}",
1232 "ResourceListDto": {
1239 "description": "Resource ID"
1260 "x-mask": "{resourceId,resourcePoolId,resourceTypeId,description,parentId}",
1263 "ResourceGetDto2": {
1270 "description": "Resource ID"
1293 "$ref": "#/definitions/ResourceGetDto1"
1297 "x-mask": "{resourceId,resourcePoolId,resourceTypeId,description,parentId}",
1300 "ResourceGetDto1": {
1307 "description": "Resource ID"
1330 "$ref": "#/definitions/ResourceGetDto0"
1334 "x-mask": "{resourceId,resourcePoolId,resourceTypeId,description,parentId}",
1337 "ResourceGetDto0": {
1344 "description": "Resource ID"
1365 "x-mask": "{resourceId,resourcePoolId,resourceTypeId,description,parentId}",
1368 "DeploymentManagerListDto": {
1370 "deploymentManagerId"
1373 "deploymentManagerId": {
1375 "description": "Deployment manager ID"
1389 "profileSupportList": {
1391 "description": "Profile support list, use default for the return endpoint",
1400 "x-mask": "{deploymentManagerId,name,description,oCloudId,serviceUri,profileSupportList}",
1403 "DeploymentManagerGetDto": {
1405 "deploymentManagerId"
1408 "deploymentManagerId": {
1410 "description": "Deployment manager ID"
1425 "$ref": "#/definitions/DeploymentManagerExtensions"
1428 "x-mask": "{deploymentManagerId,name,description,oCloudId,serviceUri,extensions,profileName,profileData}",
1431 "DeploymentManagerExtensions": {
1437 "$ref": "#/definitions/DeploymentManagerGetDtoProfile"
1442 "DeploymentManagerGetDtoProfile": {
1444 "cluster_api_endpoint": {
1447 "cluster_ca_cert": {
1453 "admin_client_cert": {
1456 "admin_client_key": {
1459 "helmcli_host_with_port": {
1462 "helmcli_username": {
1465 "helmcli_password": {
1468 "helmcli_kubeconfig": {
1474 "SubscriptionCreateDto": {
1481 "description": "Subscription callback address"
1483 "consumerSubscriptionId": {
1492 "SubscriptionGetDto": {
1499 "description": "Subscription ID"
1504 "consumerSubscriptionId": {
1511 "x-mask": "{subscriptionId,callback}",
1516 "alarmEventRecordId"
1519 "alarmEventRecordId": {
1521 "description": "Alarm Event Record ID",
1522 "example": "f078a1d3-56df-46c2-88a2-dd659aa3f6bd"
1536 "alarmDefinitionId": {
1539 "alarmDefinitionID": {
1542 "probableCauseId": {
1545 "probableCauseID": {
1548 "alarmRaisedTime": {
1551 "alarmChangedTime": {
1554 "alarmAcknowledgeTime": {
1557 "alarmAcknowledged": {
1560 "perceivedSeverity": {
1569 "AlarmSubscriptionCreateDto": {
1576 "description": "Alarm Subscription callback address"
1578 "consumerSubscriptionId": {
1587 "AlarmSubscriptionGetDto": {
1589 "alarmSubscriptionId"
1592 "alarmSubscriptionId": {
1594 "description": "Alarm Subscription ID"
1599 "consumerSubscriptionId": {
1606 "x-mask": "{alarmSubscriptionId,callback}",
1612 "description": "When a mask can't be parsed"
1615 "description": "When any error occurs on mask"
1618 "description": "Default error handler"
1621 "description": "notfound handler"
1623 "BadRequestException": {
1624 "description": "Return a custom message and 400 status code"
1626 "NotFoundException": {
1627 "description": "Return a custom message and 404 status code"
1629 "MethodNotAllowed": {
1630 "description": "Return a custom message and 405 status code"
1632 "InternalServerError": {
1633 "description": "Return a custom message and 500 status code"
1636 "description": "Return a custom message and 500 status code"