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/shcmraconfiguration

Operation

Delete the existing Sh Cache Microservice Client configuration

Request Method

DELETE

Path

/hss/shcmraconfiguration

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 Sh Cache Microservice Client configuration

Request Method

POST

Path

/hss/shcmraconfiguration

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

Update the existing Sh Cache Microservice Client configuration

Request Method

PUT

Path

/hss/shcmraconfiguration

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

Operation

Retrieve the existing Sh Cache Microservice Client configuration

Request Method

GET

Path

/hss/shcmraconfiguration

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

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>

ShCMRAConfigurationDto

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

JSON
{
  "type" : "object",
  "properties" : {
    "proxyEnabled" : {
      "type" : "boolean",
      "required" : true
    },
    "proxyHost" : {
      "type" : "string"
    },
    "proxyPort" : {
      "type" : "integer"
    },
    "serverURL" : {
      "type" : "string"
    },
    "httpIoThreads" : {
      "type" : "integer"
    },
    "httpConnectTimeout" : {
      "type" : "integer"
    },
    "httpIdleTimeout" : {
      "type" : "integer"
    },
    "httpRequestTimeout" : {
      "type" : "integer"
    },
    "httpKeepAlive" : {
      "type" : "boolean",
      "required" : true
    },
    "httpKeepAliveTimeout" : {
      "type" : "integer"
    },
    "httpMaxPoolSize" : {
      "type" : "integer"
    }
  }
}
XML
<?xml version="1.0" standalone="yes"?>
<xs:schema version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">

  <xs:element name="shcmraConfiguration" type="ShCMRAConfigurationType"/>

  <xs:complexType name="ShCMRAConfigurationType">
    <xs:sequence>
      <xs:element name="proxyEnabled" type="xs:boolean"/>
      <xs:element name="proxyHost" type="xs:string" minOccurs="0"/>
      <xs:element name="proxyPort" type="xs:int" minOccurs="0"/>
      <xs:element name="serverURL" type="xs:string"/>
      <xs:element name="httpIoThreads" type="xs:int"/>
      <xs:element name="httpConnectTimeout" type="xs:int"/>
      <xs:element name="httpIdleTimeout" type="xs:int"/>
      <xs:element name="httpRequestTimeout" type="xs:int"/>
      <xs:element name="httpKeepAlive" type="xs:boolean"/>
      <xs:element name="httpKeepAliveTimeout" type="xs:int" minOccurs="0"/>
      <xs:element name="httpMaxPoolSize" type="xs:int"/>
    </xs:sequence>
  </xs:complexType>
</xs:schema>
Previous page Next page