INF O2 Services API (1.0.0)

Download OpenAPI specification:Download

Swagger OpenAPI document for the INF O2 Services

O2IMS-InfrastructureInventory

O2 IMS Inventory related operations.

Get Inventory Version

Responses

Response samples

Content type
application/json
{}

Get Ocloud Information

query Parameters
exclude_default
string

Exclude showing all default fields, Set "true" to enable.

exclude_fields
string

Set fields to exclude showing, split by comma, "/" for parent and children. Like "name,parent/children". This value will cover "exclude_default".

fields
string

Set fields to show, split by comma, "/" for parent and children. Like "name,parent/children". This value will cover "exculde_fields".

all_fields
string

Set any value for show all fields. This value will cover "fields" and "all_fields".

Responses

Response samples

Content type
application/json
{
  • "oCloudId": "f078a1d3-56df-46c2-88a2-dd659aa3f6bd",
  • "globalCloudId": "10a07219-4201-4b3e-a52d-81ab6a755d8a",
  • "globalcloudId": "10a07219-4201-4b3e-a52d-81ab6a755d8a",
  • "name": "95b818b8-b315-4d9f-af37-b82c492101f1",
  • "description": "An ocloud",
  • "extensions": ""
}

Get Ocloud Information

query Parameters
exclude_default
string

Exclude showing all default fields, Set "true" to enable.

exclude_fields
string

Set fields to exclude showing, split by comma, "/" for parent and children. Like "name,parent/children". This value will cover "exclude_default".

fields
string

Set fields to show, split by comma, "/" for parent and children. Like "name,parent/children". This value will cover "exculde_fields".

all_fields
string

Set any value for show all fields. This value will cover "fields" and "all_fields".

Responses

Response samples

Content type
application/json
{
  • "oCloudId": "f078a1d3-56df-46c2-88a2-dd659aa3f6bd",
  • "globalCloudId": "10a07219-4201-4b3e-a52d-81ab6a755d8a",
  • "globalcloudId": "10a07219-4201-4b3e-a52d-81ab6a755d8a",
  • "name": "95b818b8-b315-4d9f-af37-b82c492101f1",
  • "description": "An ocloud",
  • "extensions": ""
}

Get Inventory API version

Responses

Response samples

Content type
application/json
{}

Get Deployment Manager List

query Parameters
filter
string

Filter of the query.

exclude_default
string

Exclude showing all default fields, Set "true" to enable.

exclude_fields
string

Set fields to exclude showing, split by comma, "/" for parent and children. Like "name,parent/children". This value will cover "exclude_default".

fields
string

Set fields to show, split by comma, "/" for parent and children. Like "name,parent/children". This value will cover "exculde_fields".

all_fields
string

Set any value for show all fields. This value will cover "fields" and "all_fields".

nextpage_opaque_marker
string
Default: 1

Page number of the results to fetch. Default: 1

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Deployment Manager Information

path Parameters
deploymentManagerID
required
string

ID of the deployment manager

query Parameters
exclude_default
string

Exclude showing all default fields, Set "true" to enable.

exclude_fields
string

Set fields to exclude showing, split by comma, "/" for parent and children. Like "name,parent/children". This value will cover "exclude_default".

fields
string

Set fields to show, split by comma, "/" for parent and children. Like "name,parent/children". This value will cover "exculde_fields".

all_fields
string

Set any value for show all fields. This value will cover "fields" and "all_fields".

profile
string

DMS profile: value supports "native_k8sapi"

Responses

Response samples

Content type
application/json
{
  • "deploymentManagerId": "c765516a-a84e-30c9-b954-9c3031bf71c8",
  • "name": "95b818b8-b315-4d9f-af37-b82c492101f1.kubernetes",
  • "description": "A DMS",
  • "oCloudId": "f078a1d3-56df-46c2-88a2-dd659aa3f6bd",
  • "supportedLocations": "string",
  • "capabilities": {
    },
  • "capacity": {
    },
  • "extensions": {
    }
}

Get Resource Pool List

query Parameters
filter
string

