Resource Cassandra Subscriber Data Store

Resource

Cassandra Subscriber Data Store

Workspace

Sentinel Services

Path

/cassandrabasedsubscriberdatastore

Operations

Operation

Retrieve a list of sub-resources offered by this resource

Request Method

GET

Path

/cassandrabasedsubscriberdatastore

Parameters

Request Body

Not used

Success Result

200 OK

Response Headers

None

Response Body

Feature

/cassandrabasedsubscriberdatastore/config

Operation

Retrieve an existing Cassandra Subscriber Data Store Config entry or a listing of Cassandra Subscriber Data Store Config entries

Request Method

GET

Path

/cassandrabasedsubscriberdatastore/config

Parameters

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

  • selectionKey — the Sentinel selection key 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: CassandraBasedSubscriberDataStoreConfig Otherwise: CassandraBasedSubscriberDataStoreConfigs

Operation

Update an existing Cassandra Subscriber Data Store Config entry

Request Method

PUT

Path

/cassandrabasedsubscriberdatastore/config

Parameters

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

  • selectionKey — the Sentinel selection key scope to use

Request Body

CassandraBasedSubscriberDataStoreConfig

Success Result

204 No content

Response Headers

None

Response Body

Not used

Operation

Delete an existing Cassandra Subscriber Data Store Config entry

Request Method

DELETE

Path

/cassandrabasedsubscriberdatastore/config

Parameters

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

  • selectionKey — the Sentinel selection key scope to use

Request Body

Not used

Success Result

204 No content

Response Headers

None

Response Body

Not used

Operation

Create a new Cassandra Subscriber Data Store Config entry

Request Method

POST

Path

/cassandrabasedsubscriberdatastore/config

Parameters

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

  • selectionKey — the Sentinel selection key scope to use

Request Body

CassandraBasedSubscriberDataStoreConfig

Success Result

201 Created

Response Headers

Location — contains the URL to access the created record

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>

CassandraBasedSubscriberDataStoreConfig

Class: com.opencloud.sentinel.provisioning.registrar.CassandraBasedSubscriberDataStoreConfig

JSON
{
  "type" : "object",
  "properties" : {
    "cassandraTTL" : {
      "type" : "integer"
    },
    "cassandraTracing" : {
      "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="cassandraBasedSubscriberDataStoreConfig" type="CassandraBasedSubscriberDataStoreConfigType"/>

  <xs:complexType name="CassandraBasedSubscriberDataStoreConfigType">
    <xs:sequence>
      <xs:element name="cassandraTTL" type="xs:int"/>
      <xs:element name="cassandraTracing" type="xs:boolean"/>
    </xs:sequence>
  </xs:complexType>
</xs:schema>

CassandraBasedSubscriberDataStoreConfigs

Class: com.opencloud.sentinel.rest.server.resources.registrar.CassandraBasedSubscriberDataStoreConfigResource$CassandraBasedSubscriberDataStoreConfigs

JSON
{
  "type" : "object",
  "properties" : {
    "entries" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "properties" : {
          "name" : {
            "type" : "string"
          },
          "resources" : {
            "type" : "array",
            "items" : {
              "type" : "object",
              "properties" : {
                "rel" : {
                  "type" : "string"
                },
                "href" : {
                  "type" : "string"
                },
                "title" : {
                  "type" : "string"
                }
              }
            }
          },
          "selectionKey" : {
            "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="cassandraBasedSubscriberDataStoreConfig" type="CassandraBasedSubscriberDataStoreConfigsEntryType"/>

  <xs:element name="cassandraBasedSubscriberDataStoreConfigs" type="CassandraBasedSubscriberDataStoreConfigsType"/>

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

  <xs:complexType name="CassandraBasedSubscriberDataStoreConfigsType">
    <xs:sequence>
      <xs:element ref="cassandraBasedSubscriberDataStoreConfig" 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="CassandraBasedSubscriberDataStoreConfigsEntryType">
    <xs:complexContent>
      <xs:extension base="simpleEntry">
        <xs:sequence>
          <xs:element name="selectionKey" type="xs:string" minOccurs="0"/>
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>

  <xs:complexType name="simpleEntry" abstract="true">
    <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>
Previous page Next page