Resource HSS Configuration

Resource

HSS Configuration

Workspace

VoLTE Services

Path

/hss

Operations

Operation

Retrieve a list of sub-resources offered by this resource

Request Method

GET

Path

/hss

Parameters

Request Body

Not used

Success Result

200 OK

Response Headers

None

Response Body

/hss/diameterconfiguration

Operation

Delete the existing HSS Diameter configuration

Request Method

DELETE

Path

/hss/diameterconfiguration

Parameters

  • rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)

Request Body

Not used

Success Result

204 No content

Response Headers

None

Response Body

Not used

Operation

Create a new HSS Diameter configuration

Request Method

POST

Path

/hss/diameterconfiguration

Parameters

  • rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)

Request Body

Success Result

201 Created

Response Headers

Location — contains the URL to access the created record

Response Body

Not used

Operation

Retrieve the existing HSS Diameter configuration

Request Method

GET

Path

/hss/diameterconfiguration

Parameters

  • rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)

Request Body

Not used

Success Result

200 OK

Response Headers

None

Response Body

Operation

Update the existing HSS Diameter configuration

Request Method

PUT

Path

/hss/diameterconfiguration

Parameters

  • rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)

Request Body

Success Result

204 No content

Response Headers

None

Response Body

Not used

/hss/diameterstack

Operation

Retrieve the HSS Diameter peer status for a specific peer

Request Method

GET

Path

/hss/diameterstack/peerstatus/{peerName}

Parameters

  • rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)

Request Body

Not used

Success Result

200 OK

Response Headers

None

Response Body

Operation

Retrieve the HSS Diameter peer status

Request Method

GET

Path

/hss/diameterstack/peerstatus

Parameters

  • rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)

Request Body

Not used

Success Result

200 OK

Response Headers

None

Response Body

/hss/destinations

Operation

Create a new Diameter destination

Request Method

POST

Path

/hss/destinations

Parameters

  • rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)

  • networkOperator — the network operator scope to use

Request Body

Success Result

201 Created

Response Headers

Location — contains the URL to access the created record

Response Body

Not used

Operation

Retrieve an existing Diameter destination

Request Method

GET

Path

/hss/destinations

Parameters

  • rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)

  • networkOperator — the network operator scope to use

  • page — the page to retrieve if results span multiple pages (default = 1 if not provided)

Request Body

Not used

Success Result

200 OK

Response Headers

None

Response Body

If scope is provided: DiameterDestinationDto Otherwise: DiameterDestinations

Operation

Update an existing Diameter destination

Request Method

PUT

Path

/hss/destinations

Parameters

  • rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)

  • networkOperator — the network operator scope to use

Request Body

Success Result

204 No content

Response Headers

None

Response Body

Not used

Operation

Delete an existing Diameter destination

Request Method

DELETE

Path

/hss/destinations

Parameters

  • rhinoInstanceId — the ID of the Rhino instance to connect to (as defined in REM)

  • networkOperator — the network operator scope to use

Request Body

Not used

Success Result

204 No content

Response Headers

None

Response Body

Not used

Schemas

Feature

Class: com.opencloud.sentinel.rest.common.Feature

JSON
{
  "type" : "object",
  "properties" : {
    "name" : {
      "type" : "string"
    },
    "resources" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "properties" : {
          "rel" : {
            "type" : "string"
          },
          "href" : {
            "type" : "string"
          },
          "title" : {
            "type" : "string"
          }
        }
      }
    }
  }
}
XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">

  <xs:element name="feature" type="FeatureType"/>

  <xs:element name="link" type="LinkType"/>

  <xs:complexType name="FeatureType">
    <xs:sequence>
      <xs:element name="name" type="xs:string" minOccurs="0"/>
      <xs:element name="resources" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="LinkType">
    <xs:sequence/>
    <xs:attribute name="rel" type="xs:string"/>
    <xs:attribute name="href" type="xs:string"/>
    <xs:attribute name="title" type="xs:string"/>
  </xs:complexType>
</xs:schema>

DiameterConfigurationDto

Class: com.opencloud.volte.sentinel.provisioning.hss.DiameterConfigurationDto

JSON
{
  "type" : "object",
  "properties" : {
    "profileName" : {
      "type" : "string"
    },
    "threadPoolSize" : {
      "type" : "integer"
    },
    "ioServerWorkers" : {
      "type" : "integer"
    },
    "ioClientWorkers" : {
      "type" : "integer"
    },
    "requestTimeout" : {
      "type" : "number"
    },
    "watchdogTimeout" : {
      "type" : "number"
    },
    "baseMessageApplicationID" : {
      "type" : "integer"
    },
    "reconnectDelay" : {
      "type" : "number"
    },
    "forceReconnectAfterDpr" : {
      "type" : "boolean",
      "required" : true
    }
  }
}
XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">

  <xs:element name="diameterConfiguration" type="HSSDiameterConfigurationType"/>

  <xs:complexType name="HSSDiameterConfigurationType">
    <xs:sequence>
      <xs:element name="profileName" type="xs:string"/>
      <xs:element name="threadPoolSize" type="xs:int"/>
      <xs:element name="ioServerWorkers" type="xs:int"/>
      <xs:element name="ioClientWorkers" type="xs:int"/>
      <xs:element name="requestTimeout" type="xs:long"/>
      <xs:element name="watchdogTimeout" type="xs:long"/>
      <xs:element name="baseMessageApplicationID" type="xs:int"/>
      <xs:element name="reconnectDelay" type="xs:long"/>
      <xs:element name="forceReconnectAfterDpr" type="xs:boolean"/>
    </xs:sequence>
  </xs:complexType>