Filter of the query.

exclude_default
string

Exclude showing all default fields, Set "true" to enable.

exclude_fields
string

Set fields to exclude showing, split by comma, "/" for parent and children. Like "name,parent/children". This value will cover "exclude_default".

fields
string

Set fields to show, split by comma, "/" for parent and children. Like "name,parent/children". This value will cover "exculde_fields".

all_fields
string

Set any value for show all fields. This value will cover "fields" and "all_fields".

nextpage_opaque_marker
string
Default: 1

Page number of the results to fetch. Default: 1

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Resource Pool Information

path Parameters
resourcePoolID
required
string

ID of the resource pool

query Parameters
exclude_default
string

Exclude showing all default fields, Set "true" to enable.

exclude_fields
string

Set fields to exclude showing, split by comma, "/" for parent and children. Like "name,parent/children". This value will cover "exclude_default".

fields
string

Set fields to show, split by comma, "/" for parent and children. Like "name,parent/children". This value will cover "exculde_fields".

all_fields
string

Set any value for show all fields. This value will cover "fields" and "all_fields".

Responses

Response samples

Content type
application/json
{
  • "resourcePoolId": "f078a1d3-56df-46c2-88a2-dd659aa3f6bd",
  • "globalLocationId": "",
  • "name": "RegionOne",
  • "description": "A Resource Pool",
  • "oCloudId": "f078a1d3-56df-46c2-88a2-dd659aa3f6bd",
  • "location": "",
  • "extensions": ""
}

Get Resource List

path Parameters
resourcePoolID
required
string

ID of the resource pool

query Parameters
filter
string

Filter of the query.

exclude_default
string

Exclude showing all default fields, Set "true" to enable.

exclude_fields
string

Set fields to exclude showing, split by comma, "/" for parent and children. Like "name,parent/children". This value will cover "exclude_default".

fields
string

Set fields to show, split by comma, "/" for parent and children. Like "name,parent/children". This value will cover "exculde_fields".

all_fields
string

Set any value for show all fields. This value will cover "fields" and "all_fields".

nextpage_opaque_marker
string
Default: 1

Page number of the results to fetch. Default: 1

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Resource Information

path Parameters
resourceID
required
string

ID of the resource

resourcePoolID
required
string

ID of the resource pool

query Parameters
exclude_default
string

Exclude showing all default fields, Set "true" to enable.

exclude_fields
string

Set fields to exclude showing, split by comma, "/" for parent and children. Like "name,parent/children". This value will cover "exclude_default".

fields
string

Set fields to show, split by comma, "/" for parent and children. Like "name,parent/children". This value will cover "exculde_fields".

all_fields
string

Set any value for show all fields. This value will cover "fields" and "all_fields".

Responses

Response samples

Content type
application/json
{
  • "resourceId": "eee8b101-6b7f-4f0a-b54b-89adc0f3f906",
  • "resourceTypeId": "a45983bb-199a-30ec-b7a1-eab2455f333c",
  • "resourcePoolId": "f078a1d3-56df-46c2-88a2-dd659aa3f6bd",
  • "globalAssetId": "",
  • "parentId": "5b3a2da8-17da-466c-b5f7-972590c7baf2",
  • "description": "cpu:0;core:0;thread:0;cpu_family:6;cpu_model:Intel(R) Xeon(R) CPU E5-2670 v2 @ 2.50GHz;allocated_function:Platform;numa_node:0",
  • "extensions": { },
  • "elements": [
    ]
}

Get Resource Type List

query Parameters
filter
string

Filter of the query.

exclude_default
string

Exclude showing all default fields, Set "true" to enable.

exclude_fields
string

Set fields to exclude showing, split by comma, "/" for parent and children. Like "name,parent/children". This value will cover "exclude_default".

fields
string

Set fields to show, split by comma, "/" for parent and children. Like "name,parent/children". This value will cover "exculde_fields".

all_fields
string

Set any value for show all fields. This value will cover "fields" and "all_fields".

nextpage_opaque_marker
string
Default: 1

Page number of the results to fetch. Default: 1

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Resource Type Information

path Parameters
resourceTypeID
required
string

ID of the resource type

query Parameters
exclude_default
string

Exclude showing all default fields, Set "true" to enable.

exclude_fields
string

Set fields to exclude showing, split by comma, "/" for parent and children. Like "name,parent/children". This value will cover "exclude_default".

fields
string

Set fields to show, split by comma, "/" for parent and children. Like "name,parent/children". This value will cover "exculde_fields".

all_fields
string

Set any value for show all fields. This value will cover "fields" and "all_fields".

Responses

Response samples

Content type
application/json
{
  • "resourceTypeId": "60cba7be-e2cd-3b8c-a7ff-16e0f10573f9",
  • "name": "pserver",
  • "description": "The Physical Server resource type",
  • "vendor": "",
  • "model": "",
  • "version": "",
  • "alarmDictionary": {
    },
  • "extensions": ""
}

Get Subscription List

query Parameters
filter
string

Filter of the query.

exclude_default
string

Exclude showing all default fields, Set "true" to enable.

exclude_fields
string

Set fields to exclude showing, split by comma, "/" for parent and children. Like "name,parent/children". This value will cover "exclude_default".

fields
string

Set fields to show, split by comma, "/" for parent and children. Like "name,parent/children". This value will cover "exculde_fields".

all_fields
string

Set any value for show all fields. This value will cover "fields" and "all_fields".

nextpage_opaque_marker
string
Default: 1

Page number of the results to fetch. Default: 1

Responses

Response samples

Content type
application/json
[]

Create a Subscription

Request Body schema: application/json
callback
required
string

Identifier for the Subscription.

consumerSubscriptionId
string

Identifier for the consumer of events sent due to the Subscription.

filter
string

Criteria for events which do not need to be reported or will be filtered by the subscription notification service. Therefore, if a filter is not provided then all events are reported.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Get Subscription Information

path Parameters
subscriptionID
required
string

ID of the subscription

query Parameters
exclude_default
string

Exclude showing all default fields, Set "true" to enable.

exclude_fields
string

Set fields to exclude showing, split by comma, "/" for parent and children. Like "name,parent/children". This value will cover "exclude_default".

fields
string

Set fields to show, split by comma, "/" for parent and children. Like "name,parent/children". This value will cover "exculde_fields".

all_fields
string

Set any value for show all fields. This value will cover "fields" and "all_fields".

Responses

Response samples

Content type
application/json
{}

Delete a Subscription

path Parameters
subscriptionID
required
string

ID of the subscription

Responses

O2IMS-InfrastructureMonitoring

O2 IMS Monitoring related operations.

Get Monitoring Version

Responses

Response samples

Content type
application/json
{}

Get Alarm Subscription List

query Parameters
filter
string

Filter of the query.

exclude_default
string

Exclude showing all default fields, Set "true" to enable.

exclude_fields
string

Set fields to exclude showing, split by comma, "/" for parent and children. Like "name,parent/children". This value will cover "exclude_default".

fields
string

Set fields to show, split by comma, "/" for parent and children. Like "name,parent/children". This value will cover "exculde_fields".

all_fields
string

Set any value for show all fields. This value will cover "fields" and "all_fields".

nextpage_opaque_marker
string
Default: 1

Page number of the results to fetch. Default: 1

Responses

Response samples

Content type
application/json
[]

Create a Alarm Subscription

Request Body schema: application/json
callback
required
string

The fully qualified URI to a consumer procedure which can process a Post of the InventoryEventNotification.

consumerSubscriptionId
string

Identifier for the consumer of events sent due to the Subscription.

filter
string

Criteria for events which do not need to be reported or will be filtered by the subscription notification service. Therefore, if a filter is not provided then all events are reported.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Get Alarm Subscription Information

path Parameters
alarmSubscriptionID
required
string

ID of the Alarm Subscription

query Parameters
exclude_default
string

Exclude showing all default fields, Set "true" to enable.

exclude_fields
string