</xs:schema>

PeerStatus

Class: com.opencloud.volte.sentinel.provisioning.hss.DiameterPeerStatus$PeerStatus

JSON
{
  "type" : "object",
  "properties" : {
    "name" : {
      "type" : "string"
    },
    "started" : {
      "type" : "boolean",
      "required" : true
    },
    "inService" : {
      "type" : "boolean",
      "required" : true
    }
  }
}
XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">

  <xs:element name="peerStatus" type="HSSPeerStatusType"/>

  <xs:complexType name="HSSPeerStatusType">
    <xs:sequence>
      <xs:element name="name" type="xs:string" minOccurs="0"/>
      <xs:element name="started" type="xs:boolean"/>
      <xs:element name="inService" type="xs:boolean"/>
    </xs:sequence>
  </xs:complexType>
</xs:schema>

DiameterPeerStatus

Class: com.opencloud.volte.sentinel.provisioning.hss.DiameterPeerStatus

JSON
{
  "type" : "object",
  "properties" : {
    "peerStatus" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "properties" : {
          "name" : {
            "type" : "string"
          },
          "started" : {
            "type" : "boolean",
            "required" : true
          },
          "inService" : {
            "type" : "boolean",
            "required" : true
          }
        }
      }
    }
  }
}
XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">

  <xs:element name="diameterPeerStatus" type="HSSDiameterPeerStatusType"/>

  <xs:element name="peerStatus" type="HSSPeerStatusType"/>

  <xs:complexType name="HSSDiameterPeerStatusType">
    <xs:sequence>
      <xs:element ref="peerStatus" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="HSSPeerStatusType">
    <xs:sequence>
      <xs:element name="name" type="xs:string" minOccurs="0"/>
      <xs:element name="started" type="xs:boolean"/>
      <xs:element name="inService" type="xs:boolean"/>
    </xs:sequence>
  </xs:complexType>
</xs:schema>

DiameterDestinationDto

Class: com.opencloud.volte.sentinel.provisioning.hss.DiameterDestinationDto

JSON
{
  "type" : "object",
  "properties" : {
    "destinationRealm" : {
      "type" : "string"
    },
    "destinationHost" : {
      "type" : "string"
    }
  }
}
XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">

  <xs:element name="diameterDestination" type="HSSDiameterDestinationType"/>

  <xs:complexType name="HSSDiameterDestinationType">
    <xs:sequence>
      <xs:element name="destinationRealm" type="xs:string"/>
      <xs:element name="destinationHost" type="xs:string" nillable="true" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>
</xs:schema>

DiameterDestinations

Class: com.opencloud.volte.sentinel.rest.server.resources.DiameterDestinationResource$DiameterDestinations

JSON
{
  "type" : "object",
  "properties" : {
    "entries" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "properties" : {
          "destinationRealm" : {
            "type" : "string"
          },
          "destinationHost" : {
            "type" : "string"
          },
          "resources" : {
            "type" : "array",
            "items" : {
              "type" : "object",
              "properties" : {
                "rel" : {
                  "type" : "string"
                },
                "href" : {
                  "type" : "string"
                },
                "title" : {
                  "type" : "string"
                }
              }
            }
          }
        }
      }
    },
    "next" : {
      "type" : "string"
    },
    "prev" : {
      "type" : "string"
    }
  }
}
XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">

  <xs:element name="diameterDestination" type="HSSDiameterDestinationEntryType"/>

  <xs:element name="diameterDestinations" type="HSSDiameterDestinationsType"/>

  <xs:element name="link" type="LinkType"/>

  <xs:complexType name="HSSDiameterDestinationsType">
    <xs:sequence>
      <xs:element ref="diameterDestination" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
    <xs:attribute name="next" type="xs:string"/>
    <xs:attribute name="prev" type="xs:string"/>
  </xs:complexType>

  <xs:complexType name="HSSDiameterDestinationEntryType">
    <xs:sequence>
      <xs:element name="destinationRealm" type="xs:string" minOccurs="0"/>
      <xs:element name="destinationHost" type="xs:string" minOccurs="0"/>
      <xs:element name="resources" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element ref="link" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="LinkType">
    <xs:sequence/>
    <xs:attribute name="rel" type="xs:string"/>
    <xs:attribute name="href" type="xs:string"/>
    <xs:attribute name="title" type="xs:string"/>
  </xs:complexType>
</xs:schema>
Previous page Next page