Set fields to exclude showing, split by comma, "/" for parent and children. Like "name,parent/children". This value will cover "exclude_default".

fields
string

Set fields to show, split by comma, "/" for parent and children. Like "name,parent/children". This value will cover "exculde_fields".

all_fields
string

Set any value for show all fields. This value will cover "fields" and "all_fields".

Responses

Response samples

Content type
application/json
{}

Delete an Alarm Subscription

path Parameters
alarmSubscriptionID
required
string

ID of the Alarm Subscription

Responses

Get Alarm Event Record List

query Parameters
filter
string

Filter of the query.

exclude_default
string

Exclude showing all default fields, Set "true" to enable.

exclude_fields
string

Set fields to exclude showing, split by comma, "/" for parent and children. Like "name,parent/children". This value will cover "exclude_default".

fields
string

Set fields to show, split by comma, "/" for parent and children. Like "name,parent/children". This value will cover "exculde_fields".

all_fields
string

Set any value for show all fields. This value will cover "fields" and "all_fields".

nextpage_opaque_marker
string
Default: 1

Page number of the results to fetch. Default: 1

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Patch Alarm Event Record Information

path Parameters
alarmEventRecordId
required
string

ID of the alarm event record

query Parameters
exclude_default
string

Exclude showing all default fields, Set "true" to enable.

exclude_fields
string

Set fields to exclude showing, split by comma, "/" for parent and children. Like "name,parent/children". This value will cover "exclude_default".

fields
string

Set fields to show, split by comma, "/" for parent and children. Like "name,parent/children". This value will cover "exculde_fields".

all_fields
string

Set any value for show all fields. This value will cover "fields" and "all_fields".

Request Body schema: application/json
alarmAcknowledged
boolean

Boolean value indication of a management system has acknowledged the alarm.

perceivedSeverity
string

indicate that the alarm record is requested to be cleared. Only the value "5" for "CLEARED" is permitted in a request message content.

Responses

Request samples

Content type
application/json
{
  • "alarmAcknowledged": true,
  • "perceivedSeverity": "5"
}

Response samples

Content type
application/json
{
  • "alarmAcknowledged": true,
  • "perceivedSeverity": "5"
}

Get Alarm Event Record Information

path Parameters
alarmEventRecordId
required
string

ID of the alarm event record

query Parameters
exclude_default
string

Exclude showing all default fields, Set "true" to enable.

exclude_fields
string

Set fields to exclude showing, split by comma, "/" for parent and children. Like "name,parent/children". This value will cover "exclude_default".

fields
string

Set fields to show, split by comma, "/" for parent and children. Like "name,parent/children". This value will cover "exculde_fields".

all_fields
string

Set any value for show all fields. This value will cover "fields" and "all_fields".

Responses

Response samples

Content type
application/json
{
  • "alarmEventRecordId": "97cc2b01-0e71-4a93-a911-2e87f04d996f",
  • "resourceTypeId": "60cba7be-e2cd-3b8c-a7ff-16e0f10573f9",
  • "resourceTypeID": "60cba7be-e2cd-3b8c-a7ff-16e0f10573f9",
  • "resourceId": "5b3a2da8-17da-466c-b5f7-972590c7baf2",
  • "resourceID": "5b3a2da8-17da-466c-b5f7-972590c7baf2",
  • "alarmDefinitionId": "1197f463-b3d4-3aa3-9c14-faa493baa069",
  • "alarmDefinitionID": "1197f463-b3d4-3aa3-9c14-faa493baa069",
  • "probableCauseId": "f52054c9-6f3c-39a0-aab8-e00e01d8c4d3",
  • "probableCauseID": "f52054c9-6f3c-39a0-aab8-e00e01d8c4d3",
  • "alarmRaisedTime": "2022-12-22 09:42:53",
  • "alarmChangedTime": "",
  • "alarmAcknowledgeTime": "",
  • "alarmAcknowledged": false,
  • "perceivedSeverity": "1",
  • "extensions": { }
}

Get Monitoring API version

Responses

Response samples

Content type
application/json
[]