https://{target}/mmi/dsr/v2.0/
Introduction & Overview
The Oracle Communications Diameter Signaling Router Machine to Machine Interface
This Application Programming Interface (API) document describes the Machine to Machine Interface (MMI) for the Oracle Communications Diameter Signaling Router (OC-DSR, often shortened to simply DSR). The DSR MMI is a RESTful (Representational State Transfer) interface providing access to a broad range of Operations, Administration, and Maintenance (OAM) services that clients use to configure and manage the DSR. This document is the comprehensive API reference guide to the RESTful services the DSR makes available to clients through the DSR MMI.
General URI Format for DSR MMI Requests
The general format of a Uniform Resource Identifier (URI) used to send an MMI request to the DSR is:
https://{target}/mmi/dsr/{version}/{area}/{resource}[/{instance}][/{sub-resource}[/{sub-instance}]]*[/{attribute or action}]
where
- {target} is the IP address or FQDN (Fully Qualified Domain Name) of the OAM server receiving the MMI request.
- {version} is the MMI API version number. If the MMI client specifies a version that is not supported by the DSR, HTTP status code 404 is returned in the response.
- {area} is the functional area that includes the desired MMI API (areas are defined in the next paragraph).
- {resource} is the specific DSR resource being accessed - with DSR, the resource generally equates to a Managed Object (MO).
- {instance} is necessary when the client is accessing a specific instance of a resource; {instance} is the unique identifier for the resource record, and is often the instance's name attribute (although some resources use a different attribute as the unique identifier, particularly when the resource's instances don't have names).
- {sub-resource} is the specific sub-resource within the resource associated with the requested operation. It could consist of one or more tokens (e.g., /db/backup).
- {sub-instance} is only necessary when the client is accessing a specific sub-instance of a sub-resource; typically the {sub-instance} value is the name of a specific sub-resource; {sub-instance} should only appear when following a {sub-resource}.
- {attribute or action} is only necessary when the client is performing an action on a specific instance. {attribute or action} could be name of an attribute being read or updated (e.g., the administrative state) of an instance or sub-instance. Note: in this context, {action} is not one of the standard HTTP actions, but is instead one of the specific actions supported by the resource or sub-resource.
DSR MMI clients use Secure Sockets Layer (SSL) connections (HTTPS) to communicate with the target DSR.
APIs are Grouped by Functional Area
DSR MMI APIs are grouped by functional area and, as shown in section General URI Format for DSR MMI Requests, the area is one segment of the URI sent to the DSR. MMI APIs are available for the following areas of DSR functionality:
- Client Authentication (area: auth) - MMI security - authentication, authorization, and audit
- Bulk Configuration (area: bulk) - bulk export and import of system configuration
- System Administration (area: admin) - DSR network administration functions
- System Monitoring (area: mon) - access to system processes, logs, statistics, and measurements
- Topology Configuration and Management (area: topo) - insert, edit, delete, retrieval, and management of system topology resources; note that the topo area only covers management of server and network resources; application-specific resources are part of other areas (e.g., diameter)
- Core Diameter (area: diameter) - configuration establishing the DSR as a Diameter Relay Agent, including IP Front End (IPFE) behavior
- Non-Specific (area: all) - general APIs that span multiple areas of functionality
Within this API documentation, resource descriptions are organized by area, then alphabetically by the individual resource name within each area. A few resources do not have a Request block for a particular action (e.g., /diameter/mpprofileassignments GET; /mon/measurements/budget GET). This is not a mistake or oversight. In these cases, there are no valid query parameters for the API, and the Request block is simply omitted.
Both Network and Site OAM Servers Provide MMI Access
A DSR is a collection of cooperating servers arranged in a three-tiered hierarchical topology. MMI functionality is available at the top two levels of the hierarchy:
- Network - the administrative domain consisting of all DSR Sites, managed using highly available (HA) clusters of Network Operations, Administration, and Maintenance (NOAM) servers. Network-scoped functionality is hosted in this top level of the topology hierarchy and is referred to as the A-Level.
- Site - a site-level administrative domain, managed using clusters of HA Site Operations, Administration, and Maintenance (SOAM) servers. Operations performed at the SOAM are scoped to the specific SOAM (all SOAM servers in the HA cluster, plus all sub-tending C-level servers - note that these servers may not all reside at the same physical location). Site-scoped functionality is hosted in the middle layer of the topology hierarchy and is referred to as the B-Level.
The bottom level of the topology hierarchy, the C-Level, is reserved for application-level servers (DA-MPs, IPFEs, SBRs, SS7-MPs), which do not provide any administrative access. DSR MMI functionality is only available on the OAM servers.
Adding or editing a resource instance is done at either the NOAM or the SOAM, but not both. The documentation for each resource identifies whether the NOAM or SOAM is the target of an MMI request for that resource. Note that, for some resources configured at the NOAM, it is possible to retrieve the configuration - but not change it - at an SOAM. Also, status/monitoring resources like measurements, KPIs, and alarms can be retrieved at both the NOAM and SOAM. The data returned by the target OAM server is scoped to that server.
MMI Requests Are Sent to Active OAM Servers
Whenever OAM servers are deployed in High-Availability (HA) clusters, it is the server holding the HA role of active that must receive an MMI request. If a Virtual IP (VIP) is configured for the OAM cluster, requests sent to that VIP are automatically handled by the active OAM server. If an OAM server is standing alone (not part of an HA cluster), it is by default considered the active server and should be the target of client MMI requests.
RESTful Operation Overview
The DSR configuration is managed through Create, Retrieve, Update, and Delete (CRUD) actions on instances of the various resource types built into the DSR. A particular type of resource (e.g., Server, Network Element, Peer Node, Traffic Throttle Group) is also known as a Managed Object (MO), and a specific instance of a resource is known as an MO instance. Throughout this document, the term MO is used to refer either to the type or to a particular instance of a type. The intended usage should be clear from the context.
The CRUD operations are implemented using standard HTTP verbs:
- HTTP POST is used to Create a new resource instance.
- HTTP GET is used to Retrieve one or more resource instances.
- HTTP PUT is used to Update a resource instance.
- HTTP DELETE is used to Delete a resource instance.
The following sections provide a brief overview of how the CRUD operations work through the MMI using simple examples. In these examples, a simplified version of the RESTful result structure is used for illustration purposes. Refer to the schema definition in the API description for a particular resource for a complete response definition specific to that resource.
Create Pattern
To create a new instance of a resource, POST it to the collection. POST returns a response populated with the identifier of the newly created resource instance. In most cases, the resource instance identifier is simply the client-provided name of the resource. For resources that do not have a simple name field, or for which the name field is not required to be unique, a unique identifier is constructed and returned.
For example:
POST /resource/ + BODY { "name":"newInstance", "description":"an example" }
Returns the new resource ID:
"data":"newInstance",
"messages":[],
"links":[],
"status":true
Update and Delete Patterns
To update an instance of a resource, the PUT operation is used. To delete an instance, the DELETE operation is used.
There are a few common reasons why an update operation might fail:
- System updates have been disabled.
- The update data is incomplete or is some other way invalid.
- The MMI user account does not have permission to perform the requested operation for the specified resource.
- The server is currently overloaded and cannot handle a new request.
Any failure explanation(s) are returned in the messages portion of the response.
Use of Natural Identifiers
Most of the DSR MMI resource APIs use the natural identifier (typically the name field) for a resource instance. For example, the /topo/servers resource uses the server name as its natural identifier. However, in certain cases, where there is no natural identifier, a unique identifier is generated. The /route resource, for example, has no natural identifier, so one is generated at the time a new route is created.
The documentation for each resource defines what property is used as the identifier (as returned in a POST response).
Idempotent GET/PUT
A GET of a resource instance, followed by a PUT of the same resource instance, leaves the resource essentially unchanged.
Note that occasionally there are fields in a resource schema that are described as computed. These fields are always ignored on PUT. Computed fields are also ignored on initial creation requests using POST.
Some fields are read-only, and are identified as such in the JSON schemas. If included by the client in a PUT request, read-only field values are ignored by the DSR.
Some fields are not updatable. These fields must be set on initial creation via POST, and are ignored on subsequent updates.
Structured Response
Unless stated otherwise, operations place returned results in a structured container of the form:
- data (optional) - If the operation returns data, the data is placed in the data portion of the result.
- messages (optional) - If the operation returns any warnings, errors, status, or other informational data, they are placed in the messages portion of the result.
- links (optional) - If the operation returns links supporting or suggesting follow-up resources or actions, they are placed in the links portion of the result.
- status - true on success, false on failure. If false, the messages portion of the response provides details.
HTTP Status Codes
DSR operations available through the MMI API are atomic, unless stated otherwise for a specific resource. If a configuration operation does not complete successfully, the DSR is left in its original state. The RESTful operations generally available for resources, and possible return codes for each, are:
- GET - retrieve one or more items from a collection, or retrieve just a single item identified by a unique name/id
- 200 - operation successful
- 400 - bad request
- 401 - not authenticated
- 403 - not authorized
- 404 - item not found/API version not supported
- 429 - too many requests
- POST - insert a new item into a collection
- 201 - operation successful - item created
- 202 - request accepted - operation in progress
- 400 - bad request
- 401 - not authenticated
- 403 - not authorized
- 404 - API version not supported
- 500 - internal server error
- PUT - update a specific, existing item in a collection
- 200 - operation successful
- 202 - request accepted - operation in progress
- 400 - bad request
- 401 - not authenticated
- 403 - not authorized
- 404 - API version not supported
- 409 - resource state conflict
- 500 - internal server error
- DELETE - delete a specific item from a collection
- 204 - operation successful (no content is returned from a delete operation)
- 400 - bad request
- 401 - not authenticated
- 403 - not authorized
- 404 - API version not supported
- 409 - resource state conflict
- 500 - internal server error
General Behaviors
This section defines general behaviors of the DSR Machine to Machine Interface.
Read-only attributes - Most resources have one or more read-only attributes, and these are identified in the JavaScript Object Notation (JSON) schemas by the readOnly property. Read-only attributes are always returned in any GET response. Clients should not include read-only attributes in the JSON data accompanying a POST or PUT request, as the presence of read-only values never results in a DSR state change. If a POST or PUT request does include a read-only attribute value that has the correct data type (per the JSON schema), the DSR ignores the value and processes the request as if the read-only attribute were not present. If, however, a POST or PUT request includes a read-only attribute value whose data type is not correct, the DSR returns an error response. The client should fix the data type - or remove the attribute from the JSON data entirely - and re-send the request.
Simultaneous client interactions - If two or more DSR clients attempt to modify the same resource at the same time, the last-in-time request received by the DSR is the one with final impact on the state of the DSR. No error response is sent to the other clients, but the changes requested by those clients are overwritten as a result of the request received from the last-in-time client, if there is any overlap between the requests. For example, if client #1 updates the configuration of a resource instance, but client #2 subsequently deletes that same resource instance, the instance is deleted and client #1 receives no notification that the instance it just updated has been deleted.
Filtering and sorting - Generally speaking, query parameters for a collection GET operation can be used to tailor the returned results to a select subset of the collection. In this version of the API, the only tailoring somewhat widely supported is paging - returning N items beginning at a specified offset into the collection. In general, the following are not supported operations: 1) filtering results by an arbitrary named attribute, and 2) sorting the results by any arbitrary attribute. There are a few APIs - namely, for status sub-resources - that support this kind of attribute-based filtering. These are so indicated in the individual resource documentation.
Paging - Paging parameters for a collection GET operation are used to return a client-defined number of resource instances, beginning at a specified offset. In this version of the API, only resources in the Core Diameter (/diameter) area support paging. For the Core Diameter area, if paging query parameters are not supplied in the request, the number of records returned is limited to a default page size, and always begins with the first record in the configuration. If paging query parameters are supplied in the request, a success response is returned only if the requested number of instances is less than or equal to the default page size. The success response contains links for the next and previous set of records, and a message indicating the count of remaining records, when applicable. The default page size - the number of resources returned by the DSR in a GETALL request when the client does not specify a desired count in the request - is defined by the DSR and is currently set to 1000.
Default attribute values - In general, DSR provides no default value for an attribute when POSTing a new instance to the configuration. If no value is provided in the client request for an attribute that is required, the POST fails and a specific error message is returned. If no value is supplied by the client for an attribute that is not required, that attribute may or may not have a value in the configuration, depending on the specific behavior of the resource being configured.
Data validation - The data for all PUT and POST operations is validated both for syntactic and semantic correctness before the operation is allowed to proceed. If any validation errors occur, the response has a status of false, and the messages portion of the response contains one or more messages documenting the specific error details. Any unexpected operation failures also result in a status of false being returned, along with details in the messages portion of the response.
Attempting to delete a resource instance that doesn't exist - If a client attempts to delete a resource instance whose unique identifier is not present in the DSR's configuration, the DSR responds with either a 400 or 409 HTTP status code, depending on the resource type.
Handling of invalid query parameters - In this release of the DSR software, the error handling capability for invalid query parameters is limited. If a client sends a query string with one or more invalid query parameter values, the DSR's response to the request is not guaranteed to be expected.
MMI Security
With very few exceptions, access to any of the RESTful APIs supported by the DSR requires authentication. Section The Client Authentication Area describes the specifics of the authentication mechanism. In short, a client must obtain a token from the DSR by providing valid credentials. Once the client has the token, it can access any DSR MMI resource that requires authentication by providing the token in the header of the HTTP request.
Each individual resource action (GET, POST, etc.) described in this API specification includes a "secured by" designation. If the resource action requires authenticated access, this designation is "Secured by x-other". If the resource can be accessed by a client without authentication, the designation is "Secured by none". If the resource can be accessed with or without authentication, both "Secured by x-other" and "Secured by none" are present.
Note that in this release of the API, there are only two resources that can be accessed without authentication - and both of those can also be accessed with authentication.
Any resource action that includes "Secured by x-other" is rendered with a lock icon preceding the action name.
Examples
Retrieving Resource Instances: GET
There are many ways an MMI client can create the HTTP request sent to the DSR. One common tool is curl, which is available in many languages and supports several internet protocols, including HTTPS. The following example illustrates use of curl from a command line to GET all of the Capacity Configuration Sets (/diameter/capacityconfigurationsets) configured at the target DSR (here represented by 'localhost'):
curl --header 'X-Auth-Token:EFEFC54B7F19EE5B75DF' --request GET 'https://localhost/mmi/dsr/v1.0/diameter/capacityconfigurationsets'
The structured response returned by the DSR contains the following JSON data structure:
{
"data": [
{
"configurationLevel": "0",
"convergenceTime": 1000,
"ingressMpsMajorAlarmThreshold": 80,
"ingressMpsMinorAlarmThreshold": 50,
"maxIngressMps": 10000,
"name": "Default",
"reservedIngressMps": 0,
"reservedIngressMpsAbatementTime": 2000
}
],
"links": {},
"messages": [],
"status": true
}
The value of true for "status" indicates that the request was successfully processed, without any errors. In this case, there is only a single Capacity Configuration Set present in the DSR configuration, so only one instance appears in the array in the "data" section of the response.
Inserting a Resource Instance: POST
When inserting a new resource instance into the DSR configuration, the client must supply a JSON data structure, in accordance with the schema defined for the resource being inserted. In the following example, a Capacity Configuration Set (/diameter/capacityconfigurationsets) is added to the DSR represented by 'localhost' using curl from a command line:
curl --header 'X-Auth-Token:D2D588AE818739218A33' --request POST --data '{"name": "CapacityConfigurationSet1", "ingressMpsMajorAlarmThreshold": 80, "maxIngressMps": 10000, "reservedIngressMpsAbatementTime": 2000, "ingressMpsMinorAlarmThreshold": 50, "convergenceTime": 1000, "reservedIngressMps": 0}' 'https://localhost/mmi/dsr/v1.0/diameter/capacityconfigurationsets'
Assuming all supplied data is valid and the Capacity Configuration Set is successfully added to the configuration, the response from the DSR is:
{
"data":
{
"id": "CapacityConfigurationSet1",
},
"links": {},
"messages": [],
"status": true
}
The Client Authentication Area
(area: "auth")
Authentication
The auth area provides the tokens (/auth/tokens) interface for client authentication. Before performing any other operation with DSR, the client must first obtain an authentication token using the tokens interface.
The client provides credentials to identify itself, and if the credentials are successfully authenticated, DSR returns a valid token. The client then embeds the token in subsequent MMI calls using the X-Auth-Token header.
Tokens typically expire after two hours. It is the responsibility of the client to request a fresh token before or when the previous token expires. A valid token can also be used to authenticate a client, so it is possible to replace an unexpired token with a new one that has a fresh two-hour lifetime.
A token created on any OAM server is immediately usable on that server, and becomes usable on all the OAM servers in the DSR topology after a short propagation delay (typically 3-5 seconds).
It is recommended that MMI clients re-use a valid token for up to its full two hour lifetime, rather than request a new token for each MMI non-authentication request. Requesting a new token for each non-authentication request effectively doubles the number of MMI requests the client sends to the DSR. Clients may observe decreased MMI responsiveness if a new token is requested for every non-authentication MMI request, compared to getting a token and using it for all subsequent MMI requests within its two hour lifetime.
Authorization
The token grants the bearer the same capabilities as the original MMI authentication credentials. GUI and MMI share the same user accounts and permissions database (GUI group) settings. Note that some user accounts may be limited to GUI-only or MMI-only access.
Audit Trail
All uses of a token are logged to the system security log (also shared with the GUI). Token creation and expiration generate events in the system event log.
The Topology Configuration and Management Area
(area: "topo")
The topo area provides RESTful interfaces enabling topology configuration and management for:
- Servers
- Server Groups
- Resource Domains
- Places
- Place Associations
- Network Elements
- Networks
- Network Routes
- Network Devices
- Network Service Paths
- DSCP Port Rules
- DSCP Interface Rules
The topo area covers general server/network/DSR topology configuration - the higher-level configuration that is necessary to support the mission of a DSR. Diameter-specific configuration is not part of the topo area - that is covered by the diameter area for core routing configuration, and several of the other areas, which are specific to the various applications DSR supports.
Management Services
The /topo/servers and /topo/networkelements resources provide the following management and control facilities:
- Server Status - A general summary status report for a server
- Server Management - Server management - reboot and ntpsync
- Server DB Status and Management - Database status and management (backup/restore) for a server
- Server HA Status and Management - High Availability status and management (roles) for a server
- Server Provisioning Status and Management - Data Provisioning status and management for a server
- Server Replication Status and Management - Data Replication status and management for a server
- Server Application Status and Management - Application status and management for a server
- Router Monitoring Status and Management - Gateway Router monitoring management for a network element
In general, a status request returns the current state of the resource (using GET), while a management request updates the resource (using PUT) to change its status.
The Bulk Configuration Area
(area: "bulk")
The bulk area supplies a bulk export/import facility (/bulk/configurator). The bulk export is used to extract configuration information from a DSR in bulk. Bulk export is always done per area, although multiple areas can be specified in a single MMI request. All resources included in the specified area(s) are exported together, and the results are written to an XML file located on the OAM server that received the request. Bulk export of individual resources is not supported.
Bulk import is limited to just the topo area, and is used to deploy the configuration associated with the topology rapidly for one or more DSR sites. The bulk import facility can only be used to insert (POST) configuration instances; it cannot be used to edit or delete configuration.
The import operation is non-atomic; the import operation returns a result code and a list of all the import failures providing details on why the import operation failed. At the end of the import operation, any objects that were successfully configured remain configured; any objects that failed configuration are not configured. It is up to the client to interpret any error messages and take whatever remedial action is necessary to ensure a complete and correct topology configuration.
Some common reasons why an object may fail to be successfully imported are:
- The object is already in the configuration (duplicate id).
- The syntax of the XML specification for the object is incorrect (syntax).
- Internal validation rules block the creation of the object (semantic checks).
- The server is overloaded and cannot handle a new request.
Managed objects cannot be edited or deleted using the import interface. Rather, the individual resource MMI APIs must be used (e.g., DELETE /topo/servers/{servername}).
Bootstrapping
Whenever a new server is created using either the bulk import operation or the topology server insert (POST), the new server needs to be bootstrapped to activate it and enable it to become part of the functioning system topology. Depending on how much configuration was performed on the bare metal or on the new VM by an infrastructure manager, the bootstrap may have more or less to do. The bootstrap is performed by invoking the /topo/servers/{servername}/bootstrap operation directly on the new server, passing a list of bootstrap options. Shortly after the bootstrap has completed, the other servers in the topology should recognize the new server, and the new server is configured and prepared for operation. The progress of the server can be monitored using the server status interface (/topo/servers/{servername}/status).
The System Administration Area
(area: admin)
The system administration (admin) area allows an MMI client to set up the following for the DSR network:
- Domain Name System (DNS) configuration for communication by the DSR with remote servers
- Security Certificates for secure communication between the DSR and remote servers
- Secure File Transfer Protocol (SFTP) User configuration
- Simple Network Management Protocol (SNMP) Trap manager configuration
This area also provides an API for clients to retrieve the DSR software version identifier for the software version currently running on the target OAM server.
The System Monitoring Area
(area: "mon")
The system monitoring (mon) area provides access to:
- Measurements - Historical store of system counters
- Key Performance Indicators - Point in time indicators of system health
- Alarms - Currently active alarms
- Processes - System Process resource impacts
- Tasks - Recently run or running background tasks
- Periodic Tasks - The schedule of regularly executing tasks
The system monitoring interfaces are primarily read-only, and are used to obtain status information about the system.
Scoped Data
In general, when data is requested via MMI from an OAM server, the data received is scoped to that OAM server. Therefore, a request made to the NOAM, which is at the top (A) level of the hierarchy, returns data for all servers in the DSR topology, while a request made to an SOAM (B-level) only returns data scoped to that SOAM Server Group - all SOAM servers in the HA cluster, plus all sub-tending C-level servers.
Some data (notably some measurements and alarms) is scoped to an SOAM, and is not available at the network (NOAM) level. Requests to retrieve SOAM-scoped data must be made to the specific SOAM.
Time-Ordered Data
The /measurements and /alarms services provide access to time-ordered datasets. Requests can be restricted to a specific time range (often useful in post-mortem problem analysis). If no time range is specified, the /measurements resource returns the most current measurements data set, while the alarms service returns all the currently active alarms.
Rate-Limited Data
The /measurements resource is rate-limited. To ensure that the processing costs associated with creating a measurement report do not exceed the available OAM server resources, each query of measurement data counts against a budget allocated for the request interval.
- At the start of each interval (an even 5 minute boundary), the request budget is reset.
- Each measurement query in the request interval subtracts from the budget.
- If a request is made while the budget is empty, the request is rejected.
The /measurements/budget resource can be used to determine the remaining available budget for the current request interval. Each measurement request returns the remaining budget and the cost of the request.
A measurement report cost is calculated based on the following rules:
- Each cell of reported data has a cost of one unit.
- An arrayed measurement with N populated subindexes has a cost of N units.
- Each reported time-interval multiplies the cost by the number of intervals.
- Each reported server multiplies the cost by the number of servers.
Applying these rules, a hypothetical measurement report has a report cost of 15,000,000 if it 1) has arrayed measurements with 15,000 subindexes; 2) spans 100 servers; and 3) includes 10 time-intervals.
Clients typically do not need to keep track of the measurement report budget. Each OAM server should be configured with a budget large enough to support most typical measurement report requests. If a request is submitted after the budget for an interval has been exhausted, the client receives an HTTP response of 429 - too many requests. The measurement report request should be re-submitted later.
The Core Diameter Area
(area: "diameter")
The diameter area includes all of the MMI APIs required to configure a DSR to be a Diameter Relay Agent (DRA). Diameter routing entities like Local Nodes, Peer Nodes, Connections, Route Groups, and Route Lists are all part of the diameter area. Also included is IPFE configuration, which is used to load balance Diameter Connections across a set of DA-MPs.
The discussion of the various patterns (create, update, delete) given in the Introduction & Overview section is highly relevant to the diameter area. Individual Managed Objects and collections of MOs are accessed by the client using the APIs defined for each core Diameter resource. Any operation that completes successfully returns a 2XX HTTP code, while unsuccessful operations return a 4XX HTTP code.
The All Area
(area: all)
The all area includes resources that span functional areas. For this release of the API, the object versioning interface is the only resource included in all.
Overview of Object Versioning
DSR supports the concept of object versioning, so that an MMI client can easily track the configuration changes that are made to the DSR. The configuration level is an integer value that gets incremented each time a change is made, and the configuration level integer exists 1) for the OAM server as a whole to track all changes made to the configuration database, and 2) for each individual resource type to track changes made to the instances of that particular resource.
An MMI client requests the current configuration level data from an OAM server, and uses that data to identify where changes have been made since the last time the client had a current view of the configuration. Clients use the Configuration Levels (/all/configurationlevels) URI to retrieve the current configuration level data, and the response to this request returns the server-scoped integer value (identified by "consolidated" in the response data) as well as the various resource-specific integer values for all resources supported by the OAM server (identified by the specific resource name).
Object versioning via configuration level is not yet included by all the functional areas within the DSR MMI API specification. For this release, only the diameter area supports configuration level.
Change Log
API Version v2.0 ( DSR Release 8.2.0.0.0_82.15.0 )
Backward Compatible Changes
- Added new resource Mcc Mnc (diameter/mccmncs).
- Added new resource Mcc Mnc Mappings (/diameter/mccmncmappings).
- Added new resource Reserved Mcc Ranges (/diameter/reservedmccranges).
- Added new resource Common Application Options (/diameter/commonapplicationoptions).
- Initial Creation for area: rbar.
- Updated GTT Selectors (/vstp/gttselectors). Added new optional attributes - linksetName (Link Set Name), cdgttsn (CdPA GTT Set Name), cggttsn (CgPA GTT Set Name), cgssn (CgPA subsystem number), selid(Selector ID). Marked older attribute gttSetName from required to optional.
- Updated Link Sets (/vstp/linksets). Added new optional attribute gttmode.
- Updated SCCP Options (/vstp/sccpoptions). Added new optional attributes dfltfallback and dfltgttmode.
- Updated GTA (/vstp/globaltitleaddresses). Added new optional attributes - acn (Application Context Name), actsn (Action Set Name), cdselid (Called Party Selector Id), cdssn (Start Called Party SubSytem Number), cgpc (Calling Party Point Code), cgpcaction (Calling Party Point Code Actions), cgselid (Calling Party Selector Id), cgssn (Start Calling Party SubSytem Number), defmapvr (Default MAP Version), domain (Domain), ecdssn (End Called Party SubSytem Number), ecgssn (End Calling Party SubSytem Number), emapaddr (MAP based End Address), fallback (Fallback), family (Family), opc (Origin Point Code), opcode (OpCode), opcsn (Origin Point Code Set Name), optsn (Optional Set Name), pkgtype (Package Type), routingIndicator (Routing Indicator), smapaddr (MAP based Start Address).
- Updated GTT Sets (/vstp/gttsets). Added new optional attribute npsn (Not Present Set Name). Added new enum values - Cdssn, Cdgta, Cgpc, Cgssn, Imsi, Msisdn, Opc, Opcode - for attribute gttSetType.
- Added new resource GTT Action Sets (/vstp/gttactionsets).
- Added new resource GTT Actions (/vstp/gttactions).
Non-Backward Compatible Changes
- Maximum tuple (mapSetId + RSP + SSN) allowed for mapset and mrnset (mrnSetId + RSP) is reduced to 6000 and 3000 respectively.
- Allowed range value for mapSetId and mrnSetId is reduced to 6000 and 1500 respectively. This is applicable for /vstp/mapsets, /vstp/mrnsets, /vstp/gttaddresses and /vstp/gttactions.
- GTT Load sharing features - FGTTLS, IGTTLS and WGTTLS are enabled by default.
Non-Interface Changes
- None
API Version v1.1 ( DSR Release 8.1.0.0.0_81.20.0 )
Backward Compatible Changes
- Updated Software Versions (/admin/softwareversions). Added new attribute - hostname.
- Added new resource Application Priority Options (/diameter/applicationpriorityoptions).
- Updated Connection Configuration Sets (/diameter/connectionconfigurationsets). Added new optional attributes - cl1MinPriorityAllowed, cl2MinPriorityAllowed, cl3MinPriorityAllowed.
- Updated Pending Transaction Limit Configuration Sets (/diameter/pendingtransactionlimitingconfigurationsets). Added new optional attribute - pendConvergenceTime.
- Updated Egress Throttle Group Status (/diameter/egressthrottlegroupstatus). Added new optional attributes - averagePendTransHoldTime, egressRequestRate, numberOfPendingTransactions, offeredTrafficRate, percentTransDiverted, targetEtr.
- Updated Options (/diameter/options). Added new optional attributes - congestionDiscardPolicy, etgMode, ngnPs16PriorityAdminStateEnabled, ngnPsAnswerPriorityMode, ngnPsMaxPriority0Allowed, ngnPsMaxPriority1Allowed, ngnPsMaxPriority2Allowed.
- Updated Options (/diameter/options). Added new readonly attributes - ngnPsMaxNormalRequestPriority.
- Updated Options (/diameter/options). Extended the range - New range for ngnPsMinimumAnswerPriority is [P0,P3,P14,P15], New range for ngnPsMinimumInviolablePriority is [P3,P4,P15,P99].
- Updated Peer Route Rule (/diameter/peerrouterules). Extended the range - New range for msgPriority is [Nc,Pr0,Pr1,Pr2,Pr3,Pr4,Pr5,Pr6,Pr7,Pr8,Pr9,Pr10,Pr11,Pr12,Pr13,Pr14,Pr15].
- Updated Message Priority Configuration Sets (/diameter/messagepriorityconfigurationsets). Max value for priority is increased to 15.
- Added new optional attribute isTrafficMeasuringEnabled in Route Group (/diameter/routegroups).
- Added new optional attribute answerOnAnyEnabledConnection in Peer Node (/diameter/peernodes).
- Added new MP Profiles - Gen9V2_Relay, Gen9V2_Database, and Gen9V2_Session in MP Profile Assignment (/diameter/mpprofileassignments).
- Updated Message Priority Configuration Sets (/diameter/messagepriorityconfigurationsets). Max value for priority is increased to 15.
- Added new resource Signaling Ip Addresses (/diameter/signalingipaddresses).
- Updated Network Devices (/topo/networkdevices). Marked attributes as read only - persistentDhclient, hwAddr, ethtoolOpts, ethtoolAccelOpts.
- Initial Creation for area: vstp.
Non-Backward Compatible Changes
- None
Non-Interface Changes
- Updated descriptions against Onset and Abatement Threshold Levels in Pending Transaction Limiting Configuration Sets (/diameter/pendingtransactionlimitingconfigurationsets).
- Updated descriptions against Onset and Abatement Threshold Levels in Rate Limiting Configuration Sets (/diameter/ratelimitingconfigurationsets).
API Version v1.0 ( DSR Release 8.0.0.0.0_80.25.0 )
Backward Compatible Changes
- Initial Creation for area: admin.
- Initial Creation for area: all.
- Initial Creation for area: appworks.
- Initial Creation for area: auth.
- Initial Creation for area: bulk.
- Initial Creation for area: diameter.
- Initial Creation for area: mon.
- Initial Creation for area: topo.
Non-Backward Compatible Changes
- None
Non-Interface Changes
- None
Admin: DNS Configuration
The DNS Configuration resource allows a client to configure a DNS for use by DSR servers. A DNS is configured in one of two modes: global (e.g., network-wide), or per-site. When configured as global, the same configuration is used by the active NOAM and each active SOAM within the DSR network. If the DNS configuration mode is set to Global, all of the site-specific DNS Configurations are deleted from the DSR; only the single, global DNS Configuration is retained. When configured as per-site, unique DNS configurations can be created for each site, as well as for the NOAM.
Each DNS configuration instance is identified by the OAM Network Element (/topo/servergroups) to which is corresponds. So in global mode, there is just one instance, and it is identified by the configured name of the NOAM Network Element. In per-site mode, there can be up to one instance per configured OAM Network Element. In the current release of DSR, MMI clients can retrieve only a single DSR Configuration instance at a time.
DNS configuration is created, edited, and retrieved at the NOAM, but can also be retrieved from any active SOAM server. No DNS configuration changes can be made at any SOAM.
/admin/dnsconfigurations
post /admin/dnsconfigurations
Adds a new DNS Configuration instance to the DSR configuration. The new instance must be associated with an OAM Network Element that does not already have an instance configured for it.
Target server: NOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/admin/dnsconfiguration/dnsconfiguration.json",
"properties": {
"configurationMode": {
"description": "When set to Global, the DNS configuration instance applies to every OAM Network Element (/topo/networkelements) in the DSR network - the NOAM Network Element and each SOAM Network Element. Setting the configuration mode to Global is only allowed on the NOAM Network Element and doing so will remove all DNS configurations configured on non-NOAM Network Elements. When set to PerSite, each OAM Network Element can have its own unique DNS configuration instance.",
"enum": [
"Global",
"PerSite"
],
"type": "string"
},
"domainSearchOrder": {
"description": "A list of up to six valid domain names, in priority order. If a lower priority search domain is set without the corresponding higher priority search domain set, the DSR automatically elevates the search domain to the highest available (unset) priority.",
"properties": {
"searchDomain1": {
"description": "A valid domain name",
"type": "string"
},
"searchDomain2": {
"description": "A valid domain name",
"type": "string"
},
"searchDomain3": {
"description": "A valid domain name",
"type": "string"
},
"searchDomain4": {
"description": "A valid domain name",
"type": "string"
},
"searchDomain5": {
"description": "A valid domain name",
"type": "string"
},
"searchDomain6": {
"description": "A valid domain name",
"type": "string"
}
},
"type": "object"
},
"nameServer": {
"description": "The address of an external DNS name server. This value must be valid IPv4 or IPv6 address.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"networkElementName": {
"description": "The name of an OAM Network Element to which this DNS configuration instance applies. Must be either the NOAM Network Element name, or the name of one of the configured SOAM Network Elements.",
"maximum": 32,
"minimum": 1,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"configurationMode",
"nameServer",
"networkElementName"
],
"type": "object"
}
Example
{
"configurationMode": "Global",
"domainSearchOrder": {
"searchDomain1": "test1.com",
"searchDomain2": "test2.com",
"searchDomain3": "test3.com"
},
"nameServer": "10.250.50.121",
"networkElementName": "NOAM_NE"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/admin/dnsconfigurations/{networkElementName}
get /admin/dnsconfigurations/{networkElementName}
Returns the details for the specified DNS configuration instance. The instance is specified by the name of the OAM Network Element to which it corresponds. If the named instance does not exist in the DSR configuration, an error message is returned within the HTTP response.
Secured by x-other
Request
URI Parameters
- networkElementName: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/admin/items/dnsconfigurationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/admin/dnsconfiguration/dnsconfiguration.json",
"properties": {
"configurationMode": {
"description": "When set to Global, the DNS configuration instance applies to every OAM Network Element (/topo/networkelements) in the DSR network - the NOAM Network Element and each SOAM Network Element. Setting the configuration mode to Global is only allowed on the NOAM Network Element and doing so will remove all DNS configurations configured on non-NOAM Network Elements. When set to PerSite, each OAM Network Element can have its own unique DNS configuration instance.",
"enum": [
"Global",
"PerSite"
],
"type": "string"
},
"domainSearchOrder": {
"description": "A list of up to six valid domain names, in priority order. If a lower priority search domain is set without the corresponding higher priority search domain set, the DSR automatically elevates the search domain to the highest available (unset) priority.",
"properties": {
"searchDomain1": {
"description": "A valid domain name",
"type": "string"
},
"searchDomain2": {
"description": "A valid domain name",
"type": "string"
},
"searchDomain3": {
"description": "A valid domain name",
"type": "string"
},
"searchDomain4": {
"description": "A valid domain name",
"type": "string"
},
"searchDomain5": {
"description": "A valid domain name",
"type": "string"
},
"searchDomain6": {
"description": "A valid domain name",
"type": "string"
}
},
"type": "object"
},
"nameServer": {
"description": "The address of an external DNS name server. This value must be valid IPv4 or IPv6 address.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"networkElementName": {
"description": "The name of an OAM Network Element to which this DNS configuration instance applies. Must be either the NOAM Network Element name, or the name of one of the configured SOAM Network Elements.",
"maximum": 32,
"minimum": 1,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"configurationMode",
"nameServer",
"networkElementName"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"configurationMode": "Global",
"domainSearchOrder": {
"searchDomain1": "test1.com",
"searchDomain2": "test2.com",
"searchDomain3": "test3.com"
},
"nameServer": "10.250.50.121",
"networkElementName": "NOAM_NE"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /admin/dnsconfigurations/{networkElementName}
Updates the specified DNS configuration instance. The instance is specified by the name of the OAM Network Element to which it corresponds.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- networkElementName: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/admin/dnsconfiguration/dnsconfiguration.json",
"properties": {
"configurationMode": {
"description": "When set to Global, the DNS configuration instance applies to every OAM Network Element (/topo/networkelements) in the DSR network - the NOAM Network Element and each SOAM Network Element. Setting the configuration mode to Global is only allowed on the NOAM Network Element and doing so will remove all DNS configurations configured on non-NOAM Network Elements. When set to PerSite, each OAM Network Element can have its own unique DNS configuration instance.",
"enum": [
"Global",
"PerSite"
],
"type": "string"
},
"domainSearchOrder": {
"description": "A list of up to six valid domain names, in priority order. If a lower priority search domain is set without the corresponding higher priority search domain set, the DSR automatically elevates the search domain to the highest available (unset) priority.",
"properties": {
"searchDomain1": {
"description": "A valid domain name",
"type": "string"
},
"searchDomain2": {
"description": "A valid domain name",
"type": "string"
},
"searchDomain3": {
"description": "A valid domain name",
"type": "string"
},
"searchDomain4": {
"description": "A valid domain name",
"type": "string"
},
"searchDomain5": {
"description": "A valid domain name",
"type": "string"
},
"searchDomain6": {
"description": "A valid domain name",
"type": "string"
}
},
"type": "object"
},
"nameServer": {
"description": "The address of an external DNS name server. This value must be valid IPv4 or IPv6 address.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"networkElementName": {
"description": "The name of an OAM Network Element to which this DNS configuration instance applies. Must be either the NOAM Network Element name, or the name of one of the configured SOAM Network Elements.",
"maximum": 32,
"minimum": 1,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"configurationMode",
"nameServer",
"networkElementName"
],
"type": "object"
}
Example
{
"configurationMode": "Global",
"domainSearchOrder": {
"searchDomain1": "test1.com",
"searchDomain2": "test2.com",
"searchDomain3": "test3.com"
},
"nameServer": "10.250.50.121",
"networkElementName": "NOAM_NE"
}
delete /admin/dnsconfigurations/{networkElementName}
Deletes the specified DNS configuration instance. The instance is specified by the name of the OAM Network Element to which it corresponds.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- networkElementName: required (string)
Admin: Security Certificates
The Security Certificate resource allows a client to configure X.509 certificates and private keys, and to retrieve X.509 certificates.
A private key can be configured with its associated certificate, although only certain certificate types are configured with private keys. Private keys can be configured with a certificate only when first added to the configuration, and private keys cannot be subsequently accessed by the client. Private keys cannot be updated, and are never included in GET response data. If the certificate information for an existing certificate is updated, the updated information is stored with the existing private key. If a private key must be changed, the entire certificate must be deleted and a new one added with the correct private key.
Each certificate (and its associated private key, if configured) is identified by the certificate's Common Name, which is a string embedded within the encrypted certificate information. When a client performs a GET, PUT, or DELETE of a single certificate, the client must first extract the Common Name and use it in the URI sent to the DSR.
In this release of the DSR software, only certificates of type CA or TLS (both used for secure Diameter signaling Connections (/diameter/connections)) can be inserted via MMI into the configuration. Certificates of other types, configured via other means (e.g., the GUI), are returned in a collection GET response so a client has access to all configured certificiates. But these other types cannot currently be added to the DSR configuration using the machine-to-machine interface.
Certificate configuration is created, edited, and retrieved at the NOAM, but certificates can also be retrieved from any active SOAM server. No certificate changes can be made at any SOAM.
/admin/securitycertificates
get /admin/securitycertificates
Returns all configured Security Certificates, regardless of type, but never includes private keys or passphrases.
Target server: NOAM or SOAM
Secured by x-other
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/admin/collections/securitycertificateCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/admin/securitycertificate/securitycertificate.json",
"properties": {
"name": {
"description": "The name for this certificate. The DSR assigns the name string; it is never assigned by the client. For most certificate types, this string is the Common Name taken directly from the contents of the certificate itself. The exception is for certificates of type SSOLocal, where the name string is the Single Sign-On zone name. There is no definable pattern that certificate name strings must follow.",
"maxLength": 64,
"readOnly": true,
"type": "string"
},
"passphrase": {
"description": "If a privateKey is provided, it may be encrypted by the client using a passphrase. In this case, the passphrase must be provided so the DSR can decrypt the privateKey before using it. The passphrase should be omitted if the privateKey is not encrypted. The passphrase is not stored by the DSR. When certificate information is retrieved from the DSR via any GET operation, the passphrase attribute is never present in the response. There is no definable pattern that passphrase strings must follow.",
"maxLength": 15,
"type": "string"
},
"privateKey": {
"description": "The private key used in association with the public key stored in the x509Certificate. Private keys are only used with certain certificateTypes, typically including TLS and the HTTPS types. Once the privateKey is first inserted into the DSR configuration, it cannot be retrieved nor updated. When certificate information is retrieved from the DSR via any GET operation, the privateKey attribute is never present in the response. There is no definable pattern that privateKey strings must follow.",
"maxLength": 2048,
"type": "string"
},
"certificateType": {
"description": "Identifies the security certificate type. The type is based on the certificate's use within the DSR. Ca and Tls certificates are used when establishing a secure Diameter Connection (/diameter/connections) between the DSR and a Peer Node. The Ldap certificate is used when establishing a secure channel between the DSR and an external LDAP server. The three HTTPS types apply to secure HTTP links between clients and DSR OAM servers. An HttpsWildcard certificate spans the entire DSR network, meaning all OAM servers within the DSR network use the same HTTPS certificate. An HttpsServerGroup certficate is scoped to the OAM servers within an NOAM or SOAM Server Group (/topo/servergroups), while an HttpsServer certificate applies to just a single OAM server (/topo/servers). Finally, the SsoLocal certificate is used when a Single Sign-On zone for GUI access is configured for the DSR. For this release of the DSR sofrtware, the only certificate types that can be inserted by the client using the /admin/securitycertificates API are Ca and Tls. Certificates of other types may be present in the DSR configuration if they were inserted by other means (e.g., the GUI), and those other types will be present in the response to a client's request to GET all certificate data.",
"enum": [
"Ca",
"Ldap",
"HttpsServer",
"HttpsServerGroup",
"HttpsWildcard",
"SsoLocal",
"SsoRemote",
"Tls"
],
"readOnly": true,
"type": "string"
},
"x509Certificate": {
"description": "The Privacy Enhanced Mail (PEM)-encoded X.509 security certificate.",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"x509Certificate"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"name": "SERVER",
"certificateType": "TLS",
"x509Certificate": "-----BEGIN CERTIFICATE-----\nMIICqzCCAhQCAQEwDQYJKoZIhvcNAQEEBQAwgZ4xCzAJBgNVBAYTAlVTMRcwFQYD\nVQQIDA5Ob3J0aCBDYXJvbGluYTEUMBIGA1UEBwwLTW9ycmlzdmlsbGUxDzANBgNV\nBAoMBk9yYWNsZTEQMA4GA1UECwwHQ0FfVGVzdDETMBEGA1UEAwwKU3RraXR0c19D\nQTEoMCYGCSqGSIb3DQEJARYZbWF0dGhldy5maXNoZXJAb3JhY2xlLmNvbTAeFw0x\nNjExMDExNzE4MDlaFw0xNzExMDExNzE4MDlaMIGcMQswCQYDVQQGEwJVUzEXMBUG\nA1UECAwOTm9ydGggQ2Fyb2xpbmExFDASBgNVBAcMC01vcnJpc3ZpbGxlMQ8wDQYD\nVQQKDAZPcmFjbGUxETAPBgNVBAsMCFRlc3RUZXN0MRAwDgYDVQQDDAdTdGtpdHRz\nMSgwJgYJKoZIhvcNAQkBFhltYXR0aGV3LmZpc2hlckBvcmFjbGUuY29tMIGfMA0G\nCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDnEgS08aLnFra8tozs61tYAd09dgRWHSet\nGR/qrmUbNW5b2Xpqvn+CsTxipQIxp0PjeN0X3PuMCQDGudDfkGLXke/cCcyZMZ2N\nSdvMyxVOx8AR2+drkPpe8K/6jfhCorsfD1TzlW0rigTfgIvO8BhD3pnBZF+41o8C\nF0/FrLCy7QIDAQABMA0GCSqGSIb3DQEBBAUAA4GBAAeOdSl85XPoeUFLyZvwfyDD\noydRy82Kw/gmoTR+O7PCFZlR3vwNv/cR9eYnGcn981SSpdwnKhCjjW7vpYORtnos\nLOC2f08Xa5spqT/d/4nEbxyfXyM6SU5wagsuh8wuqrQMUd/P4+qL5ruRhAzT4oNc\n2I22+7hxvXZXXg/EmsT4\n-----END CERTIFICATE-----"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /admin/securitycertificates
Adds a new Security Certificate to the DSR configuration. In this release of the DSR software, only certificates for secure Diameter signaling Connections (/diameter/connections) - type CA or TLS - can be added via the POST operation.
Target Server: NOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/admin/securitycertificate/securitycertificate.json",
"properties": {
"name": {
"description": "The name for this certificate. The DSR assigns the name string; it is never assigned by the client. For most certificate types, this string is the Common Name taken directly from the contents of the certificate itself. The exception is for certificates of type SSOLocal, where the name string is the Single Sign-On zone name. There is no definable pattern that certificate name strings must follow.",
"maxLength": 64,
"readOnly": true,
"type": "string"
},
"passphrase": {
"description": "If a privateKey is provided, it may be encrypted by the client using a passphrase. In this case, the passphrase must be provided so the DSR can decrypt the privateKey before using it. The passphrase should be omitted if the privateKey is not encrypted. The passphrase is not stored by the DSR. When certificate information is retrieved from the DSR via any GET operation, the passphrase attribute is never present in the response. There is no definable pattern that passphrase strings must follow.",
"maxLength": 15,
"type": "string"
},
"privateKey": {
"description": "The private key used in association with the public key stored in the x509Certificate. Private keys are only used with certain certificateTypes, typically including TLS and the HTTPS types. Once the privateKey is first inserted into the DSR configuration, it cannot be retrieved nor updated. When certificate information is retrieved from the DSR via any GET operation, the privateKey attribute is never present in the response. There is no definable pattern that privateKey strings must follow.",
"maxLength": 2048,
"type": "string"
},
"certificateType": {
"description": "Identifies the security certificate type. The type is based on the certificate's use within the DSR. Ca and Tls certificates are used when establishing a secure Diameter Connection (/diameter/connections) between the DSR and a Peer Node. The Ldap certificate is used when establishing a secure channel between the DSR and an external LDAP server. The three HTTPS types apply to secure HTTP links between clients and DSR OAM servers. An HttpsWildcard certificate spans the entire DSR network, meaning all OAM servers within the DSR network use the same HTTPS certificate. An HttpsServerGroup certficate is scoped to the OAM servers within an NOAM or SOAM Server Group (/topo/servergroups), while an HttpsServer certificate applies to just a single OAM server (/topo/servers). Finally, the SsoLocal certificate is used when a Single Sign-On zone for GUI access is configured for the DSR. For this release of the DSR sofrtware, the only certificate types that can be inserted by the client using the /admin/securitycertificates API are Ca and Tls. Certificates of other types may be present in the DSR configuration if they were inserted by other means (e.g., the GUI), and those other types will be present in the response to a client's request to GET all certificate data.",
"enum": [
"Ca",
"Ldap",
"HttpsServer",
"HttpsServerGroup",
"HttpsWildcard",
"SsoLocal",
"SsoRemote",
"Tls"
],
"readOnly": true,
"type": "string"
},
"x509Certificate": {
"description": "The Privacy Enhanced Mail (PEM)-encoded X.509 security certificate.",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"x509Certificate"
],
"type": "object"
}
Example
{
"name": "SERVER",
"certificateType": "TLS",
"x509Certificate": "-----BEGIN CERTIFICATE-----\nMIICqzCCAhQCAQEwDQYJKoZIhvcNAQEEBQAwgZ4xCzAJBgNVBAYTAlVTMRcwFQYD\nVQQIDA5Ob3J0aCBDYXJvbGluYTEUMBIGA1UEBwwLTW9ycmlzdmlsbGUxDzANBgNV\nBAoMBk9yYWNsZTEQMA4GA1UECwwHQ0FfVGVzdDETMBEGA1UEAwwKU3RraXR0c19D\nQTEoMCYGCSqGSIb3DQEJARYZbWF0dGhldy5maXNoZXJAb3JhY2xlLmNvbTAeFw0x\nNjExMDExNzE4MDlaFw0xNzExMDExNzE4MDlaMIGcMQswCQYDVQQGEwJVUzEXMBUG\nA1UECAwOTm9ydGggQ2Fyb2xpbmExFDASBgNVBAcMC01vcnJpc3ZpbGxlMQ8wDQYD\nVQQKDAZPcmFjbGUxETAPBgNVBAsMCFRlc3RUZXN0MRAwDgYDVQQDDAdTdGtpdHRz\nMSgwJgYJKoZIhvcNAQkBFhltYXR0aGV3LmZpc2hlckBvcmFjbGUuY29tMIGfMA0G\nCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDnEgS08aLnFra8tozs61tYAd09dgRWHSet\nGR/qrmUbNW5b2Xpqvn+CsTxipQIxp0PjeN0X3PuMCQDGudDfkGLXke/cCcyZMZ2N\nSdvMyxVOx8AR2+drkPpe8K/6jfhCorsfD1TzlW0rigTfgIvO8BhD3pnBZF+41o8C\nF0/FrLCy7QIDAQABMA0GCSqGSIb3DQEBBAUAA4GBAAeOdSl85XPoeUFLyZvwfyDD\noydRy82Kw/gmoTR+O7PCFZlR3vwNv/cR9eYnGcn981SSpdwnKhCjjW7vpYORtnos\nLOC2f08Xa5spqT/d/4nEbxyfXyM6SU5wagsuh8wuqrQMUd/P4+qL5ruRhAzT4oNc\n2I22+7hxvXZXXg/EmsT4\n-----END CERTIFICATE-----"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/admin/securitycertificates/{name}
get /admin/securitycertificates/{name}
Returns the specified Security Certificate. The certificate is identified by its Common Name. If the named Security Certificate does not exist in the OAM's configuration, an error message is returned within the HTTP response.
Target Server: NOAM or SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/admin/items/securitycertificateItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/admin/securitycertificate/securitycertificate.json",
"properties": {
"name": {
"description": "The name for this certificate. The DSR assigns the name string; it is never assigned by the client. For most certificate types, this string is the Common Name taken directly from the contents of the certificate itself. The exception is for certificates of type SSOLocal, where the name string is the Single Sign-On zone name. There is no definable pattern that certificate name strings must follow.",
"maxLength": 64,
"readOnly": true,
"type": "string"
},
"passphrase": {
"description": "If a privateKey is provided, it may be encrypted by the client using a passphrase. In this case, the passphrase must be provided so the DSR can decrypt the privateKey before using it. The passphrase should be omitted if the privateKey is not encrypted. The passphrase is not stored by the DSR. When certificate information is retrieved from the DSR via any GET operation, the passphrase attribute is never present in the response. There is no definable pattern that passphrase strings must follow.",
"maxLength": 15,
"type": "string"
},
"privateKey": {
"description": "The private key used in association with the public key stored in the x509Certificate. Private keys are only used with certain certificateTypes, typically including TLS and the HTTPS types. Once the privateKey is first inserted into the DSR configuration, it cannot be retrieved nor updated. When certificate information is retrieved from the DSR via any GET operation, the privateKey attribute is never present in the response. There is no definable pattern that privateKey strings must follow.",
"maxLength": 2048,
"type": "string"
},
"certificateType": {
"description": "Identifies the security certificate type. The type is based on the certificate's use within the DSR. Ca and Tls certificates are used when establishing a secure Diameter Connection (/diameter/connections) between the DSR and a Peer Node. The Ldap certificate is used when establishing a secure channel between the DSR and an external LDAP server. The three HTTPS types apply to secure HTTP links between clients and DSR OAM servers. An HttpsWildcard certificate spans the entire DSR network, meaning all OAM servers within the DSR network use the same HTTPS certificate. An HttpsServerGroup certficate is scoped to the OAM servers within an NOAM or SOAM Server Group (/topo/servergroups), while an HttpsServer certificate applies to just a single OAM server (/topo/servers). Finally, the SsoLocal certificate is used when a Single Sign-On zone for GUI access is configured for the DSR. For this release of the DSR sofrtware, the only certificate types that can be inserted by the client using the /admin/securitycertificates API are Ca and Tls. Certificates of other types may be present in the DSR configuration if they were inserted by other means (e.g., the GUI), and those other types will be present in the response to a client's request to GET all certificate data.",
"enum": [
"Ca",
"Ldap",
"HttpsServer",
"HttpsServerGroup",
"HttpsWildcard",
"SsoLocal",
"SsoRemote",
"Tls"
],
"readOnly": true,
"type": "string"
},
"x509Certificate": {
"description": "The Privacy Enhanced Mail (PEM)-encoded X.509 security certificate.",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"x509Certificate"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"name": "SERVER",
"certificateType": "TLS",
"x509Certificate": "-----BEGIN CERTIFICATE-----\nMIICqzCCAhQCAQEwDQYJKoZIhvcNAQEEBQAwgZ4xCzAJBgNVBAYTAlVTMRcwFQYD\nVQQIDA5Ob3J0aCBDYXJvbGluYTEUMBIGA1UEBwwLTW9ycmlzdmlsbGUxDzANBgNV\nBAoMBk9yYWNsZTEQMA4GA1UECwwHQ0FfVGVzdDETMBEGA1UEAwwKU3RraXR0c19D\nQTEoMCYGCSqGSIb3DQEJARYZbWF0dGhldy5maXNoZXJAb3JhY2xlLmNvbTAeFw0x\nNjExMDExNzE4MDlaFw0xNzExMDExNzE4MDlaMIGcMQswCQYDVQQGEwJVUzEXMBUG\nA1UECAwOTm9ydGggQ2Fyb2xpbmExFDASBgNVBAcMC01vcnJpc3ZpbGxlMQ8wDQYD\nVQQKDAZPcmFjbGUxETAPBgNVBAsMCFRlc3RUZXN0MRAwDgYDVQQDDAdTdGtpdHRz\nMSgwJgYJKoZIhvcNAQkBFhltYXR0aGV3LmZpc2hlckBvcmFjbGUuY29tMIGfMA0G\nCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDnEgS08aLnFra8tozs61tYAd09dgRWHSet\nGR/qrmUbNW5b2Xpqvn+CsTxipQIxp0PjeN0X3PuMCQDGudDfkGLXke/cCcyZMZ2N\nSdvMyxVOx8AR2+drkPpe8K/6jfhCorsfD1TzlW0rigTfgIvO8BhD3pnBZF+41o8C\nF0/FrLCy7QIDAQABMA0GCSqGSIb3DQEBBAUAA4GBAAeOdSl85XPoeUFLyZvwfyDD\noydRy82Kw/gmoTR+O7PCFZlR3vwNv/cR9eYnGcn981SSpdwnKhCjjW7vpYORtnos\nLOC2f08Xa5spqT/d/4nEbxyfXyM6SU5wagsuh8wuqrQMUd/P4+qL5ruRhAzT4oNc\n2I22+7hxvXZXXg/EmsT4\n-----END CERTIFICATE-----"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /admin/securitycertificates/{name}
Updates the specified Security Certificate. The certificate is identified by its Common Name. Only the X.509 certificate information itself can be updated - private keys and passphrases cannot be updated for an existing certificate. If a private key or passphrase must be updated, the certificate should be deleted, then inserted back into the configuration with the desired private key and/or passphrase.
Target Server: NOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/admin/securitycertificate/securitycertificate.json",
"properties": {
"name": {
"description": "The name for this certificate. The DSR assigns the name string; it is never assigned by the client. For most certificate types, this string is the Common Name taken directly from the contents of the certificate itself. The exception is for certificates of type SSOLocal, where the name string is the Single Sign-On zone name. There is no definable pattern that certificate name strings must follow.",
"maxLength": 64,
"readOnly": true,
"type": "string"
},
"passphrase": {
"description": "If a privateKey is provided, it may be encrypted by the client using a passphrase. In this case, the passphrase must be provided so the DSR can decrypt the privateKey before using it. The passphrase should be omitted if the privateKey is not encrypted. The passphrase is not stored by the DSR. When certificate information is retrieved from the DSR via any GET operation, the passphrase attribute is never present in the response. There is no definable pattern that passphrase strings must follow.",
"maxLength": 15,
"type": "string"
},
"privateKey": {
"description": "The private key used in association with the public key stored in the x509Certificate. Private keys are only used with certain certificateTypes, typically including TLS and the HTTPS types. Once the privateKey is first inserted into the DSR configuration, it cannot be retrieved nor updated. When certificate information is retrieved from the DSR via any GET operation, the privateKey attribute is never present in the response. There is no definable pattern that privateKey strings must follow.",
"maxLength": 2048,
"type": "string"
},
"certificateType": {
"description": "Identifies the security certificate type. The type is based on the certificate's use within the DSR. Ca and Tls certificates are used when establishing a secure Diameter Connection (/diameter/connections) between the DSR and a Peer Node. The Ldap certificate is used when establishing a secure channel between the DSR and an external LDAP server. The three HTTPS types apply to secure HTTP links between clients and DSR OAM servers. An HttpsWildcard certificate spans the entire DSR network, meaning all OAM servers within the DSR network use the same HTTPS certificate. An HttpsServerGroup certficate is scoped to the OAM servers within an NOAM or SOAM Server Group (/topo/servergroups), while an HttpsServer certificate applies to just a single OAM server (/topo/servers). Finally, the SsoLocal certificate is used when a Single Sign-On zone for GUI access is configured for the DSR. For this release of the DSR sofrtware, the only certificate types that can be inserted by the client using the /admin/securitycertificates API are Ca and Tls. Certificates of other types may be present in the DSR configuration if they were inserted by other means (e.g., the GUI), and those other types will be present in the response to a client's request to GET all certificate data.",
"enum": [
"Ca",
"Ldap",
"HttpsServer",
"HttpsServerGroup",
"HttpsWildcard",
"SsoLocal",
"SsoRemote",
"Tls"
],
"readOnly": true,
"type": "string"
},
"x509Certificate": {
"description": "The Privacy Enhanced Mail (PEM)-encoded X.509 security certificate.",
"maxLength": 2048,
"type": "string"
}
},
"required": [
"x509Certificate"
],
"type": "object"
}
Example
{
"name": "SERVER",
"certificateType": "TLS",
"x509Certificate": "-----BEGIN CERTIFICATE-----\nMIICqzCCAhQCAQEwDQYJKoZIhvcNAQEEBQAwgZ4xCzAJBgNVBAYTAlVTMRcwFQYD\nVQQIDA5Ob3J0aCBDYXJvbGluYTEUMBIGA1UEBwwLTW9ycmlzdmlsbGUxDzANBgNV\nBAoMBk9yYWNsZTEQMA4GA1UECwwHQ0FfVGVzdDETMBEGA1UEAwwKU3RraXR0c19D\nQTEoMCYGCSqGSIb3DQEJARYZbWF0dGhldy5maXNoZXJAb3JhY2xlLmNvbTAeFw0x\nNjExMDExNzE4MDlaFw0xNzExMDExNzE4MDlaMIGcMQswCQYDVQQGEwJVUzEXMBUG\nA1UECAwOTm9ydGggQ2Fyb2xpbmExFDASBgNVBAcMC01vcnJpc3ZpbGxlMQ8wDQYD\nVQQKDAZPcmFjbGUxETAPBgNVBAsMCFRlc3RUZXN0MRAwDgYDVQQDDAdTdGtpdHRz\nMSgwJgYJKoZIhvcNAQkBFhltYXR0aGV3LmZpc2hlckBvcmFjbGUuY29tMIGfMA0G\nCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDnEgS08aLnFra8tozs61tYAd09dgRWHSet\nGR/qrmUbNW5b2Xpqvn+CsTxipQIxp0PjeN0X3PuMCQDGudDfkGLXke/cCcyZMZ2N\nSdvMyxVOx8AR2+drkPpe8K/6jfhCorsfD1TzlW0rigTfgIvO8BhD3pnBZF+41o8C\nF0/FrLCy7QIDAQABMA0GCSqGSIb3DQEBBAUAA4GBAAeOdSl85XPoeUFLyZvwfyDD\noydRy82Kw/gmoTR+O7PCFZlR3vwNv/cR9eYnGcn981SSpdwnKhCjjW7vpYORtnos\nLOC2f08Xa5spqT/d/4nEbxyfXyM6SU5wagsuh8wuqrQMUd/P4+qL5ruRhAzT4oNc\n2I22+7hxvXZXXg/EmsT4\n-----END CERTIFICATE-----"
}
delete /admin/securitycertificates/{name}
Deletes the specified Security Certificate from the DSR configuration. The certificate is identified by its Common Name.
Target Server: NOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Admin: SFTP Users
The Secure File Transfer Protocol (SFTP) User resource allows a client to configure user accounts such that external servers can have SFTP access to Measurements, Events, Alarms, and Logs (MEAL) data stored on the DSR. SFTP User access to the DSR must be authenticated, and so each SFTP User configured must have either a Secure Shell (SSH) key or a password configured to it. Once properly configured, an authenticated user can retrieve MEAL data from the DSR using SFTP.
SFTP User configuration is created, edited, and retrieved at the NOAM, but can also be retrieved from any active SOAM server. No SFTP User configuration changes can be made at any SOAM.
/admin/sftpusers
get /admin/sftpusers
Returns all SFTP user accounts configured at the DSR.
Target Server: NOAM or SOAM
Secured by x-other
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/admin/collections/sftpuserCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/admin/sftpuser/sftpuser.json",
"properties": {
"comment": {
"description": "Comments about the SFTP user.",
"maxLength": 100,
"type": "string"
},
"permissions": {
"description": "Permissions associated with the SFTP User account. The SFTP user is only able to access export files matching their assigned permission level.",
"enum": [
"MeasurementsAlarmsEvents",
"SecurityLogs",
"MeasurementsAlarmsEventsSecurityLogs"
],
"type": "string"
},
"username": {
"description": "User name for the SFTP account. Valid character are between 5 and 32 lowercase alphanumeric charaters.",
"maxLength": 32,
"minLength": 5,
"pattern": "^[0-9a-z]{5,32}$",
"type": "string"
},
"sshKey": {
"description": "The SSH public key to use with this SFTP account. The key is typically generated using the ssh-keygen utility; the key starts with a type of 'ssh-rsa' or 'ssh-dsa', and is followed by the encoded key value. Anything following the key value (typically a comment string) is ignored.",
"maxLength": 8518,
"type": "string"
}
},
"required": [
"permissions",
"username"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"comments": "User is Admin",
"permissions": "MeasurementsAlarmsEvents",
"username": "sftpadministrator",
"sshKey": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAgEAu1UzDEI96E9oVC0HHM/3DNHfa1dCjseXZsD9QeNLRTrQqZajPe1Q2JHI+q9txyzhCnAkySRLQTSxCjEaUREFQ6B6ecrZJcwoDBcfkVblHQU/ZifN652nFqIHotN/4TGcN1H7p7pagCp3Wmm3647xhRM6dhJ40/zn8h79/x4PxjvUmGpe6B8dEz+TMEYLM3pFq9cdK98nPcJssbHgOgW+IAljeyGkCoCKBjFhKOEdh2hiH5BMBy3BckvPNG01szNZYk3KFCW8tCGjlY1yYQfj+c83nriBqX3bB6CM8zw9yHYTEFJMRKvAbandlUEc+UfFXVOFiuh6tK6Zww7yBbjweNe6tTBqboWIcTaCxjlr1t3AZnHq8BSt2iF78TUs+hINSM9r7sYppEp9J/pLnTM+83ZhH87PIvVMG9BfZlmGewtrp4i1FWtEiNkxod0706/IlXlrn4WiiSlCNoH4TxcDziQzu+MazDSAPBbS6qX8BPPNpdjIGaxKvEVk0nitTnUOtoV6Fke7SLL5UNWKIQTnYgoUMFhg7ZiHgizD0T49iF+k83UiA/XA440xVXFOGonqzQ30lvDwOjTMCqBNjlv+7zXCVr7TRYDpFUIXpujmFEkYla8iJWICISQ3p7pEGGFHuB1iP+4Rb/f2vF2OK9EiFzvn/wu/5Dt3dVMz4oHcfsk= root@amber-noa"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /admin/sftpusers
Adds a new SFTP user account. The new SFTP username must be unique within the DSR configuration.
Target Server: NOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/admin/sftpuser/sftpuser.json",
"properties": {
"comment": {
"description": "Comments about the SFTP user.",
"maxLength": 100,
"type": "string"
},
"permissions": {
"description": "Permissions associated with the SFTP User account. The SFTP user is only able to access export files matching their assigned permission level.",
"enum": [
"MeasurementsAlarmsEvents",
"SecurityLogs",
"MeasurementsAlarmsEventsSecurityLogs"
],
"type": "string"
},
"username": {
"description": "User name for the SFTP account. Valid character are between 5 and 32 lowercase alphanumeric charaters.",
"maxLength": 32,
"minLength": 5,
"pattern": "^[0-9a-z]{5,32}$",
"type": "string"
},
"sshKey": {
"description": "The SSH public key to use with this SFTP account. The key is typically generated using the ssh-keygen utility; the key starts with a type of 'ssh-rsa' or 'ssh-dsa', and is followed by the encoded key value. Anything following the key value (typically a comment string) is ignored.",
"maxLength": 8518,
"type": "string"
}
},
"required": [
"permissions",
"username"
],
"type": "object"
}
Example
{
"comments": "User is Admin",
"permissions": "MeasurementsAlarmsEvents",
"username": "sftpadministrator",
"sshKey": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAgEAu1UzDEI96E9oVC0HHM/3DNHfa1dCjseXZsD9QeNLRTrQqZajPe1Q2JHI+q9txyzhCnAkySRLQTSxCjEaUREFQ6B6ecrZJcwoDBcfkVblHQU/ZifN652nFqIHotN/4TGcN1H7p7pagCp3Wmm3647xhRM6dhJ40/zn8h79/x4PxjvUmGpe6B8dEz+TMEYLM3pFq9cdK98nPcJssbHgOgW+IAljeyGkCoCKBjFhKOEdh2hiH5BMBy3BckvPNG01szNZYk3KFCW8tCGjlY1yYQfj+c83nriBqX3bB6CM8zw9yHYTEFJMRKvAbandlUEc+UfFXVOFiuh6tK6Zww7yBbjweNe6tTBqboWIcTaCxjlr1t3AZnHq8BSt2iF78TUs+hINSM9r7sYppEp9J/pLnTM+83ZhH87PIvVMG9BfZlmGewtrp4i1FWtEiNkxod0706/IlXlrn4WiiSlCNoH4TxcDziQzu+MazDSAPBbS6qX8BPPNpdjIGaxKvEVk0nitTnUOtoV6Fke7SLL5UNWKIQTnYgoUMFhg7ZiHgizD0T49iF+k83UiA/XA440xVXFOGonqzQ30lvDwOjTMCqBNjlv+7zXCVr7TRYDpFUIXpujmFEkYla8iJWICISQ3p7pEGGFHuB1iP+4Rb/f2vF2OK9EiFzvn/wu/5Dt3dVMz4oHcfsk= root@amber-noa"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/admin/sftpusers/{username}
get /admin/sftpusers/{username}
Returns the configuration details for the specified SFTP user account. If the specified SFTP user does not exist in the NOAM's configuration, an error message is returned within the HTTP reponse.
Target Server: NOAM or SOAM
Secured by x-other
Request
URI Parameters
- username: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/admin/sftpuser/sftpuser.json",
"properties": {
"comment": {
"description": "Comments about the SFTP user.",
"maxLength": 100,
"type": "string"
},
"permissions": {
"description": "Permissions associated with the SFTP User account. The SFTP user is only able to access export files matching their assigned permission level.",
"enum": [
"MeasurementsAlarmsEvents",
"SecurityLogs",
"MeasurementsAlarmsEventsSecurityLogs"
],
"type": "string"
},
"username": {
"description": "User name for the SFTP account. Valid character are between 5 and 32 lowercase alphanumeric charaters.",
"maxLength": 32,
"minLength": 5,
"pattern": "^[0-9a-z]{5,32}$",
"type": "string"
},
"sshKey": {
"description": "The SSH public key to use with this SFTP account. The key is typically generated using the ssh-keygen utility; the key starts with a type of 'ssh-rsa' or 'ssh-dsa', and is followed by the encoded key value. Anything following the key value (typically a comment string) is ignored.",
"maxLength": 8518,
"type": "string"
}
},
"required": [
"permissions",
"username"
],
"type": "object"
}
Example
{
"data":
{
"comments": "User is Admin",
"permissions": "MeasurementsAlarmsEvents",
"username": "sftpadministrator",
"sshKey": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAgEAu1UzDEI96E9oVC0HHM/3DNHfa1dCjseXZsD9QeNLRTrQqZajPe1Q2JHI+q9txyzhCnAkySRLQTSxCjEaUREFQ6B6ecrZJcwoDBcfkVblHQU/ZifN652nFqIHotN/4TGcN1H7p7pagCp3Wmm3647xhRM6dhJ40/zn8h79/x4PxjvUmGpe6B8dEz+TMEYLM3pFq9cdK98nPcJssbHgOgW+IAljeyGkCoCKBjFhKOEdh2hiH5BMBy3BckvPNG01szNZYk3KFCW8tCGjlY1yYQfj+c83nriBqX3bB6CM8zw9yHYTEFJMRKvAbandlUEc+UfFXVOFiuh6tK6Zww7yBbjweNe6tTBqboWIcTaCxjlr1t3AZnHq8BSt2iF78TUs+hINSM9r7sYppEp9J/pLnTM+83ZhH87PIvVMG9BfZlmGewtrp4i1FWtEiNkxod0706/IlXlrn4WiiSlCNoH4TxcDziQzu+MazDSAPBbS6qX8BPPNpdjIGaxKvEVk0nitTnUOtoV6Fke7SLL5UNWKIQTnYgoUMFhg7ZiHgizD0T49iF+k83UiA/XA440xVXFOGonqzQ30lvDwOjTMCqBNjlv+7zXCVr7TRYDpFUIXpujmFEkYla8iJWICISQ3p7pEGGFHuB1iP+4Rb/f2vF2OK9EiFzvn/wu/5Dt3dVMz4oHcfsk= root@amber-noa"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /admin/sftpusers/{username}
Updates the configuration for the SFTP user account. If the provided SFTP user data is invalid in any way, the update fails, resulting in one or more error messages returned within the HTTP response.
Target Server: NOAM
Secured by x-other
Request
URI Parameters
- username: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/admin/sftpuser/sftpuser.json",
"properties": {
"comment": {
"description": "Comments about the SFTP user.",
"maxLength": 100,
"type": "string"
},
"permissions": {
"description": "Permissions associated with the SFTP User account. The SFTP user is only able to access export files matching their assigned permission level.",
"enum": [
"MeasurementsAlarmsEvents",
"SecurityLogs",
"MeasurementsAlarmsEventsSecurityLogs"
],
"type": "string"
},
"username": {
"description": "User name for the SFTP account. Valid character are between 5 and 32 lowercase alphanumeric charaters.",
"maxLength": 32,
"minLength": 5,
"pattern": "^[0-9a-z]{5,32}$",
"type": "string"
},
"sshKey": {
"description": "The SSH public key to use with this SFTP account. The key is typically generated using the ssh-keygen utility; the key starts with a type of 'ssh-rsa' or 'ssh-dsa', and is followed by the encoded key value. Anything following the key value (typically a comment string) is ignored.",
"maxLength": 8518,
"type": "string"
}
},
"required": [
"permissions",
"username"
],
"type": "object"
}
Example
{
"comments": "User is Admin",
"permissions": "MeasurementsAlarmsEvents",
"username": "sftpadministrator",
"sshKey": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAgEAu1UzDEI96E9oVC0HHM/3DNHfa1dCjseXZsD9QeNLRTrQqZajPe1Q2JHI+q9txyzhCnAkySRLQTSxCjEaUREFQ6B6ecrZJcwoDBcfkVblHQU/ZifN652nFqIHotN/4TGcN1H7p7pagCp3Wmm3647xhRM6dhJ40/zn8h79/x4PxjvUmGpe6B8dEz+TMEYLM3pFq9cdK98nPcJssbHgOgW+IAljeyGkCoCKBjFhKOEdh2hiH5BMBy3BckvPNG01szNZYk3KFCW8tCGjlY1yYQfj+c83nriBqX3bB6CM8zw9yHYTEFJMRKvAbandlUEc+UfFXVOFiuh6tK6Zww7yBbjweNe6tTBqboWIcTaCxjlr1t3AZnHq8BSt2iF78TUs+hINSM9r7sYppEp9J/pLnTM+83ZhH87PIvVMG9BfZlmGewtrp4i1FWtEiNkxod0706/IlXlrn4WiiSlCNoH4TxcDziQzu+MazDSAPBbS6qX8BPPNpdjIGaxKvEVk0nitTnUOtoV6Fke7SLL5UNWKIQTnYgoUMFhg7ZiHgizD0T49iF+k83UiA/XA440xVXFOGonqzQ30lvDwOjTMCqBNjlv+7zXCVr7TRYDpFUIXpujmFEkYla8iJWICISQ3p7pEGGFHuB1iP+4Rb/f2vF2OK9EiFzvn/wu/5Dt3dVMz4oHcfsk= root@amber-noa"
}
delete /admin/sftpusers/{username}
Deletes the specified SFTP user from the NOAM configuration.
Target Server: NOAM
Secured by x-other
Request
URI Parameters
- username: required (string)
/admin/sftpusers/{username}/password
put /admin/sftpusers/{username}/password
Add a password or change an existing password for the specified SFTP User account.
Request
URI Parameters
- username: required (string)
Response
HTTP status code 200
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/admin/sftpuser/sftpuserpassword.json",
"properties": {
"sftpUserPassword": {
"description": "Passwords for an SFTP User account must contain at least three of the following characters to be valid: numeric, lowercase letters, uppercase letters, or a special character (!@#$%^&*?~).",
"maxLength": 16,
"minLength": 8,
"type": "string"
}
},
"required": [
"sftpUserPassword"
],
"type": "object"
}
Example
{
"sftpUserPassword": "Password1234&"
}
Admin: SNMP Trapping
The Simple Network Management Protocol (SNMP) Trapping resource allows a client to configure external managers to receive unsolicited SNMP Traps (messages) from DSR servers. SNMP Trapping is configured in one of two modes: global (e.g., network-wide), or per-site. When configured as global, the same configuration is used by the active NOAM and each active SOAM within the DSR network. When configured as per-site, unique SNMP Trapping configuration can be created for each site, as well as for the NOAM.
Each SNMP Trapping configuration instance is identified by the OAM Server Group (/topo/servergroups) to which it corresponds. So in global mode, there is just one instance, and it is identified by the configured name of the NOAM Server Group. In per-site mode, there can be up to one instance per configured OAM Server Group.
SNMP Trapping configuration is created, edited, and retrieved at the NOAM, but can also be retrieved from any active SOAM server. No SNMP Trapping configuration changes can be made at any SOAM.
/admin/snmptrapping
get /admin/snmptrapping
Returns all SNMP Trapping configuration instances.
Target Server: NOAM or SOAM
Secured by x-other
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/admin/collections/snmptrappingCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/admin/snmptrapping/snmptrapping.json",
"properties": {
"configurationMode": {
"description": "When set to Global, the SNMP trap sending configuration instance applies to every OAM Server Group (/topo/servergroups) in the DSR network - the NOAM Server Group and each SOAM Server Group. When set to PerSite, each OAM Server Group can have its own unique SNMP trap sending configuration instance.",
"enum": [
"Global",
"PerSite"
],
"type": "string"
},
"managers": {
"description": "An SNMP Trapping configuration instance can specify up to five remote managers to receive SNMP traps. Each manager specified in this array receives SNMP traps sourced by the OAM Server Group(s) governed by this SNMP Trapping configuration instance.",
"items": {
"properties": {
"identifier": {
"description": "Identifies a remote manager to receive the SNMP traps, if the manager enabled via the enabled attribute. The value for the identifier consists of a network address optionally followed by the port for the remote manager. The network address can either be a valid IPv4 or IPv6 address, or a valid hostname. The port is optional, must be an integer between 1 and 65535, inclusive, and is specified by a colon (:) and port number following the network address. If no port number follows a network address, the standard SNMP trap port 162 is used by the DSR. IPv6 addresses must appear within square brackets if the port number is specified, like this: [IPv6_address]:port. Finally, hostnames are case-insensitive and cannot exceed 255 characters.",
"maxLength": 255,
"type": "string"
},
"enabled": {
"description": "When set to true, SNMP traps are autonomously sent to the external manager by the DSR. When set to false, traps are not sent to the external manager, but can be sent to any other manager that is in the enabled state.",
"type": "boolean"
}
},
"type": "object"
},
"maxItems": 5,
"minItems": 0,
"type": "array"
},
"sendTrapsFromIndividualServers": {
"description": "When set to true, SNMP traps are sent from the individual servers within the scope of this SNMP Trapping configuration instance. When set to false, system-wide traps are sent from the active NOAM server and site-specific traps are sent from active SOAM servers.",
"type": "boolean"
},
"serverGroupName": {
"description": "The name of the OAM Server Group (/topo/servergroups) to which this SNMP Trapping instance applies. Must be either the NOAM Server Group name, or the name of one of the configured SOAM Server Groups.",
"minLength": 1,
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"snmpVersionsEnabled": {
"description": "Indicates which version(s) of SNMP is/are enabled on the DSR. Supported SNMP versions are 2c and 3. When set to V2c or V2cAndV3, snmpV2cOptions must contain valid values. When set to V2cAndV3 or V3, snmpV3Options must contain valid values. Recommended value is V3.",
"enum": [
"V2c",
"V2cAndV3",
"V3"
],
"type": "string"
},
"snmpV2cOptions": {
"description": "The configuration options that must be set if SNMP version 2c is enabled for the DSR. Not required if SNMP version 2c is not enabled.",
"properties": {
"readOnlyCommunityName": {
"description": "The read-only community name. When SNMP Trap information is retrieved from the DSR via any GET operation, the readOnlyCommunityName attribute is never present in the response - it is effectively a write-only attribute..",
"maxLength": 31,
"minLength": 1,
"pattern": "^[a-zA-Z0-9]{1,31}$",
"type": "string"
},
"readWriteCommunityName": {
"description": "The read-write community name. When SNMP Trap information is retrieved from the DSR via any GET operation, the readWriteCommunityName attribute is never present in the response - it is effectively a write-only attribute.",
"maxLength": 31,
"minLength": 1,
"pattern": "^[a-zA-Z0-9]{1,31}$",
"type": "string"
}
},
"type": "object"
},
"snmpV3Options": {
"description": "The configuration options that must be set if SNMP version 3 is enabled for the DSR. Not required if SNMP version 3 is not enabled.",
"properties": {
"authenticationType": {
"description": "The authentication protocol. When set to MD5, Message Digest 5 authentication is used. When set to SHA1, Secure Hash Algorithm 1 is used. Typical value is SHA1.",
"enum": [
"MD5",
"SHA1"
],
"type": "string"
},
"engineId": {
"description": "The configured engine ID, which is a string of 10 to 64 hexadecimal digits.",
"maxLength": 64,
"minLength": 10,
"pattern": "^[a-f0-9]{10,64}$",
"type": "string"
},
"password": {
"description": "The authentication password, associated with username. password is a string of between 8 and 64 characters. When SNMP Trap information is retrieved from the DSR via any GET operation, the password attribute is never present in the response - it is effectively a write-only attribute.",
"maxLength": 64,
"minLength": 8,
"type": "string"
},
"privacyType": {
"description": "The privacy protocol. When set to AES, Advanced Encryption Standard privacy is used. When set to DES, Data Encryption Standard Privacy is used. Typical value is AES.",
"enum": [
"AES",
"DES"
],
"type": "string"
},
"securityLevel": {
"description": "The authentication and privacy options for the given username. When set to NoAuthNoPriv, username is authenticated by user name only, and Privacy (encryption) is not applied. When set to AuthNoPriv, username is authenticated via the method specified by authenticationType, and Privacy is not applied. When set to AuthPriv, username is authenticated via the method specified by authenticationType, and encryption is applied according to the privacyType value.",
"enum": [
"AuthPriv",
"AuthNoPriv",
"NoAuthNoPriv"
],
"type": "string"
},
"username": {
"description": "The SNMP username.",
"maxLength": 32,
"minLength": 1,
"pattern": "^[a-zA-Z0-9]{1,32}$",
"type": "string"
}
},
"type": "object"
},
"trapsSuspended": {
"description": "Set to true by the DSR if the client suspends all traps (/admin/snmptrapping/{name}/suspend) for this SNMP trapping instance. Set to false by the DSR if the client has never suspended traps for this instance, or has resumed sending traps (/admin/snmptrapping/{name}/resume).",
"readOnly": true,
"type": "boolean"
}
},
"required": [
"configurationMode",
"sendTrapsFromIndividualServers",
"serverGroupName",
"snmpVersionsEnabled"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"configurationMode": "PerSite",
"managers": [
{
"identifier": "199.13.47.4:180",
"enabled": false
},
{
"identifier": "SNMPManager1",
"enabled": true
}
],
"sendTrapsFromIndividualServers": false,
"serverGroupName": "SO_SG1",
"snmpVersionsEnabled": "V3",
"snmpV3Options": {
"authenticationType": "SHA1",
"engineId": "800001430c005056010224",
"password": "abcdefghij",
"privacyType": "AES",
"securityLevel": "AuthPriv",
"username": "TekSNMPUser"
},
"trapsSuspended": false
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /admin/snmptrapping
Adds a new SNMP Trapping instance to the DSR configuration. The new instance must be associated with an OAM Server Group that does not already have an instance configured for it.
Target Server: NOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/admin/snmptrapping/snmptrapping.json",
"properties": {
"configurationMode": {
"description": "When set to Global, the SNMP trap sending configuration instance applies to every OAM Server Group (/topo/servergroups) in the DSR network - the NOAM Server Group and each SOAM Server Group. When set to PerSite, each OAM Server Group can have its own unique SNMP trap sending configuration instance.",
"enum": [
"Global",
"PerSite"
],
"type": "string"
},
"managers": {
"description": "An SNMP Trapping configuration instance can specify up to five remote managers to receive SNMP traps. Each manager specified in this array receives SNMP traps sourced by the OAM Server Group(s) governed by this SNMP Trapping configuration instance.",
"items": {
"properties": {
"identifier": {
"description": "Identifies a remote manager to receive the SNMP traps, if the manager enabled via the enabled attribute. The value for the identifier consists of a network address optionally followed by the port for the remote manager. The network address can either be a valid IPv4 or IPv6 address, or a valid hostname. The port is optional, must be an integer between 1 and 65535, inclusive, and is specified by a colon (:) and port number following the network address. If no port number follows a network address, the standard SNMP trap port 162 is used by the DSR. IPv6 addresses must appear within square brackets if the port number is specified, like this: [IPv6_address]:port. Finally, hostnames are case-insensitive and cannot exceed 255 characters.",
"maxLength": 255,
"type": "string"
},
"enabled": {
"description": "When set to true, SNMP traps are autonomously sent to the external manager by the DSR. When set to false, traps are not sent to the external manager, but can be sent to any other manager that is in the enabled state.",
"type": "boolean"
}
},
"type": "object"
},
"maxItems": 5,
"minItems": 0,
"type": "array"
},
"sendTrapsFromIndividualServers": {
"description": "When set to true, SNMP traps are sent from the individual servers within the scope of this SNMP Trapping configuration instance. When set to false, system-wide traps are sent from the active NOAM server and site-specific traps are sent from active SOAM servers.",
"type": "boolean"
},
"serverGroupName": {
"description": "The name of the OAM Server Group (/topo/servergroups) to which this SNMP Trapping instance applies. Must be either the NOAM Server Group name, or the name of one of the configured SOAM Server Groups.",
"minLength": 1,
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"snmpVersionsEnabled": {
"description": "Indicates which version(s) of SNMP is/are enabled on the DSR. Supported SNMP versions are 2c and 3. When set to V2c or V2cAndV3, snmpV2cOptions must contain valid values. When set to V2cAndV3 or V3, snmpV3Options must contain valid values. Recommended value is V3.",
"enum": [
"V2c",
"V2cAndV3",
"V3"
],
"type": "string"
},
"snmpV2cOptions": {
"description": "The configuration options that must be set if SNMP version 2c is enabled for the DSR. Not required if SNMP version 2c is not enabled.",
"properties": {
"readOnlyCommunityName": {
"description": "The read-only community name. When SNMP Trap information is retrieved from the DSR via any GET operation, the readOnlyCommunityName attribute is never present in the response - it is effectively a write-only attribute..",
"maxLength": 31,
"minLength": 1,
"pattern": "^[a-zA-Z0-9]{1,31}$",
"type": "string"
},
"readWriteCommunityName": {
"description": "The read-write community name. When SNMP Trap information is retrieved from the DSR via any GET operation, the readWriteCommunityName attribute is never present in the response - it is effectively a write-only attribute.",
"maxLength": 31,
"minLength": 1,
"pattern": "^[a-zA-Z0-9]{1,31}$",
"type": "string"
}
},
"type": "object"
},
"snmpV3Options": {
"description": "The configuration options that must be set if SNMP version 3 is enabled for the DSR. Not required if SNMP version 3 is not enabled.",
"properties": {
"authenticationType": {
"description": "The authentication protocol. When set to MD5, Message Digest 5 authentication is used. When set to SHA1, Secure Hash Algorithm 1 is used. Typical value is SHA1.",
"enum": [
"MD5",
"SHA1"
],
"type": "string"
},
"engineId": {
"description": "The configured engine ID, which is a string of 10 to 64 hexadecimal digits.",
"maxLength": 64,
"minLength": 10,
"pattern": "^[a-f0-9]{10,64}$",
"type": "string"
},
"password": {
"description": "The authentication password, associated with username. password is a string of between 8 and 64 characters. When SNMP Trap information is retrieved from the DSR via any GET operation, the password attribute is never present in the response - it is effectively a write-only attribute.",
"maxLength": 64,
"minLength": 8,
"type": "string"
},
"privacyType": {
"description": "The privacy protocol. When set to AES, Advanced Encryption Standard privacy is used. When set to DES, Data Encryption Standard Privacy is used. Typical value is AES.",
"enum": [
"AES",
"DES"
],
"type": "string"
},
"securityLevel": {
"description": "The authentication and privacy options for the given username. When set to NoAuthNoPriv, username is authenticated by user name only, and Privacy (encryption) is not applied. When set to AuthNoPriv, username is authenticated via the method specified by authenticationType, and Privacy is not applied. When set to AuthPriv, username is authenticated via the method specified by authenticationType, and encryption is applied according to the privacyType value.",
"enum": [
"AuthPriv",
"AuthNoPriv",
"NoAuthNoPriv"
],
"type": "string"
},
"username": {
"description": "The SNMP username.",
"maxLength": 32,
"minLength": 1,
"pattern": "^[a-zA-Z0-9]{1,32}$",
"type": "string"
}
},
"type": "object"
},
"trapsSuspended": {
"description": "Set to true by the DSR if the client suspends all traps (/admin/snmptrapping/{name}/suspend) for this SNMP trapping instance. Set to false by the DSR if the client has never suspended traps for this instance, or has resumed sending traps (/admin/snmptrapping/{name}/resume).",
"readOnly": true,
"type": "boolean"
}
},
"required": [
"configurationMode",
"sendTrapsFromIndividualServers",
"serverGroupName",
"snmpVersionsEnabled"
],
"type": "object"
}
Example
{
"configurationMode": "PerSite",
"managers": [
{
"identifier": "199.13.47.4:180",
"enabled": false
},
{
"identifier": "SNMPManager1",
"enabled": true
}
],
"sendTrapsFromIndividualServers": false,
"serverGroupName": "SO_SG1",
"snmpVersionsEnabled": "V3",
"snmpV3Options": {
"authenticationType": "SHA1",
"engineId": "800001430c005056010224",
"password": "abcdefghij",
"privacyType": "AES",
"securityLevel": "AuthPriv",
"username": "TekSNMPUser"
},
"trapsSuspended": false
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/admin/snmptrapping/{name}
get /admin/snmptrapping/{name}
Returns the details for the specified SNMP Trapping configuration instance. The instance is specified by the name of the OAM Server Group to which it correponds. If the named instance does not exist in the DSR configuration, an error message is returned within the HTTP response.
Target Server: NOAM or SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/admin/items/snmptrappingItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/admin/snmptrapping/snmptrapping.json",
"properties": {
"configurationMode": {
"description": "When set to Global, the SNMP trap sending configuration instance applies to every OAM Server Group (/topo/servergroups) in the DSR network - the NOAM Server Group and each SOAM Server Group. When set to PerSite, each OAM Server Group can have its own unique SNMP trap sending configuration instance.",
"enum": [
"Global",
"PerSite"
],
"type": "string"
},
"managers": {
"description": "An SNMP Trapping configuration instance can specify up to five remote managers to receive SNMP traps. Each manager specified in this array receives SNMP traps sourced by the OAM Server Group(s) governed by this SNMP Trapping configuration instance.",
"items": {
"properties": {
"identifier": {
"description": "Identifies a remote manager to receive the SNMP traps, if the manager enabled via the enabled attribute. The value for the identifier consists of a network address optionally followed by the port for the remote manager. The network address can either be a valid IPv4 or IPv6 address, or a valid hostname. The port is optional, must be an integer between 1 and 65535, inclusive, and is specified by a colon (:) and port number following the network address. If no port number follows a network address, the standard SNMP trap port 162 is used by the DSR. IPv6 addresses must appear within square brackets if the port number is specified, like this: [IPv6_address]:port. Finally, hostnames are case-insensitive and cannot exceed 255 characters.",
"maxLength": 255,
"type": "string"
},
"enabled": {
"description": "When set to true, SNMP traps are autonomously sent to the external manager by the DSR. When set to false, traps are not sent to the external manager, but can be sent to any other manager that is in the enabled state.",
"type": "boolean"
}
},
"type": "object"
},
"maxItems": 5,
"minItems": 0,
"type": "array"
},
"sendTrapsFromIndividualServers": {
"description": "When set to true, SNMP traps are sent from the individual servers within the scope of this SNMP Trapping configuration instance. When set to false, system-wide traps are sent from the active NOAM server and site-specific traps are sent from active SOAM servers.",
"type": "boolean"
},
"serverGroupName": {
"description": "The name of the OAM Server Group (/topo/servergroups) to which this SNMP Trapping instance applies. Must be either the NOAM Server Group name, or the name of one of the configured SOAM Server Groups.",
"minLength": 1,
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"snmpVersionsEnabled": {
"description": "Indicates which version(s) of SNMP is/are enabled on the DSR. Supported SNMP versions are 2c and 3. When set to V2c or V2cAndV3, snmpV2cOptions must contain valid values. When set to V2cAndV3 or V3, snmpV3Options must contain valid values. Recommended value is V3.",
"enum": [
"V2c",
"V2cAndV3",
"V3"
],
"type": "string"
},
"snmpV2cOptions": {
"description": "The configuration options that must be set if SNMP version 2c is enabled for the DSR. Not required if SNMP version 2c is not enabled.",
"properties": {
"readOnlyCommunityName": {
"description": "The read-only community name. When SNMP Trap information is retrieved from the DSR via any GET operation, the readOnlyCommunityName attribute is never present in the response - it is effectively a write-only attribute..",
"maxLength": 31,
"minLength": 1,
"pattern": "^[a-zA-Z0-9]{1,31}$",
"type": "string"
},
"readWriteCommunityName": {
"description": "The read-write community name. When SNMP Trap information is retrieved from the DSR via any GET operation, the readWriteCommunityName attribute is never present in the response - it is effectively a write-only attribute.",
"maxLength": 31,
"minLength": 1,
"pattern": "^[a-zA-Z0-9]{1,31}$",
"type": "string"
}
},
"type": "object"
},
"snmpV3Options": {
"description": "The configuration options that must be set if SNMP version 3 is enabled for the DSR. Not required if SNMP version 3 is not enabled.",
"properties": {
"authenticationType": {
"description": "The authentication protocol. When set to MD5, Message Digest 5 authentication is used. When set to SHA1, Secure Hash Algorithm 1 is used. Typical value is SHA1.",
"enum": [
"MD5",
"SHA1"
],
"type": "string"
},
"engineId": {
"description": "The configured engine ID, which is a string of 10 to 64 hexadecimal digits.",
"maxLength": 64,
"minLength": 10,
"pattern": "^[a-f0-9]{10,64}$",
"type": "string"
},
"password": {
"description": "The authentication password, associated with username. password is a string of between 8 and 64 characters. When SNMP Trap information is retrieved from the DSR via any GET operation, the password attribute is never present in the response - it is effectively a write-only attribute.",
"maxLength": 64,
"minLength": 8,
"type": "string"
},
"privacyType": {
"description": "The privacy protocol. When set to AES, Advanced Encryption Standard privacy is used. When set to DES, Data Encryption Standard Privacy is used. Typical value is AES.",
"enum": [
"AES",
"DES"
],
"type": "string"
},
"securityLevel": {
"description": "The authentication and privacy options for the given username. When set to NoAuthNoPriv, username is authenticated by user name only, and Privacy (encryption) is not applied. When set to AuthNoPriv, username is authenticated via the method specified by authenticationType, and Privacy is not applied. When set to AuthPriv, username is authenticated via the method specified by authenticationType, and encryption is applied according to the privacyType value.",
"enum": [
"AuthPriv",
"AuthNoPriv",
"NoAuthNoPriv"
],
"type": "string"
},
"username": {
"description": "The SNMP username.",
"maxLength": 32,
"minLength": 1,
"pattern": "^[a-zA-Z0-9]{1,32}$",
"type": "string"
}
},
"type": "object"
},
"trapsSuspended": {
"description": "Set to true by the DSR if the client suspends all traps (/admin/snmptrapping/{name}/suspend) for this SNMP trapping instance. Set to false by the DSR if the client has never suspended traps for this instance, or has resumed sending traps (/admin/snmptrapping/{name}/resume).",
"readOnly": true,
"type": "boolean"
}
},
"required": [
"configurationMode",
"sendTrapsFromIndividualServers",
"serverGroupName",
"snmpVersionsEnabled"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"configurationMode": "PerSite",
"managers": [
{
"identifier": "199.13.47.4:180",
"enabled": false
},
{
"identifier": "SNMPManager1",
"enabled": true
}
],
"sendTrapsFromIndividualServers": false,
"serverGroupName": "SO_SG1",
"snmpVersionsEnabled": "V3",
"snmpV3Options": {
"authenticationType": "SHA1",
"engineId": "800001430c005056010224",
"password": "abcdefghij",
"privacyType": "AES",
"securityLevel": "AuthPriv",
"username": "TekSNMPUser"
},
"trapsSuspended": false
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /admin/snmptrapping/{name}
Updates the specified SNMP Trapping configuration instance. The instance is specified by the name of the OAM Server Group to which it correponds.
Target Server: NOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/admin/snmptrapping/snmptrapping.json",
"properties": {
"configurationMode": {
"description": "When set to Global, the SNMP trap sending configuration instance applies to every OAM Server Group (/topo/servergroups) in the DSR network - the NOAM Server Group and each SOAM Server Group. When set to PerSite, each OAM Server Group can have its own unique SNMP trap sending configuration instance.",
"enum": [
"Global",
"PerSite"
],
"type": "string"
},
"managers": {
"description": "An SNMP Trapping configuration instance can specify up to five remote managers to receive SNMP traps. Each manager specified in this array receives SNMP traps sourced by the OAM Server Group(s) governed by this SNMP Trapping configuration instance.",
"items": {
"properties": {
"identifier": {
"description": "Identifies a remote manager to receive the SNMP traps, if the manager enabled via the enabled attribute. The value for the identifier consists of a network address optionally followed by the port for the remote manager. The network address can either be a valid IPv4 or IPv6 address, or a valid hostname. The port is optional, must be an integer between 1 and 65535, inclusive, and is specified by a colon (:) and port number following the network address. If no port number follows a network address, the standard SNMP trap port 162 is used by the DSR. IPv6 addresses must appear within square brackets if the port number is specified, like this: [IPv6_address]:port. Finally, hostnames are case-insensitive and cannot exceed 255 characters.",
"maxLength": 255,
"type": "string"
},
"enabled": {
"description": "When set to true, SNMP traps are autonomously sent to the external manager by the DSR. When set to false, traps are not sent to the external manager, but can be sent to any other manager that is in the enabled state.",
"type": "boolean"
}
},
"type": "object"
},
"maxItems": 5,
"minItems": 0,
"type": "array"
},
"sendTrapsFromIndividualServers": {
"description": "When set to true, SNMP traps are sent from the individual servers within the scope of this SNMP Trapping configuration instance. When set to false, system-wide traps are sent from the active NOAM server and site-specific traps are sent from active SOAM servers.",
"type": "boolean"
},
"serverGroupName": {
"description": "The name of the OAM Server Group (/topo/servergroups) to which this SNMP Trapping instance applies. Must be either the NOAM Server Group name, or the name of one of the configured SOAM Server Groups.",
"minLength": 1,
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"snmpVersionsEnabled": {
"description": "Indicates which version(s) of SNMP is/are enabled on the DSR. Supported SNMP versions are 2c and 3. When set to V2c or V2cAndV3, snmpV2cOptions must contain valid values. When set to V2cAndV3 or V3, snmpV3Options must contain valid values. Recommended value is V3.",
"enum": [
"V2c",
"V2cAndV3",
"V3"
],
"type": "string"
},
"snmpV2cOptions": {
"description": "The configuration options that must be set if SNMP version 2c is enabled for the DSR. Not required if SNMP version 2c is not enabled.",
"properties": {
"readOnlyCommunityName": {
"description": "The read-only community name. When SNMP Trap information is retrieved from the DSR via any GET operation, the readOnlyCommunityName attribute is never present in the response - it is effectively a write-only attribute..",
"maxLength": 31,
"minLength": 1,
"pattern": "^[a-zA-Z0-9]{1,31}$",
"type": "string"
},
"readWriteCommunityName": {
"description": "The read-write community name. When SNMP Trap information is retrieved from the DSR via any GET operation, the readWriteCommunityName attribute is never present in the response - it is effectively a write-only attribute.",
"maxLength": 31,
"minLength": 1,
"pattern": "^[a-zA-Z0-9]{1,31}$",
"type": "string"
}
},
"type": "object"
},
"snmpV3Options": {
"description": "The configuration options that must be set if SNMP version 3 is enabled for the DSR. Not required if SNMP version 3 is not enabled.",
"properties": {
"authenticationType": {
"description": "The authentication protocol. When set to MD5, Message Digest 5 authentication is used. When set to SHA1, Secure Hash Algorithm 1 is used. Typical value is SHA1.",
"enum": [
"MD5",
"SHA1"
],
"type": "string"
},
"engineId": {
"description": "The configured engine ID, which is a string of 10 to 64 hexadecimal digits.",
"maxLength": 64,
"minLength": 10,
"pattern": "^[a-f0-9]{10,64}$",
"type": "string"
},
"password": {
"description": "The authentication password, associated with username. password is a string of between 8 and 64 characters. When SNMP Trap information is retrieved from the DSR via any GET operation, the password attribute is never present in the response - it is effectively a write-only attribute.",
"maxLength": 64,
"minLength": 8,
"type": "string"
},
"privacyType": {
"description": "The privacy protocol. When set to AES, Advanced Encryption Standard privacy is used. When set to DES, Data Encryption Standard Privacy is used. Typical value is AES.",
"enum": [
"AES",
"DES"
],
"type": "string"
},
"securityLevel": {
"description": "The authentication and privacy options for the given username. When set to NoAuthNoPriv, username is authenticated by user name only, and Privacy (encryption) is not applied. When set to AuthNoPriv, username is authenticated via the method specified by authenticationType, and Privacy is not applied. When set to AuthPriv, username is authenticated via the method specified by authenticationType, and encryption is applied according to the privacyType value.",
"enum": [
"AuthPriv",
"AuthNoPriv",
"NoAuthNoPriv"
],
"type": "string"
},
"username": {
"description": "The SNMP username.",
"maxLength": 32,
"minLength": 1,
"pattern": "^[a-zA-Z0-9]{1,32}$",
"type": "string"
}
},
"type": "object"
},
"trapsSuspended": {
"description": "Set to true by the DSR if the client suspends all traps (/admin/snmptrapping/{name}/suspend) for this SNMP trapping instance. Set to false by the DSR if the client has never suspended traps for this instance, or has resumed sending traps (/admin/snmptrapping/{name}/resume).",
"readOnly": true,
"type": "boolean"
}
},
"required": [
"configurationMode",
"sendTrapsFromIndividualServers",
"serverGroupName",
"snmpVersionsEnabled"
],
"type": "object"
}
Example
{
"configurationMode": "PerSite",
"managers": [
{
"identifier": "199.13.47.4:180",
"enabled": false
},
{
"identifier": "SNMPManager1",
"enabled": true
}
],
"sendTrapsFromIndividualServers": false,
"serverGroupName": "SO_SG1",
"snmpVersionsEnabled": "V3",
"snmpV3Options": {
"authenticationType": "SHA1",
"engineId": "800001430c005056010224",
"password": "abcdefghij",
"privacyType": "AES",
"securityLevel": "AuthPriv",
"username": "TekSNMPUser"
},
"trapsSuspended": false
}
delete /admin/snmptrapping/{name}
Deletes the specified SNMP Trapping configuration instance. The instance is specified by the name of the OAM Server Group to which it corresponds.
Target Server: NOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
/admin/snmptrapping/{name}/suspend
put /admin/snmptrapping/{name}/suspend
Suspends all SNMP Traps from being sent by the OAM (or its subtending servers, if so configured). The current state (suspended/not suspended) is available in the data returned by a GET response.
Target Server: NOAM or SOAM
Request
URI Parameters
- name: required (string)
Response
HTTP status code 202
Successfully suspended SNMP Traps for the specified OAM Server Group (or its subtending servers).
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/bulk/items/emptyItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/bulk/empty/empty.json",
"properties": {
},
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
HTTP status code 400
The SNMP Traps could not be suspended for the specified OAM Server Group.
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/bulk/items/emptyItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/bulk/empty/empty.json",
"properties": {
},
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
/admin/snmptrapping/{name}/resume
put /admin/snmptrapping/{name}/resume
Resumes sending SNMP Traps from the OAM (or its subtending servers, if so configured). The current state (suspended/not suspended) is available in the data returned by a GET response.
Target Server: NOAM or SOAM
Request
URI Parameters
- name: required (string)
Response
HTTP status code 202
Successfully resumed sending SNMP Traps from the specified OAM Server Group (or its subtending servers).
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/bulk/items/emptyItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/bulk/empty/empty.json",
"properties": {
},
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
HTTP status code 400
Sending SNMP Traps could not be resumed for the specified OAM Server Group.
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/bulk/items/emptyItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/bulk/empty/empty.json",
"properties": {
},
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Admin: Versions
The Software Versions resource retrieves the current DSR software version for every Server (/topo/servers) within the topology known to the OAM Server receiving the /softwareversions request.
/admin/softwareversions
get /admin/softwareversions
Retrieves the current DSR software version for every Server(/topo/servers) within the topology known to the OAM Server receiving the /softwareversions request.
Target server: NOAM or SOAM
Secured by x-other
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/admin/collections/softwareversionCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/admin/softwareversion/softwareversion.json",
"properties": {
"application": {
"description": "The top-level software application (or product) for which version information is available.",
"properties": {
"hostname": {
"description": "The name of the Server (/topo/servers).",
"type": "string"
},
"name": {
"description": "The name of the software application (or product).",
"type": "string"
},
"version": {
"description": "The version of the software application (or product).",
"type": "string"
}
},
"type": "object"
},
"installedSoftware": {
"description": "The software entities installed as part of this product.",
"type": "array",
"items": {
"properties": {
"name": {
"description": "The name of the software entity.",
"type": "string"
},
"version": {
"description": "The version of the software entity.",
"type": "string"
}
},
"type": "object"
},
"minItems": 0
}
},
"readOnly": true,
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"application": {
"hostname": "NO1",
"name": "dsr",
"version": "8.1.0.0.0-81.11.0"
},
"installedSoftware": []
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
All: Configuration Levels
The configuration level of the database when a resource is inserted or updated.
/all/configurationlevels
get /all/configurationlevels
Returns: 1) the current database configuration level, and 2) individual resource type configuration levels for all resource types residing on the OAM server which support the configurationLevel attribute, and for which a user or client has modified the configuration in some way. If no user or client has ever modified the configuration of a resource - for example, by adding a new instance, or by editing an attribute in an option resource - then no entry for that resource appears in the data returned in the GET response.
Target Server: NOAM or SOAM
Secured by x-other
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/all/collections/configurationlevelCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/all/configurationlevel/configurationlevel.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when the instance of the resource type is inserted or updated.",
"format": "int64",
"type": "string"
},
"resource": {
"description": "The name of the resource type.",
"type": "string"
}
},
"required": [
"configurationLevel",
"resource"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"configurationLevel": "256",
"resource": "currentConfigurationLevel"
},
{
"configurationLevel": "246",
"resource": "applicationrouterules"
},
{
"configurationLevel": "141",
"resource": "applicationroutetables"
},
{
"configurationLevel": "50",
"resource": "applicationids"
},
{
"configurationLevel": "30",
"resource": "capacityconfigurationsets"
},
{
"configurationLevel": "211",
"resource": "cexconfigurationsets"
},
{
"configurationLevel": "222",
"resource": "connections"
},
{
"configurationLevel": "181",
"resource": "connectionconfigurationsets"
},
{
"configurationLevel": "216",
"resource": "egressthrottlegroups"
},
{
"configurationLevel": "214",
"resource": "localnodes"
},
{
"configurationLevel": "111",
"resource": "messagecopyconfigurationsets"
},
{
"configurationLevel": "257",
"resource": "mpprofileassignments"
},
{
"configurationLevel": "201",
"resource": "messagepriorityconfigurationsets"
},
{
"configurationLevel": "40",
"resource": "egressmessagethrottlingconfigurationsets"
},
{
"configurationLevel": "60",
"resource": "peernodes"
},
{
"configurationLevel": "256",
"resource": "peernodegroups"
},
{
"configurationLevel": "20",
"resource": "peerrouterules"
},
{
"configurationLevel": "10",
"resource": "peerroutetables"
},
{
"configurationLevel": "121",
"resource": "pendingtransactionlimitingconfigurationsets"
},
{
"configurationLevel": "151",
"resource": "pendinganswertimers"
},
{
"configurationLevel": "131",
"resource": "ratelimitingconfigurationsets"
},
{
"configurationLevel": "236",
"resource": "reroutesonanswer"
},
{
"configurationLevel": "70",
"resource": "routegroups"
},
{
"configurationLevel": "101",
"resource": "routelists"
},
{
"configurationLevel": "161",
"resource": "routingoptionsets"
},
{
"configurationLevel": "191",
"resource": "trafficthrottlepointconfigurationsets"
},
{
"configurationLevel": "91",
"resource": "trafficthrottlegroups"
},
{
"configurationLevel": "81",
"resource": "trafficthrottlepoints"
},
{
"configurationLevel": "171",
"resource": "transactionconfigurationsets"
}
],
"messages":
[
],
"links":
{
},
"status": true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
Auth: Authentication Service
Authenticates the MMI user and, if successful, creates an authentication token returned to the client.
Authentication is performed at the NOAM.
/auth/tokens
post /auth/tokens
Requests a new authentication token. The requestor is authenticated using one and only one of the following credentials:
- A valid authentication token (This is supplied in the X-Auth-Token header rather than in the form parameters)
- A username / password pair
A token is immediately usable on the server that created it. The same token is usable on other OAM servers in the topology after a short propagation delay of 3-5 seconds, assuming database replication is operational.
Target server: NOAM or SOAM
Secured by none
Secured by x-other
Request
Body
Type: application/x-www-form-urlencoded
Form Parameters- username: (string)
The user part of a username/password credential pair.
- password: (string)
The password part of a username/password credential pair.
Response
HTTP status code 201
Authentication success
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/auth/items/tokenItem.json",
"type": "object",
"properties": {
"data":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/auth/token/token.json",
"type": "object",
"required": true,
"properties": {
"token": {
"description": "An authentication token",
"type": "string",
"example": "CF77CD9EC60F8791F1B",
"pattern" : "^[0-9A-F]{20}$"
},
"gooduntil": {
"description": "Authentication token expiry date / time",
"type": "string",
"example": "2015-08-04T12:36:16-04:00",
"pattern": "^[0-9]{4}[-][0-1]{1}[0-9]{1}[-][0-3]{1}[0-9]{1}T[0-2]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}([.][0-9]{1,7})?[+-](?:2[0-3]|[0-1][0-9])[:][0-5][0-9]?$"
}
}
}
,
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"token": "BF904A8915130B782D01",
"gooduntil": "2015-08-04T12:36:16-04:00"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 401
Authentication failure
Bulk: Bulk Configuration Service
Import (POST) and export (GET) of XML encoded topology configuration data.
Bulk configuration export requests are supported by both the NOAM and SOAM, but Bulk configuration import requests are only supported on the active or unconfigured first NOAMP.
Topology configuration information included in the topo area is exported at the NOAM. Application-specific configuration information may be exported at the NOAM, SOAM, or both, depending on the application itself.
/bulk/configurator
get /bulk/configurator
Exports all of the configuration items available at the OAM server that receives the GET request. The configuration items are encoded in a structured XML document written to the File Management area.
The export action is asynchronous, and creates a task when the request is received. The task ID is returned, and the status of the export can be queried using Task Monitoring API (/mon/tasks/{id}). The task details includes a reference to the generated XML file in File Management.
The Export XSD schema is available at Bulk Export XSD Schema.
Target server: NOAM or SOAM
Secured by x-other
Request
Query Parameters
- area: (string)
A comma separated list of areas to include in the export.
- filename: (string)
Specify a filename for the export XML file generated in File Management. If the parameter is not provided a default name of 'bulkexport_{timestamp}.xml is used. The filename must be a string of length 5-255 characters. The valid characters from which the filename must be constructed are all alphanumeric characters, (period), (underscore) and (hyphen). But, the first character of the filename must be alphanumeric or (underscore).
Response
HTTP status code 202
Successfully started export task.
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/bulk/items/emptyItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/bulk/empty/empty.json",
"properties": {
},
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
HTTP status code 400
Export failure.
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/bulk/items/emptyItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/bulk/empty/empty.json",
"properties": {
},
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
post /bulk/configurator
The body of the request is an XML specification of topology configuration data. The provided data is validated before being imported, and if an item already exists, or if a validation check on an item fails, the import of that item fails but the import operation continues with the next item in the XML document. A list of any failed items is returned in the response.
To delete, update, or insert individual items, use the CRUD APIs defined for each specific configuration item.
The XSD schema, included below, can be viewed and downloaded by opening https://{target}/wsdl/Bulk.xsd
Secured by x-other
Request
Body
Type: application/xml
Schema
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<xsd:simpleType name="requiredString">
<xsd:restriction base="xsd:string">
<xsd:minLength value="1" />
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="IPv4">
<xsd:restriction base="xsd:string">
<xsd:pattern value="(([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])" />
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="IPv4orIPv6">
<xsd:restriction base="xsd:string">
<xsd:pattern value="((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))|([0-9A-Fa-f:]){1,46}|([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\.]*[0-9A-Fa-f]){0,46}" />
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="IPv4orIPv6NetMask">
<xsd:restriction base="xsd:string">
<xsd:pattern value="((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))|/[0-9]{1,3}" />
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="yesNo">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="yes" />
<xsd:enumeration value="no" />
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="sgLevel">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="A" />
<xsd:enumeration value="B" />
<xsd:enumeration value="C" />
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="serverRole">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Noam" />
<xsd:enumeration value="Soam" />
<xsd:enumeration value="Mp" />
<xsd:enumeration value="QueryServer" />
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="deviceType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Bonding" />
<xsd:enumeration value="Vlan" />
<xsd:enumeration value="Alias" />
<xsd:enumeration value="Ethernet" />
</xsd:restriction>
</xsd:simpleType>
<xsd:complexType name="deviceInterface">
<xsd:sequence>
<xsd:element minOccurs="0" name="ipAddress" type="IPv4orIPv6" />
<xsd:element name="networkName" type="requiredString" />
</xsd:sequence>
</xsd:complexType>
<xsd:simpleType name="routeType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Net" />
<xsd:enumeration value="Host" />
<xsd:enumeration value="Default" />
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="bootProtoType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="None" />
<xsd:enumeration value="Dhcp" />
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="monitorType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Mii" />
<xsd:enumeration value="Arp" />
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="arpValidationType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="None" />
<xsd:enumeration value="Active" />
<xsd:enumeration value="Backup" />
<xsd:enumeration value="All" />
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="svcAction">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="insert" />
<xsd:enumeration value="update" />
<xsd:enumeration value="delete" />
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="scopeType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Server" />
<xsd:enumeration value="ServerGroup" />
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="rolePref">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Default" />
<xsd:enumeration value="Active" />
<xsd:enumeration value="Standby" />
<xsd:enumeration value="Spare" />
</xsd:restriction>
</xsd:simpleType>
<xsd:complexType name="ntpServer">
<xsd:sequence>
<xsd:element name="ipAddress" type="IPv4orIPv6" />
<xsd:element name="prefer" type="xsd:boolean" />
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="networkElement">
<xsd:sequence>
<xsd:element name="name" type="requiredString" />
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="configHostname">
<xsd:sequence>
<xsd:element name="hostname" type="requiredString" />
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="network">
<xsd:sequence>
<xsd:element name="name" type="requiredString" />
<xsd:element minOccurs="0" name="UUID" type="xsd:string" />
<xsd:element minOccurs="0" name="neName" type="xsd:string" />
<xsd:element minOccurs="0" name="type" type="xsd:string" />
<xsd:element name="vlanId" type="xsd:string" />
<xsd:element name="ipAddress" type="IPv4orIPv6" />
<xsd:element name="subnetMask" type="IPv4orIPv6NetMask" />
<xsd:element minOccurs="0" name="gatewayAddress" type="IPv4orIPv6" />
<xsd:element name="isDefault" type="xsd:boolean" />
<xsd:element name="isRoutable" type="xsd:boolean" />
<xsd:element name="locked" type="xsd:boolean" />
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="ntpref">
<xsd:sequence>
<xsd:element name="NTP_Reference" type="IPv4" />
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="servicePath">
<xsd:sequence>
<xsd:element name="name" type="requiredString" />
<xsd:element name="intraSitePath" type="requiredString" />
<xsd:element name="interSitePath" type="requiredString" />
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="server">
<xsd:sequence>
<xsd:element name="hostname" type="requiredString" />
<xsd:element name="networkElementName" type="requiredString" />
<xsd:element minOccurs="0" name="serverGroupName" type="xsd:string" />
<xsd:element name="profileName" type="requiredString" />
<xsd:element name="location" type="xsd:string" />
<xsd:element name="role" type="serverRole" />
<xsd:element name="systemId" type="xsd:string" />
<xsd:element name="ntpServers">
<xsd:complexType>
<xsd:sequence>
<xsd:element maxOccurs="unbounded" name="ntpServer" type="ntpServer" />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="serverGroup">
<xsd:sequence>
<xsd:element name="name" type="requiredString" />
<xsd:element name="level" type="sgLevel" />
<xsd:element name="parentSgName" type="xsd:string" />
<xsd:element name="functionName" type="xsd:string" />
<xsd:element minOccurs="0" name="numWanRepConn" type="xsd:positiveInteger" />
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="networkDevice">
<xsd:sequence>
<xsd:element minOccurs="0" name="port" type="xsd:string" />
<xsd:element name="type" type="deviceType" />
<xsd:element minOccurs="0" name="status" type="xsd:string" />
<xsd:element minOccurs="0" name="UUID" type="xsd:string" />
<xsd:element name="hostname" type="requiredString" />
<xsd:element minOccurs="0" name="interfaces">
<xsd:complexType>
<xsd:sequence>
<xsd:element maxOccurs="unbounded" minOccurs="0" name="interface" type="deviceInterface" />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="options">
<xsd:complexType>
<xsd:all>
<xsd:element minOccurs="1" name="onboot" type="xsd:boolean" />
<xsd:element minOccurs="1" name="bootProto" type="bootProtoType" />
<xsd:element minOccurs="0" name="mtu" type="xsd:integer" />
<xsd:element minOccurs="0" name="baseDevice">
<xsd:complexType>
<xsd:sequence>
<xsd:element maxOccurs="unbounded" minOccurs="1" name="baseDeviceItem" type="requiredString" />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element maxOccurs="1" minOccurs="0" name="monitorType" type="monitorType" />
<xsd:element maxOccurs="1" minOccurs="0" name="primary" type="xsd:string" />
<xsd:element maxOccurs="1" minOccurs="0" name="miimon" type="xsd:integer" />
<xsd:element maxOccurs="1" minOccurs="0" name="updelay" type="xsd:integer" />
<xsd:element maxOccurs="1" minOccurs="0" name="downdelay" type="xsd:integer" />
<xsd:element maxOccurs="1" minOccurs="0" name="arpInterval" type="xsd:integer" />
<xsd:element maxOccurs="1" minOccurs="0" name="arpValidate" type="arpValidationType" />
<xsd:element maxOccurs="1" minOccurs="0" name="arpIpTarget" type="xsd:string" />
<xsd:element maxOccurs="1" minOccurs="0" name="hwAddr" type="xsd:string" />
<xsd:element maxOccurs="1" minOccurs="0" name="persistentDhclient" type="xsd:string" />
<xsd:element maxOccurs="1" minOccurs="0" name="ethtoolOpts" type="xsd:string" />
<xsd:element maxOccurs="1" minOccurs="0" name="ethtoolAccelOpts" type="xsd:string" />
</xsd:all>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="networkRoute">
<xsd:sequence>
<xsd:element name="hostname" type="xsd:string" />
<xsd:element minOccurs="0" name="UUID" type="xsd:string" />
<xsd:element name="type" type="routeType" />
<xsd:element name="port" type="xsd:string" />
<xsd:element minOccurs="0" name="networkAddress" type="IPv4orIPv6" />
<xsd:element minOccurs="0" name="subnetMask" type="IPv4orIPv6NetMask" />
<xsd:element name="gatewayAddress" type="IPv4orIPv6" />
<xsd:element name="scope" type="xsd:string" />
<xsd:element name="scopeType" type="scopeType" />
<xsd:element minOccurs="0" name="status" type="xsd:string" />
<xsd:element minOccurs="0" name="statusDetails" type="xsd:string" />
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="resourceDomain">
<xsd:sequence>
<xsd:element name="name" type="requiredString" />
<xsd:element name="profileName" type="xsd:string" />
<xsd:element minOccurs="0" name="sgNames">
<xsd:complexType>
<xsd:sequence>
<xsd:element maxOccurs="unbounded" name="sgName" type="requiredString" />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="place">
<xsd:sequence>
<xsd:element name="name" type="requiredString" />
<xsd:element minOccurs="0" name="parentPlaceName" type="xsd:string" />
<xsd:element name="typeName" type="requiredString" />
<xsd:element minOccurs="0" name="serverList">
<xsd:complexType>
<xsd:sequence>
<xsd:element maxOccurs="unbounded" name="serverListItem" type="requiredString" />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="placeAssociation">
<xsd:sequence>
<xsd:element name="name" type="requiredString" />
<xsd:element name="typeName" type="requiredString" />
<xsd:element minOccurs="0" name="placeList">
<xsd:complexType>
<xsd:sequence>
<xsd:element maxOccurs="unbounded" name="placeListItem" type="requiredString" />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="dscpInterfaceRule">
<xsd:sequence>
<xsd:element minOccurs="0" name="UUID" type="xsd:string" />
<xsd:element name="interface" type="requiredString" />
<xsd:element name="dscp" type="xsd:integer" />
<xsd:element name="protocol" type="protocolType" />
<xsd:element name="scope" type="xsd:string" />
<xsd:element name="scopeType" type="scopeType" />
</xsd:sequence>
</xsd:complexType>
<xsd:simpleType name="protocolType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Tcp" />
<xsd:enumeration value="Sctp" />
</xsd:restriction>
</xsd:simpleType>
<xsd:complexType name="dscpPortRule">
<xsd:sequence>
<xsd:element minOccurs="0" name="UUID" type="xsd:string" />
<xsd:element name="port" type="xsd:integer" />
<xsd:element name="dscp" type="xsd:integer" />
<xsd:element name="protocol" type="protocolType" />
<xsd:element name="scope" type="xsd:string" />
<xsd:element name="scopeType" type="scopeType" />
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="vip">
<xsd:sequence>
<xsd:element minOccurs="0" name="UUID" type="xsd:string" />
<xsd:element name="serverGroupName" type="requiredString" />
<xsd:element name="ipAddress" type="IPv4orIPv6" />
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="member">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="haRolePreference" type="rolePref" />
<xsd:element maxOccurs="1" minOccurs="1" name="hostname" type="requiredString" />
<xsd:element maxOccurs="1" minOccurs="1" name="serverGroupName" type="requiredString" />
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="topoArea">
<xsd:choice maxOccurs="unbounded" minOccurs="0">
<xsd:element name="configHostname" type="configHostname" />
<xsd:element name="networkElement" type="networkElement" />
<xsd:element name="network" type="network" />
<xsd:element name="servicePath" type="servicePath" />
<xsd:element name="server" type="server" />
<xsd:element name="serverGroup" type="serverGroup" />
<xsd:element name="networkDevice" type="networkDevice" />
<xsd:element name="networkRoute" type="networkRoute" />
<xsd:element name="resourceDomain" type="resourceDomain" />
<xsd:element name="place" type="place" />
<xsd:element name="placeAssociation" type="placeAssociation" />
<xsd:element name="dscpInterfaceRule" type="dscpInterfaceRule" />
<xsd:element name="dscpPortRule" type="dscpPortRule" />
<xsd:element name="member" type="member" />
<xsd:element name="vip" type="vip" />
</xsd:choice>
</xsd:complexType>
<xsd:element name="configuration">
<xsd:complexType>
<xsd:all>
<xsd:element minOccurs="0" name="topo" type="topoArea" />
</xsd:all>
</xsd:complexType>
</xsd:element>
</xsd:schema>Diameter: Application Ids
An Application Id is an identification number used to identify a Diameter application on the DSR. Application Ids, and associated Application Names, can be retrieved, deleted, and assigned. An Application Id value cannot be changed, but the Application Name can be changed.
Standard Application Ids range from 0 to 16777215; Vendor-specific Application Ids range from 16777216 to 4194967294; and Relay is assigned 4294967295. The maximum number of Ids that can be assigned is 1000.
All Application Id configuration is done at the SOAM.
/diameter/applicationids
get /diameter/applicationids
Returns all Application Ids configured at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those Application Ids meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section).
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/applicationidCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/applicationid/applicationid.json",
"properties": {
"appId": {
"description": "The Application Id is the numeric value used to identify a Diameter Application.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name associated with the Application Id.",
"maxLength": 32,
"pattern": "^(([0-9_][A-Za-z0-9_ \\+\\-\\*\\(\\)]*[A-Za-z][A-Za-z0-9_ \\+\\-\\*\\(\\)]*)|([A-Za-z][A-Za-z0-9_ \\+\\-\\*\\(\\)]*))$",
"type": "string"
}
},
"required": [
"appId",
"name"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"appId": 4294967295,
"configurationLevel": "0",
"name": "Relay"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/applicationids
Adds a new Application Id to the DSR configuration. The new Application Id must be unique and have an associated Application Name.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/applicationid/applicationid.json",
"properties": {
"appId": {
"description": "The Application Id is the numeric value used to identify a Diameter Application.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name associated with the Application Id.",
"maxLength": 32,
"pattern": "^(([0-9_][A-Za-z0-9_ \\+\\-\\*\\(\\)]*[A-Za-z][A-Za-z0-9_ \\+\\-\\*\\(\\)]*)|([A-Za-z][A-Za-z0-9_ \\+\\-\\*\\(\\)]*))$",
"type": "string"
}
},
"required": [
"appId",
"name"
],
"type": "object"
}
Example
{
"appId": 4294967295,
"configurationLevel": "0",
"name": "Relay"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/applicationids/{id}
get /diameter/applicationids/{id}
Returns the configuration details for the specified Application Id. If the specified Application Id does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- id: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/applicationidItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/applicationid/applicationid.json",
"properties": {
"appId": {
"description": "The Application Id is the numeric value used to identify a Diameter Application.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name associated with the Application Id.",
"maxLength": 32,
"pattern": "^(([0-9_][A-Za-z0-9_ \\+\\-\\*\\(\\)]*[A-Za-z][A-Za-z0-9_ \\+\\-\\*\\(\\)]*)|([A-Za-z][A-Za-z0-9_ \\+\\-\\*\\(\\)]*))$",
"type": "string"
}
},
"required": [
"appId",
"name"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"appId": 4294967295,
"configurationLevel": "0",
"name": "Relay"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/applicationids/{id}
Updates the associated Application Name for the Application Id.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- id: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/applicationid/applicationid.json",
"properties": {
"appId": {
"description": "The Application Id is the numeric value used to identify a Diameter Application.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name associated with the Application Id.",
"maxLength": 32,
"pattern": "^(([0-9_][A-Za-z0-9_ \\+\\-\\*\\(\\)]*[A-Za-z][A-Za-z0-9_ \\+\\-\\*\\(\\)]*)|([A-Za-z][A-Za-z0-9_ \\+\\-\\*\\(\\)]*))$",
"type": "string"
}
},
"required": [
"appId",
"name"
],
"type": "object"
}
Example
{
"appId": 4294967295,
"configurationLevel": "0",
"name": "Relay"
}
delete /diameter/applicationids/{id}
Deletes the specified Application Id from the SOAM configuration. An Application ID can only be deleted if all delete validation checks pass. In general, if the Application Id is part of the configuration of some other Managed Object, the Application Id cannot be deleted. For example, if the Application Id is named by a Peer Route Table (/diameter/peerroutetables), the Application Id must first be removed from the Peer Route Table. Then the Application Id can be deleted from the configuration. An attempt to delete an Application Id that cannot be deleted results in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Diameter: Application Priority Options
An ApplicationPriorityOption has been added to support DRMP on a per Diameter ApplicationID basis. It only allows a user to configure priorities for those ApplicationID which already exists on SOAM.
All ApplicationPriorityOption configuration is done at the SOAM.
/diameter/applicationpriorityoptions
get /diameter/applicationpriorityoptions
Returns all ApplicationPriorityOption configured for specific ApplicationID at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those Application Priority Option meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section).
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (one of configurationLevel)
The field being matched
Only the configurationLevel field is supported.
Example:
filter_name=configurationLevel
- filter_op: (one of GREATER_THAN, GREATER_THAN_EQUAL)
The match operation (operator)
Example:
filter_op=GREATER_THAN
- filter_values: (string)
The matched value
The configurationLevel value by which the data is being filtered. Only a single value is supported.
Example:
filter_values=10
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/applicationpriorityoptionCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/applicationpriorityoption/applicationpriorityoption.json",
"properties": {
"answerDrmpAvpAdminStateEnabled": {
"description": "When set to true, the DRMP AVP in the Answer message is used to assign the Answer priority for messages having Application Id equal to the appId attribute value. The typical value is false. answerDrmpAvpAdminStateEnabled only affects the behavior of the DSR when ngnPsAdminStateEnabled value (/diameter/options) is set to true.",
"type": "boolean"
},
"appId": {
"description": "The value for appId must be that of an Application Id already configured at this SOAM.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"ngnPsDrmpAvpAdminStateEnabled": {
"description": "When set to true, the NGN-PS tagging based on DRMP AVP is enabled for this Application Id. The typical value is false. ngnPsDrmpAvpAdminStateEnabled only affects the behavior of the DSR when ngnPsAdminStateEnabled value (/diameter/options) and ngnPs16PriorityAdminStateEnabled value (/diameter/options) are set to true.",
"type": "boolean"
},
"ngnPs3gppAvpAdminStateEnabled": {
"description": "When set to true, the NGN-PS tagging based on 3GPP AVP's is enabled for this Application Id. The typical value is false. ngnPs3gppAvpAdminStateEnabled only affects the behavior of the DSR when ngnPsAdminStateEnabled value (/diameter/options) is set to true and appId attribute value is set to 16777216, 16777217, 16777236 or 16777238.",
"type": "boolean"
},
"requestDrmpAvpAdminStateEnabled": {
"description": "When set to true, DRMP AVP in Request message is used to assign Request priority for this Application Id. The typical value is false. requestDrmpAvpAdminStateEnabled only affects the behavior of the DSR when ngnPs16PriorityAdminStateEnabled value (/diameter/options) is set to true.",
"type": "boolean"
}
},
"required": [
"appId"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"answerDrmpAvpAdminStateEnabled" : false,
"appId" : 16777216,
"configurationLevel": "0",
"ngnPsDrmpAvpAdminStateEnabled": false,
"ngnPs3gppAvpAdminStateEnabled": false,
"requestDrmpAvpAdminStateEnabled": false
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/applicationpriorityoptions
Adds a new ApplicationPriorityOption for the existing ApplicationID to the DSR configuration. The selected ApplicationID must be unique and have an associated Application Name.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/applicationpriorityoption/applicationpriorityoption.json",
"properties": {
"answerDrmpAvpAdminStateEnabled": {
"description": "When set to true, the DRMP AVP in the Answer message is used to assign the Answer priority for messages having Application Id equal to the appId attribute value. The typical value is false. answerDrmpAvpAdminStateEnabled only affects the behavior of the DSR when ngnPsAdminStateEnabled value (/diameter/options) is set to true.",
"type": "boolean"
},
"appId": {
"description": "The value for appId must be that of an Application Id already configured at this SOAM.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"ngnPsDrmpAvpAdminStateEnabled": {
"description": "When set to true, the NGN-PS tagging based on DRMP AVP is enabled for this Application Id. The typical value is false. ngnPsDrmpAvpAdminStateEnabled only affects the behavior of the DSR when ngnPsAdminStateEnabled value (/diameter/options) and ngnPs16PriorityAdminStateEnabled value (/diameter/options) are set to true.",
"type": "boolean"
},
"ngnPs3gppAvpAdminStateEnabled": {
"description": "When set to true, the NGN-PS tagging based on 3GPP AVP's is enabled for this Application Id. The typical value is false. ngnPs3gppAvpAdminStateEnabled only affects the behavior of the DSR when ngnPsAdminStateEnabled value (/diameter/options) is set to true and appId attribute value is set to 16777216, 16777217, 16777236 or 16777238.",
"type": "boolean"
},
"requestDrmpAvpAdminStateEnabled": {
"description": "When set to true, DRMP AVP in Request message is used to assign Request priority for this Application Id. The typical value is false. requestDrmpAvpAdminStateEnabled only affects the behavior of the DSR when ngnPs16PriorityAdminStateEnabled value (/diameter/options) is set to true.",
"type": "boolean"
}
},
"required": [
"appId"
],
"type": "object"
}
Example
{
"answerDrmpAvpAdminStateEnabled" : false,
"appId" : 16777216,
"configurationLevel": "0",
"ngnPsDrmpAvpAdminStateEnabled": false,
"ngnPs3gppAvpAdminStateEnabled": false,
"requestDrmpAvpAdminStateEnabled": false
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/applicationpriorityoptions/{name}
get /diameter/applicationpriorityoptions/{name}
Returns the configuration details for the specified Application Id from ApplicationPriorityOption. If the specified Application Id does not exist in ApplicationPriorityOption at SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/applicationpriorityoptionItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/applicationpriorityoption/applicationpriorityoption.json",
"properties": {
"answerDrmpAvpAdminStateEnabled": {
"description": "When set to true, the DRMP AVP in the Answer message is used to assign the Answer priority for messages having Application Id equal to the appId attribute value. The typical value is false. answerDrmpAvpAdminStateEnabled only affects the behavior of the DSR when ngnPsAdminStateEnabled value (/diameter/options) is set to true.",
"type": "boolean"
},
"appId": {
"description": "The value for appId must be that of an Application Id already configured at this SOAM.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"ngnPsDrmpAvpAdminStateEnabled": {
"description": "When set to true, the NGN-PS tagging based on DRMP AVP is enabled for this Application Id. The typical value is false. ngnPsDrmpAvpAdminStateEnabled only affects the behavior of the DSR when ngnPsAdminStateEnabled value (/diameter/options) and ngnPs16PriorityAdminStateEnabled value (/diameter/options) are set to true.",
"type": "boolean"
},
"ngnPs3gppAvpAdminStateEnabled": {
"description": "When set to true, the NGN-PS tagging based on 3GPP AVP's is enabled for this Application Id. The typical value is false. ngnPs3gppAvpAdminStateEnabled only affects the behavior of the DSR when ngnPsAdminStateEnabled value (/diameter/options) is set to true and appId attribute value is set to 16777216, 16777217, 16777236 or 16777238.",
"type": "boolean"
},
"requestDrmpAvpAdminStateEnabled": {
"description": "When set to true, DRMP AVP in Request message is used to assign Request priority for this Application Id. The typical value is false. requestDrmpAvpAdminStateEnabled only affects the behavior of the DSR when ngnPs16PriorityAdminStateEnabled value (/diameter/options) is set to true.",
"type": "boolean"
}
},
"required": [
"appId"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"answerDrmpAvpAdminStateEnabled" : false,
"appId" : 16777216,
"configurationLevel": "0",
"ngnPsDrmpAvpAdminStateEnabled": false,
"ngnPs3gppAvpAdminStateEnabled": false,
"requestDrmpAvpAdminStateEnabled": false
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/applicationpriorityoptions/{name}
Updates the associated attrubutes(ReqDRMPAVPAdminState, AnsDRMPAVPAdminState, NgnPs3gppAVPAdminState, NgnPsDRMPAVPAdminState) for the Application Id.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/applicationpriorityoption/applicationpriorityoption.json",
"properties": {
"answerDrmpAvpAdminStateEnabled": {
"description": "When set to true, the DRMP AVP in the Answer message is used to assign the Answer priority for messages having Application Id equal to the appId attribute value. The typical value is false. answerDrmpAvpAdminStateEnabled only affects the behavior of the DSR when ngnPsAdminStateEnabled value (/diameter/options) is set to true.",
"type": "boolean"
},
"appId": {
"description": "The value for appId must be that of an Application Id already configured at this SOAM.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"ngnPsDrmpAvpAdminStateEnabled": {
"description": "When set to true, the NGN-PS tagging based on DRMP AVP is enabled for this Application Id. The typical value is false. ngnPsDrmpAvpAdminStateEnabled only affects the behavior of the DSR when ngnPsAdminStateEnabled value (/diameter/options) and ngnPs16PriorityAdminStateEnabled value (/diameter/options) are set to true.",
"type": "boolean"
},
"ngnPs3gppAvpAdminStateEnabled": {
"description": "When set to true, the NGN-PS tagging based on 3GPP AVP's is enabled for this Application Id. The typical value is false. ngnPs3gppAvpAdminStateEnabled only affects the behavior of the DSR when ngnPsAdminStateEnabled value (/diameter/options) is set to true and appId attribute value is set to 16777216, 16777217, 16777236 or 16777238.",
"type": "boolean"
},
"requestDrmpAvpAdminStateEnabled": {
"description": "When set to true, DRMP AVP in Request message is used to assign Request priority for this Application Id. The typical value is false. requestDrmpAvpAdminStateEnabled only affects the behavior of the DSR when ngnPs16PriorityAdminStateEnabled value (/diameter/options) is set to true.",
"type": "boolean"
}
},
"required": [
"appId"
],
"type": "object"
}
Example
{
"answerDrmpAvpAdminStateEnabled" : false,
"appId" : 16777216,
"configurationLevel": "0",
"ngnPsDrmpAvpAdminStateEnabled": false,
"ngnPs3gppAvpAdminStateEnabled": false,
"requestDrmpAvpAdminStateEnabled": false
}
delete /diameter/applicationpriorityoptions/{name}
Deletes the specified Application Id from the ApplicationPriorityOption at SOAM configuration. An Application ID can only be deleted if all delete validation checks pass. In general, if the Application Id is part of the configuration of some other Managed Object, the Application Id cannot be deleted. An attempt to delete an Application Id that cannot be deleted results in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Diameter: Application Route Rules
Application Route Rules are individual rules that specify how ingress request messages are routed by the DSR. Each Application Route Rule is associated with exactly one Application Route Table (/diameter/applicationroutetables). Whenever a request message is processed by the DSR, one of the configured Application Route Tables is selected (based on the DSR's general routing behavior, tailored by the DSR's specific configuration), and then the Application Route Rules owned by the selected Application Route Table are evaluated to see which Rule is applied to the request message. All Application Route Rules associated with an Application Route Table form the prioritized set of rules against which the request message is compared. The request is then routed based on the configuration of the selected Rule.
Each Application Route Rule specifies criteria, called conditions, against which the request message is compared. Each Rule also has a defined priority. The action taken by the DSR in response to the request message is based on the highest-priority Application Route Rule whose conditions match the request message information. The possible actions are: route to an Application, which occurs when the request conditions match the the Rules; forward to a Peer Node (/diameter/peernodes); send an answer message to the ingress Application that transmitted the request message; or abandon the request message.
All Application Route Rule configuration is done at the SOAM.
/diameter/applicationrouterules
get /diameter/applicationrouterules
Returns all Application Route Rules configured at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those Application Route Rules meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section).
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/applicationrouteruleCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/applicationrouterule/applicationrouterule.json",
"properties": {
"action": {
"description": "Action associated with this Rule. When set to RouteToAppl, DSR routes the message to the DSR Application specified in the Rule. When set to ForwardToEgressRouting, DSR chooses a PRT and routes, answers, or abandons the message based on the current DSR routing configuration (depending on whether or not the message matches any rule in the selected PRT). When set to SendAnswer, DSR abandons message routing and sends an Answer response containing the ansResultCode value associated with this Rule. When set to AbandonWithNoAns, DSR discards the message and an Answer is not sent to the originating Peer Node (/diameter/peernodes). When set to ForwardToArt, DSR routes the message to the Application Route Table (/diameter/applicationroutetables) for further processing. When set to ForwardToPrt, DSR routes the message to the Peer Route Table (/diameter/peerroutetables) for further processing.",
"enum": [
"AbandonWithNoAns",
"ForwardToArt",
"ForwardToEgressRouting",
"ForwardToPrt",
"RouteToAppl",
"SendAnswer"
],
"type": "string"
},
"ansErrorMessage": {
"description": "The string placed in the Error-Message AVP of the Answer message whenever the action is set to SendAnswer.",
"maxLength": 64,
"type": "string"
},
"ansResultCode": {
"description": "The value placed in the Result-Code AVP of the Answer message sent whenever the action is set to SendAnswer.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"appName": {
"description": "Name for the DSR Application associated with this rule.",
"maxLength": 32,
"type": "string"
},
"appRouteTableName": {
"description": "The name of the Application Route Table (/diameter/applicationroutetables) to which this Application Route Rule belongs.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"conditions": {
"description": "The conditions associated with this Application Route Rule. There are six conditions, and because DSR logically ANDs them, all six must be present in the Rule definition. However, any individual condition, which does not apply to the Rule, should simply have the DontCare operator assigned. The six conditions are Destination-Realm, Destination-Host, Application-Id, Command-Code, Origin-Realm, and Origin-Host. Application-Id and Command-Code refer to values found in the Diameter request message header, while the other four conditions apply to AVPs within the Diameter message body.",
"properties": {
"appId": {
"description": "The appId condition is used when it is necessary to examine the Application-Id value in the Diameter request message. The Equal operator is used to match the message's Application-ID value exactly. The NotEqual operator is used to exclude a specific Application-Id value. In either the Equal or NotEqual case, the supplied value must be an integer in the range 0-4294967295. If Application-Id is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"DontCare",
"Equal",
"NotEqual"
],
"type": "string"
},
"value": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"required": [
"operator"
],
"type": "object"
},
"cmdCode": {
"description": "The cmdCode condition is used when it is necessary to examine the Command-Code value in the Diameter request message. The Equal operator is used to match the message's Command-Code value exactly. The NotEqual operator is used to exclude a specific Command-Code value. In either the Equal or NotEqual case, the supplied value must be a configured Command Code or Extended Command Code. Command Codes are integers in the range 0-16777215, while Extended Command Codes have the form X.Y.Z, where each of X (the Command Code), Y (the AVP code), and Z (the AVP value) are integers in the range 0-16777215. If Command-Code is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"DontCare",
"Equal",
"NotEqual"
],
"type": "string"
},
"value": {
"maxLength": 30,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
},
"destHost": {
"description": "The destHost condition is used when it is necessary to examine the Destination-Host AVP value in the Diameter request message. The Equal operator is used to match the message's Destination-Host AVP value exactly. The NotEqual operator is used to exclude a specific Destination-Host value. In these two cases, the supplied value must be a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label can be no longer than 63 characters and the string can be no longer than 255 characters. If Destination-Host is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored. The StartsWith, EndsWith, and Contains operators are used as their names infer, to match the beginning, end, or any contiguous part of the Destination-Host AVP value. In any of these cases, the supplied value is a case-insensitive string limited to alphanumeric, dash ('-'), dot ('.'), and underscore ('_') characters. For EndsWith or StartsWith, the string can be no longer than 255 characters. For Contains, the string can be no longer than 50 characters. In addition, the Present and Absent operators can be used with Destination-Host. Neither Present nor Absent takes a value. If Present is used, there is a match when the Destination-Host AVP is present in the request message. If Absent is used, there is a match when the Destination-Host AVP is not present in the request message.",
"properties": {
"operator": {
"enum": [
"Absent",
"Contains",
"DontCare",
"EndsWith",
"Equal",
"NotEqual",
"Present",
"StartsWith"
],
"type": "string"
},
"value": {
"maxLength": 255,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
},
"destRealm": {
"description": "The destRealm condition is used when it is necessary to examine the Destination-Realm AVP value in the Diameter request message. The Equal operator is used to match the message's Destination-Realm AVP value exactly. The NotEqual operator is used to exclude a specific Destination-Realm value. In these two cases, the supplied value must be a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label can be no longer than 63 characters and the string can be no longer than 255 characters. The StartsWith, EndsWith, and Contains operators are used as their names infer, to match the beginning, end, or any contiguous part of the Destination-Realm AVP value. In any of these cases, the supplied value is a case-insensitive string limited to alphanumeric, dash ('-'), dot ('.'), and underscore ('_') characters. For EndsWith or StartsWith, the string can be no longer than 255 characters. For Contains, the string can be no longer than 50 characters. If Destination-Realm is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"Contains",
"DontCare",
"EndsWith",
"Equal",
"NotEqual",
"StartsWith"
],
"type": "string"
},
"value": {
"maxLength": 255,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
},
"origHost": {
"description": "The origHost condition is used when it is necessary to examine the Origin-Host AVP value in the Diameter request message. The Equal operator is used to match the message's Origin-Host AVP value exactly. The NotEqual operator is used to exclude a specific Origin-Host value. In these two cases, the supplied value must be a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label can be no longer than 63 characters and the string can be no longer than 255 characters. The StartsWith, EndsWith, and Contains operators are used as their names infer, to match the beginning, end, or any contiguous part of the Origin-Host AVP value. In any of these cases, the supplied value is a case-insensitive string limited to alphanumeric, dash ('-'), dot ('.'), and underscore ('_') characters. For EndsWith or StartsWith, the string can be no longer than 255 characters. For Contains, the string can be no longer than 50 characters. If Origin-Host is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"Contains",
"DontCare",
"EndsWith",
"Equal",
"NotEqual",
"StartsWith"
],
"type": "string"
},
"value": {
"maxLength": 255,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
},
"origRealm": {
"description": "The origRealm condition is used when it is necessary to examine the Origin-Realm AVP value in the Diameter request message. The Equal operator is used to match the message's Origin-Realm AVP value exactly. The NotEqual operator is used to exclude a specific Origin-Realm value. In these two cases, the supplied value must be a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label can be no longer than 63 characters and the string can be no longer than 255 characters. The StartsWith, EndsWith, and Contains operators are used as their names infer, to match the beginning, end, or any contiguous part of the Origin-Realm AVP value. In any of these cases, the supplied value is a case-insensitive string limited to alphanumeric, dash ('-'), dot ('.'), and underscore ('_') characters. For EndsWith or StartsWith, the string can be no longer than 255 characters. For Contains, the string can be no longer than 50 characters. If Origin-Realm is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"Contains",
"DontCare",
"EndsWith",
"Equal",
"NotEqual",
"StartsWith"
],
"type": "string"
},
"value": {
"maxLength": 255,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
}
},
"required": [
"appId",
"destRealm",
"origRealm",
"origHost",
"destHost",
"cmdCode"
],
"type": "object"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"forwardToTableName": {
"description": "Name of the Application Route Table (/diameter/applicationroutetables) or Peer Route Table (/diameter/peerroutetables) where the message is forwarded for further processing. Clients supply a value for this attribute only when this Application Route Rule's action value is ForwardToArt or ForwardToPrt.",
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"gxPrimeRequest": {
"description": "If true, and if this Rule matches a request, PCA treats the request's Diameter Application as Gx-Prime.",
"type": "boolean"
},
"name": {
"description": "Name for the Application Rule, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"priority": {
"description": "Priority of this Rule within the Application Route Table (/diameter/applicationroutetables). A lower value means a higher priority, so a Rule whose priority is a smaller integer is preferred over a Rule whose priority is a larger integer when the two Rules are being compared for selection.",
"maximum": 1000,
"minimum": 1,
"type": "integer"
},
"vendorId": {
"description": "The value placed in the Vendor-Id AVP of the Answer message sent whenever the action is set to SendAnswer.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
}
},
"required": [
"action",
"appRouteTableName",
"conditions",
"gxPrimeRequest",
"name",
"priority"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"action": "SendAnswer",
"ansErrorMessage": "ErrorMessage",
"ansResultCode": 2000,
"appRouteTableName": "Default",
"conditions":
{
"appId":
{
"operator": "DontCare"
} ,
"cmdCode":
{
"operator": "Equal",
"value": "1"
},
"destHost":
{
"operator": "EndsWith",
"value": "domain.com"
},
"destRealm":
{
"operator": "EndsWith",
"value": "domain.com"
},
"origHost":
{
"operator": "DontCare"
},
"origRealm":
{
"operator": "NotEqual",
"value": "dp.domain.com"
}
},
"configurationLevel": "45",
"gxPrimeRequest": false,
"name": "ApplicationRouteRule_31",
"priority": 999,
"vendorId": 30
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/applicationrouterules
Adds a new Application Route Rule to the specified Application Route Table (/diameter/applicationroutetables). Even though an Application Route Rule is owned by a single Application Route Table, each Application Route Rule must have a name unique across all Application Route Tables configured at the SOAM.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/applicationrouterule/applicationrouterule.json",
"properties": {
"action": {
"description": "Action associated with this Rule. When set to RouteToAppl, DSR routes the message to the DSR Application specified in the Rule. When set to ForwardToEgressRouting, DSR chooses a PRT and routes, answers, or abandons the message based on the current DSR routing configuration (depending on whether or not the message matches any rule in the selected PRT). When set to SendAnswer, DSR abandons message routing and sends an Answer response containing the ansResultCode value associated with this Rule. When set to AbandonWithNoAns, DSR discards the message and an Answer is not sent to the originating Peer Node (/diameter/peernodes). When set to ForwardToArt, DSR routes the message to the Application Route Table (/diameter/applicationroutetables) for further processing. When set to ForwardToPrt, DSR routes the message to the Peer Route Table (/diameter/peerroutetables) for further processing.",
"enum": [
"AbandonWithNoAns",
"ForwardToArt",
"ForwardToEgressRouting",
"ForwardToPrt",
"RouteToAppl",
"SendAnswer"
],
"type": "string"
},
"ansErrorMessage": {
"description": "The string placed in the Error-Message AVP of the Answer message whenever the action is set to SendAnswer.",
"maxLength": 64,
"type": "string"
},
"ansResultCode": {
"description": "The value placed in the Result-Code AVP of the Answer message sent whenever the action is set to SendAnswer.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"appName": {
"description": "Name for the DSR Application associated with this rule.",
"maxLength": 32,
"type": "string"
},
"appRouteTableName": {
"description": "The name of the Application Route Table (/diameter/applicationroutetables) to which this Application Route Rule belongs.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"conditions": {
"description": "The conditions associated with this Application Route Rule. There are six conditions, and because DSR logically ANDs them, all six must be present in the Rule definition. However, any individual condition, which does not apply to the Rule, should simply have the DontCare operator assigned. The six conditions are Destination-Realm, Destination-Host, Application-Id, Command-Code, Origin-Realm, and Origin-Host. Application-Id and Command-Code refer to values found in the Diameter request message header, while the other four conditions apply to AVPs within the Diameter message body.",
"properties": {
"appId": {
"description": "The appId condition is used when it is necessary to examine the Application-Id value in the Diameter request message. The Equal operator is used to match the message's Application-ID value exactly. The NotEqual operator is used to exclude a specific Application-Id value. In either the Equal or NotEqual case, the supplied value must be an integer in the range 0-4294967295. If Application-Id is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"DontCare",
"Equal",
"NotEqual"
],
"type": "string"
},
"value": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"required": [
"operator"
],
"type": "object"
},
"cmdCode": {
"description": "The cmdCode condition is used when it is necessary to examine the Command-Code value in the Diameter request message. The Equal operator is used to match the message's Command-Code value exactly. The NotEqual operator is used to exclude a specific Command-Code value. In either the Equal or NotEqual case, the supplied value must be a configured Command Code or Extended Command Code. Command Codes are integers in the range 0-16777215, while Extended Command Codes have the form X.Y.Z, where each of X (the Command Code), Y (the AVP code), and Z (the AVP value) are integers in the range 0-16777215. If Command-Code is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"DontCare",
"Equal",
"NotEqual"
],
"type": "string"
},
"value": {
"maxLength": 30,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
},
"destHost": {
"description": "The destHost condition is used when it is necessary to examine the Destination-Host AVP value in the Diameter request message. The Equal operator is used to match the message's Destination-Host AVP value exactly. The NotEqual operator is used to exclude a specific Destination-Host value. In these two cases, the supplied value must be a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label can be no longer than 63 characters and the string can be no longer than 255 characters. If Destination-Host is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored. The StartsWith, EndsWith, and Contains operators are used as their names infer, to match the beginning, end, or any contiguous part of the Destination-Host AVP value. In any of these cases, the supplied value is a case-insensitive string limited to alphanumeric, dash ('-'), dot ('.'), and underscore ('_') characters. For EndsWith or StartsWith, the string can be no longer than 255 characters. For Contains, the string can be no longer than 50 characters. In addition, the Present and Absent operators can be used with Destination-Host. Neither Present nor Absent takes a value. If Present is used, there is a match when the Destination-Host AVP is present in the request message. If Absent is used, there is a match when the Destination-Host AVP is not present in the request message.",
"properties": {
"operator": {
"enum": [
"Absent",
"Contains",
"DontCare",
"EndsWith",
"Equal",
"NotEqual",
"Present",
"StartsWith"
],
"type": "string"
},
"value": {
"maxLength": 255,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
},
"destRealm": {
"description": "The destRealm condition is used when it is necessary to examine the Destination-Realm AVP value in the Diameter request message. The Equal operator is used to match the message's Destination-Realm AVP value exactly. The NotEqual operator is used to exclude a specific Destination-Realm value. In these two cases, the supplied value must be a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label can be no longer than 63 characters and the string can be no longer than 255 characters. The StartsWith, EndsWith, and Contains operators are used as their names infer, to match the beginning, end, or any contiguous part of the Destination-Realm AVP value. In any of these cases, the supplied value is a case-insensitive string limited to alphanumeric, dash ('-'), dot ('.'), and underscore ('_') characters. For EndsWith or StartsWith, the string can be no longer than 255 characters. For Contains, the string can be no longer than 50 characters. If Destination-Realm is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"Contains",
"DontCare",
"EndsWith",
"Equal",
"NotEqual",
"StartsWith"
],
"type": "string"
},
"value": {
"maxLength": 255,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
},
"origHost": {
"description": "The origHost condition is used when it is necessary to examine the Origin-Host AVP value in the Diameter request message. The Equal operator is used to match the message's Origin-Host AVP value exactly. The NotEqual operator is used to exclude a specific Origin-Host value. In these two cases, the supplied value must be a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label can be no longer than 63 characters and the string can be no longer than 255 characters. The StartsWith, EndsWith, and Contains operators are used as their names infer, to match the beginning, end, or any contiguous part of the Origin-Host AVP value. In any of these cases, the supplied value is a case-insensitive string limited to alphanumeric, dash ('-'), dot ('.'), and underscore ('_') characters. For EndsWith or StartsWith, the string can be no longer than 255 characters. For Contains, the string can be no longer than 50 characters. If Origin-Host is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"Contains",
"DontCare",
"EndsWith",
"Equal",
"NotEqual",
"StartsWith"
],
"type": "string"
},
"value": {
"maxLength": 255,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
},
"origRealm": {
"description": "The origRealm condition is used when it is necessary to examine the Origin-Realm AVP value in the Diameter request message. The Equal operator is used to match the message's Origin-Realm AVP value exactly. The NotEqual operator is used to exclude a specific Origin-Realm value. In these two cases, the supplied value must be a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label can be no longer than 63 characters and the string can be no longer than 255 characters. The StartsWith, EndsWith, and Contains operators are used as their names infer, to match the beginning, end, or any contiguous part of the Origin-Realm AVP value. In any of these cases, the supplied value is a case-insensitive string limited to alphanumeric, dash ('-'), dot ('.'), and underscore ('_') characters. For EndsWith or StartsWith, the string can be no longer than 255 characters. For Contains, the string can be no longer than 50 characters. If Origin-Realm is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"Contains",
"DontCare",
"EndsWith",
"Equal",
"NotEqual",
"StartsWith"
],
"type": "string"
},
"value": {
"maxLength": 255,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
}
},
"required": [
"appId",
"destRealm",
"origRealm",
"origHost",
"destHost",
"cmdCode"
],
"type": "object"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"forwardToTableName": {
"description": "Name of the Application Route Table (/diameter/applicationroutetables) or Peer Route Table (/diameter/peerroutetables) where the message is forwarded for further processing. Clients supply a value for this attribute only when this Application Route Rule's action value is ForwardToArt or ForwardToPrt.",
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"gxPrimeRequest": {
"description": "If true, and if this Rule matches a request, PCA treats the request's Diameter Application as Gx-Prime.",
"type": "boolean"
},
"name": {
"description": "Name for the Application Rule, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"priority": {
"description": "Priority of this Rule within the Application Route Table (/diameter/applicationroutetables). A lower value means a higher priority, so a Rule whose priority is a smaller integer is preferred over a Rule whose priority is a larger integer when the two Rules are being compared for selection.",
"maximum": 1000,
"minimum": 1,
"type": "integer"
},
"vendorId": {
"description": "The value placed in the Vendor-Id AVP of the Answer message sent whenever the action is set to SendAnswer.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
}
},
"required": [
"action",
"appRouteTableName",
"conditions",
"gxPrimeRequest",
"name",
"priority"
],
"type": "object"
}
Example
{
"action": "SendAnswer",
"ansErrorMessage": "ErrorMessage",
"ansResultCode": 2000,
"appRouteTableName": "Default",
"conditions":
{
"appId":
{
"operator": "DontCare"
} ,
"cmdCode":
{
"operator": "Equal",
"value": "1"
},
"destHost":
{
"operator": "EndsWith",
"value": "domain.com"
},
"destRealm":
{
"operator": "EndsWith",
"value": "domain.com"
},
"origHost":
{
"operator": "DontCare"
},
"origRealm":
{
"operator": "NotEqual",
"value": "dp.domain.com"
}
},
"configurationLevel": "45",
"gxPrimeRequest": false,
"name": "ApplicationRouteRule_31",
"priority": 999,
"vendorId": 30
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/applicationrouterules/{name}
get /diameter/applicationrouterules/{name}
Returns the configuration details for the specified Application Route Rule. If the specified Application Route Rule does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/applicationrouteruleItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/applicationrouterule/applicationrouterule.json",
"properties": {
"action": {
"description": "Action associated with this Rule. When set to RouteToAppl, DSR routes the message to the DSR Application specified in the Rule. When set to ForwardToEgressRouting, DSR chooses a PRT and routes, answers, or abandons the message based on the current DSR routing configuration (depending on whether or not the message matches any rule in the selected PRT). When set to SendAnswer, DSR abandons message routing and sends an Answer response containing the ansResultCode value associated with this Rule. When set to AbandonWithNoAns, DSR discards the message and an Answer is not sent to the originating Peer Node (/diameter/peernodes). When set to ForwardToArt, DSR routes the message to the Application Route Table (/diameter/applicationroutetables) for further processing. When set to ForwardToPrt, DSR routes the message to the Peer Route Table (/diameter/peerroutetables) for further processing.",
"enum": [
"AbandonWithNoAns",
"ForwardToArt",
"ForwardToEgressRouting",
"ForwardToPrt",
"RouteToAppl",
"SendAnswer"
],
"type": "string"
},
"ansErrorMessage": {
"description": "The string placed in the Error-Message AVP of the Answer message whenever the action is set to SendAnswer.",
"maxLength": 64,
"type": "string"
},
"ansResultCode": {
"description": "The value placed in the Result-Code AVP of the Answer message sent whenever the action is set to SendAnswer.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"appName": {
"description": "Name for the DSR Application associated with this rule.",
"maxLength": 32,
"type": "string"
},
"appRouteTableName": {
"description": "The name of the Application Route Table (/diameter/applicationroutetables) to which this Application Route Rule belongs.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"conditions": {
"description": "The conditions associated with this Application Route Rule. There are six conditions, and because DSR logically ANDs them, all six must be present in the Rule definition. However, any individual condition, which does not apply to the Rule, should simply have the DontCare operator assigned. The six conditions are Destination-Realm, Destination-Host, Application-Id, Command-Code, Origin-Realm, and Origin-Host. Application-Id and Command-Code refer to values found in the Diameter request message header, while the other four conditions apply to AVPs within the Diameter message body.",
"properties": {
"appId": {
"description": "The appId condition is used when it is necessary to examine the Application-Id value in the Diameter request message. The Equal operator is used to match the message's Application-ID value exactly. The NotEqual operator is used to exclude a specific Application-Id value. In either the Equal or NotEqual case, the supplied value must be an integer in the range 0-4294967295. If Application-Id is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"DontCare",
"Equal",
"NotEqual"
],
"type": "string"
},
"value": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"required": [
"operator"
],
"type": "object"
},
"cmdCode": {
"description": "The cmdCode condition is used when it is necessary to examine the Command-Code value in the Diameter request message. The Equal operator is used to match the message's Command-Code value exactly. The NotEqual operator is used to exclude a specific Command-Code value. In either the Equal or NotEqual case, the supplied value must be a configured Command Code or Extended Command Code. Command Codes are integers in the range 0-16777215, while Extended Command Codes have the form X.Y.Z, where each of X (the Command Code), Y (the AVP code), and Z (the AVP value) are integers in the range 0-16777215. If Command-Code is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"DontCare",
"Equal",
"NotEqual"
],
"type": "string"
},
"value": {
"maxLength": 30,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
},
"destHost": {
"description": "The destHost condition is used when it is necessary to examine the Destination-Host AVP value in the Diameter request message. The Equal operator is used to match the message's Destination-Host AVP value exactly. The NotEqual operator is used to exclude a specific Destination-Host value. In these two cases, the supplied value must be a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label can be no longer than 63 characters and the string can be no longer than 255 characters. If Destination-Host is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored. The StartsWith, EndsWith, and Contains operators are used as their names infer, to match the beginning, end, or any contiguous part of the Destination-Host AVP value. In any of these cases, the supplied value is a case-insensitive string limited to alphanumeric, dash ('-'), dot ('.'), and underscore ('_') characters. For EndsWith or StartsWith, the string can be no longer than 255 characters. For Contains, the string can be no longer than 50 characters. In addition, the Present and Absent operators can be used with Destination-Host. Neither Present nor Absent takes a value. If Present is used, there is a match when the Destination-Host AVP is present in the request message. If Absent is used, there is a match when the Destination-Host AVP is not present in the request message.",
"properties": {
"operator": {
"enum": [
"Absent",
"Contains",
"DontCare",
"EndsWith",
"Equal",
"NotEqual",
"Present",
"StartsWith"
],
"type": "string"
},
"value": {
"maxLength": 255,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
},
"destRealm": {
"description": "The destRealm condition is used when it is necessary to examine the Destination-Realm AVP value in the Diameter request message. The Equal operator is used to match the message's Destination-Realm AVP value exactly. The NotEqual operator is used to exclude a specific Destination-Realm value. In these two cases, the supplied value must be a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label can be no longer than 63 characters and the string can be no longer than 255 characters. The StartsWith, EndsWith, and Contains operators are used as their names infer, to match the beginning, end, or any contiguous part of the Destination-Realm AVP value. In any of these cases, the supplied value is a case-insensitive string limited to alphanumeric, dash ('-'), dot ('.'), and underscore ('_') characters. For EndsWith or StartsWith, the string can be no longer than 255 characters. For Contains, the string can be no longer than 50 characters. If Destination-Realm is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"Contains",
"DontCare",
"EndsWith",
"Equal",
"NotEqual",
"StartsWith"
],
"type": "string"
},
"value": {
"maxLength": 255,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
},
"origHost": {
"description": "The origHost condition is used when it is necessary to examine the Origin-Host AVP value in the Diameter request message. The Equal operator is used to match the message's Origin-Host AVP value exactly. The NotEqual operator is used to exclude a specific Origin-Host value. In these two cases, the supplied value must be a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label can be no longer than 63 characters and the string can be no longer than 255 characters. The StartsWith, EndsWith, and Contains operators are used as their names infer, to match the beginning, end, or any contiguous part of the Origin-Host AVP value. In any of these cases, the supplied value is a case-insensitive string limited to alphanumeric, dash ('-'), dot ('.'), and underscore ('_') characters. For EndsWith or StartsWith, the string can be no longer than 255 characters. For Contains, the string can be no longer than 50 characters. If Origin-Host is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"Contains",
"DontCare",
"EndsWith",
"Equal",
"NotEqual",
"StartsWith"
],
"type": "string"
},
"value": {
"maxLength": 255,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
},
"origRealm": {
"description": "The origRealm condition is used when it is necessary to examine the Origin-Realm AVP value in the Diameter request message. The Equal operator is used to match the message's Origin-Realm AVP value exactly. The NotEqual operator is used to exclude a specific Origin-Realm value. In these two cases, the supplied value must be a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label can be no longer than 63 characters and the string can be no longer than 255 characters. The StartsWith, EndsWith, and Contains operators are used as their names infer, to match the beginning, end, or any contiguous part of the Origin-Realm AVP value. In any of these cases, the supplied value is a case-insensitive string limited to alphanumeric, dash ('-'), dot ('.'), and underscore ('_') characters. For EndsWith or StartsWith, the string can be no longer than 255 characters. For Contains, the string can be no longer than 50 characters. If Origin-Realm is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"Contains",
"DontCare",
"EndsWith",
"Equal",
"NotEqual",
"StartsWith"
],
"type": "string"
},
"value": {
"maxLength": 255,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
}
},
"required": [
"appId",
"destRealm",
"origRealm",
"origHost",
"destHost",
"cmdCode"
],
"type": "object"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"forwardToTableName": {
"description": "Name of the Application Route Table (/diameter/applicationroutetables) or Peer Route Table (/diameter/peerroutetables) where the message is forwarded for further processing. Clients supply a value for this attribute only when this Application Route Rule's action value is ForwardToArt or ForwardToPrt.",
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"gxPrimeRequest": {
"description": "If true, and if this Rule matches a request, PCA treats the request's Diameter Application as Gx-Prime.",
"type": "boolean"
},
"name": {
"description": "Name for the Application Rule, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"priority": {
"description": "Priority of this Rule within the Application Route Table (/diameter/applicationroutetables). A lower value means a higher priority, so a Rule whose priority is a smaller integer is preferred over a Rule whose priority is a larger integer when the two Rules are being compared for selection.",
"maximum": 1000,
"minimum": 1,
"type": "integer"
},
"vendorId": {
"description": "The value placed in the Vendor-Id AVP of the Answer message sent whenever the action is set to SendAnswer.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
}
},
"required": [
"action",
"appRouteTableName",
"conditions",
"gxPrimeRequest",
"name",
"priority"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"action": "SendAnswer",
"ansErrorMessage": "ErrorMessage",
"ansResultCode": 2000,
"appRouteTableName": "Default",
"conditions":
{
"appId":
{
"operator": "DontCare"
} ,
"cmdCode":
{
"operator": "Equal",
"value": "1"
},
"destHost":
{
"operator": "EndsWith",
"value": "domain.com"
},
"destRealm":
{
"operator": "EndsWith",
"value": "domain.com"
},
"origHost":
{
"operator": "DontCare"
},
"origRealm":
{
"operator": "NotEqual",
"value": "dp.domain.com"
}
},
"configurationLevel": "45",
"gxPrimeRequest": false,
"name": "ApplicationRouteRule_31",
"priority": 999,
"vendorId": 30
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/applicationrouterules/{name}
Updates the configuration for the specified Application Route Rule. If the provided Application Route Rule data is invalid in any way, the update fails, resulting in one or more error messages returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/applicationrouterule/applicationrouterule.json",
"properties": {
"action": {
"description": "Action associated with this Rule. When set to RouteToAppl, DSR routes the message to the DSR Application specified in the Rule. When set to ForwardToEgressRouting, DSR chooses a PRT and routes, answers, or abandons the message based on the current DSR routing configuration (depending on whether or not the message matches any rule in the selected PRT). When set to SendAnswer, DSR abandons message routing and sends an Answer response containing the ansResultCode value associated with this Rule. When set to AbandonWithNoAns, DSR discards the message and an Answer is not sent to the originating Peer Node (/diameter/peernodes). When set to ForwardToArt, DSR routes the message to the Application Route Table (/diameter/applicationroutetables) for further processing. When set to ForwardToPrt, DSR routes the message to the Peer Route Table (/diameter/peerroutetables) for further processing.",
"enum": [
"AbandonWithNoAns",
"ForwardToArt",
"ForwardToEgressRouting",
"ForwardToPrt",
"RouteToAppl",
"SendAnswer"
],
"type": "string"
},
"ansErrorMessage": {
"description": "The string placed in the Error-Message AVP of the Answer message whenever the action is set to SendAnswer.",
"maxLength": 64,
"type": "string"
},
"ansResultCode": {
"description": "The value placed in the Result-Code AVP of the Answer message sent whenever the action is set to SendAnswer.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"appName": {
"description": "Name for the DSR Application associated with this rule.",
"maxLength": 32,
"type": "string"
},
"appRouteTableName": {
"description": "The name of the Application Route Table (/diameter/applicationroutetables) to which this Application Route Rule belongs.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"conditions": {
"description": "The conditions associated with this Application Route Rule. There are six conditions, and because DSR logically ANDs them, all six must be present in the Rule definition. However, any individual condition, which does not apply to the Rule, should simply have the DontCare operator assigned. The six conditions are Destination-Realm, Destination-Host, Application-Id, Command-Code, Origin-Realm, and Origin-Host. Application-Id and Command-Code refer to values found in the Diameter request message header, while the other four conditions apply to AVPs within the Diameter message body.",
"properties": {
"appId": {
"description": "The appId condition is used when it is necessary to examine the Application-Id value in the Diameter request message. The Equal operator is used to match the message's Application-ID value exactly. The NotEqual operator is used to exclude a specific Application-Id value. In either the Equal or NotEqual case, the supplied value must be an integer in the range 0-4294967295. If Application-Id is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"DontCare",
"Equal",
"NotEqual"
],
"type": "string"
},
"value": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"required": [
"operator"
],
"type": "object"
},
"cmdCode": {
"description": "The cmdCode condition is used when it is necessary to examine the Command-Code value in the Diameter request message. The Equal operator is used to match the message's Command-Code value exactly. The NotEqual operator is used to exclude a specific Command-Code value. In either the Equal or NotEqual case, the supplied value must be a configured Command Code or Extended Command Code. Command Codes are integers in the range 0-16777215, while Extended Command Codes have the form X.Y.Z, where each of X (the Command Code), Y (the AVP code), and Z (the AVP value) are integers in the range 0-16777215. If Command-Code is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"DontCare",
"Equal",
"NotEqual"
],
"type": "string"
},
"value": {
"maxLength": 30,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
},
"destHost": {
"description": "The destHost condition is used when it is necessary to examine the Destination-Host AVP value in the Diameter request message. The Equal operator is used to match the message's Destination-Host AVP value exactly. The NotEqual operator is used to exclude a specific Destination-Host value. In these two cases, the supplied value must be a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label can be no longer than 63 characters and the string can be no longer than 255 characters. If Destination-Host is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored. The StartsWith, EndsWith, and Contains operators are used as their names infer, to match the beginning, end, or any contiguous part of the Destination-Host AVP value. In any of these cases, the supplied value is a case-insensitive string limited to alphanumeric, dash ('-'), dot ('.'), and underscore ('_') characters. For EndsWith or StartsWith, the string can be no longer than 255 characters. For Contains, the string can be no longer than 50 characters. In addition, the Present and Absent operators can be used with Destination-Host. Neither Present nor Absent takes a value. If Present is used, there is a match when the Destination-Host AVP is present in the request message. If Absent is used, there is a match when the Destination-Host AVP is not present in the request message.",
"properties": {
"operator": {
"enum": [
"Absent",
"Contains",
"DontCare",
"EndsWith",
"Equal",
"NotEqual",
"Present",
"StartsWith"
],
"type": "string"
},
"value": {
"maxLength": 255,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
},
"destRealm": {
"description": "The destRealm condition is used when it is necessary to examine the Destination-Realm AVP value in the Diameter request message. The Equal operator is used to match the message's Destination-Realm AVP value exactly. The NotEqual operator is used to exclude a specific Destination-Realm value. In these two cases, the supplied value must be a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label can be no longer than 63 characters and the string can be no longer than 255 characters. The StartsWith, EndsWith, and Contains operators are used as their names infer, to match the beginning, end, or any contiguous part of the Destination-Realm AVP value. In any of these cases, the supplied value is a case-insensitive string limited to alphanumeric, dash ('-'), dot ('.'), and underscore ('_') characters. For EndsWith or StartsWith, the string can be no longer than 255 characters. For Contains, the string can be no longer than 50 characters. If Destination-Realm is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"Contains",
"DontCare",
"EndsWith",
"Equal",
"NotEqual",
"StartsWith"
],
"type": "string"
},
"value": {
"maxLength": 255,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
},
"origHost": {
"description": "The origHost condition is used when it is necessary to examine the Origin-Host AVP value in the Diameter request message. The Equal operator is used to match the message's Origin-Host AVP value exactly. The NotEqual operator is used to exclude a specific Origin-Host value. In these two cases, the supplied value must be a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label can be no longer than 63 characters and the string can be no longer than 255 characters. The StartsWith, EndsWith, and Contains operators are used as their names infer, to match the beginning, end, or any contiguous part of the Origin-Host AVP value. In any of these cases, the supplied value is a case-insensitive string limited to alphanumeric, dash ('-'), dot ('.'), and underscore ('_') characters. For EndsWith or StartsWith, the string can be no longer than 255 characters. For Contains, the string can be no longer than 50 characters. If Origin-Host is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"Contains",
"DontCare",
"EndsWith",
"Equal",
"NotEqual",
"StartsWith"
],
"type": "string"
},
"value": {
"maxLength": 255,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
},
"origRealm": {
"description": "The origRealm condition is used when it is necessary to examine the Origin-Realm AVP value in the Diameter request message. The Equal operator is used to match the message's Origin-Realm AVP value exactly. The NotEqual operator is used to exclude a specific Origin-Realm value. In these two cases, the supplied value must be a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label can be no longer than 63 characters and the string can be no longer than 255 characters. The StartsWith, EndsWith, and Contains operators are used as their names infer, to match the beginning, end, or any contiguous part of the Origin-Realm AVP value. In any of these cases, the supplied value is a case-insensitive string limited to alphanumeric, dash ('-'), dot ('.'), and underscore ('_') characters. For EndsWith or StartsWith, the string can be no longer than 255 characters. For Contains, the string can be no longer than 50 characters. If Origin-Realm is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"Contains",
"DontCare",
"EndsWith",
"Equal",
"NotEqual",
"StartsWith"
],
"type": "string"
},
"value": {
"maxLength": 255,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
}
},
"required": [
"appId",
"destRealm",
"origRealm",
"origHost",
"destHost",
"cmdCode"
],
"type": "object"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"forwardToTableName": {
"description": "Name of the Application Route Table (/diameter/applicationroutetables) or Peer Route Table (/diameter/peerroutetables) where the message is forwarded for further processing. Clients supply a value for this attribute only when this Application Route Rule's action value is ForwardToArt or ForwardToPrt.",
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"gxPrimeRequest": {
"description": "If true, and if this Rule matches a request, PCA treats the request's Diameter Application as Gx-Prime.",
"type": "boolean"
},
"name": {
"description": "Name for the Application Rule, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"priority": {
"description": "Priority of this Rule within the Application Route Table (/diameter/applicationroutetables). A lower value means a higher priority, so a Rule whose priority is a smaller integer is preferred over a Rule whose priority is a larger integer when the two Rules are being compared for selection.",
"maximum": 1000,
"minimum": 1,
"type": "integer"
},
"vendorId": {
"description": "The value placed in the Vendor-Id AVP of the Answer message sent whenever the action is set to SendAnswer.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
}
},
"required": [
"action",
"appRouteTableName",
"conditions",
"gxPrimeRequest",
"name",
"priority"
],
"type": "object"
}
Example
{
"action": "SendAnswer",
"ansErrorMessage": "ErrorMessage",
"ansResultCode": 2000,
"appRouteTableName": "Default",
"conditions":
{
"appId":
{
"operator": "DontCare"
} ,
"cmdCode":
{
"operator": "Equal",
"value": "1"
},
"destHost":
{
"operator": "EndsWith",
"value": "domain.com"
},
"destRealm":
{
"operator": "EndsWith",
"value": "domain.com"
},
"origHost":
{
"operator": "DontCare"
},
"origRealm":
{
"operator": "NotEqual",
"value": "dp.domain.com"
}
},
"configurationLevel": "45",
"gxPrimeRequest": false,
"name": "ApplicationRouteRule_31",
"priority": 999,
"vendorId": 30
}
delete /diameter/applicationrouterules/{name}
Deletes the specified Application Route Rule from the SOAM configuration. An Application Route Rule can always be deleted - there are no validation checks when deleting a Rule.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Diameter: Application Route Tables
An Application Route Table (ART) is a collection of prioritized Application Route Rules the DSR searches to determine how to route a Diameter request message to a specific DSR Application. An SOAM can be configured with multiple ARTs, which each cover a partial, yet distinct, subset of routing scenarios. The number and content of ARTs configured at an SOAM depends entirely on the DSR's required role within the larger Diameter network.
A given ART can be associated with a Peer Node or with a Transaction Configuration Set.
Request messages received by the DSR are compared against the Application Route Rules within the applicable ART. The action taken by the DSR in response to the request message is based on the highest-priority Application Route Rule that matches the request message information. The possible actions are: route a message to a DSR Application associated with the rule; forward to egress routing, which forwards the message to the Peer Route Table to route to a Peer; send an answer message to the Peer that originated the Diameter request message; or abandon the message routing without sending an answer response.
All Application Route Table configuration is done at the SOAM.
/diameter/applicationroutetables
get /diameter/applicationroutetables
Returns all Application Route Tables configured at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those Application Route Tables meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section).
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (one of configurationLevel)
The field being matched
Only the configurationLevel field is supported.
Example:
filter_name=configurationLevel
- filter_op: (one of GREATER_THAN, GREATER_THAN_EQUAL)
The match operation (operator)
Example:
filter_op=GREATER_THAN
- filter_values: (string)
The matched value
The configurationLevel value by which the data is being filtered. Only a single value is supported.
Example:
filter_values=10
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/applicationroutetableCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/applicationroutetable/applicationroutetable.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name for the Application Route Table, which must be unique within the DSR site. A name is required, and cannot be changed after the ART is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"configurationLevel": "202",
"name": "appRouteTable1"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/applicationroutetables
Adds a new Application Route Table to the DSR configuration. The new ART must have a name unique to the SOAM's configuration.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/applicationroutetable/applicationroutetable.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name for the Application Route Table, which must be unique within the DSR site. A name is required, and cannot be changed after the ART is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
Example
{
"configurationLevel": "202",
"name": "appRouteTable1"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/applicationroutetables/{name}
get /diameter/applicationroutetables/{name}
Returns the configuration details for the specified ART. If the specified ART does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/applicationroutetableItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/applicationroutetable/applicationroutetable.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name for the Application Route Table, which must be unique within the DSR site. A name is required, and cannot be changed after the ART is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"configurationLevel": "202",
"name": "appRouteTable1"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
delete /diameter/applicationroutetables/{name}
Deletes the specified Application Route Table from the SOAM configuration. An ART is only deleted if all delete validation checks pass. If the ART is associated with the configuration of a Peer Node or Transaction Configuration Set, the ART cannot be deleted. For example, if the ART is associated with a Peer Node (/diameter/peernodes), that association must first be removed (either by editing the Peer Node and choosing a different ART, or deleting the Peer Node entirely). Then the ART can be deleted from the configuration. An attempt to delete an ART that cannot be deleted results in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Diameter: AVP Removal Lists
An AVP Removal List is used to selectively remove AVPs from Diameter messages, and it is associated with a Peer Node (/diameter/peernodes) through Peer Node configuration. Any AVP can be removed using this mechanism, but one potential use case is the removal of vendor-specific AVPs.
AVPs can be removed from within the body of Diameter messages: 1) ingressing the DSR; 2) egressing the DSR; or 3) both. In addition, an AVP Removal List can be applied to just request messages, just answer messages, or both request and answer messages. Up to ten AVPs can be specified in an AVP Removal List, and all AVPs in the list that are found within a message to be processed are removed from that message.
All AVP Removal List configuration is done at the SOAM.
/diameter/avpremovallists
get /diameter/avpremovallists
Returns all AVP Removal Lists configured at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those AVP Removal Lists meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section).
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (one of configurationLevel)
The field being matched
Only the configurationLevel field is supported.
Example:
filter_name=configurationLevel
- filter_op: (one of GREATER_THAN, GREATER_THAN_EQUAL)
The match operation (operator)
Example:
filter_op=GREATER_THAN
- filter_values: (string)
The matched value
The configurationLevel value by which the data is being filtered. Only a single value is supported.
Example:
filter_values=10
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/avpremovallistCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/avpremovallist/avpremovallist.json",
"properties": {
"avp": {
"description": "The AVPs associated with this AVP Removal List. An AVP Removal List must have between one and ten AVPs in the list.",
"items": {
"properties": {
"avpCode": {
"description": "The 32-bit number that, when combined with the vendorId value, uniquely identifies the Diameter attribute.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"avpName": {
"description": "User-defined name associated with this avpCode. Informational only - it is not used by the DSR when executing AVP Removal Lists.",
"maxLength": 32,
"type": "string"
},
"vendorId": {
"description": "The 32-bit number that identifies the vendor for vendor-specific AVPs. If the avpCode is not vendor-specific, the vendorId field should be zero.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"vendorName": {
"description": "User-defined name associated with the vendorId value. Informational only - it is not used by the DSR when executing AVP Removal Lists.",
"maxLength": 32,
"type": "string"
}
},
"required": [
"avpCode",
"vendorId"
],
"type": "object"
},
"minItems": 1,
"maxItems": 10,
"type": "array"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"direction": {
"description": "When set to Ingress, only messages (request or answer) entering the DSR can be stripped of the AVPs in the list. When set to Egress, AVPs can only be removed from messages exiting the DSR. When set to IngressAndEgress, AVPs can be removed from both ingress and egress messages.",
"enum": [
"Egress",
"Ingress",
"IngressAndEgress"
],
"type": "string"
},
"messageType": {
"description": "When set to RequestOnly, AVPs can be removed only from request messages. When set to AnswerOnly, AVPs can be removed only from answer messages. When set to RequestAndAnswer, AVPs can be removed from both request and answer messages.",
"enum": [
"AnswerOnly",
"RequestAndAnswer",
"RequestOnly"
],
"type": "string"
},
"name": {
"description": "Name for this AVP Removal List, which must be unique within the DSR site. A name is required, and cannot be changed after the AVP Removal List is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"avp",
"direction",
"messageType",
"name"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"avp": [
{
"avpCode": 1000,
"avpName": "testAVP",
"vendorId": 4242,
"vendorName": "testVendor"
},
{
"avpCode": 2000,
"avpName": "testAVP2",
"vendorId": 908,
"vendorName": "testVendor2"
}
],
"configurationLevel": "8675309",
"direction": "Ingress",
"messageType": "RequestAndAnswer",
"name": "AvpRemovalList1"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/avpremovallists
Adds a new AVP Removal List to the DSR configuration. The new AVP Removal List must have a name that is unique across all AVP Removal Lists at the SOAM.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/avpremovallist/avpremovallist.json",
"properties": {
"avp": {
"description": "The AVPs associated with this AVP Removal List. An AVP Removal List must have between one and ten AVPs in the list.",
"items": {
"properties": {
"avpCode": {
"description": "The 32-bit number that, when combined with the vendorId value, uniquely identifies the Diameter attribute.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"avpName": {
"description": "User-defined name associated with this avpCode. Informational only - it is not used by the DSR when executing AVP Removal Lists.",
"maxLength": 32,
"type": "string"
},
"vendorId": {
"description": "The 32-bit number that identifies the vendor for vendor-specific AVPs. If the avpCode is not vendor-specific, the vendorId field should be zero.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"vendorName": {
"description": "User-defined name associated with the vendorId value. Informational only - it is not used by the DSR when executing AVP Removal Lists.",
"maxLength": 32,
"type": "string"
}
},
"required": [
"avpCode",
"vendorId"
],
"type": "object"
},
"minItems": 1,
"maxItems": 10,
"type": "array"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"direction": {
"description": "When set to Ingress, only messages (request or answer) entering the DSR can be stripped of the AVPs in the list. When set to Egress, AVPs can only be removed from messages exiting the DSR. When set to IngressAndEgress, AVPs can be removed from both ingress and egress messages.",
"enum": [
"Egress",
"Ingress",
"IngressAndEgress"
],
"type": "string"
},
"messageType": {
"description": "When set to RequestOnly, AVPs can be removed only from request messages. When set to AnswerOnly, AVPs can be removed only from answer messages. When set to RequestAndAnswer, AVPs can be removed from both request and answer messages.",
"enum": [
"AnswerOnly",
"RequestAndAnswer",
"RequestOnly"
],
"type": "string"
},
"name": {
"description": "Name for this AVP Removal List, which must be unique within the DSR site. A name is required, and cannot be changed after the AVP Removal List is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"avp",
"direction",
"messageType",
"name"
],
"type": "object"
}
Example
{
"avp": [
{
"avpCode": 1000,
"avpName": "testAVP",
"vendorId": 4242,
"vendorName": "testVendor"
},
{
"avpCode": 2000,
"avpName": "testAVP2",
"vendorId": 908,
"vendorName": "testVendor2"
}
],
"configurationLevel": "8675309",
"direction": "Ingress",
"messageType": "RequestAndAnswer",
"name": "AvpRemovalList1"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/avpremovallists/{name}
get /diameter/avpremovallists/{name}
Returns the configuration details for the specified AVP Removal List. If the specified AVP Removal List does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/avpremovallistItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/avpremovallist/avpremovallist.json",
"properties": {
"avp": {
"description": "The AVPs associated with this AVP Removal List. An AVP Removal List must have between one and ten AVPs in the list.",
"items": {
"properties": {
"avpCode": {
"description": "The 32-bit number that, when combined with the vendorId value, uniquely identifies the Diameter attribute.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"avpName": {
"description": "User-defined name associated with this avpCode. Informational only - it is not used by the DSR when executing AVP Removal Lists.",
"maxLength": 32,
"type": "string"
},
"vendorId": {
"description": "The 32-bit number that identifies the vendor for vendor-specific AVPs. If the avpCode is not vendor-specific, the vendorId field should be zero.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"vendorName": {
"description": "User-defined name associated with the vendorId value. Informational only - it is not used by the DSR when executing AVP Removal Lists.",
"maxLength": 32,
"type": "string"
}
},
"required": [
"avpCode",
"vendorId"
],
"type": "object"
},
"minItems": 1,
"maxItems": 10,
"type": "array"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"direction": {
"description": "When set to Ingress, only messages (request or answer) entering the DSR can be stripped of the AVPs in the list. When set to Egress, AVPs can only be removed from messages exiting the DSR. When set to IngressAndEgress, AVPs can be removed from both ingress and egress messages.",
"enum": [
"Egress",
"Ingress",
"IngressAndEgress"
],
"type": "string"
},
"messageType": {
"description": "When set to RequestOnly, AVPs can be removed only from request messages. When set to AnswerOnly, AVPs can be removed only from answer messages. When set to RequestAndAnswer, AVPs can be removed from both request and answer messages.",
"enum": [
"AnswerOnly",
"RequestAndAnswer",
"RequestOnly"
],
"type": "string"
},
"name": {
"description": "Name for this AVP Removal List, which must be unique within the DSR site. A name is required, and cannot be changed after the AVP Removal List is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"avp",
"direction",
"messageType",
"name"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"avp": [
{
"avpCode": 1000,
"avpName": "testAVP",
"vendorId": 4242,
"vendorName": "testVendor"
},
{
"avpCode": 2000,
"avpName": "testAVP2",
"vendorId": 908,
"vendorName": "testVendor2"
}
],
"configurationLevel": "8675309",
"direction": "Ingress",
"messageType": "RequestAndAnswer",
"name": "AvpRemovalList1"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/avpremovallists/{name}
Updates the configuration for the specified AVP Removal List. If the provided AVP Removal List data is invalid in any way, the update fails, resulting in one or more error messages returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/avpremovallist/avpremovallist.json",
"properties": {
"avp": {
"description": "The AVPs associated with this AVP Removal List. An AVP Removal List must have between one and ten AVPs in the list.",
"items": {
"properties": {
"avpCode": {
"description": "The 32-bit number that, when combined with the vendorId value, uniquely identifies the Diameter attribute.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"avpName": {
"description": "User-defined name associated with this avpCode. Informational only - it is not used by the DSR when executing AVP Removal Lists.",
"maxLength": 32,
"type": "string"
},
"vendorId": {
"description": "The 32-bit number that identifies the vendor for vendor-specific AVPs. If the avpCode is not vendor-specific, the vendorId field should be zero.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"vendorName": {
"description": "User-defined name associated with the vendorId value. Informational only - it is not used by the DSR when executing AVP Removal Lists.",
"maxLength": 32,
"type": "string"
}
},
"required": [
"avpCode",
"vendorId"
],
"type": "object"
},
"minItems": 1,
"maxItems": 10,
"type": "array"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"direction": {
"description": "When set to Ingress, only messages (request or answer) entering the DSR can be stripped of the AVPs in the list. When set to Egress, AVPs can only be removed from messages exiting the DSR. When set to IngressAndEgress, AVPs can be removed from both ingress and egress messages.",
"enum": [
"Egress",
"Ingress",
"IngressAndEgress"
],
"type": "string"
},
"messageType": {
"description": "When set to RequestOnly, AVPs can be removed only from request messages. When set to AnswerOnly, AVPs can be removed only from answer messages. When set to RequestAndAnswer, AVPs can be removed from both request and answer messages.",
"enum": [
"AnswerOnly",
"RequestAndAnswer",
"RequestOnly"
],
"type": "string"
},
"name": {
"description": "Name for this AVP Removal List, which must be unique within the DSR site. A name is required, and cannot be changed after the AVP Removal List is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"avp",
"direction",
"messageType",
"name"
],
"type": "object"
}
Example
{
"avp": [
{
"avpCode": 1000,
"avpName": "testAVP",
"vendorId": 4242,
"vendorName": "testVendor"
},
{
"avpCode": 2000,
"avpName": "testAVP2",
"vendorId": 908,
"vendorName": "testVendor2"
}
],
"configurationLevel": "8675309",
"direction": "Ingress",
"messageType": "RequestAndAnswer",
"name": "AvpRemovalList1"
}
delete /diameter/avpremovallists/{name}
Deletes the specified AVP Removal List from the SOAM configuration. An AVP Removal List can only be deleted if all delete validation checks pass. In general, if the AVP Removal List is part of the configuration of some other Managed Object, the AVP Removal List cannot be deleted. For example, if the AVP Removal List is named by a Peer Node (/diameter/peernodes), the AVP Removal List must first be removed from the Peer Node. Then the AVP Removal List can be deleted from the configuration. An attempt to delete an AVP Removal List that cannot be deleted results in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Diameter: Capacity Configuration Sets
Capacity Configuration Sets provide a mechanism for adjusting a Connection (/diameter/connections) to account for the network quality of service and Peer Node (/diameter/peernodes) requirements, and allow management of capacity data for Diameter Connections. Each Connection has a Capacity Configuration Set assigned to it so the attributes of Capacity Configuration Set essentially become attributes of the Connection(s) to which it is assigned.
The Capacity Configuration Set named Default is always available. The Default Capacity Configuration Set can be modified, but it cannot be deleted.
All Capacity Configuration Set configuration is done at the SOAM.
/diameter/capacityconfigurationsets
get /diameter/capacityconfigurationsets
Returns all Capacity Configuration Sets configured at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those Capacity Configuration Sets meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section).
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/capacityconfigurationsetCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/capacityconfigurationset/capacityconfigurationset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"convergenceTime": {
"description": "The time, in milliseconds, it takes to converge on a per second rate. If the convergence time is less than 1000 msec, the rate is extrapolated. If the convergence time is greater than 1000 msec, the rate is averaged. Typical value is 1000.",
"enum": [250, 500, 1000, 2000, 4000],
"type": "integer"
},
"ingressMpsMajorAlarmThreshold": {
"description": "The percentage of the Maximum Ingress MPS at which a major alarm is raised for connections using the Capacity Configuration Set. Once an alarm is raised, it is not cleared until the ingress MPS falls 5% or more below the ingress Capacity Major Alarm Threshold. The Major Alarm Threshold must be greater than the Minor Alarm Threshold. Typical value is 80.",
"maximum": 100,
"minimum": 11,
"type": "integer"
},
"ingressMpsMinorAlarmThreshold": {
"description": "The percentage of the Maximum Ingress MPS at which a minor alarm is raised for connections using the Capacity Configuration Set. Once an alarm is raised, it is not cleared until the ingress MPS falls 5% or more below the ingress Capacity Minor Alarm Threshold. The Minor Alarm Threshold must be less than the Major Alarm Threshold. Typical value is 50.",
"maximum": 99,
"minimum": 10,
"type": "integer"
},
"maxIngressMps": {
"description": "The maximum rate ingress messages per second that a Diameter Connection using this Capacity Configuration Set is allowed to process. The maximum ingress MPS must be greater than or equal to the reserved ingress MPS. Any difference between the maximum ingress MPS and the reserved ingress MPS represents MP server resources that are shared among Connections using this Capacity Configuration Set. Typical value is 10000.",
"maximum": 10000,
"minimum": 10,
"type": "integer"
},
"name": {
"description": "Name for the Capacity Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit. This value is required for all Capacity Configuration Sets.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"reservedIngressMpsAbatementTime": {
"description": "The time, in milliseconds, a Connection's ingress message rate must remain 5% below an alarm onset threshold before clearing. Typical value is 2000.",
"maximum": 5000,
"minimum": 1000,
"type": "integer"
},
"reservedIngressMps": {
"description": "The capacity, in messages per second, explicitly reserved for a Connection (/diameter/connections) that is assigned this Capacity Configuration Set. Typical value is 0.",
"maximum": 10000,
"minimum": 0,
"type": "integer"
}
},
"required": [
"convergenceTime",
"ingressMpsMajorAlarmThreshold",
"ingressMpsMinorAlarmThreshold",
"maxIngressMps",
"name",
"reservedIngressMpsAbatementTime",
"reservedIngressMps"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"configurationLevel": "47",
"convergenceTime": 1000,
"ingressMpsMajorAlarmThreshold": 80,
"ingressMpsMinorAlarmThreshold": 50,
"maxIngressMps": 10000,
"name": "CapacityConfigurationSet1",
"reservedIngressMpsAbatementTime": 2000,
"reservedIngressMps": 0
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/capacityconfigurationsets
Adds a new Capacity Configuration Set to the DSR configuration. The new Capacity Configuration Set must have a name that is unique across all Capacity Configuration Sets at the SOAM.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/capacityconfigurationset/capacityconfigurationset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"convergenceTime": {
"description": "The time, in milliseconds, it takes to converge on a per second rate. If the convergence time is less than 1000 msec, the rate is extrapolated. If the convergence time is greater than 1000 msec, the rate is averaged. Typical value is 1000.",
"enum": [250, 500, 1000, 2000, 4000],
"type": "integer"
},
"ingressMpsMajorAlarmThreshold": {
"description": "The percentage of the Maximum Ingress MPS at which a major alarm is raised for connections using the Capacity Configuration Set. Once an alarm is raised, it is not cleared until the ingress MPS falls 5% or more below the ingress Capacity Major Alarm Threshold. The Major Alarm Threshold must be greater than the Minor Alarm Threshold. Typical value is 80.",
"maximum": 100,
"minimum": 11,
"type": "integer"
},
"ingressMpsMinorAlarmThreshold": {
"description": "The percentage of the Maximum Ingress MPS at which a minor alarm is raised for connections using the Capacity Configuration Set. Once an alarm is raised, it is not cleared until the ingress MPS falls 5% or more below the ingress Capacity Minor Alarm Threshold. The Minor Alarm Threshold must be less than the Major Alarm Threshold. Typical value is 50.",
"maximum": 99,
"minimum": 10,
"type": "integer"
},
"maxIngressMps": {
"description": "The maximum rate ingress messages per second that a Diameter Connection using this Capacity Configuration Set is allowed to process. The maximum ingress MPS must be greater than or equal to the reserved ingress MPS. Any difference between the maximum ingress MPS and the reserved ingress MPS represents MP server resources that are shared among Connections using this Capacity Configuration Set. Typical value is 10000.",
"maximum": 10000,
"minimum": 10,
"type": "integer"
},
"name": {
"description": "Name for the Capacity Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit. This value is required for all Capacity Configuration Sets.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"reservedIngressMpsAbatementTime": {
"description": "The time, in milliseconds, a Connection's ingress message rate must remain 5% below an alarm onset threshold before clearing. Typical value is 2000.",
"maximum": 5000,
"minimum": 1000,
"type": "integer"
},
"reservedIngressMps": {
"description": "The capacity, in messages per second, explicitly reserved for a Connection (/diameter/connections) that is assigned this Capacity Configuration Set. Typical value is 0.",
"maximum": 10000,
"minimum": 0,
"type": "integer"
}
},
"required": [
"convergenceTime",
"ingressMpsMajorAlarmThreshold",
"ingressMpsMinorAlarmThreshold",
"maxIngressMps",
"name",
"reservedIngressMpsAbatementTime",
"reservedIngressMps"
],
"type": "object"
}
Example
{
"configurationLevel": "47",
"convergenceTime": 1000,
"ingressMpsMajorAlarmThreshold": 80,
"ingressMpsMinorAlarmThreshold": 50,
"maxIngressMps": 10000,
"name": "CapacityConfigurationSet1",
"reservedIngressMpsAbatementTime": 2000,
"reservedIngressMps": 0
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/capacityconfigurationsets/{name}
get /diameter/capacityconfigurationsets/{name}
Returns the configuration details for the specified Capacity Configuration Set. If the Capacity Configuration Set does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/capacityconfigurationsetItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/capacityconfigurationset/capacityconfigurationset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"convergenceTime": {
"description": "The time, in milliseconds, it takes to converge on a per second rate. If the convergence time is less than 1000 msec, the rate is extrapolated. If the convergence time is greater than 1000 msec, the rate is averaged. Typical value is 1000.",
"enum": [250, 500, 1000, 2000, 4000],
"type": "integer"
},
"ingressMpsMajorAlarmThreshold": {
"description": "The percentage of the Maximum Ingress MPS at which a major alarm is raised for connections using the Capacity Configuration Set. Once an alarm is raised, it is not cleared until the ingress MPS falls 5% or more below the ingress Capacity Major Alarm Threshold. The Major Alarm Threshold must be greater than the Minor Alarm Threshold. Typical value is 80.",
"maximum": 100,
"minimum": 11,
"type": "integer"
},
"ingressMpsMinorAlarmThreshold": {
"description": "The percentage of the Maximum Ingress MPS at which a minor alarm is raised for connections using the Capacity Configuration Set. Once an alarm is raised, it is not cleared until the ingress MPS falls 5% or more below the ingress Capacity Minor Alarm Threshold. The Minor Alarm Threshold must be less than the Major Alarm Threshold. Typical value is 50.",
"maximum": 99,
"minimum": 10,
"type": "integer"
},
"maxIngressMps": {
"description": "The maximum rate ingress messages per second that a Diameter Connection using this Capacity Configuration Set is allowed to process. The maximum ingress MPS must be greater than or equal to the reserved ingress MPS. Any difference between the maximum ingress MPS and the reserved ingress MPS represents MP server resources that are shared among Connections using this Capacity Configuration Set. Typical value is 10000.",
"maximum": 10000,
"minimum": 10,
"type": "integer"
},
"name": {
"description": "Name for the Capacity Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit. This value is required for all Capacity Configuration Sets.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"reservedIngressMpsAbatementTime": {
"description": "The time, in milliseconds, a Connection's ingress message rate must remain 5% below an alarm onset threshold before clearing. Typical value is 2000.",
"maximum": 5000,
"minimum": 1000,
"type": "integer"
},
"reservedIngressMps": {
"description": "The capacity, in messages per second, explicitly reserved for a Connection (/diameter/connections) that is assigned this Capacity Configuration Set. Typical value is 0.",
"maximum": 10000,
"minimum": 0,
"type": "integer"
}
},
"required": [
"convergenceTime",
"ingressMpsMajorAlarmThreshold",
"ingressMpsMinorAlarmThreshold",
"maxIngressMps",
"name",
"reservedIngressMpsAbatementTime",
"reservedIngressMps"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"configurationLevel": "47",
"convergenceTime": 1000,
"ingressMpsMajorAlarmThreshold": 80,
"ingressMpsMinorAlarmThreshold": 50,
"maxIngressMps": 10000,
"name": "CapacityConfigurationSet1",
"reservedIngressMpsAbatementTime": 2000,
"reservedIngressMps": 0
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/capacityconfigurationsets/{name}
Updates the configuration of the specified Capacity Configuration Set.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/capacityconfigurationset/capacityconfigurationset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"convergenceTime": {
"description": "The time, in milliseconds, it takes to converge on a per second rate. If the convergence time is less than 1000 msec, the rate is extrapolated. If the convergence time is greater than 1000 msec, the rate is averaged. Typical value is 1000.",
"enum": [250, 500, 1000, 2000, 4000],
"type": "integer"
},
"ingressMpsMajorAlarmThreshold": {
"description": "The percentage of the Maximum Ingress MPS at which a major alarm is raised for connections using the Capacity Configuration Set. Once an alarm is raised, it is not cleared until the ingress MPS falls 5% or more below the ingress Capacity Major Alarm Threshold. The Major Alarm Threshold must be greater than the Minor Alarm Threshold. Typical value is 80.",
"maximum": 100,
"minimum": 11,
"type": "integer"
},
"ingressMpsMinorAlarmThreshold": {
"description": "The percentage of the Maximum Ingress MPS at which a minor alarm is raised for connections using the Capacity Configuration Set. Once an alarm is raised, it is not cleared until the ingress MPS falls 5% or more below the ingress Capacity Minor Alarm Threshold. The Minor Alarm Threshold must be less than the Major Alarm Threshold. Typical value is 50.",
"maximum": 99,
"minimum": 10,
"type": "integer"
},
"maxIngressMps": {
"description": "The maximum rate ingress messages per second that a Diameter Connection using this Capacity Configuration Set is allowed to process. The maximum ingress MPS must be greater than or equal to the reserved ingress MPS. Any difference between the maximum ingress MPS and the reserved ingress MPS represents MP server resources that are shared among Connections using this Capacity Configuration Set. Typical value is 10000.",
"maximum": 10000,
"minimum": 10,
"type": "integer"
},
"name": {
"description": "Name for the Capacity Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit. This value is required for all Capacity Configuration Sets.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"reservedIngressMpsAbatementTime": {
"description": "The time, in milliseconds, a Connection's ingress message rate must remain 5% below an alarm onset threshold before clearing. Typical value is 2000.",
"maximum": 5000,
"minimum": 1000,
"type": "integer"
},
"reservedIngressMps": {
"description": "The capacity, in messages per second, explicitly reserved for a Connection (/diameter/connections) that is assigned this Capacity Configuration Set. Typical value is 0.",
"maximum": 10000,
"minimum": 0,
"type": "integer"
}
},
"required": [
"convergenceTime",
"ingressMpsMajorAlarmThreshold",
"ingressMpsMinorAlarmThreshold",
"maxIngressMps",
"name",
"reservedIngressMpsAbatementTime",
"reservedIngressMps"
],
"type": "object"
}
Example
{
"configurationLevel": "47",
"convergenceTime": 1000,
"ingressMpsMajorAlarmThreshold": 80,
"ingressMpsMinorAlarmThreshold": 50,
"maxIngressMps": 10000,
"name": "CapacityConfigurationSet1",
"reservedIngressMpsAbatementTime": 2000,
"reservedIngressMps": 0
}
delete /diameter/capacityconfigurationsets/{name}
Deletes the specified Capacity Configuration Set from the SOAM configuration. The Default Capacity Configuration Set cannot be deleted. A Capacity Configuration Set can only be deleted if all delete validation checks pass. In general, if the Capacity Configuration Set is part of the configuration of one or more Connections (/diameter/connections), the Capacity Configuration Set cannot be deleted. If the Capacity Configuration Set is named in Connections, the Capacity Configuration Set must first be removed from the Connection. Then the Capacity Configuration Set can be deleted from the configuration. An attempt to delete a Capacity Configuration Set that cannot be deleted results in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Diameter: CEX Configuration Sets
A Capabilities Exchange (CEX) Configuration Set encapsulates a number of parameters that are used in the first interaction between Diameter nodes, called the capabilities exchange. By collecting these parameters into a configuration set, the set of parameters can be easily assigned to multiple Connections (/diameter/connections). The DSR and a Peer Node (/diameter/peernodes) negotiating to connect use the Diameter Application Ids (/diameter/applicationids) in the CEX Configuration Set to determine if they have enough Diameter functionality in common to establish the Connection and thus begin to transact Diameter messages.
All CEX Configuration Set configuration is done at the SOAM.
/diameter/cexconfigurationsets
get /diameter/cexconfigurationsets
Returns all CEX Configuration Sets configured at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those CEX Configuration Sets meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section).
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/cexconfigurationsetCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/cexconfigurationset/cexconfigurationset.json",
"properties": {
"clientMustIncludeAppIds": {
"description": "List of CEX Parameters (/diameter/cexparameters) which a Peer Node (/diameter/peernodes) must support in order for a Connection (/diameter/connections) to be established between the DSR and the Peer Node. If the Peer Node does not support all of the Diameter Application Ids (/diameter/applicationids) contained in this list of CEX Parameters (a CEX Parameter is defined in large part by its Diameter Application Id), the Connection would not be established. The Application Ids in clientMustIncludeAppIds are always considered a subset of the DSR-supported Application Ids. So clientMustIncludeAppIds and dsrSupportedAppIds together form the complete set of Application Ids (via CEX Parameters) that the DSR supports on a Connection assigned this CEX Configuration Set. Both clientMustIncludeAppIds and dsrSupportedAppIds cannot simultaneously be empty lists.",
"items": {
"properties": {
"appId": {
"description": "The Application Id is the numeric value that identifies a Diameter Application.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"appIdType": {
"description": "Indicates the type of the appId present in a Capabilities Exchange message. Valid values are Authentication and Accounting.",
"enum": [
"Authentication",
"Accounting"
],
"type": "string"
},
"vendorId": {
"description": "The value placed in the Vendor-Id AVP of the Capabilities Exchange message sent when a vendor-specific appId is selected. When a Vendor-specific appId ranging from 16777216 to 4194967294 is selected, a valid vendorId must also be provided.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"maxItems": 10,
"minItems": 0,
"type": "array"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"dsrSupportedAppIds": {
"description": "List of CEX Parameters (/diameter/cexparameters) that the DSR supports, but which a Peer Node (/diameter/peernodes) is not required to support, in order for a Connection (/diameter/connections) to be established between the DSR and the Peer Node. If clientMustIncludeAppIds is empty (meaning the DSR is not requiring a Peer Node to support a particular Application Id (/diameter/applicationids) in order for the Connection to be established), then there must be at least one Application Id in dsrSupportedAppIds that the Peer Node also supports (unless the Relay Application Id, 424967295, is specified). Otherwise the Connection would not be established. If clientMustIncludeAppIds is not empty, then the Peer Node must support all Application Ids in that list. In that case, the Connection can be established, and any overlap between dsrSupportedAppIds and additional Application Ids the Peer Node supports simply represents additional Diameter functionality the two nodes have in common. Note: any time dsrSupportedAppIds includes the Relay Application Id, 424967295, and clientMustIncludeAppIds is empty, the DSR allows the Connection to come up. In this case the DSR is advertising its relay capability, which is not limited to any particular Application Id. Both clientMustIncludeAppIds and dsrSupportedAppIds cannot simultaneously be empty lists.",
"items": {
"properties": {
"appId": {
"description": "The Application Id is the numeric value that identifies a Diameter Application.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"appIdType": {
"description": "Indicates the type of the appId present in a Capabilities Exchange message. Valid values are Authentication and Accounting.",
"enum": [
"Authentication",
"Accounting"
],
"type": "string"
},
"vendorId": {
"description": "The value placed in the Vendor-Id AVP of the Capabilities Exchange message sent when a vendor-specific appId is selected. When a Vendor-specific appId ranging from 16777216 to 4194967294 is selected, a valid vendorId must also be provided.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"maxItems": 10,
"minItems": 0,
"type": "array"
},
"dsrSupportedVendorIds": {
"description": "List of vendor IDs the DSR supports. Each vendor ID in this list must be one of the vendor IDs configured for vendor-specific Application IDs (/diameter/applicationids) within the CEX Parameters (/diameter/cexparameters) configuration.",
"items": {
"type": "integer"
},
"maxItems": 10,
"minItems": 0,
"type": "array"
},
"includeDsrFeatureStatusAvp": {
"description": "If true, the Oracle-specific DSR Feature Status AVP is included in CER/CEA messages sent by the DSR as part of the capabilities exchange process. Typically, this value is only set to true for Connections (/diameter/connections) between two DSRs.",
"type": "boolean"
},
"isDynamic": {
"description": "If true, means the CEX Configuration Set was created dynamically as a result of dynamic peer discovery. isDynamic is read-only.",
"readOnly": true,
"type": "boolean"
},
"name": {
"description": "Name for the CEX Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit. This value is required for all CEX Configuration Sets.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"includeDsrFeatureStatusAvp",
"name"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"clientMustIncludeAppIds": [
{
"appId": 4294967295,
"appIdType": "Authentication"
},
{
"appId": 16777224,
"appIdType": "Authentication",
"vendorId": 323
}
],
"configurationLevel": "888",
"dsrSupportedAppIds": [
{
"appId": 16777217,
"appIdType": "Authentication",
"vendorId": 323
}
],
"dsrSupportedVendorIds": [
323
],
"includeDsrFeatureStatusAvp": false,
"isDynamic": false,
"name": "cexCfgSet111"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/cexconfigurationsets
Adds a new CEX Configuration Set to the DSR configuration. The new CEX Configuration Set must have a name that is unique across all CEX Configuration Sets at the SOAM.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/cexconfigurationset/cexconfigurationset.json",
"properties": {
"clientMustIncludeAppIds": {
"description": "List of CEX Parameters (/diameter/cexparameters) which a Peer Node (/diameter/peernodes) must support in order for a Connection (/diameter/connections) to be established between the DSR and the Peer Node. If the Peer Node does not support all of the Diameter Application Ids (/diameter/applicationids) contained in this list of CEX Parameters (a CEX Parameter is defined in large part by its Diameter Application Id), the Connection would not be established. The Application Ids in clientMustIncludeAppIds are always considered a subset of the DSR-supported Application Ids. So clientMustIncludeAppIds and dsrSupportedAppIds together form the complete set of Application Ids (via CEX Parameters) that the DSR supports on a Connection assigned this CEX Configuration Set. Both clientMustIncludeAppIds and dsrSupportedAppIds cannot simultaneously be empty lists.",
"items": {
"properties": {
"appId": {
"description": "The Application Id is the numeric value that identifies a Diameter Application.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"appIdType": {
"description": "Indicates the type of the appId present in a Capabilities Exchange message. Valid values are Authentication and Accounting.",
"enum": [
"Authentication",
"Accounting"
],
"type": "string"
},
"vendorId": {
"description": "The value placed in the Vendor-Id AVP of the Capabilities Exchange message sent when a vendor-specific appId is selected. When a Vendor-specific appId ranging from 16777216 to 4194967294 is selected, a valid vendorId must also be provided.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"maxItems": 10,
"minItems": 0,
"type": "array"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"dsrSupportedAppIds": {
"description": "List of CEX Parameters (/diameter/cexparameters) that the DSR supports, but which a Peer Node (/diameter/peernodes) is not required to support, in order for a Connection (/diameter/connections) to be established between the DSR and the Peer Node. If clientMustIncludeAppIds is empty (meaning the DSR is not requiring a Peer Node to support a particular Application Id (/diameter/applicationids) in order for the Connection to be established), then there must be at least one Application Id in dsrSupportedAppIds that the Peer Node also supports (unless the Relay Application Id, 424967295, is specified). Otherwise the Connection would not be established. If clientMustIncludeAppIds is not empty, then the Peer Node must support all Application Ids in that list. In that case, the Connection can be established, and any overlap between dsrSupportedAppIds and additional Application Ids the Peer Node supports simply represents additional Diameter functionality the two nodes have in common. Note: any time dsrSupportedAppIds includes the Relay Application Id, 424967295, and clientMustIncludeAppIds is empty, the DSR allows the Connection to come up. In this case the DSR is advertising its relay capability, which is not limited to any particular Application Id. Both clientMustIncludeAppIds and dsrSupportedAppIds cannot simultaneously be empty lists.",
"items": {
"properties": {
"appId": {
"description": "The Application Id is the numeric value that identifies a Diameter Application.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"appIdType": {
"description": "Indicates the type of the appId present in a Capabilities Exchange message. Valid values are Authentication and Accounting.",
"enum": [
"Authentication",
"Accounting"
],
"type": "string"
},
"vendorId": {
"description": "The value placed in the Vendor-Id AVP of the Capabilities Exchange message sent when a vendor-specific appId is selected. When a Vendor-specific appId ranging from 16777216 to 4194967294 is selected, a valid vendorId must also be provided.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"maxItems": 10,
"minItems": 0,
"type": "array"
},
"dsrSupportedVendorIds": {
"description": "List of vendor IDs the DSR supports. Each vendor ID in this list must be one of the vendor IDs configured for vendor-specific Application IDs (/diameter/applicationids) within the CEX Parameters (/diameter/cexparameters) configuration.",
"items": {
"type": "integer"
},
"maxItems": 10,
"minItems": 0,
"type": "array"
},
"includeDsrFeatureStatusAvp": {
"description": "If true, the Oracle-specific DSR Feature Status AVP is included in CER/CEA messages sent by the DSR as part of the capabilities exchange process. Typically, this value is only set to true for Connections (/diameter/connections) between two DSRs.",
"type": "boolean"
},
"isDynamic": {
"description": "If true, means the CEX Configuration Set was created dynamically as a result of dynamic peer discovery. isDynamic is read-only.",
"readOnly": true,
"type": "boolean"
},
"name": {
"description": "Name for the CEX Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit. This value is required for all CEX Configuration Sets.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"includeDsrFeatureStatusAvp",
"name"
],
"type": "object"
}
Example
{
"clientMustIncludeAppIds": [
{
"appId": 4294967295,
"appIdType": "Authentication"
},
{
"appId": 16777224,
"appIdType": "Authentication",
"vendorId": 323
}
],
"configurationLevel": "888",
"dsrSupportedAppIds": [
{
"appId": 16777217,
"appIdType": "Authentication",
"vendorId": 323
}
],
"dsrSupportedVendorIds": [
323
],
"includeDsrFeatureStatusAvp": false,
"isDynamic": false,
"name": "cexCfgSet111"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/cexconfigurationsets/{name}
get /diameter/cexconfigurationsets/{name}
Returns the configuration details for the specified CEX Configuration Set. If the CEX Configuration Set does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/cexconfigurationsetItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/cexconfigurationset/cexconfigurationset.json",
"properties": {
"clientMustIncludeAppIds": {
"description": "List of CEX Parameters (/diameter/cexparameters) which a Peer Node (/diameter/peernodes) must support in order for a Connection (/diameter/connections) to be established between the DSR and the Peer Node. If the Peer Node does not support all of the Diameter Application Ids (/diameter/applicationids) contained in this list of CEX Parameters (a CEX Parameter is defined in large part by its Diameter Application Id), the Connection would not be established. The Application Ids in clientMustIncludeAppIds are always considered a subset of the DSR-supported Application Ids. So clientMustIncludeAppIds and dsrSupportedAppIds together form the complete set of Application Ids (via CEX Parameters) that the DSR supports on a Connection assigned this CEX Configuration Set. Both clientMustIncludeAppIds and dsrSupportedAppIds cannot simultaneously be empty lists.",
"items": {
"properties": {
"appId": {
"description": "The Application Id is the numeric value that identifies a Diameter Application.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"appIdType": {
"description": "Indicates the type of the appId present in a Capabilities Exchange message. Valid values are Authentication and Accounting.",
"enum": [
"Authentication",
"Accounting"
],
"type": "string"
},
"vendorId": {
"description": "The value placed in the Vendor-Id AVP of the Capabilities Exchange message sent when a vendor-specific appId is selected. When a Vendor-specific appId ranging from 16777216 to 4194967294 is selected, a valid vendorId must also be provided.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"maxItems": 10,
"minItems": 0,
"type": "array"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"dsrSupportedAppIds": {
"description": "List of CEX Parameters (/diameter/cexparameters) that the DSR supports, but which a Peer Node (/diameter/peernodes) is not required to support, in order for a Connection (/diameter/connections) to be established between the DSR and the Peer Node. If clientMustIncludeAppIds is empty (meaning the DSR is not requiring a Peer Node to support a particular Application Id (/diameter/applicationids) in order for the Connection to be established), then there must be at least one Application Id in dsrSupportedAppIds that the Peer Node also supports (unless the Relay Application Id, 424967295, is specified). Otherwise the Connection would not be established. If clientMustIncludeAppIds is not empty, then the Peer Node must support all Application Ids in that list. In that case, the Connection can be established, and any overlap between dsrSupportedAppIds and additional Application Ids the Peer Node supports simply represents additional Diameter functionality the two nodes have in common. Note: any time dsrSupportedAppIds includes the Relay Application Id, 424967295, and clientMustIncludeAppIds is empty, the DSR allows the Connection to come up. In this case the DSR is advertising its relay capability, which is not limited to any particular Application Id. Both clientMustIncludeAppIds and dsrSupportedAppIds cannot simultaneously be empty lists.",
"items": {
"properties": {
"appId": {
"description": "The Application Id is the numeric value that identifies a Diameter Application.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"appIdType": {
"description": "Indicates the type of the appId present in a Capabilities Exchange message. Valid values are Authentication and Accounting.",
"enum": [
"Authentication",
"Accounting"
],
"type": "string"
},
"vendorId": {
"description": "The value placed in the Vendor-Id AVP of the Capabilities Exchange message sent when a vendor-specific appId is selected. When a Vendor-specific appId ranging from 16777216 to 4194967294 is selected, a valid vendorId must also be provided.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"maxItems": 10,
"minItems": 0,
"type": "array"
},
"dsrSupportedVendorIds": {
"description": "List of vendor IDs the DSR supports. Each vendor ID in this list must be one of the vendor IDs configured for vendor-specific Application IDs (/diameter/applicationids) within the CEX Parameters (/diameter/cexparameters) configuration.",
"items": {
"type": "integer"
},
"maxItems": 10,
"minItems": 0,
"type": "array"
},
"includeDsrFeatureStatusAvp": {
"description": "If true, the Oracle-specific DSR Feature Status AVP is included in CER/CEA messages sent by the DSR as part of the capabilities exchange process. Typically, this value is only set to true for Connections (/diameter/connections) between two DSRs.",
"type": "boolean"
},
"isDynamic": {
"description": "If true, means the CEX Configuration Set was created dynamically as a result of dynamic peer discovery. isDynamic is read-only.",
"readOnly": true,
"type": "boolean"
},
"name": {
"description": "Name for the CEX Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit. This value is required for all CEX Configuration Sets.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"includeDsrFeatureStatusAvp",
"name"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"clientMustIncludeAppIds": [
{
"appId": 4294967295,
"appIdType": "Authentication"
},
{
"appId": 16777224,
"appIdType": "Authentication",
"vendorId": 323
}
],
"configurationLevel": "888",
"dsrSupportedAppIds": [
{
"appId": 16777217,
"appIdType": "Authentication",
"vendorId": 323
}
],
"dsrSupportedVendorIds": [
323
],
"includeDsrFeatureStatusAvp": false,
"isDynamic": false,
"name": "cexCfgSet111"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/cexconfigurationsets/{name}
Updates the configuration of the specified CEX Configuration Set.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/cexconfigurationset/cexconfigurationset.json",
"properties": {
"clientMustIncludeAppIds": {
"description": "List of CEX Parameters (/diameter/cexparameters) which a Peer Node (/diameter/peernodes) must support in order for a Connection (/diameter/connections) to be established between the DSR and the Peer Node. If the Peer Node does not support all of the Diameter Application Ids (/diameter/applicationids) contained in this list of CEX Parameters (a CEX Parameter is defined in large part by its Diameter Application Id), the Connection would not be established. The Application Ids in clientMustIncludeAppIds are always considered a subset of the DSR-supported Application Ids. So clientMustIncludeAppIds and dsrSupportedAppIds together form the complete set of Application Ids (via CEX Parameters) that the DSR supports on a Connection assigned this CEX Configuration Set. Both clientMustIncludeAppIds and dsrSupportedAppIds cannot simultaneously be empty lists.",
"items": {
"properties": {
"appId": {
"description": "The Application Id is the numeric value that identifies a Diameter Application.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"appIdType": {
"description": "Indicates the type of the appId present in a Capabilities Exchange message. Valid values are Authentication and Accounting.",
"enum": [
"Authentication",
"Accounting"
],
"type": "string"
},
"vendorId": {
"description": "The value placed in the Vendor-Id AVP of the Capabilities Exchange message sent when a vendor-specific appId is selected. When a Vendor-specific appId ranging from 16777216 to 4194967294 is selected, a valid vendorId must also be provided.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"maxItems": 10,
"minItems": 0,
"type": "array"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"dsrSupportedAppIds": {
"description": "List of CEX Parameters (/diameter/cexparameters) that the DSR supports, but which a Peer Node (/diameter/peernodes) is not required to support, in order for a Connection (/diameter/connections) to be established between the DSR and the Peer Node. If clientMustIncludeAppIds is empty (meaning the DSR is not requiring a Peer Node to support a particular Application Id (/diameter/applicationids) in order for the Connection to be established), then there must be at least one Application Id in dsrSupportedAppIds that the Peer Node also supports (unless the Relay Application Id, 424967295, is specified). Otherwise the Connection would not be established. If clientMustIncludeAppIds is not empty, then the Peer Node must support all Application Ids in that list. In that case, the Connection can be established, and any overlap between dsrSupportedAppIds and additional Application Ids the Peer Node supports simply represents additional Diameter functionality the two nodes have in common. Note: any time dsrSupportedAppIds includes the Relay Application Id, 424967295, and clientMustIncludeAppIds is empty, the DSR allows the Connection to come up. In this case the DSR is advertising its relay capability, which is not limited to any particular Application Id. Both clientMustIncludeAppIds and dsrSupportedAppIds cannot simultaneously be empty lists.",
"items": {
"properties": {
"appId": {
"description": "The Application Id is the numeric value that identifies a Diameter Application.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"appIdType": {
"description": "Indicates the type of the appId present in a Capabilities Exchange message. Valid values are Authentication and Accounting.",
"enum": [
"Authentication",
"Accounting"
],
"type": "string"
},
"vendorId": {
"description": "The value placed in the Vendor-Id AVP of the Capabilities Exchange message sent when a vendor-specific appId is selected. When a Vendor-specific appId ranging from 16777216 to 4194967294 is selected, a valid vendorId must also be provided.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"maxItems": 10,
"minItems": 0,
"type": "array"
},
"dsrSupportedVendorIds": {
"description": "List of vendor IDs the DSR supports. Each vendor ID in this list must be one of the vendor IDs configured for vendor-specific Application IDs (/diameter/applicationids) within the CEX Parameters (/diameter/cexparameters) configuration.",
"items": {
"type": "integer"
},
"maxItems": 10,
"minItems": 0,
"type": "array"
},
"includeDsrFeatureStatusAvp": {
"description": "If true, the Oracle-specific DSR Feature Status AVP is included in CER/CEA messages sent by the DSR as part of the capabilities exchange process. Typically, this value is only set to true for Connections (/diameter/connections) between two DSRs.",
"type": "boolean"
},
"isDynamic": {
"description": "If true, means the CEX Configuration Set was created dynamically as a result of dynamic peer discovery. isDynamic is read-only.",
"readOnly": true,
"type": "boolean"
},
"name": {
"description": "Name for the CEX Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit. This value is required for all CEX Configuration Sets.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"includeDsrFeatureStatusAvp",
"name"
],
"type": "object"
}
Example
{
"clientMustIncludeAppIds": [
{
"appId": 4294967295,
"appIdType": "Authentication"
},
{
"appId": 16777224,
"appIdType": "Authentication",
"vendorId": 323
}
],
"configurationLevel": "888",
"dsrSupportedAppIds": [
{
"appId": 16777217,
"appIdType": "Authentication",
"vendorId": 323
}
],
"dsrSupportedVendorIds": [
323
],
"includeDsrFeatureStatusAvp": false,
"isDynamic": false,
"name": "cexCfgSet111"
}
delete /diameter/cexconfigurationsets/{name}
Deletes the specified CEX Configuration Set from the SOAM configuration. The Default CEX Configuration Set cannot be deleted. A CEX Configuration Set can only be deleted if all delete validation checks pass. In general, if the CEX Configuration Set is part of the configuration of some other Managed Object, the CEX Configuration Set cannot be deleted. For example, if the CEX Configuration Set is named by a Connection (/diameter/connections), the CEX Configuration Set must be removed from the Connection. Then the CEX Configuration Set can be deleted from the configuration. An attempt to delete a CEX Configuration Set that cannot be deleted results in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Diameter: CEX Parameters
A Capabilities Exchange (CEX) Parameter is an association between a Diameter Application and an application type and vendor Id. CEX Parameters are selected in the Capabilities Exchange Configuration Sets (/diameter/cexconfigurationsets), which are used by Diameter Connections (/diameter/connections) for performing Capabilities Exchange with a Diameter Peer Node (/diameter/peernodes).
When a Vendor-specific Application Id ranging from 16777216 to 4194967294 is selected, a valid Vendor Id must also be provided.
The CEX Parameter resource has no natural identifier within the DSR - each instance is not explicitly named. But to support the DELETE operation, DSR must provide an identifier to be used in the URI. The id field in the JSON schemas serves this purpose. Clients do not need to provide a value for id in the JSON data when submitting POST requests. The id value DSR supplies in a GET response only needs to be used in the URI for any subsequent DELETE.
All Capabilities Exchange Parameter configuration is done at the SOAM.
/diameter/cexparameters
get /diameter/cexparameters
Returns all CEX Parameters configured at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those CEX Parameters meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section).
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (one of configurationLevel)
The field being matched
Only the configurationLevel field is supported.
Example:
filter_name=configurationLevel
- filter_op: (one of GREATER_THAN, GREATER_THAN_EQUAL)
The match operation (operator)
Example:
filter_op=GREATER_THAN
- filter_values: (string)
The matched value
The configurationLevel value by which the data is being filtered. Only a single value is supported.
Example:
filter_values=10
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/cexparameterCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/cexparameter/cexparameter.json",
"properties": {
"appId": {
"description": "The Application Id is the numeric value that identifies a Diameter Application.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"appIdType": {
"description": "Indicates the type of the appId present in a Capabilities Exchange message. Valid values are Authentication and Accounting.",
"enum": [
"Authentication",
"Accounting"
],
"type": "string"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"id": {
"description": "The natural identifier for the CEX Parameter instance (which has no name).",
"maxLength": 36,
"readOnly": true,
"type": "string"
},
"vendorId": {
"description": "The value placed in the Vendor-Id AVP of the Capabilities Exchange message sent when a vendor-specific appId is selected. When a Vendor-specific appId ranging from 16777216 to 4194967294 is selected, a valid vendorId must also be provided.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
}
},
"required": [
"appId",
"appIdType"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"appId": 4294967295,
"appIdType": "Authentication",
"configurationLevel": "123",
"id": "4294967295-Authentication-1",
"vendorId": 1
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/cexparameters
Adds a new Capabilities Exchange Parameter to the DSR configuration.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/cexparameter/cexparameter.json",
"properties": {
"appId": {
"description": "The Application Id is the numeric value that identifies a Diameter Application.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"appIdType": {
"description": "Indicates the type of the appId present in a Capabilities Exchange message. Valid values are Authentication and Accounting.",
"enum": [
"Authentication",
"Accounting"
],
"type": "string"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"id": {
"description": "The natural identifier for the CEX Parameter instance (which has no name).",
"maxLength": 36,
"readOnly": true,
"type": "string"
},
"vendorId": {
"description": "The value placed in the Vendor-Id AVP of the Capabilities Exchange message sent when a vendor-specific appId is selected. When a Vendor-specific appId ranging from 16777216 to 4194967294 is selected, a valid vendorId must also be provided.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
}
},
"required": [
"appId",
"appIdType"
],
"type": "object"
}
Example
{
"appId": 4294967295,
"appIdType": "Authentication",
"configurationLevel": "123",
"id": "4294967295-Authentication-1",
"vendorId": 1
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/cexparameters/{id}
get /diameter/cexparameters/{id}
Returns the configuration details for the specified Capabilities Exchange Parameter. If the specified CEX Parameter does not exist in the SOAM's configuration, an error message is returned within the HTTP response. A CEX Parameter instance is uniquely identified by the id attribute returned in the JSON data accompanying a GET response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- id: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/cexparameterItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/cexparameter/cexparameter.json",
"properties": {
"appId": {
"description": "The Application Id is the numeric value that identifies a Diameter Application.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"appIdType": {
"description": "Indicates the type of the appId present in a Capabilities Exchange message. Valid values are Authentication and Accounting.",
"enum": [
"Authentication",
"Accounting"
],
"type": "string"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"id": {
"description": "The natural identifier for the CEX Parameter instance (which has no name).",
"maxLength": 36,
"readOnly": true,
"type": "string"
},
"vendorId": {
"description": "The value placed in the Vendor-Id AVP of the Capabilities Exchange message sent when a vendor-specific appId is selected. When a Vendor-specific appId ranging from 16777216 to 4194967294 is selected, a valid vendorId must also be provided.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
}
},
"required": [
"appId",
"appIdType"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"appId": 4294967295,
"appIdType": "Authentication",
"configurationLevel": "123",
"id": "4294967295-Authentication-1",
"vendorId": 1
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
delete /diameter/cexparameters/{id}
Deletes the specified Capabilities Exchange Parameter from the SOAM configuration. A CEX Parameter can only be deleted if all delete validation checks pass. In general, if the CEX Parameter is part of the configuration of some other Managed Object, the CEX Parameter cannot be deleted. For example, if the CEX Parameter is named in a Capabilities Exchange Configuration Set (/diameter/cexconfigurationsets), the CEX Parameter must first be removed from the Capabilities Exchange Configuration Set. Then the CEX Parameter can be deleted from the configuration. An attempt to delete a CEX Parameter that cannot be deleted results in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Diameter: Command Codes
Application Routing Rules (/diameter/applicationrouterules), Peer Routing Rules (/diameter/peerrouterules), and other configuration resources use the Command Code parameter to further define the action that is to be taken for a particular Diameter message. A Command Code is an integer value in the range 0-16777215, and DSR clients can insert, edit, and delete Command Codes as needed.
DSR also has the concept of an Extended Command Code (ECC), which is a command code extension that includes a Command Code, an AVP code, and an AVP data value. ECCs have the format X.Y.Z, where: X is an integer in the range 0-167777215; Y and Z are unsigned 32-bit integers (range 0-4294967295); and the dots are literal. The Extended Command Code allows additional application-specific Diameter or 3GPP AVP content per Command Code. DSR clients cannot insert, edit, or delete ECCs; the DSR has a set of pre-configured ECCs that are returned in the GET response and are thus read-only to clients.
All Command Code configuration is done at the SOAM.
/diameter/commandcodes
get /diameter/commandcodes
Returns all Command Codes configured at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those Command Codes meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section).
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/commandcodeCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/commandcode/commandcode.json",
"properties": {
"cmdCode": {
"description": "Identifies the Command Code or Extended Command Code associated with a message. The Command Code is an integer (represented as a string) in the range 0-16777215, while Extended Command Codes are of the format X.Y.Z, where X is a Command Code; Y and Z are 32-bit unassigned integers; and the dots are literal. Extended Command Codes are read-only to DSR clients, while Command Codes can be inserted, edited, and deleted by clients.",
"maxLength": 30,
"type": "string"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Client-assigned name associated with cmdCode.",
"maxLength": 64,
"type": "string"
}
},
"required": [
"cmdCode",
"name"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"cmdCode": "16777211",
"configurationLevel": "123",
"name": "Default"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/commandcodes
Adds a new Command Code to the DSR configuration. The Command Code must be unique and have an associated Command Code Name. Only Command Codes can be added; Extended Command Codes are effectely read-only to DSR clients.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/commandcode/commandcode.json",
"properties": {
"cmdCode": {
"description": "Identifies the Command Code or Extended Command Code associated with a message. The Command Code is an integer (represented as a string) in the range 0-16777215, while Extended Command Codes are of the format X.Y.Z, where X is a Command Code; Y and Z are 32-bit unassigned integers; and the dots are literal. Extended Command Codes are read-only to DSR clients, while Command Codes can be inserted, edited, and deleted by clients.",
"maxLength": 30,
"type": "string"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Client-assigned name associated with cmdCode.",
"maxLength": 64,
"type": "string"
}
},
"required": [
"cmdCode",
"name"
],
"type": "object"
}
Example
{
"cmdCode": "16777211",
"configurationLevel": "123",
"name": "Default"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/commandcodes/{id}
get /diameter/commandcodes/{id}
Returns the Command Code or Extended Command Code identified in the GET request. If the specified Command Code/ECC does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- id: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/commandcodeItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/commandcode/commandcode.json",
"properties": {
"cmdCode": {
"description": "Identifies the Command Code or Extended Command Code associated with a message. The Command Code is an integer (represented as a string) in the range 0-16777215, while Extended Command Codes are of the format X.Y.Z, where X is a Command Code; Y and Z are 32-bit unassigned integers; and the dots are literal. Extended Command Codes are read-only to DSR clients, while Command Codes can be inserted, edited, and deleted by clients.",
"maxLength": 30,
"type": "string"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Client-assigned name associated with cmdCode.",
"maxLength": 64,
"type": "string"
}
},
"required": [
"cmdCode",
"name"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"cmdCode": "16777211",
"configurationLevel": "123",
"name": "Default"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/commandcodes/{id}
Updates the associated Command Code name for the provided Command Code.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- id: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/commandcode/commandcode.json",
"properties": {
"cmdCode": {
"description": "Identifies the Command Code or Extended Command Code associated with a message. The Command Code is an integer (represented as a string) in the range 0-16777215, while Extended Command Codes are of the format X.Y.Z, where X is a Command Code; Y and Z are 32-bit unassigned integers; and the dots are literal. Extended Command Codes are read-only to DSR clients, while Command Codes can be inserted, edited, and deleted by clients.",
"maxLength": 30,
"type": "string"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Client-assigned name associated with cmdCode.",
"maxLength": 64,
"type": "string"
}
},
"required": [
"cmdCode",
"name"
],
"type": "object"
}
Example
{
"cmdCode": "16777211",
"configurationLevel": "123",
"name": "Default"
}
delete /diameter/commandcodes/{id}
Deletes the specified Command Code from the SOAM configuration. A Command Code can only be deleted if all delete validation checks pass. In general, if the Command Code is part of the configuration of some other Managed Object, the Command Code cannot be deleted. For example, if the Command Code is named by a Peer Route Rule (/diameter/peerouterules), the Command Code must first be removed from the Peer Route Rule. Then the Command Code can be deleted from the configuration. An attempt to delete a Command Code that cannot be deleted results in an error message within the HTTP response.
Target Server: SOAM
Secured by x-other
Diameter: Common Application Options
The Common Application Options are those configuration values that govern the overall application functionality and are not directly related to any particular Target Set. There is a single instance of this resource, which contains each of the individual options that can be retrieved and set. Because there is no collection of instances, there is no collection GET action. No new IPFE Options resource can be created, so there is no POST action, and the single instance cannot be removed, so there is no DELETE action. The single instance GET is used to retrieve the options, and PUT is used to update one or more values within the set of options. A name for this single, non-deletable instance is neither required nor expected.
All Common Application Options configuration is done at the NOAM.
/diameter/commonapplicationoptions
get /diameter/commonapplicationoptions
Returns the set of current values for the Common Application Options.
Target Server: NOAM
Response
HTTP status code 200
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/commonappoptionItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/commonappoption/commonappoption.json",
"properties": {
"enableEnhancedOverloadControl": {
"description": "If the Enhanced Overload Control Function is disabled, the existing PCA/SBR overload control function developed prior to Release 8.1 applies to those DA-MPs and SBR MPs where the DRMP feature is disabled. If the Enhanced Overload Control Function is enabled, the enhanced overload control function developed in Release 8.1 applies to all PCA DA-MPs and SBR MPs under the same NO toploogy, and all PCA DA-MPs and SBR MPs needs to be restarted.",
"type": "boolean"
}
},
"required": [
"enableEnhancedOverloadControl"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"enhancedoverloadcontrolfunction": true
},
"messages":
[
],
"links":
{
},
"status":
true
}
put /diameter/commonapplicationoptions
Updates the Common Application Options with the values supplied. To update just one of the individual options, GET the set, modify the value for the option that needs to be changed, then PUT the options.
Target Server: NOAM
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/commonappoption/commonappoption.json",
"properties": {
"enableEnhancedOverloadControl": {
"description": "If the Enhanced Overload Control Function is disabled, the existing PCA/SBR overload control function developed prior to Release 8.1 applies to those DA-MPs and SBR MPs where the DRMP feature is disabled. If the Enhanced Overload Control Function is enabled, the enhanced overload control function developed in Release 8.1 applies to all PCA DA-MPs and SBR MPs under the same NO toploogy, and all PCA DA-MPs and SBR MPs needs to be restarted.",
"type": "boolean"
}
},
"required": [
"enableEnhancedOverloadControl"
],
"type": "object"
}
Example
{
"enhancedoverloadcontrolfunction": true
}
Diameter: Connection Configuration Sets
Connection Configuration Sets provide a way to tailor a DSR connection to account for the network quality of service and Peer Node (/diameter/peernodes) requirements. A Connection Configuration Set is simply a collection of Connection (/diameter/connections) parameters that are grouped so the set can be easily assigned to multiple Connections. The parameters within a Connection Configuration Set are divided into general categories, which include TCP Options, SCTP Options, Diameter Options, and RADIUS Options. The RADIUS parameters do not apply when the Connection Configuration Set is assigned to a Diameter Connection, and the non-RADIUS parameters do not apply when the set is assigned to a RADIUS connection. The name of each parameter in the Connection Configuration Set begins with an identifier indicating which category the parameter applies to. The identifiers are diameter, radius, sctp, and tcp.
The Connection Configuration Set named Default is always available. The Default Connection Configuration Set can be modified, but it cannot be deleted.
All attributes (except for the read-only configurationLevel) for Connection Configuration Sets are marked as required in the JSON schema. A client should GET the Default instance, copy it, modify any attributes, and POST the new instance. This way, all attributes have valid values.
All configuration of the Connection Configuration Set is done at the SOAM.
/diameter/connectionconfigurationsets
get /diameter/connectionconfigurationsets
Returns all Connection Configuration Sets configured at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those Connection Configuration Sets meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section).
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/connectionconfigurationsetCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/connectionconfigurationset/connectionconfigurationset.json",
"properties": {
"cl1MinPriorityAllowed": {
"description": "Defines the minimum message priority of a Request message that can be forwarded to a Connection (/diameter/connections) whose congestion level is CL1. The typical value is 4 and the range is 1-15 when the ngnPs16PriorityAdminStateEnabled value (/diameter/options) is set to true. The typical value is 1 when the ngnPs16PriorityAdminStateEnabled value (/diameter/options) is set to false.",
"maximum": 15,
"minimum": 1,
"type": "integer"
},
"cl2MinPriorityAllowed": {
"description": "Defines the minimum message priority of a Request message that can be forwarded to a Connection (/diameter/connections) whose congestion level is CL2. The typical value is 8 and the range is 2-15 when the ngnPs16PriorityAdminStateEnabled value (/diameter/options) is set to true. The typical value is 2 when the ngnPs16PriorityAdminStateEnabled value (/diameter/options) is set to false.",
"maximum": 15,
"minimum": 2,
"type": "integer"
},
"cl3MinPriorityAllowed": {
"description": "Defines the minimum message priority of a Request message that can be forwarded to a Connection (/diameter/connections) whose congestion level is CL1. The typical value is 16 and the range is 3-16 when the ngnPs16PriorityAdminStateEnabled value (/diameter/options) is set to true. The typical value is 3 when the ngnPs16PriorityAdminStateEnabled value (/diameter/options) is set to false.",
"maximum": 16,
"minimum": 3,
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"diameterCexHostIpValidationEnabled": {
"description": "If true, Host-IP-Address AVP validation is enabled during CEX message exchange. Typical value is true.",
"type": "boolean"
},
"diameterCexTimer": {
"description": "Time (in seconds) to wait on a Capabilities Exchange Request message from a Peer Node (/diameter/peernodes) after a Connection (/diameter/connections) is initiated by the Peer Node; and time to wait on a Capabilities Exchange Answer response from a Peer Node after sending the request message. For Local Nodes (/diameter/localnodes), Capabilities Exchange Answer messages are sent in response to erroneous Capabilities Exchange Request messages. Typical value is 3.",
"maximum": 10,
"minimum": 1,
"type": "integer"
},
"diameterDisconnectTimer": {
"description": "After sending a disconnect peer request message, time (in seconds) to wait for a Peer Node (/diameter/peernodes) to disconnect the Connection (/diameter/connections); and after sending a disconnect peer request message, time to wait for the Peer Node to send the answer message. If the diameterDisconnectTimer expires, the Connection is disconnected by the application. Typical value is 3.",
"maximum": 10,
"minimum": 1,
"type": "integer"
},
"diameterPendingTransactionsPerConnection": {
"description": "The maximum number of pending request messages waiting for answer messages from the Peer Node (/diameter/peernodes) on this Connection (/diameter/connections). If the maximum is reached, this Connection is not selected for routing until the number of pending requests falls below this value. The diameterPendingTransactionsPerConnection value cannot be edited unless the Connection is disabled. Typical value is 1000.",
"maximum": 20000,
"minimum": 1,
"type": "integer"
},
"diameterProvingDeviceWatchdogRequestsToSend": {
"description": "The number of consecutive Device Watchdog Request and Answer message exchanges within a Proving Time interval during Connection (/diameter/connections) proving. Typical value is 3.",
"maximum": 1000,
"minimum": 1,
"type": "integer"
},
"diameterProvingMode": {
"description": "Proving mode for the Configuration Set. When set to Always, Device Watchdog Request and Answer exchanges are always done during Connection (/diameter/connections) proving. Suspect proving mode is only done when a Connection goes down due to an ungraceful disconnection (for example, no Disconnect Peer Request and Answer were exchanged when the Connection went down) and the Connection comes back up after the disconnection. When set to Never, proving is never done when a Connection goes down with the Peer Node (/diameter/peernodes) and it comes back up after a disconnection. Typical value is Suspect.",
"enum": [
"Always",
"Suspect",
"Never"
],
"type": "string"
},
"diameterProvingTimeout": {
"description": "The time (in milliseconds) to wait for a Peer Node (/diameter/peernodes) to send a Device Watchdog Answer message in response to a Device Watchdog Request message during Connection (/diameter/connections) proving. Typical value is 500.",
"maximum": 30000,
"minimum": 50,
"type": "integer"
},
"diameterTransportConnectionTimer": {
"description": "Controls the frequency (in seconds) that Connection (/diameter/connections) attempts are done to a Peer Node (/diameter/peernodes) where no active Connection exists. Applicable only for Connections configured to initiate a Connection with a Peer Node. Typical value is 30.",
"maximum": 60,
"minimum": 1,
"type": "integer"
},
"diameterWatchdogTimerInitValue": {
"description": "Initial value (in seconds) of the application watchdog timer. Typical value is 30.",
"maximum": 30,
"minimum": 1,
"type": "integer"
},
"name": {
"description": "Name associated with the Connection Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"minLength": 1,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"radiusCachedResponseDuration": {
"description": "Specifies the duration (in milliseconds) for which a cached response is held in the ingress transaction record. The radiusCachedResponseDuration value should cover the potential of loss of response and further retransmissions by the client. The radiusCachedResponseDuration applies only to server Connections (/diameter/connections) and only if radiusPreventDuplicateIngressRetransmission is true. Typical value is 5000.",
"maximum": 10000,
"minimum": 3000,
"type": "integer"
},
"radiusPendingTransactionsPerConnection": {
"description": "The maximum number of pending request messages waiting for a response from a Peer Node (/diameter/peernodes) on a Connection (/diameter/connections). If radiusPendingTransactionsPerConnection is reached, then the Connection is not selected for routing until the pending transactions are below the radiusPendingTransactionPerConnection value. Typical value is 1000.",
"maximum": 5000,
"minimum": 1,
"type": "integer"
},
"radiusPreventDuplicateEgressRetransmission": {
"description": "radiusPreventDuplicateEgressRetransmission applies to RADIUS client Connections (/diameter/connections) only and determines how to handle a request message being retransmitted to the same Peer Node (/diameter/peernodes) as before, but the corresponding transaction record (that contains the previously used source port, RADIUS Id, and request authenticator) has expired. If rediusPreventDuplicateEgressRetransmission is true, and if the corresponding transaction record has expired, the DSR does not forward the message to the same Peer Node (/diameter/peernodes) with a new RADIUS Id, source port, and request authenticator. An alternate Peer Node can be selected for routing in this case. If radiusPreventDuplicateEgressRetransmission is false, and the corresponding transaction record has expired, DSR selects a new source port, RADIUS Id, and request authenticator; creates a new transaction record; and forwards the message to the Peer Node. Typical value is true.",
"type": "boolean"
},
"radiusPreventDuplicateIngressRetransmission": {
"description": "radiusPreventDuplicateIngressRetransmission applies to RADIUS server Connections (/diameter/connections) only and determines how DSR processes duplicate request messages received from a client. A request is considered duplicate if the client retransmits a request message with the same source IP address, source port number, RADIUS Id, and request authenticator. If radiusPreventDuplicateIngressRetransmission is true, DSR creates an ingress transaction record for the message (with the message's source IP address, port, RADIUS Id, and request authenticator), which is used to admit only the first message into DSR and prevent admitting duplicate requests, if received, until the transaction record is present. If an egress message has been sent to the Peer Node (/diameter/peernodes) previously, it is saved in the transaction record and is forwarded to the client in response to duplicate requests. If radiusPreventDuplicateIngressRetransmission is false, DSR does not maintain ingress transaction records and admits all messages received from the client. Typical value is true.",
"type": "boolean"
},
"sctpDatagramBundlingEnabled": {
"description": "If true, datagram bundling is enable for the SCTP Connection (/diameter/connections). Typical value is true.",
"type": "boolean"
},
"sctpFragmentationEnabled": {
"description": "If true, a message exceeding the size of the path maximum transmission unit is fragmented and reassembled by the Peer Node (/diameter/peernodes). Typical value is true.",
"type": "boolean"
},
"sctpHeartbeatInterval": {
"description": "The interval in milliseconds between sending SCTP heartbeat messages to a Peer Node (/diameter/peernodes). Heartbeat messages are sent only when no user data has been sent for the duration of the sctpHeartbeatInterval. Setting sctpHeartbeatInterval to zero disables the heartbeat and is not recommended. When enabling the heartbeat, the minimum valid value is 100 ms - the DSR rejects values between 1 and 99, inclusive. Typical value is 1000.",
"maximum": 300000,
"minimum": 0,
"type": "integer"
},
"sctpMaximumBurst": {
"description": "Specifies the maximum burst of packets that can be emitted by this Connection (/diameter/connections). Typical value is 4.",
"maximum": 4,
"minimum": 1,
"type": "integer"
},
"sctpMaximumSegmentSize": {
"description": "The maximum size (in bytes) of any outgoing SCTP DATA chunk. If a message is larger than the sctpMaximumSegmentSize bytes, DSR fragments the message into chunks not exceeding this size. Set the sctpMaximumSegmentSize to zero to not stipulate a maximum segment size. When specifying a maximum segment size, the minimum allowable value is 88 - the DSR rejects values between 1 and 87, inclusive. Typical value is 0.",
"maximum": 1460,
"minimum": 0,
"type": "integer"
},
"sctpNumberInboundStreams": {
"description": "Maximum number of inbound SCTP streams supported locally by the SCTP Connection (/diameter/connections). Typical value is 8.",
"maximum": 16,
"minimum": 1,
"type": "integer"
},
"sctpNumberOutboundStreams": {
"description": "Maximum number of outbound SCTP streams supported locally by the SCTP Connection (/diameter/connections). Typical value is 8.",
"maximum": 16,
"minimum": 1,
"type": "integer"
},
"sctpOrderedDelivery": {
"description": "If true, ordered delivery of the SCTP data chunk is performed; otherwise, delivery is unordered. Typical value is false.",
"type": "boolean"
},
"sctpRetransmissionAssociationFailure": {
"description": "Number of consecutive message retransmissions that cause an SCTP Connection (/diameter/connections) to be marked as failed. The sctpRetransmissionAssociationFailure value indicates how many SCTP retransmission attempts should be made to all destinations for an SCTP Connection before marking the Connection as failed. This value should not be greater than the sum of the retransmission attempts for all destinations within the connection. Typical value is 5.",
"maximum": 20,
"minimum": 1,
"type": "integer"
},
"sctpRetransmissionInitFailure": {
"description": "Number of consecutive retransmits for INIT and COOKIE-ECHO chunks that cause an SCTP Connection (/diameter/connections) to be marked as failed. The sctpRetransmissionInitFailure value indicates how many retransmission attempts should be made to the primary IP address for INIT and COOKIE-ECHO chunks (when a secondary IP address has not been configured) before marking the Connection as failed. If a secondary IP address has been configured, the retransmission attempts are alternated between the primary and secondary IP address. Typical value is 8.",
"maximum": 20,
"minimum": 1,
"type": "integer"
},
"sctpRetransmissionInitTimeout": {
"description": "Expected average network roundtrip time in milliseconds. sctpRetransmissionInitTimeout is used to initialize the roundtrip time value when an Connection (/diameter/connections) is started but the roundtrip time has not yet been measured. DSR uses the roundtrip time to calculate when to retransmit chunks of messages. Typical value is 120.",
"maximum": 5000,
"minimum": 10,
"type": "integer"
},
"sctpRetransmissionMaximumTimeout": {
"description": "Maximum time (in milliseconds) to wait for an acknowledgment of a message sent. The sctpRetransmissionMaximumTimeout value places an upper boundary on the exponential back-off algorithm DSR uses for SCTP retransmission timing. After the retransmit interval is reached, retransmits are sent at a constant rate until an acknowledgment is received or the maximum attempts is reached. Typical value is 120.",
"maximum": 10000,
"minimum": 10,
"type": "integer"
},
"sctpRetransmissionMaximumTimeoutInit": {
"description": "Maximum time (in milliseconds) to wait for an INIT to be acknowledged. The sctpRetransmissionMaximumTimeoutInit value overrides the sctpRetransmissionMaximumTimeout and is used to bound the initial setup time. A value of zero indicates the sctpRetransmissionMaximumTimeout is used for INITs as well. When specifying an INIT timeout different from sctpRetransmissionMaximumTimeout, the minimum allowable value is 10 - the DSR rejects values between 1 and 9, inclusive. Typical value is 120.",
"maximum": 10000,
"minimum": 0,
"type": "integer"
},
"sctpRetransmissionMinimumTimeout": {
"description": "Minimum time (in milliseconds) to wait for an acknowledgment of a message sent. The sctpRetransmissionMinimumTimeout value prevents the retransmit timeout from becoming too small in networks with a very short roundtrip time. Typical value is 120.",
"maximum": 5000,
"minimum": 10,
"type": "integer"
},
"sctpRetransmissionPathFailure": {
"description": "Number of consecutive unsuccessful message retransmisssions that causes a path of the SCTP Connection (/diameter/connections) to be marked as failed. The sctpRetransmissionPathFailure value indicates how many SCTP retransmission attempts should be made to each destination of an SCTP Connection before marking the destination as failed. This value must be less than the sctpRetransmissionAssociationFailure value. Typical value is 3.",
"maximum": 10,
"minimum": 1,
"type": "integer"
},
"sctpSackDelay": {
"description": "The number of milliseconds to delay after receiving a data chunk and before sending a SACK. A non-zero value for sctpSackDelay gives the application time to bundle data chunks in the same SCTP message with the SACK, thereby reducing the number of packets in the network. Setting sctpSackDelay to zero disables this delay so that SACKs are sent as quickly as possible. Typical value is 10.",
"maximum": 200,
"minimum": 1,
"type": "integer"
},
"sctpSocketReceiveSize": {
"description": "Socket receive buffer size (in bytes) for incoming SCTP messages. The receive buffer size must be greater than or equal to the product of the bandwidth and the roundtrip delay for the Connection (/diameter/connections). Typical value is 1000000.",
"maximum": 5000000,
"minimum": 8000,
"type": "integer"
},
"sctpSocketSendSize": {
"description": "Socket send buffer size (in bytes) for outgoing SCTP messages. The send buffer size must be greater than or equal to the product of the bandwidth and the roundtrip delay for the Connection (/diameter/connections). Typical value is 1000000.",
"maximum": 5000000,
"minimum": 8000,
"type": "integer"
},
"tcpKeepAliveEnabled": {
"description": "If true, DSR probes a TCP Connection (/diameter/connections) that has been idle for the time configured in tcpKeepAliveIdleTime. Typical value is false.",
"type": "boolean"
},
"tcpKeepAliveIdleTime": {
"description": "Specifies the number of seconds of idle time between keep alive probes if tcpKeepAliveEnabled is set to true. Typical value is 1. Only applies when tcpKeepAliveEnabled is true.",
"maximum": 7200,
"minimum": 1,
"type": "integer"
},
"tcpKeepAliveMaximumCount": {
"description": "If tcpKeepAliveEnabled is true, tcpKeepAliveMaximumCount sets the maximum number of keep alive probes DSR sends without any response from the remote server before DSR gives up and aborts the Connection (/diameter/connections). Typical value is 9. Only applies when tcpKeepAliveEnabled is true.",
"maximum": 16,
"minimum": 1,
"type": "integer"
},
"tcpKeepAliveProbeInterval": {
"description": "If tcpKeepAliveEnabled is true, tcpKeepAliveProbeInterval sets the interval between keep alive probes in seconds. This value cannot be changed after a Connection (/diameter/connections) is established. Typical value is 1. Only applies when tcpKeepAliveEnabled is true.",
"maximum": 120,
"minimum": 1,
"type": "integer"
},
"tcpMaximumSegmentSize": {
"description": "The tcpMaximumSegmentSize (in bytes) is the IP maximum transmission unit minus the size of the TCP, and IPv4 or IPv6 headers for outgoing TCP packets. A value of zero indicates no limit on a maximum segment size. When specifying a maximum segment size, the minimum allowable value is 88 - the DSR rejects values between 1 and 87, inclusive. Typical value is 1024.",
"maximum": 1460,
"minimum": 0,
"type": "integer"
},
"tcpNagleEnabled": {
"description": "If true, the Nagle algorithm is enabled for the TCP Connection (/diameter/connections). Typical value is true.",
"type": "boolean"
},
"tcpSocketReceiveSize": {
"description": "Socket receive buffer size (in bytes) for incoming TCP messages. The receive buffer size should be greater than or equal to the product of the bandwidth and the round trip delay for the Connection (/diameter/connections). Typical value is 1000000.",
"maximum": 5000000,
"minimum": 8000,
"type": "integer"
},
"tcpSocketSendSize": {
"description": "Socket send buffer size (in bytes) for outgoing TCP messages. The send buffer size should be greater than or equal to the product of the bandwidth and the round trip delay for the Connection (/diameter/connections). Typical value is 1000000.",
"maximum": 5000000,
"minimum": 8000,
"type": "integer"
}
},
"required": [
"diameterCexHostIpValidationEnabled",
"diameterCexTimer",
"diameterDisconnectTimer",
"diameterPendingTransactionsPerConnection",
"diameterProvingDeviceWatchdogRequestsToSend",
"diameterProvingMode",
"diameterProvingTimeout",
"diameterTransportConnectionTimer",
"diameterWatchdogTimerInitValue",
"name",
"radiusCachedResponseDuration",
"radiusPendingTransactionsPerConnection",
"radiusPreventDuplicateEgressRetransmission",
"radiusPreventDuplicateIngressRetransmission",
"sctpDatagramBundlingEnabled",
"sctpFragmentationEnabled",
"sctpHeartbeatInterval",
"sctpMaximumBurst",
"sctpMaximumSegmentSize",
"sctpNumberInboundStreams",
"sctpNumberOutboundStreams",
"sctpOrderedDelivery",
"sctpRetransmissionAssociationFailure",
"sctpRetransmissionInitFailure",
"sctpRetransmissionInitTimeout",
"sctpRetransmissionMaximumTimeout",
"sctpRetransmissionMaximumTimeoutInit",
"sctpRetransmissionMinimumTimeout",
"sctpRetransmissionPathFailure",
"sctpSackDelay",
"sctpSocketReceiveSize",
"sctpSocketSendSize",
"tcpKeepAliveEnabled",
"tcpKeepAliveIdleTime",
"tcpKeepAliveMaximumCount",
"tcpKeepAliveProbeInterval",
"tcpMaximumSegmentSize",
"tcpNagleEnabled",
"tcpSocketReceiveSize",
"tcpSocketSendSize"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"configurationLevel": "52",
"diameterCexHostIpValidationEnabled": true,
"diameterCexTimer": 3,
"diameterDisconnectTimer": 3,
"diameterPendingTransactionsPerConnection": 1000,
"diameterProvingDeviceWatchdogRequestsToSend": 3,
"diameterProvingMode": "Suspect",
"diameterProvingTimeout": 500,
"diameterTransportConnectionTimer": 30,
"diameterWatchdogTimerInitValue": 30,
"name": "ConnectionConfigurationSet1",
"radiusCachedResponseDuration": 5000,
"radiusPendingTransactionsPerConnection": 1000,
"radiusPreventDuplicateEgressRetransmission": true,
"radiusPreventDuplicateIngressRetransmission": true,
"sctpDatagramBundlingEnabled": true,
"sctpFragmentationEnabled": true,
"sctpHeartbeatInterval": 500,
"sctpMaximumBurst": 4,
"sctpMaximumSegmentSize": 0,
"sctpNumberInboundStreams": 8,
"sctpNumberOutboundStreams": 8,
"sctpOrderedDelivery": false,
"sctpRetransmissionAssociationFailure": 5,
"sctpRetransmissionInitFailure": 8,
"sctpRetransmissionInitTimeout": 120,
"sctpRetransmissionMaximumTimeout": 120,
"sctpRetransmissionMaximumTimeoutInit": 120,
"sctpRetransmissionMinimumTimeout": 120,
"sctpRetransmissionPathFailure": 3,
"sctpSackDelay": 10,
"sctpSocketReceiveSize": 1000000,
"sctpSocketSendSize": 1000000,
"tcpKeepAliveEnabled": true,
"tcpKeepAliveIdleTime": 1,
"tcpKeepAliveMaximumCount": 9,
"tcpKeepAliveProbeInterval": 1,
"tcpMaximumSegmentSize": 1024,
"tcpNagleEnabled": true,
"tcpSocketReceiveSize": 1000000,
"tcpSocketSendSize": 1000000
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/connectionconfigurationsets
Adds a new Connection Configuration Set to the DSR configuration. The Connection Configuration Set name must be unique across all Connection Configuration Sets at the SOAM.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/connectionconfigurationset/connectionconfigurationset.json",
"properties": {
"cl1MinPriorityAllowed": {
"description": "Defines the minimum message priority of a Request message that can be forwarded to a Connection (/diameter/connections) whose congestion level is CL1. The typical value is 4 and the range is 1-15 when the ngnPs16PriorityAdminStateEnabled value (/diameter/options) is set to true. The typical value is 1 when the ngnPs16PriorityAdminStateEnabled value (/diameter/options) is set to false.",
"maximum": 15,
"minimum": 1,
"type": "integer"
},
"cl2MinPriorityAllowed": {
"description": "Defines the minimum message priority of a Request message that can be forwarded to a Connection (/diameter/connections) whose congestion level is CL2. The typical value is 8 and the range is 2-15 when the ngnPs16PriorityAdminStateEnabled value (/diameter/options) is set to true. The typical value is 2 when the ngnPs16PriorityAdminStateEnabled value (/diameter/options) is set to false.",
"maximum": 15,
"minimum": 2,
"type": "integer"
},
"cl3MinPriorityAllowed": {
"description": "Defines the minimum message priority of a Request message that can be forwarded to a Connection (/diameter/connections) whose congestion level is CL1. The typical value is 16 and the range is 3-16 when the ngnPs16PriorityAdminStateEnabled value (/diameter/options) is set to true. The typical value is 3 when the ngnPs16PriorityAdminStateEnabled value (/diameter/options) is set to false.",
"maximum": 16,
"minimum": 3,
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"diameterCexHostIpValidationEnabled": {
"description": "If true, Host-IP-Address AVP validation is enabled during CEX message exchange. Typical value is true.",
"type": "boolean"
},
"diameterCexTimer": {
"description": "Time (in seconds) to wait on a Capabilities Exchange Request message from a Peer Node (/diameter/peernodes) after a Connection (/diameter/connections) is initiated by the Peer Node; and time to wait on a Capabilities Exchange Answer response from a Peer Node after sending the request message. For Local Nodes (/diameter/localnodes), Capabilities Exchange Answer messages are sent in response to erroneous Capabilities Exchange Request messages. Typical value is 3.",
"maximum": 10,
"minimum": 1,
"type": "integer"
},
"diameterDisconnectTimer": {
"description": "After sending a disconnect peer request message, time (in seconds) to wait for a Peer Node (/diameter/peernodes) to disconnect the Connection (/diameter/connections); and after sending a disconnect peer request message, time to wait for the Peer Node to send the answer message. If the diameterDisconnectTimer expires, the Connection is disconnected by the application. Typical value is 3.",
"maximum": 10,
"minimum": 1,
"type": "integer"
},
"diameterPendingTransactionsPerConnection": {
"description": "The maximum number of pending request messages waiting for answer messages from the Peer Node (/diameter/peernodes) on this Connection (/diameter/connections). If the maximum is reached, this Connection is not selected for routing until the number of pending requests falls below this value. The diameterPendingTransactionsPerConnection value cannot be edited unless the Connection is disabled. Typical value is 1000.",
"maximum": 20000,
"minimum": 1,
"type": "integer"
},
"diameterProvingDeviceWatchdogRequestsToSend": {
"description": "The number of consecutive Device Watchdog Request and Answer message exchanges within a Proving Time interval during Connection (/diameter/connections) proving. Typical value is 3.",
"maximum": 1000,
"minimum": 1,
"type": "integer"
},
"diameterProvingMode": {
"description": "Proving mode for the Configuration Set. When set to Always, Device Watchdog Request and Answer exchanges are always done during Connection (/diameter/connections) proving. Suspect proving mode is only done when a Connection goes down due to an ungraceful disconnection (for example, no Disconnect Peer Request and Answer were exchanged when the Connection went down) and the Connection comes back up after the disconnection. When set to Never, proving is never done when a Connection goes down with the Peer Node (/diameter/peernodes) and it comes back up after a disconnection. Typical value is Suspect.",
"enum": [
"Always",
"Suspect",
"Never"
],
"type": "string"
},
"diameterProvingTimeout": {
"description": "The time (in milliseconds) to wait for a Peer Node (/diameter/peernodes) to send a Device Watchdog Answer message in response to a Device Watchdog Request message during Connection (/diameter/connections) proving. Typical value is 500.",
"maximum": 30000,
"minimum": 50,
"type": "integer"
},
"diameterTransportConnectionTimer": {
"description": "Controls the frequency (in seconds) that Connection (/diameter/connections) attempts are done to a Peer Node (/diameter/peernodes) where no active Connection exists. Applicable only for Connections configured to initiate a Connection with a Peer Node. Typical value is 30.",
"maximum": 60,
"minimum": 1,
"type": "integer"
},
"diameterWatchdogTimerInitValue": {
"description": "Initial value (in seconds) of the application watchdog timer. Typical value is 30.",
"maximum": 30,
"minimum": 1,
"type": "integer"
},
"name": {
"description": "Name associated with the Connection Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"minLength": 1,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"radiusCachedResponseDuration": {
"description": "Specifies the duration (in milliseconds) for which a cached response is held in the ingress transaction record. The radiusCachedResponseDuration value should cover the potential of loss of response and further retransmissions by the client. The radiusCachedResponseDuration applies only to server Connections (/diameter/connections) and only if radiusPreventDuplicateIngressRetransmission is true. Typical value is 5000.",
"maximum": 10000,
"minimum": 3000,
"type": "integer"
},
"radiusPendingTransactionsPerConnection": {
"description": "The maximum number of pending request messages waiting for a response from a Peer Node (/diameter/peernodes) on a Connection (/diameter/connections). If radiusPendingTransactionsPerConnection is reached, then the Connection is not selected for routing until the pending transactions are below the radiusPendingTransactionPerConnection value. Typical value is 1000.",
"maximum": 5000,
"minimum": 1,
"type": "integer"
},
"radiusPreventDuplicateEgressRetransmission": {
"description": "radiusPreventDuplicateEgressRetransmission applies to RADIUS client Connections (/diameter/connections) only and determines how to handle a request message being retransmitted to the same Peer Node (/diameter/peernodes) as before, but the corresponding transaction record (that contains the previously used source port, RADIUS Id, and request authenticator) has expired. If rediusPreventDuplicateEgressRetransmission is true, and if the corresponding transaction record has expired, the DSR does not forward the message to the same Peer Node (/diameter/peernodes) with a new RADIUS Id, source port, and request authenticator. An alternate Peer Node can be selected for routing in this case. If radiusPreventDuplicateEgressRetransmission is false, and the corresponding transaction record has expired, DSR selects a new source port, RADIUS Id, and request authenticator; creates a new transaction record; and forwards the message to the Peer Node. Typical value is true.",
"type": "boolean"
},
"radiusPreventDuplicateIngressRetransmission": {
"description": "radiusPreventDuplicateIngressRetransmission applies to RADIUS server Connections (/diameter/connections) only and determines how DSR processes duplicate request messages received from a client. A request is considered duplicate if the client retransmits a request message with the same source IP address, source port number, RADIUS Id, and request authenticator. If radiusPreventDuplicateIngressRetransmission is true, DSR creates an ingress transaction record for the message (with the message's source IP address, port, RADIUS Id, and request authenticator), which is used to admit only the first message into DSR and prevent admitting duplicate requests, if received, until the transaction record is present. If an egress message has been sent to the Peer Node (/diameter/peernodes) previously, it is saved in the transaction record and is forwarded to the client in response to duplicate requests. If radiusPreventDuplicateIngressRetransmission is false, DSR does not maintain ingress transaction records and admits all messages received from the client. Typical value is true.",
"type": "boolean"
},
"sctpDatagramBundlingEnabled": {
"description": "If true, datagram bundling is enable for the SCTP Connection (/diameter/connections). Typical value is true.",
"type": "boolean"
},
"sctpFragmentationEnabled": {
"description": "If true, a message exceeding the size of the path maximum transmission unit is fragmented and reassembled by the Peer Node (/diameter/peernodes). Typical value is true.",
"type": "boolean"
},
"sctpHeartbeatInterval": {
"description": "The interval in milliseconds between sending SCTP heartbeat messages to a Peer Node (/diameter/peernodes). Heartbeat messages are sent only when no user data has been sent for the duration of the sctpHeartbeatInterval. Setting sctpHeartbeatInterval to zero disables the heartbeat and is not recommended. When enabling the heartbeat, the minimum valid value is 100 ms - the DSR rejects values between 1 and 99, inclusive. Typical value is 1000.",
"maximum": 300000,
"minimum": 0,
"type": "integer"
},
"sctpMaximumBurst": {
"description": "Specifies the maximum burst of packets that can be emitted by this Connection (/diameter/connections). Typical value is 4.",
"maximum": 4,
"minimum": 1,
"type": "integer"
},
"sctpMaximumSegmentSize": {
"description": "The maximum size (in bytes) of any outgoing SCTP DATA chunk. If a message is larger than the sctpMaximumSegmentSize bytes, DSR fragments the message into chunks not exceeding this size. Set the sctpMaximumSegmentSize to zero to not stipulate a maximum segment size. When specifying a maximum segment size, the minimum allowable value is 88 - the DSR rejects values between 1 and 87, inclusive. Typical value is 0.",
"maximum": 1460,
"minimum": 0,
"type": "integer"
},
"sctpNumberInboundStreams": {
"description": "Maximum number of inbound SCTP streams supported locally by the SCTP Connection (/diameter/connections). Typical value is 8.",
"maximum": 16,
"minimum": 1,
"type": "integer"
},
"sctpNumberOutboundStreams": {
"description": "Maximum number of outbound SCTP streams supported locally by the SCTP Connection (/diameter/connections). Typical value is 8.",
"maximum": 16,
"minimum": 1,
"type": "integer"
},
"sctpOrderedDelivery": {
"description": "If true, ordered delivery of the SCTP data chunk is performed; otherwise, delivery is unordered. Typical value is false.",
"type": "boolean"
},
"sctpRetransmissionAssociationFailure": {
"description": "Number of consecutive message retransmissions that cause an SCTP Connection (/diameter/connections) to be marked as failed. The sctpRetransmissionAssociationFailure value indicates how many SCTP retransmission attempts should be made to all destinations for an SCTP Connection before marking the Connection as failed. This value should not be greater than the sum of the retransmission attempts for all destinations within the connection. Typical value is 5.",
"maximum": 20,
"minimum": 1,
"type": "integer"
},
"sctpRetransmissionInitFailure": {
"description": "Number of consecutive retransmits for INIT and COOKIE-ECHO chunks that cause an SCTP Connection (/diameter/connections) to be marked as failed. The sctpRetransmissionInitFailure value indicates how many retransmission attempts should be made to the primary IP address for INIT and COOKIE-ECHO chunks (when a secondary IP address has not been configured) before marking the Connection as failed. If a secondary IP address has been configured, the retransmission attempts are alternated between the primary and secondary IP address. Typical value is 8.",
"maximum": 20,
"minimum": 1,
"type": "integer"
},
"sctpRetransmissionInitTimeout": {
"description": "Expected average network roundtrip time in milliseconds. sctpRetransmissionInitTimeout is used to initialize the roundtrip time value when an Connection (/diameter/connections) is started but the roundtrip time has not yet been measured. DSR uses the roundtrip time to calculate when to retransmit chunks of messages. Typical value is 120.",
"maximum": 5000,
"minimum": 10,
"type": "integer"
},
"sctpRetransmissionMaximumTimeout": {
"description": "Maximum time (in milliseconds) to wait for an acknowledgment of a message sent. The sctpRetransmissionMaximumTimeout value places an upper boundary on the exponential back-off algorithm DSR uses for SCTP retransmission timing. After the retransmit interval is reached, retransmits are sent at a constant rate until an acknowledgment is received or the maximum attempts is reached. Typical value is 120.",
"maximum": 10000,
"minimum": 10,
"type": "integer"
},
"sctpRetransmissionMaximumTimeoutInit": {
"description": "Maximum time (in milliseconds) to wait for an INIT to be acknowledged. The sctpRetransmissionMaximumTimeoutInit value overrides the sctpRetransmissionMaximumTimeout and is used to bound the initial setup time. A value of zero indicates the sctpRetransmissionMaximumTimeout is used for INITs as well. When specifying an INIT timeout different from sctpRetransmissionMaximumTimeout, the minimum allowable value is 10 - the DSR rejects values between 1 and 9, inclusive. Typical value is 120.",
"maximum": 10000,
"minimum": 0,
"type": "integer"
},
"sctpRetransmissionMinimumTimeout": {
"description": "Minimum time (in milliseconds) to wait for an acknowledgment of a message sent. The sctpRetransmissionMinimumTimeout value prevents the retransmit timeout from becoming too small in networks with a very short roundtrip time. Typical value is 120.",
"maximum": 5000,
"minimum": 10,
"type": "integer"
},
"sctpRetransmissionPathFailure": {
"description": "Number of consecutive unsuccessful message retransmisssions that causes a path of the SCTP Connection (/diameter/connections) to be marked as failed. The sctpRetransmissionPathFailure value indicates how many SCTP retransmission attempts should be made to each destination of an SCTP Connection before marking the destination as failed. This value must be less than the sctpRetransmissionAssociationFailure value. Typical value is 3.",
"maximum": 10,
"minimum": 1,
"type": "integer"
},
"sctpSackDelay": {
"description": "The number of milliseconds to delay after receiving a data chunk and before sending a SACK. A non-zero value for sctpSackDelay gives the application time to bundle data chunks in the same SCTP message with the SACK, thereby reducing the number of packets in the network. Setting sctpSackDelay to zero disables this delay so that SACKs are sent as quickly as possible. Typical value is 10.",
"maximum": 200,
"minimum": 1,
"type": "integer"
},
"sctpSocketReceiveSize": {
"description": "Socket receive buffer size (in bytes) for incoming SCTP messages. The receive buffer size must be greater than or equal to the product of the bandwidth and the roundtrip delay for the Connection (/diameter/connections). Typical value is 1000000.",
"maximum": 5000000,
"minimum": 8000,
"type": "integer"
},
"sctpSocketSendSize": {
"description": "Socket send buffer size (in bytes) for outgoing SCTP messages. The send buffer size must be greater than or equal to the product of the bandwidth and the roundtrip delay for the Connection (/diameter/connections). Typical value is 1000000.",
"maximum": 5000000,
"minimum": 8000,
"type": "integer"
},
"tcpKeepAliveEnabled": {
"description": "If true, DSR probes a TCP Connection (/diameter/connections) that has been idle for the time configured in tcpKeepAliveIdleTime. Typical value is false.",
"type": "boolean"
},
"tcpKeepAliveIdleTime": {
"description": "Specifies the number of seconds of idle time between keep alive probes if tcpKeepAliveEnabled is set to true. Typical value is 1. Only applies when tcpKeepAliveEnabled is true.",
"maximum": 7200,
"minimum": 1,
"type": "integer"
},
"tcpKeepAliveMaximumCount": {
"description": "If tcpKeepAliveEnabled is true, tcpKeepAliveMaximumCount sets the maximum number of keep alive probes DSR sends without any response from the remote server before DSR gives up and aborts the Connection (/diameter/connections). Typical value is 9. Only applies when tcpKeepAliveEnabled is true.",
"maximum": 16,
"minimum": 1,
"type": "integer"
},
"tcpKeepAliveProbeInterval": {
"description": "If tcpKeepAliveEnabled is true, tcpKeepAliveProbeInterval sets the interval between keep alive probes in seconds. This value cannot be changed after a Connection (/diameter/connections) is established. Typical value is 1. Only applies when tcpKeepAliveEnabled is true.",
"maximum": 120,
"minimum": 1,
"type": "integer"
},
"tcpMaximumSegmentSize": {
"description": "The tcpMaximumSegmentSize (in bytes) is the IP maximum transmission unit minus the size of the TCP, and IPv4 or IPv6 headers for outgoing TCP packets. A value of zero indicates no limit on a maximum segment size. When specifying a maximum segment size, the minimum allowable value is 88 - the DSR rejects values between 1 and 87, inclusive. Typical value is 1024.",
"maximum": 1460,
"minimum": 0,
"type": "integer"
},
"tcpNagleEnabled": {
"description": "If true, the Nagle algorithm is enabled for the TCP Connection (/diameter/connections). Typical value is true.",
"type": "boolean"
},
"tcpSocketReceiveSize": {
"description": "Socket receive buffer size (in bytes) for incoming TCP messages. The receive buffer size should be greater than or equal to the product of the bandwidth and the round trip delay for the Connection (/diameter/connections). Typical value is 1000000.",
"maximum": 5000000,
"minimum": 8000,
"type": "integer"
},
"tcpSocketSendSize": {
"description": "Socket send buffer size (in bytes) for outgoing TCP messages. The send buffer size should be greater than or equal to the product of the bandwidth and the round trip delay for the Connection (/diameter/connections). Typical value is 1000000.",
"maximum": 5000000,
"minimum": 8000,
"type": "integer"
}
},
"required": [
"diameterCexHostIpValidationEnabled",
"diameterCexTimer",
"diameterDisconnectTimer",
"diameterPendingTransactionsPerConnection",
"diameterProvingDeviceWatchdogRequestsToSend",
"diameterProvingMode",
"diameterProvingTimeout",
"diameterTransportConnectionTimer",
"diameterWatchdogTimerInitValue",
"name",
"radiusCachedResponseDuration",
"radiusPendingTransactionsPerConnection",
"radiusPreventDuplicateEgressRetransmission",
"radiusPreventDuplicateIngressRetransmission",
"sctpDatagramBundlingEnabled",
"sctpFragmentationEnabled",
"sctpHeartbeatInterval",
"sctpMaximumBurst",
"sctpMaximumSegmentSize",
"sctpNumberInboundStreams",
"sctpNumberOutboundStreams",
"sctpOrderedDelivery",
"sctpRetransmissionAssociationFailure",
"sctpRetransmissionInitFailure",
"sctpRetransmissionInitTimeout",
"sctpRetransmissionMaximumTimeout",
"sctpRetransmissionMaximumTimeoutInit",
"sctpRetransmissionMinimumTimeout",
"sctpRetransmissionPathFailure",
"sctpSackDelay",
"sctpSocketReceiveSize",
"sctpSocketSendSize",
"tcpKeepAliveEnabled",
"tcpKeepAliveIdleTime",
"tcpKeepAliveMaximumCount",
"tcpKeepAliveProbeInterval",
"tcpMaximumSegmentSize",
"tcpNagleEnabled",
"tcpSocketReceiveSize",
"tcpSocketSendSize"
],
"type": "object"
}
Example
{
"configurationLevel": "52",
"diameterCexHostIpValidationEnabled": true,
"diameterCexTimer": 3,
"diameterDisconnectTimer": 3,
"diameterPendingTransactionsPerConnection": 1000,
"diameterProvingDeviceWatchdogRequestsToSend": 3,
"diameterProvingMode": "Suspect",
"diameterProvingTimeout": 500,
"diameterTransportConnectionTimer": 30,
"diameterWatchdogTimerInitValue": 30,
"name": "ConnectionConfigurationSet1",
"radiusCachedResponseDuration": 5000,
"radiusPendingTransactionsPerConnection": 1000,
"radiusPreventDuplicateEgressRetransmission": true,
"radiusPreventDuplicateIngressRetransmission": true,
"sctpDatagramBundlingEnabled": true,
"sctpFragmentationEnabled": true,
"sctpHeartbeatInterval": 500,
"sctpMaximumBurst": 4,
"sctpMaximumSegmentSize": 0,
"sctpNumberInboundStreams": 8,
"sctpNumberOutboundStreams": 8,
"sctpOrderedDelivery": false,
"sctpRetransmissionAssociationFailure": 5,
"sctpRetransmissionInitFailure": 8,
"sctpRetransmissionInitTimeout": 120,
"sctpRetransmissionMaximumTimeout": 120,
"sctpRetransmissionMaximumTimeoutInit": 120,
"sctpRetransmissionMinimumTimeout": 120,
"sctpRetransmissionPathFailure": 3,
"sctpSackDelay": 10,
"sctpSocketReceiveSize": 1000000,
"sctpSocketSendSize": 1000000,
"tcpKeepAliveEnabled": true,
"tcpKeepAliveIdleTime": 1,
"tcpKeepAliveMaximumCount": 9,
"tcpKeepAliveProbeInterval": 1,
"tcpMaximumSegmentSize": 1024,
"tcpNagleEnabled": true,
"tcpSocketReceiveSize": 1000000,
"tcpSocketSendSize": 1000000
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/connectionconfigurationsets/{name}
get /diameter/connectionconfigurationsets/{name}
Returns the configuration details for the specified Connection Configuration Set. If the Connection Configuration Set does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/connectionconfigurationsetItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/connectionconfigurationset/connectionconfigurationset.json",
"properties": {
"cl1MinPriorityAllowed": {
"description": "Defines the minimum message priority of a Request message that can be forwarded to a Connection (/diameter/connections) whose congestion level is CL1. The typical value is 4 and the range is 1-15 when the ngnPs16PriorityAdminStateEnabled value (/diameter/options) is set to true. The typical value is 1 when the ngnPs16PriorityAdminStateEnabled value (/diameter/options) is set to false.",
"maximum": 15,
"minimum": 1,
"type": "integer"
},
"cl2MinPriorityAllowed": {
"description": "Defines the minimum message priority of a Request message that can be forwarded to a Connection (/diameter/connections) whose congestion level is CL2. The typical value is 8 and the range is 2-15 when the ngnPs16PriorityAdminStateEnabled value (/diameter/options) is set to true. The typical value is 2 when the ngnPs16PriorityAdminStateEnabled value (/diameter/options) is set to false.",
"maximum": 15,
"minimum": 2,
"type": "integer"
},
"cl3MinPriorityAllowed": {
"description": "Defines the minimum message priority of a Request message that can be forwarded to a Connection (/diameter/connections) whose congestion level is CL1. The typical value is 16 and the range is 3-16 when the ngnPs16PriorityAdminStateEnabled value (/diameter/options) is set to true. The typical value is 3 when the ngnPs16PriorityAdminStateEnabled value (/diameter/options) is set to false.",
"maximum": 16,
"minimum": 3,
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"diameterCexHostIpValidationEnabled": {
"description": "If true, Host-IP-Address AVP validation is enabled during CEX message exchange. Typical value is true.",
"type": "boolean"
},
"diameterCexTimer": {
"description": "Time (in seconds) to wait on a Capabilities Exchange Request message from a Peer Node (/diameter/peernodes) after a Connection (/diameter/connections) is initiated by the Peer Node; and time to wait on a Capabilities Exchange Answer response from a Peer Node after sending the request message. For Local Nodes (/diameter/localnodes), Capabilities Exchange Answer messages are sent in response to erroneous Capabilities Exchange Request messages. Typical value is 3.",
"maximum": 10,
"minimum": 1,
"type": "integer"
},
"diameterDisconnectTimer": {
"description": "After sending a disconnect peer request message, time (in seconds) to wait for a Peer Node (/diameter/peernodes) to disconnect the Connection (/diameter/connections); and after sending a disconnect peer request message, time to wait for the Peer Node to send the answer message. If the diameterDisconnectTimer expires, the Connection is disconnected by the application. Typical value is 3.",
"maximum": 10,
"minimum": 1,
"type": "integer"
},
"diameterPendingTransactionsPerConnection": {
"description": "The maximum number of pending request messages waiting for answer messages from the Peer Node (/diameter/peernodes) on this Connection (/diameter/connections). If the maximum is reached, this Connection is not selected for routing until the number of pending requests falls below this value. The diameterPendingTransactionsPerConnection value cannot be edited unless the Connection is disabled. Typical value is 1000.",
"maximum": 20000,
"minimum": 1,
"type": "integer"
},
"diameterProvingDeviceWatchdogRequestsToSend": {
"description": "The number of consecutive Device Watchdog Request and Answer message exchanges within a Proving Time interval during Connection (/diameter/connections) proving. Typical value is 3.",
"maximum": 1000,
"minimum": 1,
"type": "integer"
},
"diameterProvingMode": {
"description": "Proving mode for the Configuration Set. When set to Always, Device Watchdog Request and Answer exchanges are always done during Connection (/diameter/connections) proving. Suspect proving mode is only done when a Connection goes down due to an ungraceful disconnection (for example, no Disconnect Peer Request and Answer were exchanged when the Connection went down) and the Connection comes back up after the disconnection. When set to Never, proving is never done when a Connection goes down with the Peer Node (/diameter/peernodes) and it comes back up after a disconnection. Typical value is Suspect.",
"enum": [
"Always",
"Suspect",
"Never"
],
"type": "string"
},
"diameterProvingTimeout": {
"description": "The time (in milliseconds) to wait for a Peer Node (/diameter/peernodes) to send a Device Watchdog Answer message in response to a Device Watchdog Request message during Connection (/diameter/connections) proving. Typical value is 500.",
"maximum": 30000,
"minimum": 50,
"type": "integer"
},
"diameterTransportConnectionTimer": {
"description": "Controls the frequency (in seconds) that Connection (/diameter/connections) attempts are done to a Peer Node (/diameter/peernodes) where no active Connection exists. Applicable only for Connections configured to initiate a Connection with a Peer Node. Typical value is 30.",
"maximum": 60,
"minimum": 1,
"type": "integer"
},
"diameterWatchdogTimerInitValue": {
"description": "Initial value (in seconds) of the application watchdog timer. Typical value is 30.",
"maximum": 30,
"minimum": 1,
"type": "integer"
},
"name": {
"description": "Name associated with the Connection Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"minLength": 1,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"radiusCachedResponseDuration": {
"description": "Specifies the duration (in milliseconds) for which a cached response is held in the ingress transaction record. The radiusCachedResponseDuration value should cover the potential of loss of response and further retransmissions by the client. The radiusCachedResponseDuration applies only to server Connections (/diameter/connections) and only if radiusPreventDuplicateIngressRetransmission is true. Typical value is 5000.",
"maximum": 10000,
"minimum": 3000,
"type": "integer"
},
"radiusPendingTransactionsPerConnection": {
"description": "The maximum number of pending request messages waiting for a response from a Peer Node (/diameter/peernodes) on a Connection (/diameter/connections). If radiusPendingTransactionsPerConnection is reached, then the Connection is not selected for routing until the pending transactions are below the radiusPendingTransactionPerConnection value. Typical value is 1000.",
"maximum": 5000,
"minimum": 1,
"type": "integer"
},
"radiusPreventDuplicateEgressRetransmission": {
"description": "radiusPreventDuplicateEgressRetransmission applies to RADIUS client Connections (/diameter/connections) only and determines how to handle a request message being retransmitted to the same Peer Node (/diameter/peernodes) as before, but the corresponding transaction record (that contains the previously used source port, RADIUS Id, and request authenticator) has expired. If rediusPreventDuplicateEgressRetransmission is true, and if the corresponding transaction record has expired, the DSR does not forward the message to the same Peer Node (/diameter/peernodes) with a new RADIUS Id, source port, and request authenticator. An alternate Peer Node can be selected for routing in this case. If radiusPreventDuplicateEgressRetransmission is false, and the corresponding transaction record has expired, DSR selects a new source port, RADIUS Id, and request authenticator; creates a new transaction record; and forwards the message to the Peer Node. Typical value is true.",
"type": "boolean"
},
"radiusPreventDuplicateIngressRetransmission": {
"description": "radiusPreventDuplicateIngressRetransmission applies to RADIUS server Connections (/diameter/connections) only and determines how DSR processes duplicate request messages received from a client. A request is considered duplicate if the client retransmits a request message with the same source IP address, source port number, RADIUS Id, and request authenticator. If radiusPreventDuplicateIngressRetransmission is true, DSR creates an ingress transaction record for the message (with the message's source IP address, port, RADIUS Id, and request authenticator), which is used to admit only the first message into DSR and prevent admitting duplicate requests, if received, until the transaction record is present. If an egress message has been sent to the Peer Node (/diameter/peernodes) previously, it is saved in the transaction record and is forwarded to the client in response to duplicate requests. If radiusPreventDuplicateIngressRetransmission is false, DSR does not maintain ingress transaction records and admits all messages received from the client. Typical value is true.",
"type": "boolean"
},
"sctpDatagramBundlingEnabled": {
"description": "If true, datagram bundling is enable for the SCTP Connection (/diameter/connections). Typical value is true.",
"type": "boolean"
},
"sctpFragmentationEnabled": {
"description": "If true, a message exceeding the size of the path maximum transmission unit is fragmented and reassembled by the Peer Node (/diameter/peernodes). Typical value is true.",
"type": "boolean"
},
"sctpHeartbeatInterval": {
"description": "The interval in milliseconds between sending SCTP heartbeat messages to a Peer Node (/diameter/peernodes). Heartbeat messages are sent only when no user data has been sent for the duration of the sctpHeartbeatInterval. Setting sctpHeartbeatInterval to zero disables the heartbeat and is not recommended. When enabling the heartbeat, the minimum valid value is 100 ms - the DSR rejects values between 1 and 99, inclusive. Typical value is 1000.",
"maximum": 300000,
"minimum": 0,
"type": "integer"
},
"sctpMaximumBurst": {
"description": "Specifies the maximum burst of packets that can be emitted by this Connection (/diameter/connections). Typical value is 4.",
"maximum": 4,
"minimum": 1,
"type": "integer"
},
"sctpMaximumSegmentSize": {
"description": "The maximum size (in bytes) of any outgoing SCTP DATA chunk. If a message is larger than the sctpMaximumSegmentSize bytes, DSR fragments the message into chunks not exceeding this size. Set the sctpMaximumSegmentSize to zero to not stipulate a maximum segment size. When specifying a maximum segment size, the minimum allowable value is 88 - the DSR rejects values between 1 and 87, inclusive. Typical value is 0.",
"maximum": 1460,
"minimum": 0,
"type": "integer"
},
"sctpNumberInboundStreams": {
"description": "Maximum number of inbound SCTP streams supported locally by the SCTP Connection (/diameter/connections). Typical value is 8.",
"maximum": 16,
"minimum": 1,
"type": "integer"
},
"sctpNumberOutboundStreams": {
"description": "Maximum number of outbound SCTP streams supported locally by the SCTP Connection (/diameter/connections). Typical value is 8.",
"maximum": 16,
"minimum": 1,
"type": "integer"
},
"sctpOrderedDelivery": {
"description": "If true, ordered delivery of the SCTP data chunk is performed; otherwise, delivery is unordered. Typical value is false.",
"type": "boolean"
},
"sctpRetransmissionAssociationFailure": {
"description": "Number of consecutive message retransmissions that cause an SCTP Connection (/diameter/connections) to be marked as failed. The sctpRetransmissionAssociationFailure value indicates how many SCTP retransmission attempts should be made to all destinations for an SCTP Connection before marking the Connection as failed. This value should not be greater than the sum of the retransmission attempts for all destinations within the connection. Typical value is 5.",
"maximum": 20,
"minimum": 1,
"type": "integer"
},
"sctpRetransmissionInitFailure": {
"description": "Number of consecutive retransmits for INIT and COOKIE-ECHO chunks that cause an SCTP Connection (/diameter/connections) to be marked as failed. The sctpRetransmissionInitFailure value indicates how many retransmission attempts should be made to the primary IP address for INIT and COOKIE-ECHO chunks (when a secondary IP address has not been configured) before marking the Connection as failed. If a secondary IP address has been configured, the retransmission attempts are alternated between the primary and secondary IP address. Typical value is 8.",
"maximum": 20,
"minimum": 1,
"type": "integer"
},
"sctpRetransmissionInitTimeout": {
"description": "Expected average network roundtrip time in milliseconds. sctpRetransmissionInitTimeout is used to initialize the roundtrip time value when an Connection (/diameter/connections) is started but the roundtrip time has not yet been measured. DSR uses the roundtrip time to calculate when to retransmit chunks of messages. Typical value is 120.",
"maximum": 5000,
"minimum": 10,
"type": "integer"
},
"sctpRetransmissionMaximumTimeout": {
"description": "Maximum time (in milliseconds) to wait for an acknowledgment of a message sent. The sctpRetransmissionMaximumTimeout value places an upper boundary on the exponential back-off algorithm DSR uses for SCTP retransmission timing. After the retransmit interval is reached, retransmits are sent at a constant rate until an acknowledgment is received or the maximum attempts is reached. Typical value is 120.",
"maximum": 10000,
"minimum": 10,
"type": "integer"
},
"sctpRetransmissionMaximumTimeoutInit": {
"description": "Maximum time (in milliseconds) to wait for an INIT to be acknowledged. The sctpRetransmissionMaximumTimeoutInit value overrides the sctpRetransmissionMaximumTimeout and is used to bound the initial setup time. A value of zero indicates the sctpRetransmissionMaximumTimeout is used for INITs as well. When specifying an INIT timeout different from sctpRetransmissionMaximumTimeout, the minimum allowable value is 10 - the DSR rejects values between 1 and 9, inclusive. Typical value is 120.",
"maximum": 10000,
"minimum": 0,
"type": "integer"
},
"sctpRetransmissionMinimumTimeout": {
"description": "Minimum time (in milliseconds) to wait for an acknowledgment of a message sent. The sctpRetransmissionMinimumTimeout value prevents the retransmit timeout from becoming too small in networks with a very short roundtrip time. Typical value is 120.",
"maximum": 5000,
"minimum": 10,
"type": "integer"
},
"sctpRetransmissionPathFailure": {
"description": "Number of consecutive unsuccessful message retransmisssions that causes a path of the SCTP Connection (/diameter/connections) to be marked as failed. The sctpRetransmissionPathFailure value indicates how many SCTP retransmission attempts should be made to each destination of an SCTP Connection before marking the destination as failed. This value must be less than the sctpRetransmissionAssociationFailure value. Typical value is 3.",
"maximum": 10,
"minimum": 1,
"type": "integer"
},
"sctpSackDelay": {
"description": "The number of milliseconds to delay after receiving a data chunk and before sending a SACK. A non-zero value for sctpSackDelay gives the application time to bundle data chunks in the same SCTP message with the SACK, thereby reducing the number of packets in the network. Setting sctpSackDelay to zero disables this delay so that SACKs are sent as quickly as possible. Typical value is 10.",
"maximum": 200,
"minimum": 1,
"type": "integer"
},
"sctpSocketReceiveSize": {
"description": "Socket receive buffer size (in bytes) for incoming SCTP messages. The receive buffer size must be greater than or equal to the product of the bandwidth and the roundtrip delay for the Connection (/diameter/connections). Typical value is 1000000.",
"maximum": 5000000,
"minimum": 8000,
"type": "integer"
},
"sctpSocketSendSize": {
"description": "Socket send buffer size (in bytes) for outgoing SCTP messages. The send buffer size must be greater than or equal to the product of the bandwidth and the roundtrip delay for the Connection (/diameter/connections). Typical value is 1000000.",
"maximum": 5000000,
"minimum": 8000,
"type": "integer"
},
"tcpKeepAliveEnabled": {
"description": "If true, DSR probes a TCP Connection (/diameter/connections) that has been idle for the time configured in tcpKeepAliveIdleTime. Typical value is false.",
"type": "boolean"
},
"tcpKeepAliveIdleTime": {
"description": "Specifies the number of seconds of idle time between keep alive probes if tcpKeepAliveEnabled is set to true. Typical value is 1. Only applies when tcpKeepAliveEnabled is true.",
"maximum": 7200,
"minimum": 1,
"type": "integer"
},
"tcpKeepAliveMaximumCount": {
"description": "If tcpKeepAliveEnabled is true, tcpKeepAliveMaximumCount sets the maximum number of keep alive probes DSR sends without any response from the remote server before DSR gives up and aborts the Connection (/diameter/connections). Typical value is 9. Only applies when tcpKeepAliveEnabled is true.",
"maximum": 16,
"minimum": 1,
"type": "integer"
},
"tcpKeepAliveProbeInterval": {
"description": "If tcpKeepAliveEnabled is true, tcpKeepAliveProbeInterval sets the interval between keep alive probes in seconds. This value cannot be changed after a Connection (/diameter/connections) is established. Typical value is 1. Only applies when tcpKeepAliveEnabled is true.",
"maximum": 120,
"minimum": 1,
"type": "integer"
},
"tcpMaximumSegmentSize": {
"description": "The tcpMaximumSegmentSize (in bytes) is the IP maximum transmission unit minus the size of the TCP, and IPv4 or IPv6 headers for outgoing TCP packets. A value of zero indicates no limit on a maximum segment size. When specifying a maximum segment size, the minimum allowable value is 88 - the DSR rejects values between 1 and 87, inclusive. Typical value is 1024.",
"maximum": 1460,
"minimum": 0,
"type": "integer"
},
"tcpNagleEnabled": {
"description": "If true, the Nagle algorithm is enabled for the TCP Connection (/diameter/connections). Typical value is true.",
"type": "boolean"
},
"tcpSocketReceiveSize": {
"description": "Socket receive buffer size (in bytes) for incoming TCP messages. The receive buffer size should be greater than or equal to the product of the bandwidth and the round trip delay for the Connection (/diameter/connections). Typical value is 1000000.",
"maximum": 5000000,
"minimum": 8000,
"type": "integer"
},
"tcpSocketSendSize": {
"description": "Socket send buffer size (in bytes) for outgoing TCP messages. The send buffer size should be greater than or equal to the product of the bandwidth and the round trip delay for the Connection (/diameter/connections). Typical value is 1000000.",
"maximum": 5000000,
"minimum": 8000,
"type": "integer"
}
},
"required": [
"diameterCexHostIpValidationEnabled",
"diameterCexTimer",
"diameterDisconnectTimer",
"diameterPendingTransactionsPerConnection",
"diameterProvingDeviceWatchdogRequestsToSend",
"diameterProvingMode",
"diameterProvingTimeout",
"diameterTransportConnectionTimer",
"diameterWatchdogTimerInitValue",
"name",
"radiusCachedResponseDuration",
"radiusPendingTransactionsPerConnection",
"radiusPreventDuplicateEgressRetransmission",
"radiusPreventDuplicateIngressRetransmission",
"sctpDatagramBundlingEnabled",
"sctpFragmentationEnabled",
"sctpHeartbeatInterval",
"sctpMaximumBurst",
"sctpMaximumSegmentSize",
"sctpNumberInboundStreams",
"sctpNumberOutboundStreams",
"sctpOrderedDelivery",
"sctpRetransmissionAssociationFailure",
"sctpRetransmissionInitFailure",
"sctpRetransmissionInitTimeout",
"sctpRetransmissionMaximumTimeout",
"sctpRetransmissionMaximumTimeoutInit",
"sctpRetransmissionMinimumTimeout",
"sctpRetransmissionPathFailure",
"sctpSackDelay",
"sctpSocketReceiveSize",
"sctpSocketSendSize",
"tcpKeepAliveEnabled",
"tcpKeepAliveIdleTime",
"tcpKeepAliveMaximumCount",
"tcpKeepAliveProbeInterval",
"tcpMaximumSegmentSize",
"tcpNagleEnabled",
"tcpSocketReceiveSize",
"tcpSocketSendSize"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"configurationLevel": "52",
"diameterCexHostIpValidationEnabled": true,
"diameterCexTimer": 3,
"diameterDisconnectTimer": 3,
"diameterPendingTransactionsPerConnection": 1000,
"diameterProvingDeviceWatchdogRequestsToSend": 3,
"diameterProvingMode": "Suspect",
"diameterProvingTimeout": 500,
"diameterTransportConnectionTimer": 30,
"diameterWatchdogTimerInitValue": 30,
"name": "ConnectionConfigurationSet1",
"radiusCachedResponseDuration": 5000,
"radiusPendingTransactionsPerConnection": 1000,
"radiusPreventDuplicateEgressRetransmission": true,
"radiusPreventDuplicateIngressRetransmission": true,
"sctpDatagramBundlingEnabled": true,
"sctpFragmentationEnabled": true,
"sctpHeartbeatInterval": 500,
"sctpMaximumBurst": 4,
"sctpMaximumSegmentSize": 0,
"sctpNumberInboundStreams": 8,
"sctpNumberOutboundStreams": 8,
"sctpOrderedDelivery": false,
"sctpRetransmissionAssociationFailure": 5,
"sctpRetransmissionInitFailure": 8,
"sctpRetransmissionInitTimeout": 120,
"sctpRetransmissionMaximumTimeout": 120,
"sctpRetransmissionMaximumTimeoutInit": 120,
"sctpRetransmissionMinimumTimeout": 120,
"sctpRetransmissionPathFailure": 3,
"sctpSackDelay": 10,
"sctpSocketReceiveSize": 1000000,
"sctpSocketSendSize": 1000000,
"tcpKeepAliveEnabled": true,
"tcpKeepAliveIdleTime": 1,
"tcpKeepAliveMaximumCount": 9,
"tcpKeepAliveProbeInterval": 1,
"tcpMaximumSegmentSize": 1024,
"tcpNagleEnabled": true,
"tcpSocketReceiveSize": 1000000,
"tcpSocketSendSize": 1000000
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/connectionconfigurationsets/{name}
Updates the configuration of the specified Connection Configuration Set.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/connectionconfigurationset/connectionconfigurationset.json",
"properties": {
"cl1MinPriorityAllowed": {
"description": "Defines the minimum message priority of a Request message that can be forwarded to a Connection (/diameter/connections) whose congestion level is CL1. The typical value is 4 and the range is 1-15 when the ngnPs16PriorityAdminStateEnabled value (/diameter/options) is set to true. The typical value is 1 when the ngnPs16PriorityAdminStateEnabled value (/diameter/options) is set to false.",
"maximum": 15,
"minimum": 1,
"type": "integer"
},
"cl2MinPriorityAllowed": {
"description": "Defines the minimum message priority of a Request message that can be forwarded to a Connection (/diameter/connections) whose congestion level is CL2. The typical value is 8 and the range is 2-15 when the ngnPs16PriorityAdminStateEnabled value (/diameter/options) is set to true. The typical value is 2 when the ngnPs16PriorityAdminStateEnabled value (/diameter/options) is set to false.",
"maximum": 15,
"minimum": 2,
"type": "integer"
},
"cl3MinPriorityAllowed": {
"description": "Defines the minimum message priority of a Request message that can be forwarded to a Connection (/diameter/connections) whose congestion level is CL1. The typical value is 16 and the range is 3-16 when the ngnPs16PriorityAdminStateEnabled value (/diameter/options) is set to true. The typical value is 3 when the ngnPs16PriorityAdminStateEnabled value (/diameter/options) is set to false.",
"maximum": 16,
"minimum": 3,
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"diameterCexHostIpValidationEnabled": {
"description": "If true, Host-IP-Address AVP validation is enabled during CEX message exchange. Typical value is true.",
"type": "boolean"
},
"diameterCexTimer": {
"description": "Time (in seconds) to wait on a Capabilities Exchange Request message from a Peer Node (/diameter/peernodes) after a Connection (/diameter/connections) is initiated by the Peer Node; and time to wait on a Capabilities Exchange Answer response from a Peer Node after sending the request message. For Local Nodes (/diameter/localnodes), Capabilities Exchange Answer messages are sent in response to erroneous Capabilities Exchange Request messages. Typical value is 3.",
"maximum": 10,
"minimum": 1,
"type": "integer"
},
"diameterDisconnectTimer": {
"description": "After sending a disconnect peer request message, time (in seconds) to wait for a Peer Node (/diameter/peernodes) to disconnect the Connection (/diameter/connections); and after sending a disconnect peer request message, time to wait for the Peer Node to send the answer message. If the diameterDisconnectTimer expires, the Connection is disconnected by the application. Typical value is 3.",
"maximum": 10,
"minimum": 1,
"type": "integer"
},
"diameterPendingTransactionsPerConnection": {
"description": "The maximum number of pending request messages waiting for answer messages from the Peer Node (/diameter/peernodes) on this Connection (/diameter/connections). If the maximum is reached, this Connection is not selected for routing until the number of pending requests falls below this value. The diameterPendingTransactionsPerConnection value cannot be edited unless the Connection is disabled. Typical value is 1000.",
"maximum": 20000,
"minimum": 1,
"type": "integer"
},
"diameterProvingDeviceWatchdogRequestsToSend": {
"description": "The number of consecutive Device Watchdog Request and Answer message exchanges within a Proving Time interval during Connection (/diameter/connections) proving. Typical value is 3.",
"maximum": 1000,
"minimum": 1,
"type": "integer"
},
"diameterProvingMode": {
"description": "Proving mode for the Configuration Set. When set to Always, Device Watchdog Request and Answer exchanges are always done during Connection (/diameter/connections) proving. Suspect proving mode is only done when a Connection goes down due to an ungraceful disconnection (for example, no Disconnect Peer Request and Answer were exchanged when the Connection went down) and the Connection comes back up after the disconnection. When set to Never, proving is never done when a Connection goes down with the Peer Node (/diameter/peernodes) and it comes back up after a disconnection. Typical value is Suspect.",
"enum": [
"Always",
"Suspect",
"Never"
],
"type": "string"
},
"diameterProvingTimeout": {
"description": "The time (in milliseconds) to wait for a Peer Node (/diameter/peernodes) to send a Device Watchdog Answer message in response to a Device Watchdog Request message during Connection (/diameter/connections) proving. Typical value is 500.",
"maximum": 30000,
"minimum": 50,
"type": "integer"
},
"diameterTransportConnectionTimer": {
"description": "Controls the frequency (in seconds) that Connection (/diameter/connections) attempts are done to a Peer Node (/diameter/peernodes) where no active Connection exists. Applicable only for Connections configured to initiate a Connection with a Peer Node. Typical value is 30.",
"maximum": 60,
"minimum": 1,
"type": "integer"
},
"diameterWatchdogTimerInitValue": {
"description": "Initial value (in seconds) of the application watchdog timer. Typical value is 30.",
"maximum": 30,
"minimum": 1,
"type": "integer"
},
"name": {
"description": "Name associated with the Connection Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"minLength": 1,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"radiusCachedResponseDuration": {
"description": "Specifies the duration (in milliseconds) for which a cached response is held in the ingress transaction record. The radiusCachedResponseDuration value should cover the potential of loss of response and further retransmissions by the client. The radiusCachedResponseDuration applies only to server Connections (/diameter/connections) and only if radiusPreventDuplicateIngressRetransmission is true. Typical value is 5000.",
"maximum": 10000,
"minimum": 3000,
"type": "integer"
},
"radiusPendingTransactionsPerConnection": {
"description": "The maximum number of pending request messages waiting for a response from a Peer Node (/diameter/peernodes) on a Connection (/diameter/connections). If radiusPendingTransactionsPerConnection is reached, then the Connection is not selected for routing until the pending transactions are below the radiusPendingTransactionPerConnection value. Typical value is 1000.",
"maximum": 5000,
"minimum": 1,
"type": "integer"
},
"radiusPreventDuplicateEgressRetransmission": {
"description": "radiusPreventDuplicateEgressRetransmission applies to RADIUS client Connections (/diameter/connections) only and determines how to handle a request message being retransmitted to the same Peer Node (/diameter/peernodes) as before, but the corresponding transaction record (that contains the previously used source port, RADIUS Id, and request authenticator) has expired. If rediusPreventDuplicateEgressRetransmission is true, and if the corresponding transaction record has expired, the DSR does not forward the message to the same Peer Node (/diameter/peernodes) with a new RADIUS Id, source port, and request authenticator. An alternate Peer Node can be selected for routing in this case. If radiusPreventDuplicateEgressRetransmission is false, and the corresponding transaction record has expired, DSR selects a new source port, RADIUS Id, and request authenticator; creates a new transaction record; and forwards the message to the Peer Node. Typical value is true.",
"type": "boolean"
},
"radiusPreventDuplicateIngressRetransmission": {
"description": "radiusPreventDuplicateIngressRetransmission applies to RADIUS server Connections (/diameter/connections) only and determines how DSR processes duplicate request messages received from a client. A request is considered duplicate if the client retransmits a request message with the same source IP address, source port number, RADIUS Id, and request authenticator. If radiusPreventDuplicateIngressRetransmission is true, DSR creates an ingress transaction record for the message (with the message's source IP address, port, RADIUS Id, and request authenticator), which is used to admit only the first message into DSR and prevent admitting duplicate requests, if received, until the transaction record is present. If an egress message has been sent to the Peer Node (/diameter/peernodes) previously, it is saved in the transaction record and is forwarded to the client in response to duplicate requests. If radiusPreventDuplicateIngressRetransmission is false, DSR does not maintain ingress transaction records and admits all messages received from the client. Typical value is true.",
"type": "boolean"
},
"sctpDatagramBundlingEnabled": {
"description": "If true, datagram bundling is enable for the SCTP Connection (/diameter/connections). Typical value is true.",
"type": "boolean"
},
"sctpFragmentationEnabled": {
"description": "If true, a message exceeding the size of the path maximum transmission unit is fragmented and reassembled by the Peer Node (/diameter/peernodes). Typical value is true.",
"type": "boolean"
},
"sctpHeartbeatInterval": {
"description": "The interval in milliseconds between sending SCTP heartbeat messages to a Peer Node (/diameter/peernodes). Heartbeat messages are sent only when no user data has been sent for the duration of the sctpHeartbeatInterval. Setting sctpHeartbeatInterval to zero disables the heartbeat and is not recommended. When enabling the heartbeat, the minimum valid value is 100 ms - the DSR rejects values between 1 and 99, inclusive. Typical value is 1000.",
"maximum": 300000,
"minimum": 0,
"type": "integer"
},
"sctpMaximumBurst": {
"description": "Specifies the maximum burst of packets that can be emitted by this Connection (/diameter/connections). Typical value is 4.",
"maximum": 4,
"minimum": 1,
"type": "integer"
},
"sctpMaximumSegmentSize": {
"description": "The maximum size (in bytes) of any outgoing SCTP DATA chunk. If a message is larger than the sctpMaximumSegmentSize bytes, DSR fragments the message into chunks not exceeding this size. Set the sctpMaximumSegmentSize to zero to not stipulate a maximum segment size. When specifying a maximum segment size, the minimum allowable value is 88 - the DSR rejects values between 1 and 87, inclusive. Typical value is 0.",
"maximum": 1460,
"minimum": 0,
"type": "integer"
},
"sctpNumberInboundStreams": {
"description": "Maximum number of inbound SCTP streams supported locally by the SCTP Connection (/diameter/connections). Typical value is 8.",
"maximum": 16,
"minimum": 1,
"type": "integer"
},
"sctpNumberOutboundStreams": {
"description": "Maximum number of outbound SCTP streams supported locally by the SCTP Connection (/diameter/connections). Typical value is 8.",
"maximum": 16,
"minimum": 1,
"type": "integer"
},
"sctpOrderedDelivery": {
"description": "If true, ordered delivery of the SCTP data chunk is performed; otherwise, delivery is unordered. Typical value is false.",
"type": "boolean"
},
"sctpRetransmissionAssociationFailure": {
"description": "Number of consecutive message retransmissions that cause an SCTP Connection (/diameter/connections) to be marked as failed. The sctpRetransmissionAssociationFailure value indicates how many SCTP retransmission attempts should be made to all destinations for an SCTP Connection before marking the Connection as failed. This value should not be greater than the sum of the retransmission attempts for all destinations within the connection. Typical value is 5.",
"maximum": 20,
"minimum": 1,
"type": "integer"
},
"sctpRetransmissionInitFailure": {
"description": "Number of consecutive retransmits for INIT and COOKIE-ECHO chunks that cause an SCTP Connection (/diameter/connections) to be marked as failed. The sctpRetransmissionInitFailure value indicates how many retransmission attempts should be made to the primary IP address for INIT and COOKIE-ECHO chunks (when a secondary IP address has not been configured) before marking the Connection as failed. If a secondary IP address has been configured, the retransmission attempts are alternated between the primary and secondary IP address. Typical value is 8.",
"maximum": 20,
"minimum": 1,
"type": "integer"
},
"sctpRetransmissionInitTimeout": {
"description": "Expected average network roundtrip time in milliseconds. sctpRetransmissionInitTimeout is used to initialize the roundtrip time value when an Connection (/diameter/connections) is started but the roundtrip time has not yet been measured. DSR uses the roundtrip time to calculate when to retransmit chunks of messages. Typical value is 120.",
"maximum": 5000,
"minimum": 10,
"type": "integer"
},
"sctpRetransmissionMaximumTimeout": {
"description": "Maximum time (in milliseconds) to wait for an acknowledgment of a message sent. The sctpRetransmissionMaximumTimeout value places an upper boundary on the exponential back-off algorithm DSR uses for SCTP retransmission timing. After the retransmit interval is reached, retransmits are sent at a constant rate until an acknowledgment is received or the maximum attempts is reached. Typical value is 120.",
"maximum": 10000,
"minimum": 10,
"type": "integer"
},
"sctpRetransmissionMaximumTimeoutInit": {
"description": "Maximum time (in milliseconds) to wait for an INIT to be acknowledged. The sctpRetransmissionMaximumTimeoutInit value overrides the sctpRetransmissionMaximumTimeout and is used to bound the initial setup time. A value of zero indicates the sctpRetransmissionMaximumTimeout is used for INITs as well. When specifying an INIT timeout different from sctpRetransmissionMaximumTimeout, the minimum allowable value is 10 - the DSR rejects values between 1 and 9, inclusive. Typical value is 120.",
"maximum": 10000,
"minimum": 0,
"type": "integer"
},
"sctpRetransmissionMinimumTimeout": {
"description": "Minimum time (in milliseconds) to wait for an acknowledgment of a message sent. The sctpRetransmissionMinimumTimeout value prevents the retransmit timeout from becoming too small in networks with a very short roundtrip time. Typical value is 120.",
"maximum": 5000,
"minimum": 10,
"type": "integer"
},
"sctpRetransmissionPathFailure": {
"description": "Number of consecutive unsuccessful message retransmisssions that causes a path of the SCTP Connection (/diameter/connections) to be marked as failed. The sctpRetransmissionPathFailure value indicates how many SCTP retransmission attempts should be made to each destination of an SCTP Connection before marking the destination as failed. This value must be less than the sctpRetransmissionAssociationFailure value. Typical value is 3.",
"maximum": 10,
"minimum": 1,
"type": "integer"
},
"sctpSackDelay": {
"description": "The number of milliseconds to delay after receiving a data chunk and before sending a SACK. A non-zero value for sctpSackDelay gives the application time to bundle data chunks in the same SCTP message with the SACK, thereby reducing the number of packets in the network. Setting sctpSackDelay to zero disables this delay so that SACKs are sent as quickly as possible. Typical value is 10.",
"maximum": 200,
"minimum": 1,
"type": "integer"
},
"sctpSocketReceiveSize": {
"description": "Socket receive buffer size (in bytes) for incoming SCTP messages. The receive buffer size must be greater than or equal to the product of the bandwidth and the roundtrip delay for the Connection (/diameter/connections). Typical value is 1000000.",
"maximum": 5000000,
"minimum": 8000,
"type": "integer"
},
"sctpSocketSendSize": {
"description": "Socket send buffer size (in bytes) for outgoing SCTP messages. The send buffer size must be greater than or equal to the product of the bandwidth and the roundtrip delay for the Connection (/diameter/connections). Typical value is 1000000.",
"maximum": 5000000,
"minimum": 8000,
"type": "integer"
},
"tcpKeepAliveEnabled": {
"description": "If true, DSR probes a TCP Connection (/diameter/connections) that has been idle for the time configured in tcpKeepAliveIdleTime. Typical value is false.",
"type": "boolean"
},
"tcpKeepAliveIdleTime": {
"description": "Specifies the number of seconds of idle time between keep alive probes if tcpKeepAliveEnabled is set to true. Typical value is 1. Only applies when tcpKeepAliveEnabled is true.",
"maximum": 7200,
"minimum": 1,
"type": "integer"
},
"tcpKeepAliveMaximumCount": {
"description": "If tcpKeepAliveEnabled is true, tcpKeepAliveMaximumCount sets the maximum number of keep alive probes DSR sends without any response from the remote server before DSR gives up and aborts the Connection (/diameter/connections). Typical value is 9. Only applies when tcpKeepAliveEnabled is true.",
"maximum": 16,
"minimum": 1,
"type": "integer"
},
"tcpKeepAliveProbeInterval": {
"description": "If tcpKeepAliveEnabled is true, tcpKeepAliveProbeInterval sets the interval between keep alive probes in seconds. This value cannot be changed after a Connection (/diameter/connections) is established. Typical value is 1. Only applies when tcpKeepAliveEnabled is true.",
"maximum": 120,
"minimum": 1,
"type": "integer"
},
"tcpMaximumSegmentSize": {
"description": "The tcpMaximumSegmentSize (in bytes) is the IP maximum transmission unit minus the size of the TCP, and IPv4 or IPv6 headers for outgoing TCP packets. A value of zero indicates no limit on a maximum segment size. When specifying a maximum segment size, the minimum allowable value is 88 - the DSR rejects values between 1 and 87, inclusive. Typical value is 1024.",
"maximum": 1460,
"minimum": 0,
"type": "integer"
},
"tcpNagleEnabled": {
"description": "If true, the Nagle algorithm is enabled for the TCP Connection (/diameter/connections). Typical value is true.",
"type": "boolean"
},
"tcpSocketReceiveSize": {
"description": "Socket receive buffer size (in bytes) for incoming TCP messages. The receive buffer size should be greater than or equal to the product of the bandwidth and the round trip delay for the Connection (/diameter/connections). Typical value is 1000000.",
"maximum": 5000000,
"minimum": 8000,
"type": "integer"
},
"tcpSocketSendSize": {
"description": "Socket send buffer size (in bytes) for outgoing TCP messages. The send buffer size should be greater than or equal to the product of the bandwidth and the round trip delay for the Connection (/diameter/connections). Typical value is 1000000.",
"maximum": 5000000,
"minimum": 8000,
"type": "integer"
}
},
"required": [
"diameterCexHostIpValidationEnabled",
"diameterCexTimer",
"diameterDisconnectTimer",
"diameterPendingTransactionsPerConnection",
"diameterProvingDeviceWatchdogRequestsToSend",
"diameterProvingMode",
"diameterProvingTimeout",
"diameterTransportConnectionTimer",
"diameterWatchdogTimerInitValue",
"name",
"radiusCachedResponseDuration",
"radiusPendingTransactionsPerConnection",
"radiusPreventDuplicateEgressRetransmission",
"radiusPreventDuplicateIngressRetransmission",
"sctpDatagramBundlingEnabled",
"sctpFragmentationEnabled",
"sctpHeartbeatInterval",
"sctpMaximumBurst",
"sctpMaximumSegmentSize",
"sctpNumberInboundStreams",
"sctpNumberOutboundStreams",
"sctpOrderedDelivery",
"sctpRetransmissionAssociationFailure",
"sctpRetransmissionInitFailure",
"sctpRetransmissionInitTimeout",
"sctpRetransmissionMaximumTimeout",
"sctpRetransmissionMaximumTimeoutInit",
"sctpRetransmissionMinimumTimeout",
"sctpRetransmissionPathFailure",
"sctpSackDelay",
"sctpSocketReceiveSize",
"sctpSocketSendSize",
"tcpKeepAliveEnabled",
"tcpKeepAliveIdleTime",
"tcpKeepAliveMaximumCount",
"tcpKeepAliveProbeInterval",
"tcpMaximumSegmentSize",
"tcpNagleEnabled",
"tcpSocketReceiveSize",
"tcpSocketSendSize"
],
"type": "object"
}
Example
{
"configurationLevel": "52",
"diameterCexHostIpValidationEnabled": true,
"diameterCexTimer": 3,
"diameterDisconnectTimer": 3,
"diameterPendingTransactionsPerConnection": 1000,
"diameterProvingDeviceWatchdogRequestsToSend": 3,
"diameterProvingMode": "Suspect",
"diameterProvingTimeout": 500,
"diameterTransportConnectionTimer": 30,
"diameterWatchdogTimerInitValue": 30,
"name": "ConnectionConfigurationSet1",
"radiusCachedResponseDuration": 5000,
"radiusPendingTransactionsPerConnection": 1000,
"radiusPreventDuplicateEgressRetransmission": true,
"radiusPreventDuplicateIngressRetransmission": true,
"sctpDatagramBundlingEnabled": true,
"sctpFragmentationEnabled": true,
"sctpHeartbeatInterval": 500,
"sctpMaximumBurst": 4,
"sctpMaximumSegmentSize": 0,
"sctpNumberInboundStreams": 8,
"sctpNumberOutboundStreams": 8,
"sctpOrderedDelivery": false,
"sctpRetransmissionAssociationFailure": 5,
"sctpRetransmissionInitFailure": 8,
"sctpRetransmissionInitTimeout": 120,
"sctpRetransmissionMaximumTimeout": 120,
"sctpRetransmissionMaximumTimeoutInit": 120,
"sctpRetransmissionMinimumTimeout": 120,
"sctpRetransmissionPathFailure": 3,
"sctpSackDelay": 10,
"sctpSocketReceiveSize": 1000000,
"sctpSocketSendSize": 1000000,
"tcpKeepAliveEnabled": true,
"tcpKeepAliveIdleTime": 1,
"tcpKeepAliveMaximumCount": 9,
"tcpKeepAliveProbeInterval": 1,
"tcpMaximumSegmentSize": 1024,
"tcpNagleEnabled": true,
"tcpSocketReceiveSize": 1000000,
"tcpSocketSendSize": 1000000
}
delete /diameter/connectionconfigurationsets/{name}
Deletes the specified Connection Configuration Set from the SOAM configuration. The Default Connection Configuration Set cannot be deleted. A Connection Configuration Set can only be deleted if all delete validation checks pass. In general, if the Connection Configuration Set is a part of the configuration of one or more Connections (/diameter/connections) or Local Nodes (/diameter/localnodes), the Connection Configuration Set cannot be deleted. If the Connection Configuration Set is named in a Connection or Local Node, the Connection Configuration Set must first be removed from the Connection or Local Node. Then the Connection Configuration Set can be deleted from the configuration. An attempt to delete a Connection Configuration Set that cannot be deleted results in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Diameter: Connections
A Connection encapsulates details of the transport layer connectivity and some Diameter characteristics between a Local Node (/diameter/localnodes) and a specific Peer Node (/diameter/peernodes). The transport protocol (TCP, SCTP, TLS/TCP, DTLS/SCTP, UDP) is configured for the Connection, as well as the IP address(s) at both the local and peer ends.
Each Connection supports Diameter messages or RADIUS messages, but not both.
All Connection configuration is done at the SOAM.
/diameter/connections
get /diameter/connections
Returns all Connections configured at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those Connections meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section).
If a property is not explicitly identified as Diameter-only or RADIUS-only, it applies to both Diameter and RADIUS Connections.
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (one of configurationLevel)
The field being matched
Only the configurationLevel field is supported.
Example:
filter_name=configurationLevel
- filter_op: (one of GREATER_THAN, GREATER_THAN_EQUAL)
The match operation (operator)
Example:
filter_op=GREATER_THAN
- filter_values: (string)
The matched value
The configurationLevel value by which the data is being filtered. Only a single value is supported.
Example:
filter_values=10
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/connectionCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/connection/connection.json",
"properties": {
"aaaProtocol": {
"description": "The AAA protocol for this Connection, which defines the Connection as either Diameter or Radius. This value is required for all Connections, and cannot be changed after the Connection is initially configured.",
"enum": [
"Diameter",
"Radius"
],
"type": "string"
},
"capacityCfgSetName": {
"description": "The Capacity Configuration Set (/diameter/capacityconfigurationsets) defines reserved and maximum ingress message processing rates and alarm thresholds for this connection. This value is required for all Connections.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"cexCfgSetName": {
"description": "The CEX Configuration Set (/diameter/capabilitiesexchangeconfigurationsets) assigned to a Connection supplies capabilities exchange parameters used during connection establishment. Diameter Connections only.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"connCfgSetName": {
"description": "The Connection Configuration Set (/diameter/connectionconfigurationsets) assigned to a Connection supplies default values for a variety of transport connection parameters. This value is required for all Connections.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"connectionMode": {
"description": "Defines the connection initiation behavior of this Connection. LocalMpInitiator, LocalMpResponder, and FullySpecified apply only to Diameter Connections, while RadiusServer and RadiusClient only apply to RADIUS Connections. LocalMpInitiator means the Local Node (/diameter/localnodes) initiates a connection attempt to the Peer Node (/diameter/peernodes). LocalMpResponder means the Local Node does not initiate a connection attempt to the Peer Node, but only responds to a connection attempt initiated by the Peer Node. FullySpecified means the Local Node initiates a connection attempt, as well as responding to connection attempts initiated by the Peer Node. RadiusServer means the Local Node receives incoming RADIUS requests from a Peer Node configured as a RADIUS client. RadiusClient means the Local Node sends RADIUS requests to a Peer Node configured as a RADIUS server. This value is required for all Connections.",
"enum": [
"FullySpecified",
"LocalMpInitiator",
"LocalMpResponder",
"RadiusServer",
"RadiusClient"
],
"type": "string"
},
"ipfeInitiatorDampIp": {
"description": "If this Connection is an IPFE Connection and can be an initiator, the IPFE Initiator DA-MP is the one DA-MP that initiates the Connection to the Peer Node. This property must therefore be an IP address configured to the DA-MP that initiates the Connection, and the DA-MP must belong to the Target Set whose address(es) are configured as the local IP address(es) for this Connection. Diameter Connections only.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"isDynamic": {
"description": "If true, means the Connection was created dynamically as a result of dynamic peer discovery. isDynamic is read-only. Diameter Connections only.",
"readOnly": true,
"type": "boolean"
},
"localInitiatorPort": {
"description": "The source port from which the DSR sends a connection initiation request to the Peer Node (/diameter/peernodes). Diameter Connections only.",
"maximum": 49151,
"minimum": 1024,
"type": "integer"
},
"localIp": {
"description": "The IP address to be used as the primary Local Node (/diameter/localnodes) address for this Connection. This IP address must be one of the IP addresses configured for the Local Node assigned to this Connection. This value is required for all Connections.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"localNodeName": {
"description": "Name of the Local Node (/diameter/localnodes) associated with this Connection. This value is required for all Connections.",
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"msgAuthCfgSetName": {
"description": "Name of the Message Authenticator Configuration Set (/diameter/messageauthenticatorconfigurationsets) associated with this Connection. RADIUS Connections only.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"msgConvCfgSetName": {
"description": "Name of the Message Conversion Configuration Set (/diameter/messageconversionconfigurationsets) associated with this Connection. RADIUS Connections only.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"msgPriorityCfgSetName": {
"description": "The Message Priority Configuration Set (/diameter/messagepriorityconfigurationsets) assigned to a Connection supplies rules governing prioritization of request messages sent by the Peer Node to the DSR. Applicable when this Connection's Message Priority Setting is UserConfigured. Diameter Connections only.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"msgPrioritySetting": {
"description": "When receiving a Request and this Connection's Message Priority Setting is set to None, then the Peer Node's (/diameter/peernodes) Message Priority Setting determines how priority is assigned to a Request. When set to RequestMessage, the message priority assigned to a request received from the Peer Node is read from the message itself. This option should only be used when the Peer Node is an Oracle Communications DSR. When set to UserConfigured, the Message Priority Configuration Set assigned to this Connection is used to determine the priority of request messages received from the Peer Node. Diameter Connections only.",
"enum": [
"None",
"RequestMessage",
"UserConfigured"
],
"type": "string"
},
"msgThrottlingCfgSetName": {
"description": "Name of the Message Throttling Configuration Set (/diameter/messagethrottlingconfigurationsets) associated with this Connection.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"name": {
"description": "Name for the Connection, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit. This value is required for all Connections.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerIdentification": {
"description": "Specifies how the Local Node (/diameter/localnodes) derives the Peer Node's (/diameter/peernodes) IP address(es) when initiating a Connection to the Peer Node, and whether the Local Node validates the Peer Node's IP address(es) when responding to a Connection from the Peer Node. When None is specified, DSR does not validate the Peer Node's IP address(s) when responding to a Connection from the Peer Node. When IP is specified, DSR uses the Peer Node's IP address(es) configured for this Connection when initiating a Connection to the Peer Node, and validates the Peer Node's IP address(es) when responding to a Connection from the Peer Node. When TransportFqdn is specified, DSR uses the DNS-resolved Transport FQDN address configured for this Connection when initiating a connection to the Peer Node, and does not validate the Peer Node's IP address(es) when responding to a Connection from the Peer Node. When PeerFqdn is specified, DSR uses the DNS-resolved FQDN address configured for the Peer Node associated with this Connection when initiating a Connection to the Peer Node, and does not validate the Peer Node's IP address(es) when responding to a Connection from the Peer Node. This value is required for all Connections.",
"enum": [
"Ip",
"TransportFqdn",
"PeerFqdn",
"None"
],
"type": "string"
},
"peerIp": {
"description": "The IP address to be used as the primary Peer Node (/diameter/peernodes) address for this Connection. Required for RADIUS Connections. For Diameter Connections, required whenever peerIdentification is not IP. priPeerIp must be one of the IP addresses configured for the Peer Node assigned to this Connection.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"peerNodeName": {
"description": "Name of the Peer Node (/diameter/peernodes) associated with this Connection. This value is required for all Connections.",
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"remoteBusyTimeout": {
"description": "Defines the time period (in seconds) that a Connection is considered BUSY from the last time a DIAMETER_TOO_BUSY response was received. Diameter Connections only.",
"maximum": 60,
"minimum": 3,
"type": "integer"
},
"remoteBusyUsage": {
"description": "Defines which Request messages can be forwarded on this Connection after receiving a DIAMETER_TOO_BUSY response from the Connection's Peer Node (/diameter/peernodes). When set to false, the Connection is not considered to be BUSY after receiving a DIAMETER_TOO_BUSY response. All Request messages continue to be forwarded to (or rerouted to) this Connection. When set to true, the Connection is considered to be BUSY after receiving a DIAMETER_TOO_BUSY response. No Request messages can be forwarded to (or rerouted to) this Connection until the Remote Busy Abatement Timeout expires. Diameter Connections only.",
"type": "boolean"
},
"altLocalIp": {
"description": "The IP address to be used as the alternate Local Node (/diameter/localnodes) address for this Connection. This address is only used for SCTP multi-homing, and must be different from the address chosen for the primary local IP address. Diameter Connections only.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"altPeerIp": {
"description": "The IP address to be used as the alternate Peer Node (/diameter/peernodes) address for this Connection. This address is only used for SCTP multi-homing, and must be different from the address chosen for the primary peer IP address. Diameter Connections only.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"sharedSecretCfgSetName": {
"description": "Name of the Shared Secret Configuration Set (/diameter/sharedsecretconfigurationsets) associated with this Connection. RADIUS Connections only.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"statusServerCfgSetName": {
"description": "Name of the Ingress Status-Server Configuration Set (/diameter/statusserverconfigurationsets) associated with this Connection. RADIUS Connections only.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"suppressConnAttempt": {
"description": "If true, connection attempts to the standby Peer Node (/diameter/peernodes) are suppressed once the Peer Node's Operational Status is Available. Diameter Connections only. ",
"type": "boolean"
},
"suppressConnUnavailableAlarm": {
"description": "If true, a connection unavailable alarm is not raised for this Connection whenever the Connection becomes Unavailable. Diameter Connections only. ",
"type": "boolean"
},
"testMode": {
"description": "If true, indicates the Connection is in test mode. Diameter Connections only.",
"type": "boolean"
},
"transportCongTimeout": {
"description": "Defines the time period (in seconds) spent by the Connection in abating each congestion level during abatement. Typical value is 5 seconds. Diameter Connections only.",
"maximum": 60,
"minimum": 3,
"type": "integer"
},
"transportFqdn": {
"description": "Fully Qualified Domain Name for this Connection. FQDN is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and a FQDN must be at most 255 characters long. Diameter Connections only.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
},
"transportProtocol": {
"description": "The transport protocol used by this Connection. The selected protocol must be supported by both the Local Node (/diameter/localnodes) and the Peer Node (/diameter/peernodes) assigned to this Connection. The transport protocols Tcp, Tls, Sctp, and Dtls may only be associated with Diameter Connections, while Udp may only be associated with RADIUS Connections. Required for all Connections. Note: The MP hosting this Connection should not have IPSEC enabled if this Connection is configured as Tls or Dtls, since enabling both IPSEC and TLS/TCP or DTLS/SCTP would have a significant, negative impact on Connection performance. This value is required for all Connections.",
"enum": [
"Sctp",
"Dtls",
"Tcp",
"Tls",
"Udp"
],
"type": "string"
},
"udpPort": {
"description": "For RADIUS Server Connections, this is the UDP port on which the DSR expects to receive incoming RADIUS requests for this Connection. For RADIUS Client Connections, this is the UDP port at the destination Peer Node (/diameter/peernodes), which receives the RADIUS request sent by the DSR. RADIUS Connections only.",
"maximum": 49151,
"minimum": 1024,
"type": "integer"
}
},
"required": [
"aaaProtocol",
"capacityCfgSetName",
"connCfgSetName",
"connectionMode",
"localNodeName",
"name",
"peerIdentification",
"peerNodeName",
"localIp",
"transportProtocol"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"aaaProtocol": "Radius",
"altLocalIp": "10.24.5.42",
"altPeerIp": "52.36.25.63",
"capCfgSetName": "capCfgSet1",
"cexCfgSetName": "cexCfgSet1",
"configurationLevel": "48",
"connCfgSetName": "connCfgSet1",
"connectionMode": "LocalMpResponder",
"isDynamic": false,
"localInitiatorPort": 6615,
"localIp": "10.24.2.8",
"localNodeName": "localNode1",
"msgConvCfgSetName": "msgConvCfgSet1",
"msgPriorityCfgSetName": "msgPriorityCfgSet1",
"msgPrioritySetting": "RequestMessage",
"name": "Connection1",
"peerIdentification": "Ip",
"peerIp": "52.36.41.9",
"peerNodeName": "peerNode1",
"remoteBusyTimeout": 30,
"remoteBusyUsage": true,
"statusServerCfgSetName": "statusServerCfgSet1",
"suppressConnAttempt": false,
"suppressConnUnavailableAlarm": true,
"testMode": false,
"transportFqdn": "transport.domain.com",
"transportProtocol": "Udp",
"udpPort": 42272
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/connections
Adds a new Connection to the DSR configuration. The new Connection must have a name that is unique across all Connections at the SOAM. For a given Peer Node (/diameter/peernodes), unique Connections can be configured for each combination of the following attributes: Local Node (/diameter/localnodes) IP address(es), Local Node Listen Port, transport protocol, Peer Node IP address(es), Peer Diameter Identity FQDN, Peer Realm, and must include Diameter Application IDs (/diameter/applicationids). If this set of Connection attributes is common for two or more Connections, then those Connections are considered part of the same Connection pool.
If a property is not explicitly identified as Diameter-only or RADIUS-only, it applies to both Diameter and RADIUS Connections.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/connection/connection.json",
"properties": {
"aaaProtocol": {
"description": "The AAA protocol for this Connection, which defines the Connection as either Diameter or Radius. This value is required for all Connections, and cannot be changed after the Connection is initially configured.",
"enum": [
"Diameter",
"Radius"
],
"type": "string"
},
"capacityCfgSetName": {
"description": "The Capacity Configuration Set (/diameter/capacityconfigurationsets) defines reserved and maximum ingress message processing rates and alarm thresholds for this connection. This value is required for all Connections.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"cexCfgSetName": {
"description": "The CEX Configuration Set (/diameter/capabilitiesexchangeconfigurationsets) assigned to a Connection supplies capabilities exchange parameters used during connection establishment. Diameter Connections only.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"connCfgSetName": {
"description": "The Connection Configuration Set (/diameter/connectionconfigurationsets) assigned to a Connection supplies default values for a variety of transport connection parameters. This value is required for all Connections.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"connectionMode": {
"description": "Defines the connection initiation behavior of this Connection. LocalMpInitiator, LocalMpResponder, and FullySpecified apply only to Diameter Connections, while RadiusServer and RadiusClient only apply to RADIUS Connections. LocalMpInitiator means the Local Node (/diameter/localnodes) initiates a connection attempt to the Peer Node (/diameter/peernodes). LocalMpResponder means the Local Node does not initiate a connection attempt to the Peer Node, but only responds to a connection attempt initiated by the Peer Node. FullySpecified means the Local Node initiates a connection attempt, as well as responding to connection attempts initiated by the Peer Node. RadiusServer means the Local Node receives incoming RADIUS requests from a Peer Node configured as a RADIUS client. RadiusClient means the Local Node sends RADIUS requests to a Peer Node configured as a RADIUS server. This value is required for all Connections.",
"enum": [
"FullySpecified",
"LocalMpInitiator",
"LocalMpResponder",
"RadiusServer",
"RadiusClient"
],
"type": "string"
},
"ipfeInitiatorDampIp": {
"description": "If this Connection is an IPFE Connection and can be an initiator, the IPFE Initiator DA-MP is the one DA-MP that initiates the Connection to the Peer Node. This property must therefore be an IP address configured to the DA-MP that initiates the Connection, and the DA-MP must belong to the Target Set whose address(es) are configured as the local IP address(es) for this Connection. Diameter Connections only.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"isDynamic": {
"description": "If true, means the Connection was created dynamically as a result of dynamic peer discovery. isDynamic is read-only. Diameter Connections only.",
"readOnly": true,
"type": "boolean"
},
"localInitiatorPort": {
"description": "The source port from which the DSR sends a connection initiation request to the Peer Node (/diameter/peernodes). Diameter Connections only.",
"maximum": 49151,
"minimum": 1024,
"type": "integer"
},
"localIp": {
"description": "The IP address to be used as the primary Local Node (/diameter/localnodes) address for this Connection. This IP address must be one of the IP addresses configured for the Local Node assigned to this Connection. This value is required for all Connections.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"localNodeName": {
"description": "Name of the Local Node (/diameter/localnodes) associated with this Connection. This value is required for all Connections.",
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"msgAuthCfgSetName": {
"description": "Name of the Message Authenticator Configuration Set (/diameter/messageauthenticatorconfigurationsets) associated with this Connection. RADIUS Connections only.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"msgConvCfgSetName": {
"description": "Name of the Message Conversion Configuration Set (/diameter/messageconversionconfigurationsets) associated with this Connection. RADIUS Connections only.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"msgPriorityCfgSetName": {
"description": "The Message Priority Configuration Set (/diameter/messagepriorityconfigurationsets) assigned to a Connection supplies rules governing prioritization of request messages sent by the Peer Node to the DSR. Applicable when this Connection's Message Priority Setting is UserConfigured. Diameter Connections only.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"msgPrioritySetting": {
"description": "When receiving a Request and this Connection's Message Priority Setting is set to None, then the Peer Node's (/diameter/peernodes) Message Priority Setting determines how priority is assigned to a Request. When set to RequestMessage, the message priority assigned to a request received from the Peer Node is read from the message itself. This option should only be used when the Peer Node is an Oracle Communications DSR. When set to UserConfigured, the Message Priority Configuration Set assigned to this Connection is used to determine the priority of request messages received from the Peer Node. Diameter Connections only.",
"enum": [
"None",
"RequestMessage",
"UserConfigured"
],
"type": "string"
},
"msgThrottlingCfgSetName": {
"description": "Name of the Message Throttling Configuration Set (/diameter/messagethrottlingconfigurationsets) associated with this Connection.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"name": {
"description": "Name for the Connection, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit. This value is required for all Connections.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerIdentification": {
"description": "Specifies how the Local Node (/diameter/localnodes) derives the Peer Node's (/diameter/peernodes) IP address(es) when initiating a Connection to the Peer Node, and whether the Local Node validates the Peer Node's IP address(es) when responding to a Connection from the Peer Node. When None is specified, DSR does not validate the Peer Node's IP address(s) when responding to a Connection from the Peer Node. When IP is specified, DSR uses the Peer Node's IP address(es) configured for this Connection when initiating a Connection to the Peer Node, and validates the Peer Node's IP address(es) when responding to a Connection from the Peer Node. When TransportFqdn is specified, DSR uses the DNS-resolved Transport FQDN address configured for this Connection when initiating a connection to the Peer Node, and does not validate the Peer Node's IP address(es) when responding to a Connection from the Peer Node. When PeerFqdn is specified, DSR uses the DNS-resolved FQDN address configured for the Peer Node associated with this Connection when initiating a Connection to the Peer Node, and does not validate the Peer Node's IP address(es) when responding to a Connection from the Peer Node. This value is required for all Connections.",
"enum": [
"Ip",
"TransportFqdn",
"PeerFqdn",
"None"
],
"type": "string"
},
"peerIp": {
"description": "The IP address to be used as the primary Peer Node (/diameter/peernodes) address for this Connection. Required for RADIUS Connections. For Diameter Connections, required whenever peerIdentification is not IP. priPeerIp must be one of the IP addresses configured for the Peer Node assigned to this Connection.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"peerNodeName": {
"description": "Name of the Peer Node (/diameter/peernodes) associated with this Connection. This value is required for all Connections.",
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"remoteBusyTimeout": {
"description": "Defines the time period (in seconds) that a Connection is considered BUSY from the last time a DIAMETER_TOO_BUSY response was received. Diameter Connections only.",
"maximum": 60,
"minimum": 3,
"type": "integer"
},
"remoteBusyUsage": {
"description": "Defines which Request messages can be forwarded on this Connection after receiving a DIAMETER_TOO_BUSY response from the Connection's Peer Node (/diameter/peernodes). When set to false, the Connection is not considered to be BUSY after receiving a DIAMETER_TOO_BUSY response. All Request messages continue to be forwarded to (or rerouted to) this Connection. When set to true, the Connection is considered to be BUSY after receiving a DIAMETER_TOO_BUSY response. No Request messages can be forwarded to (or rerouted to) this Connection until the Remote Busy Abatement Timeout expires. Diameter Connections only.",
"type": "boolean"
},
"altLocalIp": {
"description": "The IP address to be used as the alternate Local Node (/diameter/localnodes) address for this Connection. This address is only used for SCTP multi-homing, and must be different from the address chosen for the primary local IP address. Diameter Connections only.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"altPeerIp": {
"description": "The IP address to be used as the alternate Peer Node (/diameter/peernodes) address for this Connection. This address is only used for SCTP multi-homing, and must be different from the address chosen for the primary peer IP address. Diameter Connections only.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"sharedSecretCfgSetName": {
"description": "Name of the Shared Secret Configuration Set (/diameter/sharedsecretconfigurationsets) associated with this Connection. RADIUS Connections only.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"statusServerCfgSetName": {
"description": "Name of the Ingress Status-Server Configuration Set (/diameter/statusserverconfigurationsets) associated with this Connection. RADIUS Connections only.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"suppressConnAttempt": {
"description": "If true, connection attempts to the standby Peer Node (/diameter/peernodes) are suppressed once the Peer Node's Operational Status is Available. Diameter Connections only. ",
"type": "boolean"
},
"suppressConnUnavailableAlarm": {
"description": "If true, a connection unavailable alarm is not raised for this Connection whenever the Connection becomes Unavailable. Diameter Connections only. ",
"type": "boolean"
},
"testMode": {
"description": "If true, indicates the Connection is in test mode. Diameter Connections only.",
"type": "boolean"
},
"transportCongTimeout": {
"description": "Defines the time period (in seconds) spent by the Connection in abating each congestion level during abatement. Typical value is 5 seconds. Diameter Connections only.",
"maximum": 60,
"minimum": 3,
"type": "integer"
},
"transportFqdn": {
"description": "Fully Qualified Domain Name for this Connection. FQDN is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and a FQDN must be at most 255 characters long. Diameter Connections only.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
},
"transportProtocol": {
"description": "The transport protocol used by this Connection. The selected protocol must be supported by both the Local Node (/diameter/localnodes) and the Peer Node (/diameter/peernodes) assigned to this Connection. The transport protocols Tcp, Tls, Sctp, and Dtls may only be associated with Diameter Connections, while Udp may only be associated with RADIUS Connections. Required for all Connections. Note: The MP hosting this Connection should not have IPSEC enabled if this Connection is configured as Tls or Dtls, since enabling both IPSEC and TLS/TCP or DTLS/SCTP would have a significant, negative impact on Connection performance. This value is required for all Connections.",
"enum": [
"Sctp",
"Dtls",
"Tcp",
"Tls",
"Udp"
],
"type": "string"
},
"udpPort": {
"description": "For RADIUS Server Connections, this is the UDP port on which the DSR expects to receive incoming RADIUS requests for this Connection. For RADIUS Client Connections, this is the UDP port at the destination Peer Node (/diameter/peernodes), which receives the RADIUS request sent by the DSR. RADIUS Connections only.",
"maximum": 49151,
"minimum": 1024,
"type": "integer"
}
},
"required": [
"aaaProtocol",
"capacityCfgSetName",
"connCfgSetName",
"connectionMode",
"localNodeName",
"name",
"peerIdentification",
"peerNodeName",
"localIp",
"transportProtocol"
],
"type": "object"
}
Example
{
"aaaProtocol": "Radius",
"altLocalIp": "10.24.5.42",
"altPeerIp": "52.36.25.63",
"capCfgSetName": "capCfgSet1",
"cexCfgSetName": "cexCfgSet1",
"configurationLevel": "48",
"connCfgSetName": "connCfgSet1",
"connectionMode": "LocalMpResponder",
"isDynamic": false,
"localInitiatorPort": 6615,
"localIp": "10.24.2.8",
"localNodeName": "localNode1",
"msgConvCfgSetName": "msgConvCfgSet1",
"msgPriorityCfgSetName": "msgPriorityCfgSet1",
"msgPrioritySetting": "RequestMessage",
"name": "Connection1",
"peerIdentification": "Ip",
"peerIp": "52.36.41.9",
"peerNodeName": "peerNode1",
"remoteBusyTimeout": 30,
"remoteBusyUsage": true,
"statusServerCfgSetName": "statusServerCfgSet1",
"suppressConnAttempt": false,
"suppressConnUnavailableAlarm": true,
"testMode": false,
"transportFqdn": "transport.domain.com",
"transportProtocol": "Udp",
"udpPort": 42272
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/connections/connectionadminstate
put /diameter/connections/connectionadminstate
Updates the administrative state for all Connections specified in the request. The administrative update for multiple Connections is asynchronous, and creates a task when the request is received by the DSR. The task ID is returned to the client in the links section of the response. The status of the adminstrative update can be queried using the Task Monitoring API (/mon/tasks/{id}), which returns the status of the task specified by {id}. The status returned by /mon/tasks/{id} has an attribute named "details", and the value for "details" is a JSON-encoded string that contains: 1) the count of Connections that were successfully enabled/disabled; 2) the count of Connections that were not successfully enabled/disabled; and 3) and a final status message.
This API supports filtering, but only on the Connection name attribute, and only using the NOT_EQUAL, LIKE and IN filter operators. NOT_EQUAL takes a single Connection name for filter_value; LIKE takes a string that is used for pattern-matching, where the wildcard character is '*'. IN takes a comma-delimited list of Connection names.
Target Server: SOAM
Request
Query Parameters
- filter_name: (one of name)
The attribute name on which filtering occurs. For Connection bulk administrative enable/disable, only the Connection name field can be filtered.
Example:
filter_name=name
- filter_op: (one of NOT_EQUAL, LIKE, IN)
The filter operator. Only one operator can be specified for the Connection bulk administrative enable/disable filtering.
Example:
filter_op=IN
- filter_values: (string - repeat: true)
The Connection name(s) in the filter condition. If more than one Connection name is specified, the names should be comma-delimited.
Example:
filter_values='Conn1, Conn2, Conn3, Conn4'
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/connection/connectionadminstate.json",
"properties": {
"adminState": {
"description": "A Connection's administrative state can be either Enabled or Disabled. A Connection's configuration cannot be modified or deleted if its administrative state is Enabled.",
"enum": [
"Enabled",
"Disabled"
],
"example": "Enabled",
"type": "string"
}
},
"required": ["adminState"],
"type": "object"
}
Example
{
"adminState": "Enabled"
}
Response
HTTP status code 202
Successfully started the administrative enable/disable task.
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/bulk/items/emptyItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/bulk/empty/empty.json",
"properties": {
},
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
HTTP status code 400
The administrative enable/disable task could not be started successfully.
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/bulk/items/emptyItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/bulk/empty/empty.json",
"properties": {
},
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
/diameter/connections/status
get /diameter/connections/status
Returns the status of all Connections that meet the criteria specified in the request. This API supports filtering on any single attribute returned in the JSON data (except primaryRemoteIpAddress , secondaryRemoteIpAddress and operationalReason - these attributes cannot be filtered). Non-enumerated string attributes can be filtered using EQUAL, NOT_EQUAL, LIKE, or IN. Enumerated strings and integers can be filtered using EQUAL, NOT_EQUAL, or IN. LIKE is not supported for these data types. Boolean attributes can be filtered using only EQUAL.
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (string)
The attribute name on which filtering occurs. Non-enumerated string attributes can be filtered using EQUAL, NOT_EQUAL, LIKE or IN. Enumerated strings and integers can be filtered using EQUAL, NOT_EQUAL, and IN - LIKE is not supported for these data types.
Example:
filter_name=cplValue
- filter_op: (one of EQUAL, NOT_EQUAL, LIKE, IN)
The filter operator.
Example:
filter_op=EQUAL
- filter_values: (string)
The value being filtered on. When the filter_op is IN, filter_values can be a comma-delimited list of strings or integers. Otherwise, filter_value should be a single value.
Example:
filter_values=99
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/connectionstatusCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/connection/connectionstatus.json",
"properties": {
"averageEgressMps": {
"description": "The current average number of messages per second that are sent by the DSR to the Peer Node (/diameter/peernodes) configured for this Connection.",
"type": "integer"
},
"averageIngressMps": {
"description": "The current average number of messages per second that are received by the DSR from the Peer Node (/diameter/peernodes) configured for this Connection.",
"type": "integer"
},
"commonApplicationIds": {
"description": "The set of Diameter Application Ids (/diameter/applicationids) that the DSR and Peer Node (/diameter/peernodes) both support on this Connection. This set of common Application Ids is determined during Connection establishment.",
"items": {
"type": "integer"
},
"type": "array"
},
"connAdminState": {
"description": "The administrative state of this Connection. A Connection in the Disabled state cannot become established; it must first be placed into the Enabled state before attempting to initiate or listen for the configured Peer Node (/diameter/peernodes) to initiate.",
"enum": [
"Enabled",
"Disabled"
],
"type": "string"
},
"cplValue": {
"description": "The Connection Priority Level (CPL) value for this Connection. A value of zero means the Connection has no impairments. A value of 99 means the Connection is operationally unavailable or administratively disabled. A value between 0 and 99 indicates the Connection is experiencing degraded operation.",
"type": "integer"
},
"mpServerHostname": {
"description": "mpServerHostname indicates the name of the DA-MP server that is currently reporting the status of this Connection. For all three Fixed-type Connections (Initiator, Responder, Initiator & Responder) and IPFE Initiator Connections, mpServerHostname indicates the DA-MP that is configured to host the Connection. For Floating Connections that are established (IPFE Responder, IPFE Initiator & Responder Connections), mpServerHostname is the DA-MP on which the Connection became established. For Floating Connections that are not established, mpServerHostname is the DA-MP Leader, since it is the DA-MP Leader that reports status for un-established Floating Connections.",
"type": "string"
},
"name": {
"description": "The configured name of the Connection.",
"type": "string"
},
"operationalReason": {
"description": "Information elaborating on the current operationalStatus of the Connection.",
"type": "string"
},
"operationalStatus": {
"description": "The current operational state of the Connection. While this attribute can only have a value of Available, Degraded, or Unavailable, the operationalReason attribute typically contains additional information elaborating on the reported operationalStatus.",
"enum": [
"Available",
"Degraded",
"Unavailable"
],
"type": "string"
},
"pdusToDiagnose": {
"description": "The number of messages remaining to be received on this Connection that the DSR will treat as test messages for diagnostics purposes.",
"type": "integer"
},
"primaryRemoteIpAddress": {
"description": "The primary IP address of the Peer Node (/diameter/peernodes) configured for this Connection. Every established Connection has a primaryRemoteIpAddress value.",
"pattern": "^(((1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}(1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:])+$",
"type": "string"
},
"remotePort": {
"description": "The port number the Peer Node (/diameter/peernodes) is using to receive messages on this Connection.",
"type": "integer"
},
"secondaryRemoteIpAddress": {
"description": "The secondary IP address of the Peer Node (/diameter/peernodes) configured for this Connection. Only SCTP multi-homed Connections have a secondaryRemoteIpAddress value.",
"pattern": "^(((1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}(1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:])+$",
"type": "string"
},
"statusKnown": {
"description": "When set to false, current values for the run-time status attributes for this Connection are not known by the OAM. This could be due to merge issues within the DSR, or some other cause preventing the OAM from having a current view of the status of this Connection. If the OAM has current status for this Connection, statusKnown is set to true.",
"type": "boolean"
},
"timeOfLastUpdate": {
"description": "The date/time the status for this Connection was last updated by the DSR.",
"pattern": "^[0-9]{4}[-][a-zA-Z]{3}[-][0-9]{2} [0-9]{2}[:][0-9]{2}[:][0-9]{2} .*$",
"type": "string"
}
},
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"averageEgressMps": 4590,
"averageIngressMps": 4595,
"commonApplicationIds": [
4,
16777224,
4294967295
],
"connAdminState": "Enabled",
"cplValue": 0,
"mpServerHostname": "MP1",
"name": "Conn1",
"operationalReason": "Normal",
"operationalStatus": "Available",
"pdusToDiagnose": 1,
"primaryRemoteIpAddress": "48.23.10.1",
"remotePort": 35081,
"statusKnown": true,
"timeOfLastUpdate": "2016-Aug-25 11:05:05 EDT"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
/diameter/connections/{name}
get /diameter/connections/{name}
Returns the configuration details for the specified Connection. If the specified Connection does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
If a property is not explicitly identified as Diameter-only or RADIUS-only, it applies to both Diameter and RADIUS Connections.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/connectionItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/connection/connection.json",
"properties": {
"aaaProtocol": {
"description": "The AAA protocol for this Connection, which defines the Connection as either Diameter or Radius. This value is required for all Connections, and cannot be changed after the Connection is initially configured.",
"enum": [
"Diameter",
"Radius"
],
"type": "string"
},
"capacityCfgSetName": {
"description": "The Capacity Configuration Set (/diameter/capacityconfigurationsets) defines reserved and maximum ingress message processing rates and alarm thresholds for this connection. This value is required for all Connections.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"cexCfgSetName": {
"description": "The CEX Configuration Set (/diameter/capabilitiesexchangeconfigurationsets) assigned to a Connection supplies capabilities exchange parameters used during connection establishment. Diameter Connections only.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"connCfgSetName": {
"description": "The Connection Configuration Set (/diameter/connectionconfigurationsets) assigned to a Connection supplies default values for a variety of transport connection parameters. This value is required for all Connections.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"connectionMode": {
"description": "Defines the connection initiation behavior of this Connection. LocalMpInitiator, LocalMpResponder, and FullySpecified apply only to Diameter Connections, while RadiusServer and RadiusClient only apply to RADIUS Connections. LocalMpInitiator means the Local Node (/diameter/localnodes) initiates a connection attempt to the Peer Node (/diameter/peernodes). LocalMpResponder means the Local Node does not initiate a connection attempt to the Peer Node, but only responds to a connection attempt initiated by the Peer Node. FullySpecified means the Local Node initiates a connection attempt, as well as responding to connection attempts initiated by the Peer Node. RadiusServer means the Local Node receives incoming RADIUS requests from a Peer Node configured as a RADIUS client. RadiusClient means the Local Node sends RADIUS requests to a Peer Node configured as a RADIUS server. This value is required for all Connections.",
"enum": [
"FullySpecified",
"LocalMpInitiator",
"LocalMpResponder",
"RadiusServer",
"RadiusClient"
],
"type": "string"
},
"ipfeInitiatorDampIp": {
"description": "If this Connection is an IPFE Connection and can be an initiator, the IPFE Initiator DA-MP is the one DA-MP that initiates the Connection to the Peer Node. This property must therefore be an IP address configured to the DA-MP that initiates the Connection, and the DA-MP must belong to the Target Set whose address(es) are configured as the local IP address(es) for this Connection. Diameter Connections only.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"isDynamic": {
"description": "If true, means the Connection was created dynamically as a result of dynamic peer discovery. isDynamic is read-only. Diameter Connections only.",
"readOnly": true,
"type": "boolean"
},
"localInitiatorPort": {
"description": "The source port from which the DSR sends a connection initiation request to the Peer Node (/diameter/peernodes). Diameter Connections only.",
"maximum": 49151,
"minimum": 1024,
"type": "integer"
},
"localIp": {
"description": "The IP address to be used as the primary Local Node (/diameter/localnodes) address for this Connection. This IP address must be one of the IP addresses configured for the Local Node assigned to this Connection. This value is required for all Connections.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"localNodeName": {
"description": "Name of the Local Node (/diameter/localnodes) associated with this Connection. This value is required for all Connections.",
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"msgAuthCfgSetName": {
"description": "Name of the Message Authenticator Configuration Set (/diameter/messageauthenticatorconfigurationsets) associated with this Connection. RADIUS Connections only.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"msgConvCfgSetName": {
"description": "Name of the Message Conversion Configuration Set (/diameter/messageconversionconfigurationsets) associated with this Connection. RADIUS Connections only.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"msgPriorityCfgSetName": {
"description": "The Message Priority Configuration Set (/diameter/messagepriorityconfigurationsets) assigned to a Connection supplies rules governing prioritization of request messages sent by the Peer Node to the DSR. Applicable when this Connection's Message Priority Setting is UserConfigured. Diameter Connections only.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"msgPrioritySetting": {
"description": "When receiving a Request and this Connection's Message Priority Setting is set to None, then the Peer Node's (/diameter/peernodes) Message Priority Setting determines how priority is assigned to a Request. When set to RequestMessage, the message priority assigned to a request received from the Peer Node is read from the message itself. This option should only be used when the Peer Node is an Oracle Communications DSR. When set to UserConfigured, the Message Priority Configuration Set assigned to this Connection is used to determine the priority of request messages received from the Peer Node. Diameter Connections only.",
"enum": [
"None",
"RequestMessage",
"UserConfigured"
],
"type": "string"
},
"msgThrottlingCfgSetName": {
"description": "Name of the Message Throttling Configuration Set (/diameter/messagethrottlingconfigurationsets) associated with this Connection.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"name": {
"description": "Name for the Connection, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit. This value is required for all Connections.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerIdentification": {
"description": "Specifies how the Local Node (/diameter/localnodes) derives the Peer Node's (/diameter/peernodes) IP address(es) when initiating a Connection to the Peer Node, and whether the Local Node validates the Peer Node's IP address(es) when responding to a Connection from the Peer Node. When None is specified, DSR does not validate the Peer Node's IP address(s) when responding to a Connection from the Peer Node. When IP is specified, DSR uses the Peer Node's IP address(es) configured for this Connection when initiating a Connection to the Peer Node, and validates the Peer Node's IP address(es) when responding to a Connection from the Peer Node. When TransportFqdn is specified, DSR uses the DNS-resolved Transport FQDN address configured for this Connection when initiating a connection to the Peer Node, and does not validate the Peer Node's IP address(es) when responding to a Connection from the Peer Node. When PeerFqdn is specified, DSR uses the DNS-resolved FQDN address configured for the Peer Node associated with this Connection when initiating a Connection to the Peer Node, and does not validate the Peer Node's IP address(es) when responding to a Connection from the Peer Node. This value is required for all Connections.",
"enum": [
"Ip",
"TransportFqdn",
"PeerFqdn",
"None"
],
"type": "string"
},
"peerIp": {
"description": "The IP address to be used as the primary Peer Node (/diameter/peernodes) address for this Connection. Required for RADIUS Connections. For Diameter Connections, required whenever peerIdentification is not IP. priPeerIp must be one of the IP addresses configured for the Peer Node assigned to this Connection.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"peerNodeName": {
"description": "Name of the Peer Node (/diameter/peernodes) associated with this Connection. This value is required for all Connections.",
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"remoteBusyTimeout": {
"description": "Defines the time period (in seconds) that a Connection is considered BUSY from the last time a DIAMETER_TOO_BUSY response was received. Diameter Connections only.",
"maximum": 60,
"minimum": 3,
"type": "integer"
},
"remoteBusyUsage": {
"description": "Defines which Request messages can be forwarded on this Connection after receiving a DIAMETER_TOO_BUSY response from the Connection's Peer Node (/diameter/peernodes). When set to false, the Connection is not considered to be BUSY after receiving a DIAMETER_TOO_BUSY response. All Request messages continue to be forwarded to (or rerouted to) this Connection. When set to true, the Connection is considered to be BUSY after receiving a DIAMETER_TOO_BUSY response. No Request messages can be forwarded to (or rerouted to) this Connection until the Remote Busy Abatement Timeout expires. Diameter Connections only.",
"type": "boolean"
},
"altLocalIp": {
"description": "The IP address to be used as the alternate Local Node (/diameter/localnodes) address for this Connection. This address is only used for SCTP multi-homing, and must be different from the address chosen for the primary local IP address. Diameter Connections only.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"altPeerIp": {
"description": "The IP address to be used as the alternate Peer Node (/diameter/peernodes) address for this Connection. This address is only used for SCTP multi-homing, and must be different from the address chosen for the primary peer IP address. Diameter Connections only.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"sharedSecretCfgSetName": {
"description": "Name of the Shared Secret Configuration Set (/diameter/sharedsecretconfigurationsets) associated with this Connection. RADIUS Connections only.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"statusServerCfgSetName": {
"description": "Name of the Ingress Status-Server Configuration Set (/diameter/statusserverconfigurationsets) associated with this Connection. RADIUS Connections only.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"suppressConnAttempt": {
"description": "If true, connection attempts to the standby Peer Node (/diameter/peernodes) are suppressed once the Peer Node's Operational Status is Available. Diameter Connections only. ",
"type": "boolean"
},
"suppressConnUnavailableAlarm": {
"description": "If true, a connection unavailable alarm is not raised for this Connection whenever the Connection becomes Unavailable. Diameter Connections only. ",
"type": "boolean"
},
"testMode": {
"description": "If true, indicates the Connection is in test mode. Diameter Connections only.",
"type": "boolean"
},
"transportCongTimeout": {
"description": "Defines the time period (in seconds) spent by the Connection in abating each congestion level during abatement. Typical value is 5 seconds. Diameter Connections only.",
"maximum": 60,
"minimum": 3,
"type": "integer"
},
"transportFqdn": {
"description": "Fully Qualified Domain Name for this Connection. FQDN is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and a FQDN must be at most 255 characters long. Diameter Connections only.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
},
"transportProtocol": {
"description": "The transport protocol used by this Connection. The selected protocol must be supported by both the Local Node (/diameter/localnodes) and the Peer Node (/diameter/peernodes) assigned to this Connection. The transport protocols Tcp, Tls, Sctp, and Dtls may only be associated with Diameter Connections, while Udp may only be associated with RADIUS Connections. Required for all Connections. Note: The MP hosting this Connection should not have IPSEC enabled if this Connection is configured as Tls or Dtls, since enabling both IPSEC and TLS/TCP or DTLS/SCTP would have a significant, negative impact on Connection performance. This value is required for all Connections.",
"enum": [
"Sctp",
"Dtls",
"Tcp",
"Tls",
"Udp"
],
"type": "string"
},
"udpPort": {
"description": "For RADIUS Server Connections, this is the UDP port on which the DSR expects to receive incoming RADIUS requests for this Connection. For RADIUS Client Connections, this is the UDP port at the destination Peer Node (/diameter/peernodes), which receives the RADIUS request sent by the DSR. RADIUS Connections only.",
"maximum": 49151,
"minimum": 1024,
"type": "integer"
}
},
"required": [
"aaaProtocol",
"capacityCfgSetName",
"connCfgSetName",
"connectionMode",
"localNodeName",
"name",
"peerIdentification",
"peerNodeName",
"localIp",
"transportProtocol"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"aaaProtocol": "Radius",
"altLocalIp": "10.24.5.42",
"altPeerIp": "52.36.25.63",
"capCfgSetName": "capCfgSet1",
"cexCfgSetName": "cexCfgSet1",
"configurationLevel": "48",
"connCfgSetName": "connCfgSet1",
"connectionMode": "LocalMpResponder",
"isDynamic": false,
"localInitiatorPort": 6615,
"localIp": "10.24.2.8",
"localNodeName": "localNode1",
"msgConvCfgSetName": "msgConvCfgSet1",
"msgPriorityCfgSetName": "msgPriorityCfgSet1",
"msgPrioritySetting": "RequestMessage",
"name": "Connection1",
"peerIdentification": "Ip",
"peerIp": "52.36.41.9",
"peerNodeName": "peerNode1",
"remoteBusyTimeout": 30,
"remoteBusyUsage": true,
"statusServerCfgSetName": "statusServerCfgSet1",
"suppressConnAttempt": false,
"suppressConnUnavailableAlarm": true,
"testMode": false,
"transportFqdn": "transport.domain.com",
"transportProtocol": "Udp",
"udpPort": 42272
}
,
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/connections/{name}
Updates the configuration for the specified Connection. If the provided Connection data is invalid in any way, the update fails, resulting in one or more error messages returned within the HTTP response.
If a property is not explicitly identified as Diameter-only or RADIUS-only, it applies to both Diameter and RADIUS Connections.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/connection/connection.json",
"properties": {
"aaaProtocol": {
"description": "The AAA protocol for this Connection, which defines the Connection as either Diameter or Radius. This value is required for all Connections, and cannot be changed after the Connection is initially configured.",
"enum": [
"Diameter",
"Radius"
],
"type": "string"
},
"capacityCfgSetName": {
"description": "The Capacity Configuration Set (/diameter/capacityconfigurationsets) defines reserved and maximum ingress message processing rates and alarm thresholds for this connection. This value is required for all Connections.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"cexCfgSetName": {
"description": "The CEX Configuration Set (/diameter/capabilitiesexchangeconfigurationsets) assigned to a Connection supplies capabilities exchange parameters used during connection establishment. Diameter Connections only.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"connCfgSetName": {
"description": "The Connection Configuration Set (/diameter/connectionconfigurationsets) assigned to a Connection supplies default values for a variety of transport connection parameters. This value is required for all Connections.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"connectionMode": {
"description": "Defines the connection initiation behavior of this Connection. LocalMpInitiator, LocalMpResponder, and FullySpecified apply only to Diameter Connections, while RadiusServer and RadiusClient only apply to RADIUS Connections. LocalMpInitiator means the Local Node (/diameter/localnodes) initiates a connection attempt to the Peer Node (/diameter/peernodes). LocalMpResponder means the Local Node does not initiate a connection attempt to the Peer Node, but only responds to a connection attempt initiated by the Peer Node. FullySpecified means the Local Node initiates a connection attempt, as well as responding to connection attempts initiated by the Peer Node. RadiusServer means the Local Node receives incoming RADIUS requests from a Peer Node configured as a RADIUS client. RadiusClient means the Local Node sends RADIUS requests to a Peer Node configured as a RADIUS server. This value is required for all Connections.",
"enum": [
"FullySpecified",
"LocalMpInitiator",
"LocalMpResponder",
"RadiusServer",
"RadiusClient"
],
"type": "string"
},
"ipfeInitiatorDampIp": {
"description": "If this Connection is an IPFE Connection and can be an initiator, the IPFE Initiator DA-MP is the one DA-MP that initiates the Connection to the Peer Node. This property must therefore be an IP address configured to the DA-MP that initiates the Connection, and the DA-MP must belong to the Target Set whose address(es) are configured as the local IP address(es) for this Connection. Diameter Connections only.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"isDynamic": {
"description": "If true, means the Connection was created dynamically as a result of dynamic peer discovery. isDynamic is read-only. Diameter Connections only.",
"readOnly": true,
"type": "boolean"
},
"localInitiatorPort": {
"description": "The source port from which the DSR sends a connection initiation request to the Peer Node (/diameter/peernodes). Diameter Connections only.",
"maximum": 49151,
"minimum": 1024,
"type": "integer"
},
"localIp": {
"description": "The IP address to be used as the primary Local Node (/diameter/localnodes) address for this Connection. This IP address must be one of the IP addresses configured for the Local Node assigned to this Connection. This value is required for all Connections.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"localNodeName": {
"description": "Name of the Local Node (/diameter/localnodes) associated with this Connection. This value is required for all Connections.",
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"msgAuthCfgSetName": {
"description": "Name of the Message Authenticator Configuration Set (/diameter/messageauthenticatorconfigurationsets) associated with this Connection. RADIUS Connections only.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"msgConvCfgSetName": {
"description": "Name of the Message Conversion Configuration Set (/diameter/messageconversionconfigurationsets) associated with this Connection. RADIUS Connections only.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"msgPriorityCfgSetName": {
"description": "The Message Priority Configuration Set (/diameter/messagepriorityconfigurationsets) assigned to a Connection supplies rules governing prioritization of request messages sent by the Peer Node to the DSR. Applicable when this Connection's Message Priority Setting is UserConfigured. Diameter Connections only.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"msgPrioritySetting": {
"description": "When receiving a Request and this Connection's Message Priority Setting is set to None, then the Peer Node's (/diameter/peernodes) Message Priority Setting determines how priority is assigned to a Request. When set to RequestMessage, the message priority assigned to a request received from the Peer Node is read from the message itself. This option should only be used when the Peer Node is an Oracle Communications DSR. When set to UserConfigured, the Message Priority Configuration Set assigned to this Connection is used to determine the priority of request messages received from the Peer Node. Diameter Connections only.",
"enum": [
"None",
"RequestMessage",
"UserConfigured"
],
"type": "string"
},
"msgThrottlingCfgSetName": {
"description": "Name of the Message Throttling Configuration Set (/diameter/messagethrottlingconfigurationsets) associated with this Connection.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"name": {
"description": "Name for the Connection, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit. This value is required for all Connections.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerIdentification": {
"description": "Specifies how the Local Node (/diameter/localnodes) derives the Peer Node's (/diameter/peernodes) IP address(es) when initiating a Connection to the Peer Node, and whether the Local Node validates the Peer Node's IP address(es) when responding to a Connection from the Peer Node. When None is specified, DSR does not validate the Peer Node's IP address(s) when responding to a Connection from the Peer Node. When IP is specified, DSR uses the Peer Node's IP address(es) configured for this Connection when initiating a Connection to the Peer Node, and validates the Peer Node's IP address(es) when responding to a Connection from the Peer Node. When TransportFqdn is specified, DSR uses the DNS-resolved Transport FQDN address configured for this Connection when initiating a connection to the Peer Node, and does not validate the Peer Node's IP address(es) when responding to a Connection from the Peer Node. When PeerFqdn is specified, DSR uses the DNS-resolved FQDN address configured for the Peer Node associated with this Connection when initiating a Connection to the Peer Node, and does not validate the Peer Node's IP address(es) when responding to a Connection from the Peer Node. This value is required for all Connections.",
"enum": [
"Ip",
"TransportFqdn",
"PeerFqdn",
"None"
],
"type": "string"
},
"peerIp": {
"description": "The IP address to be used as the primary Peer Node (/diameter/peernodes) address for this Connection. Required for RADIUS Connections. For Diameter Connections, required whenever peerIdentification is not IP. priPeerIp must be one of the IP addresses configured for the Peer Node assigned to this Connection.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"peerNodeName": {
"description": "Name of the Peer Node (/diameter/peernodes) associated with this Connection. This value is required for all Connections.",
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"remoteBusyTimeout": {
"description": "Defines the time period (in seconds) that a Connection is considered BUSY from the last time a DIAMETER_TOO_BUSY response was received. Diameter Connections only.",
"maximum": 60,
"minimum": 3,
"type": "integer"
},
"remoteBusyUsage": {
"description": "Defines which Request messages can be forwarded on this Connection after receiving a DIAMETER_TOO_BUSY response from the Connection's Peer Node (/diameter/peernodes). When set to false, the Connection is not considered to be BUSY after receiving a DIAMETER_TOO_BUSY response. All Request messages continue to be forwarded to (or rerouted to) this Connection. When set to true, the Connection is considered to be BUSY after receiving a DIAMETER_TOO_BUSY response. No Request messages can be forwarded to (or rerouted to) this Connection until the Remote Busy Abatement Timeout expires. Diameter Connections only.",
"type": "boolean"
},
"altLocalIp": {
"description": "The IP address to be used as the alternate Local Node (/diameter/localnodes) address for this Connection. This address is only used for SCTP multi-homing, and must be different from the address chosen for the primary local IP address. Diameter Connections only.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"altPeerIp": {
"description": "The IP address to be used as the alternate Peer Node (/diameter/peernodes) address for this Connection. This address is only used for SCTP multi-homing, and must be different from the address chosen for the primary peer IP address. Diameter Connections only.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"sharedSecretCfgSetName": {
"description": "Name of the Shared Secret Configuration Set (/diameter/sharedsecretconfigurationsets) associated with this Connection. RADIUS Connections only.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"statusServerCfgSetName": {
"description": "Name of the Ingress Status-Server Configuration Set (/diameter/statusserverconfigurationsets) associated with this Connection. RADIUS Connections only.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"suppressConnAttempt": {
"description": "If true, connection attempts to the standby Peer Node (/diameter/peernodes) are suppressed once the Peer Node's Operational Status is Available. Diameter Connections only. ",
"type": "boolean"
},
"suppressConnUnavailableAlarm": {
"description": "If true, a connection unavailable alarm is not raised for this Connection whenever the Connection becomes Unavailable. Diameter Connections only. ",
"type": "boolean"
},
"testMode": {
"description": "If true, indicates the Connection is in test mode. Diameter Connections only.",
"type": "boolean"
},
"transportCongTimeout": {
"description": "Defines the time period (in seconds) spent by the Connection in abating each congestion level during abatement. Typical value is 5 seconds. Diameter Connections only.",
"maximum": 60,
"minimum": 3,
"type": "integer"
},
"transportFqdn": {
"description": "Fully Qualified Domain Name for this Connection. FQDN is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and a FQDN must be at most 255 characters long. Diameter Connections only.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
},
"transportProtocol": {
"description": "The transport protocol used by this Connection. The selected protocol must be supported by both the Local Node (/diameter/localnodes) and the Peer Node (/diameter/peernodes) assigned to this Connection. The transport protocols Tcp, Tls, Sctp, and Dtls may only be associated with Diameter Connections, while Udp may only be associated with RADIUS Connections. Required for all Connections. Note: The MP hosting this Connection should not have IPSEC enabled if this Connection is configured as Tls or Dtls, since enabling both IPSEC and TLS/TCP or DTLS/SCTP would have a significant, negative impact on Connection performance. This value is required for all Connections.",
"enum": [
"Sctp",
"Dtls",
"Tcp",
"Tls",
"Udp"
],
"type": "string"
},
"udpPort": {
"description": "For RADIUS Server Connections, this is the UDP port on which the DSR expects to receive incoming RADIUS requests for this Connection. For RADIUS Client Connections, this is the UDP port at the destination Peer Node (/diameter/peernodes), which receives the RADIUS request sent by the DSR. RADIUS Connections only.",
"maximum": 49151,
"minimum": 1024,
"type": "integer"
}
},
"required": [
"aaaProtocol",
"capacityCfgSetName",
"connCfgSetName",
"connectionMode",
"localNodeName",
"name",
"peerIdentification",
"peerNodeName",
"localIp",
"transportProtocol"
],
"type": "object"
}
Example
{
"aaaProtocol": "Radius",
"altLocalIp": "10.24.5.42",
"altPeerIp": "52.36.25.63",
"capCfgSetName": "capCfgSet1",
"cexCfgSetName": "cexCfgSet1",
"configurationLevel": "48",
"connCfgSetName": "connCfgSet1",
"connectionMode": "LocalMpResponder",
"isDynamic": false,
"localInitiatorPort": 6615,
"localIp": "10.24.2.8",
"localNodeName": "localNode1",
"msgConvCfgSetName": "msgConvCfgSet1",
"msgPriorityCfgSetName": "msgPriorityCfgSet1",
"msgPrioritySetting": "RequestMessage",
"name": "Connection1",
"peerIdentification": "Ip",
"peerIp": "52.36.41.9",
"peerNodeName": "peerNode1",
"remoteBusyTimeout": 30,
"remoteBusyUsage": true,
"statusServerCfgSetName": "statusServerCfgSet1",
"suppressConnAttempt": false,
"suppressConnUnavailableAlarm": true,
"testMode": false,
"transportFqdn": "transport.domain.com",
"transportProtocol": "Udp",
"udpPort": 42272
}
delete /diameter/connections/{name}
Deletes the specified Connection from the SOAM configuration. A Connection is only deleted if all delete validation checks pass. In general, if the Connection is part of the configuration of some other Managed Object, the Connection cannot be deleted. For example, if the Connection is named in a Connection Route Group (/diameter/routegroups), the Connection must first be removed from the Route Group. Then the Connection can be deleted from the configuration. An attempt to delete a Connection that cannot be deleted results in an error message returned within the HTTP response.
Any Connection that is administratively enabled cannot be deleted. The Connection must first be administratively disabled before deletion is allowed.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
/diameter/connections/{name}/connectionadminstate
get /diameter/connections/{name}/connectionadminstate
Retrieves the administrative state, which can be either Enabled or Disabled, for the specified Connection.
Target server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/connectionadminstateItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/connection/connectionadminstate.json",
"properties": {
"adminState": {
"description": "A Connection's administrative state can be either Enabled or Disabled. A Connection's configuration cannot be modified or deleted if its administrative state is Enabled.",
"enum": [
"Enabled",
"Disabled"
],
"example": "Enabled",
"type": "string"
}
},
"required": ["adminState"],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"adminState": "Enabled"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/connections/{name}/connectionadminstate
Updates the administrative state for the specified Diameter or RADIUS Connection to either Enable or Disabled.
A Connection's configuration cannot be modified or deleted if its administrative state is Enabled.
Target server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/connection/connectionadminstate.json",
"properties": {
"adminState": {
"description": "A Connection's administrative state can be either Enabled or Disabled. A Connection's configuration cannot be modified or deleted if its administrative state is Enabled.",
"enum": [
"Enabled",
"Disabled"
],
"example": "Enabled",
"type": "string"
}
},
"required": ["adminState"],
"type": "object"
}
Example
{
"adminState": "Enabled"
}
/diameter/connections/{name}/status
get /diameter/connections/{name}/status
Retrieves the operational status for the specified Connection.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/connectionstatusItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/connection/connectionstatus.json",
"properties": {
"averageEgressMps": {
"description": "The current average number of messages per second that are sent by the DSR to the Peer Node (/diameter/peernodes) configured for this Connection.",
"type": "integer"
},
"averageIngressMps": {
"description": "The current average number of messages per second that are received by the DSR from the Peer Node (/diameter/peernodes) configured for this Connection.",
"type": "integer"
},
"commonApplicationIds": {
"description": "The set of Diameter Application Ids (/diameter/applicationids) that the DSR and Peer Node (/diameter/peernodes) both support on this Connection. This set of common Application Ids is determined during Connection establishment.",
"items": {
"type": "integer"
},
"type": "array"
},
"connAdminState": {
"description": "The administrative state of this Connection. A Connection in the Disabled state cannot become established; it must first be placed into the Enabled state before attempting to initiate or listen for the configured Peer Node (/diameter/peernodes) to initiate.",
"enum": [
"Enabled",
"Disabled"
],
"type": "string"
},
"cplValue": {
"description": "The Connection Priority Level (CPL) value for this Connection. A value of zero means the Connection has no impairments. A value of 99 means the Connection is operationally unavailable or administratively disabled. A value between 0 and 99 indicates the Connection is experiencing degraded operation.",
"type": "integer"
},
"mpServerHostname": {
"description": "mpServerHostname indicates the name of the DA-MP server that is currently reporting the status of this Connection. For all three Fixed-type Connections (Initiator, Responder, Initiator & Responder) and IPFE Initiator Connections, mpServerHostname indicates the DA-MP that is configured to host the Connection. For Floating Connections that are established (IPFE Responder, IPFE Initiator & Responder Connections), mpServerHostname is the DA-MP on which the Connection became established. For Floating Connections that are not established, mpServerHostname is the DA-MP Leader, since it is the DA-MP Leader that reports status for un-established Floating Connections.",
"type": "string"
},
"name": {
"description": "The configured name of the Connection.",
"type": "string"
},
"operationalReason": {
"description": "Information elaborating on the current operationalStatus of the Connection.",
"type": "string"
},
"operationalStatus": {
"description": "The current operational state of the Connection. While this attribute can only have a value of Available, Degraded, or Unavailable, the operationalReason attribute typically contains additional information elaborating on the reported operationalStatus.",
"enum": [
"Available",
"Degraded",
"Unavailable"
],
"type": "string"
},
"pdusToDiagnose": {
"description": "The number of messages remaining to be received on this Connection that the DSR will treat as test messages for diagnostics purposes.",
"type": "integer"
},
"primaryRemoteIpAddress": {
"description": "The primary IP address of the Peer Node (/diameter/peernodes) configured for this Connection. Every established Connection has a primaryRemoteIpAddress value.",
"pattern": "^(((1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}(1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:])+$",
"type": "string"
},
"remotePort": {
"description": "The port number the Peer Node (/diameter/peernodes) is using to receive messages on this Connection.",
"type": "integer"
},
"secondaryRemoteIpAddress": {
"description": "The secondary IP address of the Peer Node (/diameter/peernodes) configured for this Connection. Only SCTP multi-homed Connections have a secondaryRemoteIpAddress value.",
"pattern": "^(((1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}(1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:])+$",
"type": "string"
},
"statusKnown": {
"description": "When set to false, current values for the run-time status attributes for this Connection are not known by the OAM. This could be due to merge issues within the DSR, or some other cause preventing the OAM from having a current view of the status of this Connection. If the OAM has current status for this Connection, statusKnown is set to true.",
"type": "boolean"
},
"timeOfLastUpdate": {
"description": "The date/time the status for this Connection was last updated by the DSR.",
"pattern": "^[0-9]{4}[-][a-zA-Z]{3}[-][0-9]{2} [0-9]{2}[:][0-9]{2}[:][0-9]{2} .*$",
"type": "string"
}
},
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"averageEgressMps": 4590,
"averageIngressMps": 4595,
"commonApplicationIds": [
4,
16777224,
4294967295
],
"connAdminState": "Enabled",
"cplValue": 0,
"mpServerHostname": "MP1",
"name": "Conn1",
"operationalReason": "Normal",
"operationalStatus": "Available",
"pdusToDiagnose": 1,
"primaryRemoteIpAddress": "48.23.10.1",
"remotePort": 35081,
"statusKnown": true,
"timeOfLastUpdate": "2016-Aug-25 11:05:05 EDT"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
Diameter: DNS Options
The DNS Options resource includes information the DSR needs if it must resolve one or more Peer Node (/diameter/peernodes) FQDNs to IP addresses. Peer Node configuration does not mandate that an IP address be specified. If no IP address is specified, then any attempt by the DSR to establish an Initiator or Initiator+Responder Connection (/diameter/connections) to that Peer Node requires a DNS lookup to resolve the FQDN to the correct IP address. The DNS server(s) the DSR uses for such lookups are located at the IP address(es) given in the DNS Options.
If: 1) every Peer Node configured at the DSR includes one or more IP addresses, and/or 2) only Responder-only Connections are configured at the DSR, then the DNS Options are not required, because the DSR does not have to issue DNS queries to retrieve Peer Node IP addresses.
/diameter/dnsoptions
get /diameter/dnsoptions
Returns the set of current values for the DNS Options.
Target Server: SOAM
Response
HTTP status code 200
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/dnsoptionItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/dnsoption/dnsoption.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"primaryIp": {
"description": "The IP address of the primary DNS server the DSR uses when it needs to resolve Peer Node (/diameter/peernodes) FQDNs.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"queryDuration": {
"description": "If no response is received from the primary DNS server, the DSR waits queryDuration seconds before sending the same DNS query to the secondary DNS server. If no response is received from the secondary DNS server, the DNS query fails - DSR makes no attempt to re-try either DNS server.",
"maximum": 4,
"minimum": 1,
"type": "integer"
},
"secondaryIp": {
"description": "The IP address of the secondary DNS server the DSR uses when it needs to resolve Peer Node (/diameter/peernodes) FQDNs. The secondary DNS server is only queried if the query to the primary DNS server times out.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
}
},
"required": ["queryDuration"],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"configurationLevel": "51",
"primaryIp": "1.2.3.4",
"queryDuration": 3,
"secondaryIp": "2.3.4.5"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
put /diameter/dnsoptions
Updates the DNS Options with the values supplied. To update just one of the individual options, GET the set, modify the value for the option that needs to be changed, then PUT the options.
Target Server: SOAM
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/dnsoption/dnsoption.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"primaryIp": {
"description": "The IP address of the primary DNS server the DSR uses when it needs to resolve Peer Node (/diameter/peernodes) FQDNs.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"queryDuration": {
"description": "If no response is received from the primary DNS server, the DSR waits queryDuration seconds before sending the same DNS query to the secondary DNS server. If no response is received from the secondary DNS server, the DNS query fails - DSR makes no attempt to re-try either DNS server.",
"maximum": 4,
"minimum": 1,
"type": "integer"
},
"secondaryIp": {
"description": "The IP address of the secondary DNS server the DSR uses when it needs to resolve Peer Node (/diameter/peernodes) FQDNs. The secondary DNS server is only queried if the query to the primary DNS server times out.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
}
},
"required": ["queryDuration"],
"type": "object"
}
Example
{
"configurationLevel": "51",
"primaryIp": "1.2.3.4",
"queryDuration": 3,
"secondaryIp": "2.3.4.5"
}
Diameter: Egress Message Throttling Configuration Sets
Egress Message Throttling Configuration Sets provide a mechanism for managing egress message traffic on Diameter Connections (/diameter/connections). An Egress Message Throttling Configuration Set is configured with a maximum allowable Egress Message Rate (EMR) and one to three pairs of throttling and abatement thresholds. Any Connection to which the configuration set is applied is then subject to egress message throttling, based on the parameters specified in the configuration set.
When the EMR on a Connection exceeds a throttling threshold value, the EMR congestion level for the Connection is increased. When the EMR on a Connection falls below an abatement threshold for the abatement time, the EMR congestion level is decreased. DSR throttles the addition of new request messages on a Connection that is experiencing congestion.
All configuration of Egress Messege Throttling Configuration Sets is done at the SOAM.
/diameter/egressmessagethrottlingconfigurationsets
get /diameter/egressmessagethrottlingconfigurationsets
Returns all Egress Message Throttling Configuration Sets configured at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those Egress Message Throttling Configuration Sets meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section).
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/egressmessagethrottlingconfigurationsetCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/egressmessagethrottlingconfigurationset/egressmessagethrottlingconfigurationset.json",
"properties": {
"abatementTime": {
"description": "The time, in milliseconds, a throttled Connection's (/diameter/connections) calculated Egress Message Rate (EMR) must remain below an abatement level before the Connection's congestion level is reduced. Typical value is 500 msec.",
"maximum": 10000,
"minimum": 200,
"type": "integer"
},
"abatementThresh1": {
"description": "A percentage of maxEgressMessageRate. When a Connection's (/diameter/connections) Egress Message Rate falls below abatementThresh1 for abatementTime milliseconds, the Connection's congestion level is lowered to 0. Typical value is 80.",
"maximum": 99,
"minimum": 1,
"type": "integer"
},
"abatementThresh2": {
"description": "A percentage of maxEgressMessageRate. When a Connection's (/diameter/connections) Egress Message Rate falls below abatementThresh2 for abatementTime milliseconds, the Connection's congestion level is lowered to 1.",
"maximum": 99,
"minimum": 3,
"type": "integer"
},
"abatementThresh3": {
"description": "A percentage of maxEgressMessageRate. When a Connection's (/diameter/connections) Egress Message Rate falls below abatementThresh3 for abatementTime milliseconds, the Connection's congestion level is lowered to 2.",
"maximum": 99,
"minimum": 5,
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"convergenceTime": {
"description": "The DSR uses an algorithm to determine how many request messages are being forwarded on a Connection (/diameter/connections) per unit time - the Egress Message Rate, or EMR. The time interval the DSR algorithm uses when calculating this rate - effectively a sample period - is specified by the convergenceTime value, which is in milliseconds. If convergenceTime is less than 1000 msec - meaning the sample period is less than one full second - the DSR extrapolates the per-second rate based on the observed egress request messages during the sample period. If convergenceTime is 1000 msec, then the rate is just the observed egress request messages during that 1000 msec interval. If convergenceTime is greater than 1000 msec, the rate is the average of the one-second intervals within the convergenceTime duration. Typical value is 1000.",
"enum": [250, 500, 1000, 2000, 4000],
"type": "integer"
},
"maxEgressMessageRate": {
"description": "The maximum allowed Egress Message Rate (EMR) on a Connection (/diameter/connections) that can be throttled.",
"maximum": 10000,
"minimum": 10,
"type": "integer"
},
"name": {
"description": "Name for this Egress Message Throttling Configuration Set, which must be unique within the DSR site. A name is required, and cannot be changed after the configuration set is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"throttleThresh1": {
"description": "A percentage of maxEgressMessageRate. When a Connection's (/diameter/connections) Egress Message Rate increases above throttleThresh1, the Connection's congestion level is raised to 1. Typical value is 100, which means that when the Connection's EMR exceeds maxEgressMessageRate, the Connection enters CL1 and the DSR sends no new requests on the Connection until abatement is achieved.",
"maximum": 100,
"minimum": 2,
"type": "integer"
},
"throttleThresh2": {
"description": "A percentage of maxEgressMessageRate. When a Connection's (/diameter/connections) Egress Message Rat e increases above throttleThresh2, the Connection's congestion level is raised to 2.",
"maximum": 100,
"minimum": 4,
"type": "integer"
},
"throttleThresh3": {
"description": "A percentage of maxEgressMessageRate. When a Connection's (/diameter/connections) Egress Message Rat e increases above throttleThresh3, the Connection's congestion level is raised to 3.",
"maximum": 100,
"minimum": 6,
"type": "integer"
}
},
"required": [
"abatementThresh1",
"abatementTime",
"convergenceTime",
"maxEgressMessageRate",
"name",
"throttleThresh1"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"abatementTime": 500,
"abatementThresh1": 80,
"abatementThresh2": 90,
"abatementThresh3": 95,
"configurationLevel": "27560",
"convergenceTime": 250,
"maxEgressMessageRate": 5000,
"name": "EMTCfgSet1",
"throttleThresh1": 85,
"throttleThresh2": 92,
"throttleThresh3": 98
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/egressmessagethrottlingconfigurationsets
Adds a new Egress Message Throttling Configuration Set to the DSR configuration. The new Egress Message Throttling Configuration Set must have a name that is unique across all Egress Message Throttling Configuration Sets at the SOAM.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/egressmessagethrottlingconfigurationset/egressmessagethrottlingconfigurationset.json",
"properties": {
"abatementTime": {
"description": "The time, in milliseconds, a throttled Connection's (/diameter/connections) calculated Egress Message Rate (EMR) must remain below an abatement level before the Connection's congestion level is reduced. Typical value is 500 msec.",
"maximum": 10000,
"minimum": 200,
"type": "integer"
},
"abatementThresh1": {
"description": "A percentage of maxEgressMessageRate. When a Connection's (/diameter/connections) Egress Message Rate falls below abatementThresh1 for abatementTime milliseconds, the Connection's congestion level is lowered to 0. Typical value is 80.",
"maximum": 99,
"minimum": 1,
"type": "integer"
},
"abatementThresh2": {
"description": "A percentage of maxEgressMessageRate. When a Connection's (/diameter/connections) Egress Message Rate falls below abatementThresh2 for abatementTime milliseconds, the Connection's congestion level is lowered to 1.",
"maximum": 99,
"minimum": 3,
"type": "integer"
},
"abatementThresh3": {
"description": "A percentage of maxEgressMessageRate. When a Connection's (/diameter/connections) Egress Message Rate falls below abatementThresh3 for abatementTime milliseconds, the Connection's congestion level is lowered to 2.",
"maximum": 99,
"minimum": 5,
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"convergenceTime": {
"description": "The DSR uses an algorithm to determine how many request messages are being forwarded on a Connection (/diameter/connections) per unit time - the Egress Message Rate, or EMR. The time interval the DSR algorithm uses when calculating this rate - effectively a sample period - is specified by the convergenceTime value, which is in milliseconds. If convergenceTime is less than 1000 msec - meaning the sample period is less than one full second - the DSR extrapolates the per-second rate based on the observed egress request messages during the sample period. If convergenceTime is 1000 msec, then the rate is just the observed egress request messages during that 1000 msec interval. If convergenceTime is greater than 1000 msec, the rate is the average of the one-second intervals within the convergenceTime duration. Typical value is 1000.",
"enum": [250, 500, 1000, 2000, 4000],
"type": "integer"
},
"maxEgressMessageRate": {
"description": "The maximum allowed Egress Message Rate (EMR) on a Connection (/diameter/connections) that can be throttled.",
"maximum": 10000,
"minimum": 10,
"type": "integer"
},
"name": {
"description": "Name for this Egress Message Throttling Configuration Set, which must be unique within the DSR site. A name is required, and cannot be changed after the configuration set is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"throttleThresh1": {
"description": "A percentage of maxEgressMessageRate. When a Connection's (/diameter/connections) Egress Message Rate increases above throttleThresh1, the Connection's congestion level is raised to 1. Typical value is 100, which means that when the Connection's EMR exceeds maxEgressMessageRate, the Connection enters CL1 and the DSR sends no new requests on the Connection until abatement is achieved.",
"maximum": 100,
"minimum": 2,
"type": "integer"
},
"throttleThresh2": {
"description": "A percentage of maxEgressMessageRate. When a Connection's (/diameter/connections) Egress Message Rat e increases above throttleThresh2, the Connection's congestion level is raised to 2.",
"maximum": 100,
"minimum": 4,
"type": "integer"
},
"throttleThresh3": {
"description": "A percentage of maxEgressMessageRate. When a Connection's (/diameter/connections) Egress Message Rat e increases above throttleThresh3, the Connection's congestion level is raised to 3.",
"maximum": 100,
"minimum": 6,
"type": "integer"
}
},
"required": [
"abatementThresh1",
"abatementTime",
"convergenceTime",
"maxEgressMessageRate",
"name",
"throttleThresh1"
],
"type": "object"
}
Example
{
"abatementTime": 500,
"abatementThresh1": 80,
"abatementThresh2": 90,
"abatementThresh3": 95,
"configurationLevel": "27560",
"convergenceTime": 250,
"maxEgressMessageRate": 5000,
"name": "EMTCfgSet1",
"throttleThresh1": 85,
"throttleThresh2": 92,
"throttleThresh3": 98
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/egressmessagethrottlingconfigurationsets/{name}
get /diameter/egressmessagethrottlingconfigurationsets/{name}
Returns the configuration details for the specified Egress Message Throttling Configuration Set. If the Egress Message Throttling Configuration Set does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/egressmessagethrottlingconfigurationsetItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/egressmessagethrottlingconfigurationset/egressmessagethrottlingconfigurationset.json",
"properties": {
"abatementTime": {
"description": "The time, in milliseconds, a throttled Connection's (/diameter/connections) calculated Egress Message Rate (EMR) must remain below an abatement level before the Connection's congestion level is reduced. Typical value is 500 msec.",
"maximum": 10000,
"minimum": 200,
"type": "integer"
},
"abatementThresh1": {
"description": "A percentage of maxEgressMessageRate. When a Connection's (/diameter/connections) Egress Message Rate falls below abatementThresh1 for abatementTime milliseconds, the Connection's congestion level is lowered to 0. Typical value is 80.",
"maximum": 99,
"minimum": 1,
"type": "integer"
},
"abatementThresh2": {
"description": "A percentage of maxEgressMessageRate. When a Connection's (/diameter/connections) Egress Message Rate falls below abatementThresh2 for abatementTime milliseconds, the Connection's congestion level is lowered to 1.",
"maximum": 99,
"minimum": 3,
"type": "integer"
},
"abatementThresh3": {
"description": "A percentage of maxEgressMessageRate. When a Connection's (/diameter/connections) Egress Message Rate falls below abatementThresh3 for abatementTime milliseconds, the Connection's congestion level is lowered to 2.",
"maximum": 99,
"minimum": 5,
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"convergenceTime": {
"description": "The DSR uses an algorithm to determine how many request messages are being forwarded on a Connection (/diameter/connections) per unit time - the Egress Message Rate, or EMR. The time interval the DSR algorithm uses when calculating this rate - effectively a sample period - is specified by the convergenceTime value, which is in milliseconds. If convergenceTime is less than 1000 msec - meaning the sample period is less than one full second - the DSR extrapolates the per-second rate based on the observed egress request messages during the sample period. If convergenceTime is 1000 msec, then the rate is just the observed egress request messages during that 1000 msec interval. If convergenceTime is greater than 1000 msec, the rate is the average of the one-second intervals within the convergenceTime duration. Typical value is 1000.",
"enum": [250, 500, 1000, 2000, 4000],
"type": "integer"
},
"maxEgressMessageRate": {
"description": "The maximum allowed Egress Message Rate (EMR) on a Connection (/diameter/connections) that can be throttled.",
"maximum": 10000,
"minimum": 10,
"type": "integer"
},
"name": {
"description": "Name for this Egress Message Throttling Configuration Set, which must be unique within the DSR site. A name is required, and cannot be changed after the configuration set is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"throttleThresh1": {
"description": "A percentage of maxEgressMessageRate. When a Connection's (/diameter/connections) Egress Message Rate increases above throttleThresh1, the Connection's congestion level is raised to 1. Typical value is 100, which means that when the Connection's EMR exceeds maxEgressMessageRate, the Connection enters CL1 and the DSR sends no new requests on the Connection until abatement is achieved.",
"maximum": 100,
"minimum": 2,
"type": "integer"
},
"throttleThresh2": {
"description": "A percentage of maxEgressMessageRate. When a Connection's (/diameter/connections) Egress Message Rat e increases above throttleThresh2, the Connection's congestion level is raised to 2.",
"maximum": 100,
"minimum": 4,
"type": "integer"
},
"throttleThresh3": {
"description": "A percentage of maxEgressMessageRate. When a Connection's (/diameter/connections) Egress Message Rat e increases above throttleThresh3, the Connection's congestion level is raised to 3.",
"maximum": 100,
"minimum": 6,
"type": "integer"
}
},
"required": [
"abatementThresh1",
"abatementTime",
"convergenceTime",
"maxEgressMessageRate",
"name",
"throttleThresh1"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"abatementTime": 500,
"abatementThresh1": 80,
"abatementThresh2": 90,
"abatementThresh3": 95,
"configurationLevel": "27560",
"convergenceTime": 250,
"maxEgressMessageRate": 5000,
"name": "EMTCfgSet1",
"throttleThresh1": 85,
"throttleThresh2": 92,
"throttleThresh3": 98
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/egressmessagethrottlingconfigurationsets/{name}
Updates the configuration of the specified Egress Message Throttling Configuration Set.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/egressmessagethrottlingconfigurationset/egressmessagethrottlingconfigurationset.json",
"properties": {
"abatementTime": {
"description": "The time, in milliseconds, a throttled Connection's (/diameter/connections) calculated Egress Message Rate (EMR) must remain below an abatement level before the Connection's congestion level is reduced. Typical value is 500 msec.",
"maximum": 10000,
"minimum": 200,
"type": "integer"
},
"abatementThresh1": {
"description": "A percentage of maxEgressMessageRate. When a Connection's (/diameter/connections) Egress Message Rate falls below abatementThresh1 for abatementTime milliseconds, the Connection's congestion level is lowered to 0. Typical value is 80.",
"maximum": 99,
"minimum": 1,
"type": "integer"
},
"abatementThresh2": {
"description": "A percentage of maxEgressMessageRate. When a Connection's (/diameter/connections) Egress Message Rate falls below abatementThresh2 for abatementTime milliseconds, the Connection's congestion level is lowered to 1.",
"maximum": 99,
"minimum": 3,
"type": "integer"
},
"abatementThresh3": {
"description": "A percentage of maxEgressMessageRate. When a Connection's (/diameter/connections) Egress Message Rate falls below abatementThresh3 for abatementTime milliseconds, the Connection's congestion level is lowered to 2.",
"maximum": 99,
"minimum": 5,
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"convergenceTime": {
"description": "The DSR uses an algorithm to determine how many request messages are being forwarded on a Connection (/diameter/connections) per unit time - the Egress Message Rate, or EMR. The time interval the DSR algorithm uses when calculating this rate - effectively a sample period - is specified by the convergenceTime value, which is in milliseconds. If convergenceTime is less than 1000 msec - meaning the sample period is less than one full second - the DSR extrapolates the per-second rate based on the observed egress request messages during the sample period. If convergenceTime is 1000 msec, then the rate is just the observed egress request messages during that 1000 msec interval. If convergenceTime is greater than 1000 msec, the rate is the average of the one-second intervals within the convergenceTime duration. Typical value is 1000.",
"enum": [250, 500, 1000, 2000, 4000],
"type": "integer"
},
"maxEgressMessageRate": {
"description": "The maximum allowed Egress Message Rate (EMR) on a Connection (/diameter/connections) that can be throttled.",
"maximum": 10000,
"minimum": 10,
"type": "integer"
},
"name": {
"description": "Name for this Egress Message Throttling Configuration Set, which must be unique within the DSR site. A name is required, and cannot be changed after the configuration set is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"throttleThresh1": {
"description": "A percentage of maxEgressMessageRate. When a Connection's (/diameter/connections) Egress Message Rate increases above throttleThresh1, the Connection's congestion level is raised to 1. Typical value is 100, which means that when the Connection's EMR exceeds maxEgressMessageRate, the Connection enters CL1 and the DSR sends no new requests on the Connection until abatement is achieved.",
"maximum": 100,
"minimum": 2,
"type": "integer"
},
"throttleThresh2": {
"description": "A percentage of maxEgressMessageRate. When a Connection's (/diameter/connections) Egress Message Rat e increases above throttleThresh2, the Connection's congestion level is raised to 2.",
"maximum": 100,
"minimum": 4,
"type": "integer"
},
"throttleThresh3": {
"description": "A percentage of maxEgressMessageRate. When a Connection's (/diameter/connections) Egress Message Rat e increases above throttleThresh3, the Connection's congestion level is raised to 3.",
"maximum": 100,
"minimum": 6,
"type": "integer"
}
},
"required": [
"abatementThresh1",
"abatementTime",
"convergenceTime",
"maxEgressMessageRate",
"name",
"throttleThresh1"
],
"type": "object"
}
Example
{
"abatementTime": 500,
"abatementThresh1": 80,
"abatementThresh2": 90,
"abatementThresh3": 95,
"configurationLevel": "27560",
"convergenceTime": 250,
"maxEgressMessageRate": 5000,
"name": "EMTCfgSet1",
"throttleThresh1": 85,
"throttleThresh2": 92,
"throttleThresh3": 98
}
delete /diameter/egressmessagethrottlingconfigurationsets/{name}
Deletes the specified Egress Message Throttling Configuration Set from the SOAM configuration. An Egress Message Throttling Configuration Set can only be deleted if all delete validation checks pass. In general, if the Egress Message Throttling Configuration Set is part of the configuration of one or more Connections (/diameter/connections), the Egress Message Throttling Configuration Set cannot be deleted. If the Egress Message Throttling Configuration Set is named in a Connection, the Egress Message Throttling Configuration Set must first be removed from the Connection. Then the Egress Message Throttling Configuration Set can be deleted from the configuration. An attempt to delete a Egress Message Throttling Configuration Set that cannot be deleted results in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Diameter: Egress Throttle Groups
An Egress Throttle Group (ETG) is a collection of 1 to 128 Diameter Connections (/diameter/connections), or Peer Nodes (/diameter/peernodes), or both that are logically grouped to monitor egress message rate and egress pending transactions. ETG rate limiting and pending transaction limiting throttling are done for request messages only. An ETG is independent of a Route Group (/diameter/routegroups). As the ETG's congestion level increases, message priority determines if a message can be routed to a member of the ETG, or becomes throttled.
Each ETG has its own congestion level state based on its configuration. A maximum of four congestions levels (CL0 to CL3) is supported. CL0 indicates the resource has no congestion, while CL3 is the highest level of congestion. Diameter request messages are assigned a priority of 0, 1, 2, or 4. When an ETG is at congestion level N, only request messages having priority at or above N are sent by the DSR.
An ETG can be standalone or it can be associated with an Egress Throttle List (/diameter/egressthrottlelists) that spans mated DSR sites. An ETG can be associated with only one Egress Throttle List.
All configuration of Egress Throttle Groups is done at the SOAM.
/diameter/egressthrottlegroups
get /diameter/egressthrottlegroups
Returns all Egress Throttle Groups configured at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those Egress Throttle Groups meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section).
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/egressthrottlegroupCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/egressthrottlegroup/egressthrottlegroup.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"connectionName": {
"description": "The Connection (/diameter/connections) names associated with the Egress Throttle Group. Because there can be a total of 128 Connections and Peer Nodes (/diameter/peernodes) associated with an ETG, there can be up to 128 individual Connections in the connectionName list. Any Connection to a Peer Node listed in peerNodeName is implicitly included in the ETG and should not need be included in the connectionName list.",
"items": {
"description": "Name of an individual Connection (/diameter/connections) that is part of this ETG.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"maxItems": 128,
"minItems": 0,
"type": "array"
},
"etgControlScope": {
"description": "The DSR uses etgControlScope when deciding to use ETG data or aggregated data from the parent Egress Throttle List (/diameter/egressthrottlelists) in throttling decisions.",
"enum": [
"Etg",
"Etl"
],
"type": "string"
},
"name": {
"description": "Name for the Egress Throttle Group, which must be unique within the DSR site. A name is required and cannot be changed after the Egress Throttle Group is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerNodeName": {
"description": "The Peer Node (/diameter/peernodes) names associated with the Egress Throttle Group. Because there can be a total of 128 Connections (/diameter/connections) and Peer Nodes associated with an ETG, there can be up to 128 individual Peer Nodes in the peerNodeName list. Any Connection to a Peer Node listed in peerNodeName is implicitly included in the ETG and should not need be included in the connectionName list.",
"items": {
"description": "Name of an individual Peer Node (/diameter/peernodes) that is part of this ETG.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"maxItems": 128,
"minItems": 0,
"type": "array"
},
"pendingTransLimitingCfgSetName": {
"description": "Name of the Pending Transaction Limiting Configuration Set (/diameter/pendingtransactionlimitingconfigurationsets) associated with this TTG.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"rateLimitingCfgSetName": {
"description": "Name of the Rate Limiting Configuration Set (/diameter/ratelimitingconfigurationsets) associated with this TTG.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"etgControlScope",
"name",
"pendingTransLimitingCfgSetName",
"rateLimitingCfgSetName"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"configurationLevel": "2",
"connectionName": [
"AF01",
"AF02"
],
"etgControlScope": "Etg",
"name": "EgressThrottlingGroup1",
"peerNodeName": [
"AF04",
"AF05"
],
"pendingTransLimitingCfgSetName": "Default",
"rateLimitingCfgSetName": "Default"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/egressthrottlegroups
Adds a new Egress Throttle Group to the DSR configuration. The new ETG must have a name that is unique across all ETGs at the SOAM's configuration.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/egressthrottlegroup/egressthrottlegroup.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"connectionName": {
"description": "The Connection (/diameter/connections) names associated with the Egress Throttle Group. Because there can be a total of 128 Connections and Peer Nodes (/diameter/peernodes) associated with an ETG, there can be up to 128 individual Connections in the connectionName list. Any Connection to a Peer Node listed in peerNodeName is implicitly included in the ETG and should not need be included in the connectionName list.",
"items": {
"description": "Name of an individual Connection (/diameter/connections) that is part of this ETG.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"maxItems": 128,
"minItems": 0,
"type": "array"
},
"etgControlScope": {
"description": "The DSR uses etgControlScope when deciding to use ETG data or aggregated data from the parent Egress Throttle List (/diameter/egressthrottlelists) in throttling decisions.",
"enum": [
"Etg",
"Etl"
],
"type": "string"
},
"name": {
"description": "Name for the Egress Throttle Group, which must be unique within the DSR site. A name is required and cannot be changed after the Egress Throttle Group is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerNodeName": {
"description": "The Peer Node (/diameter/peernodes) names associated with the Egress Throttle Group. Because there can be a total of 128 Connections (/diameter/connections) and Peer Nodes associated with an ETG, there can be up to 128 individual Peer Nodes in the peerNodeName list. Any Connection to a Peer Node listed in peerNodeName is implicitly included in the ETG and should not need be included in the connectionName list.",
"items": {
"description": "Name of an individual Peer Node (/diameter/peernodes) that is part of this ETG.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"maxItems": 128,
"minItems": 0,
"type": "array"
},
"pendingTransLimitingCfgSetName": {
"description": "Name of the Pending Transaction Limiting Configuration Set (/diameter/pendingtransactionlimitingconfigurationsets) associated with this TTG.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"rateLimitingCfgSetName": {
"description": "Name of the Rate Limiting Configuration Set (/diameter/ratelimitingconfigurationsets) associated with this TTG.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"etgControlScope",
"name",
"pendingTransLimitingCfgSetName",
"rateLimitingCfgSetName"
],
"type": "object"
}
Example
{
"configurationLevel": "2",
"connectionName": [
"AF01",
"AF02"
],
"etgControlScope": "Etg",
"name": "EgressThrottlingGroup1",
"peerNodeName": [
"AF04",
"AF05"
],
"pendingTransLimitingCfgSetName": "Default",
"rateLimitingCfgSetName": "Default"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/egressthrottlegroups/status
get /diameter/egressthrottlegroups/status
Returns the status of all Egress Throttle Groups that meet the criteria specified in the request. This API supports filtering on any single attribute returned in the JSON data. Non-enumerated string attributes can be filtered using EQUAL, NOT_EQUAL, LIKE, or IN. Enumerated strings and integers can be filtered using EQUAL, NOT_EQUAL, or IN. LIKE is not supported for these data types.
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (string)
The attribute name on which filtering occurs. Non-enumerated string attributes can be filtered using EQUAL, NOT_EQUAL, LIKE or IN. Enumerated strings and integers can be filtered using EQUAL, NOT_EQUAL, and IN - LIKE is not supported for these data types.
Example:
filter_name=numberPendingEtgTransactions
- filter_op: (one of EQUAL, NOT_EQUAL, LIKE)
The filter operator.
Example:
filter_op=EQUAL
- filter_values: (string)
The value being filtered on.
Example:
filter_values=99
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/egressthrottlegroupstatusCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/egressthrottlegroup/egressthrottlegroupstatus.json",
"properties": {
"averagePendTransHoldTime": {
"description": "The average transaction hold time for recently completed egress transactions associated with the ETG/ETL.",
"type": "integer"
},
"egressRequestRate": {
"description": "The egress request rate (in messages/second) to the Peer Nodes (/diameter/peernodes) and Connections (/diameter/connections) that are members of the Egress Throttle Group. If etgControlScope value (/diameter/egressthrottlegroups) is set to Etg, then this attribute value is equal to etgEgressRequestRate attribute value, else if etgControlScope value (/diameter/egressthrottlegroups) is set to Etl, then this attribute value is equal to etlEgressRequestRate attribute value.",
"type": "integer"
},
"etgEgressRequestRate": {
"description": "The egress request rate (in messages/second) to the Peer Nodes (/diameter/peernodes) and Connections (/diameter/connections) that are members of the Egress Throttle Group.",
"type": "integer"
},
"etlEgressRequestRate": {
"description": "The egress request rate (in messages/second) to the Peer Nodes (/diameter/peernodes) and Connections (/diameter/connections) that are members of an Egress Throttle List's (/diameter/egressthrottlelists) component Egress Throttle Groups.",
"type": "integer"
},
"name": {
"description": "The configured name of the Egress Throttle Group.",
"type": "string"
},
"numberActiveSmsConnections": {
"description": "The current number of active SMS connections between signaling routers with Egress Throttle Groups in an Egress Throttle List (/diameter/egressthrottlelists).",
"maximum": 2,
"minimum": 0,
"type": "integer"
},
"numberPendingEtgTransactions": {
"description": "The number of pending transactions for both Peer Nodes (/diameter/peernodes) and Connections (/diameter/connections) configured for this ETG.",
"type": "integer"
},
"numberPendingEtlTransactions": {
"description": "The number of pending transactions for both Peer Nodes (/diameter/peernodes) and Connections (/diameter/connections) configured to each Egress Throttle Group configured for an Egress Throttle List (/diameter/egressthrottlelists).",
"type": "integer"
},
"numberOfPendingTransactions": {
"description": "The number of pending transactions for both Peer Nodes (/diameter/peernodes) and Connections (/diameter/connections) configured for this ETG or to each Egress Throttle Group configured for an Egress Throttle List. If etgControlScope value (/diameter/egressthrottlegroups) is set to Etg, then this attribute value is equal to numberPendingEtgTransactions attribute value, else if etgControlScope value (/diameter/egressthrottlegroups) is set to Etl, then this attribute value is equal to numberPendingEtlTransactions attribute value.",
"type": "integer"
},
"offeredTrafficRate": {
"description": "The rate of transactions which are being routed to the ETG/ETL before diversion is applied.",
"type": "integer"
},
"pendingTransactionLimitingAdminState": {
"description": "The pending transaction limiting administrative state for this Egress Throttle Group. When pendingTransactionLimitingAdminState is set to Disabled, the DSR does not throttle requests based on the current number of pending transactions. pendingTransactionLimitingAdminState must first be set to Enabled before any throttling is performed.",
"enum": [
"Enabled",
"Disabled"
],
"type": "string"
},
"pendingTransactionLimitingOperationalReason": {
"description": "Information elaborating on the current pendingTransactionLimitingOperationalStatus of this Egress Throttle Group.",
"type": "string"
},
"pendingTransactionLimitingOperationalStatus": {
"description": "The pending transaction limiting operational status for this Egress Throttle Group. The pendingTransactionLimitingOperationalReason value contains additional information elaborating on the reported pendingTransactionLimitingOperationalStatus.",
"enum": [
"Available",
"Degraded",
"Inactive",
"Unknown"
],
"type": "string"
},
"percentTransDiverted": {
"description": "The percentage of transactions which are being routed to the ETG/ETL which are being diverted.",
"type": "integer",
"maximum": 100,
"minimum": 0
},
"rateLimitingAdminState": {
"description": "The rate limiting administrative state for this Egress Throttle Group. When rateLimitingAdminState is set to Disabled, the DSR does not throttle traffic based on request rate. rateLimitingAdminState must first be set to Enabled before limiting the rate.",
"enum": [
"Enabled",
"Disabled"
],
"type": "string"
},
"rateLimitingOperationalReason": {
"description": "Information elaborating on the current rateLimitingOperationalStatus of this Egress Throttle Group.",
"type": "string"
},
"rateLimitingOperationalStatus": {
"description": "The current rate limiting operational state of this Egress Throttle Group. The rateLimitingOperationalReason value contains additional information elaborating on the reported rateLimitingOperationalStatus.",
"enum": [
"Available",
"Degraded",
"Unavailable"
],
"type": "string"
},
"statusKnown": {
"description": "When set to false, current values for the run-time status attributes for this ETG are not known by the OAM. This could be due to merge issues within the DSR, or some other cause preventing the OAM from having a current view of the status of this ETG. If the OAM has current status for this ETG, statusKnown is set to true.",
"type": "boolean"
},
"targetEtr": {
"description": "If both rate limiting and pending transaction limiting are enabled for this ETG/ETL, the targetEtr is a computed value that is equal to the lesser of the rate limiting Egress Throttle Rate (ETR) and the pending transaction limiting ETR. If only rate limiting or pending transaction limiting is enabled for this ETG/ETL, then the targetEtr is the target ETR for the type of functionality that is enabled.",
"type": "integer"
},
"timeOfLastUpdate": {
"description": "The date/time the status for this Egress Throttle Group (/diameter/egressthrottlegroups) was last updated by the DSR.",
"pattern": "^[0-9]{4}[-][0-1]{1}[0-9]{1}[-][0-3]{1}[0-9]{1}T[0-2]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}([.][0-9]{1,7})?[+-](?:2[0-3]|[0-1][0-9])[:][0-5][0-9]?$",
"type": "string"
}
},
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"etgEgressRequestRate": 4,
"etlEgressRequestRate": 23,
"name": "egressthrottlegroupstatus1",
"numberActiveSmsConnections": 2,
"numberPendingEtgTransactions": 34,
"numberPendingEtlTransactions": 2,
"pendingTransactionLimitingAdminState": "Enabled",
"pendingTransactionLimitingOperationalReason": "Normal",
"pendingTransactionLimitingOperationalStatus": "Available",
"rateLimitingAdminState": "Enabled",
"rateLimitingOperationalReason": "Normal",
"rateLimitingOperationalStatus": "Available",
"statusKnown": true,
"timeOfLastUpdate": "2016-Aug-25 11:05:05 EDT"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
/diameter/egressthrottlegroups/{name}
get /diameter/egressthrottlegroups/{name}
Returns the configuration details for the specified Egress Throttle Group. If the specified ETG does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/egressthrottlegroupItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/egressthrottlegroup/egressthrottlegroup.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"connectionName": {
"description": "The Connection (/diameter/connections) names associated with the Egress Throttle Group. Because there can be a total of 128 Connections and Peer Nodes (/diameter/peernodes) associated with an ETG, there can be up to 128 individual Connections in the connectionName list. Any Connection to a Peer Node listed in peerNodeName is implicitly included in the ETG and should not need be included in the connectionName list.",
"items": {
"description": "Name of an individual Connection (/diameter/connections) that is part of this ETG.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"maxItems": 128,
"minItems": 0,
"type": "array"
},
"etgControlScope": {
"description": "The DSR uses etgControlScope when deciding to use ETG data or aggregated data from the parent Egress Throttle List (/diameter/egressthrottlelists) in throttling decisions.",
"enum": [
"Etg",
"Etl"
],
"type": "string"
},
"name": {
"description": "Name for the Egress Throttle Group, which must be unique within the DSR site. A name is required and cannot be changed after the Egress Throttle Group is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerNodeName": {
"description": "The Peer Node (/diameter/peernodes) names associated with the Egress Throttle Group. Because there can be a total of 128 Connections (/diameter/connections) and Peer Nodes associated with an ETG, there can be up to 128 individual Peer Nodes in the peerNodeName list. Any Connection to a Peer Node listed in peerNodeName is implicitly included in the ETG and should not need be included in the connectionName list.",
"items": {
"description": "Name of an individual Peer Node (/diameter/peernodes) that is part of this ETG.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"maxItems": 128,
"minItems": 0,
"type": "array"
},
"pendingTransLimitingCfgSetName": {
"description": "Name of the Pending Transaction Limiting Configuration Set (/diameter/pendingtransactionlimitingconfigurationsets) associated with this TTG.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"rateLimitingCfgSetName": {
"description": "Name of the Rate Limiting Configuration Set (/diameter/ratelimitingconfigurationsets) associated with this TTG.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"etgControlScope",
"name",
"pendingTransLimitingCfgSetName",
"rateLimitingCfgSetName"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"configurationLevel": "2",
"connectionName": [
"AF01",
"AF02"
],
"etgControlScope": "Etg",
"name": "EgressThrottlingGroup1",
"peerNodeName": [
"AF04",
"AF05"
],
"pendingTransLimitingCfgSetName": "Default",
"rateLimitingCfgSetName": "Default"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/egressthrottlegroups/{name}
Updates the configuration for the specified Egress Throttle Group. If the provided ETG data is invalid in any way, the update fails, resulting in one or more error messages returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/egressthrottlegroup/egressthrottlegroup.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"connectionName": {
"description": "The Connection (/diameter/connections) names associated with the Egress Throttle Group. Because there can be a total of 128 Connections and Peer Nodes (/diameter/peernodes) associated with an ETG, there can be up to 128 individual Connections in the connectionName list. Any Connection to a Peer Node listed in peerNodeName is implicitly included in the ETG and should not need be included in the connectionName list.",
"items": {
"description": "Name of an individual Connection (/diameter/connections) that is part of this ETG.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"maxItems": 128,
"minItems": 0,
"type": "array"
},
"etgControlScope": {
"description": "The DSR uses etgControlScope when deciding to use ETG data or aggregated data from the parent Egress Throttle List (/diameter/egressthrottlelists) in throttling decisions.",
"enum": [
"Etg",
"Etl"
],
"type": "string"
},
"name": {
"description": "Name for the Egress Throttle Group, which must be unique within the DSR site. A name is required and cannot be changed after the Egress Throttle Group is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerNodeName": {
"description": "The Peer Node (/diameter/peernodes) names associated with the Egress Throttle Group. Because there can be a total of 128 Connections (/diameter/connections) and Peer Nodes associated with an ETG, there can be up to 128 individual Peer Nodes in the peerNodeName list. Any Connection to a Peer Node listed in peerNodeName is implicitly included in the ETG and should not need be included in the connectionName list.",
"items": {
"description": "Name of an individual Peer Node (/diameter/peernodes) that is part of this ETG.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"maxItems": 128,
"minItems": 0,
"type": "array"
},
"pendingTransLimitingCfgSetName": {
"description": "Name of the Pending Transaction Limiting Configuration Set (/diameter/pendingtransactionlimitingconfigurationsets) associated with this TTG.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"rateLimitingCfgSetName": {
"description": "Name of the Rate Limiting Configuration Set (/diameter/ratelimitingconfigurationsets) associated with this TTG.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"etgControlScope",
"name",
"pendingTransLimitingCfgSetName",
"rateLimitingCfgSetName"
],
"type": "object"
}
Example
{
"configurationLevel": "2",
"connectionName": [
"AF01",
"AF02"
],
"etgControlScope": "Etg",
"name": "EgressThrottlingGroup1",
"peerNodeName": [
"AF04",
"AF05"
],
"pendingTransLimitingCfgSetName": "Default",
"rateLimitingCfgSetName": "Default"
}
delete /diameter/egressthrottlegroups/{name}
Deletes the specified Egress Throttle Group from the SOAM configuration. An ETG can only be deleted if all delete validation checks pass. In general, the ETG cannot be deleted if either the Rate Limiting Admin State or Pending Transaction Limiting Admin State is not in the disabled state; or the ETG is configured in an Egress Throttle List (/diameter/egressthrottlelists). For example, if the ETG is named in a Egress Throttle List, the ETG must first be removed from the Egress Throttle List at the NOAM. Then the ETG can be deleted from the configuration. An attempt to delete an ETG that cannot be deleted results in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
/diameter/egressthrottlegroups/{name}/ratelimitingadminstate
get /diameter/egressthrottlegroups/{name}/ratelimitingadminstate
Retrieves the rate limiting administrative state for the specified Egress Throttle Group, which can be Enabled or Disabled.
Target server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/ratelimitingadminstateItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/ratelimitingadminstate/ratelimitingadminstate.json",
"properties": {
"adminState": {
"description": "An Egress Throttle Group's rate limiting administrative state can be either Enabled or Disabled. An Egress Throttle Group's configuration cannot be modified, nor can the Egress Throttle Group be deleted from the DSR configuration, if its rate limiting administrative state is Enabled.",
"enum": [
"Enabled",
"Disabled"
],
"example": "Enabled",
"type": "string"
}
},
"required": [
"adminState"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"adminState": "Enabled"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/egressthrottlegroups/{name}/ratelimitingadminstate
Updates the rate limiting administrative state for the specified Egress Throttle Group to either Enabled or Disabled.
An Egress Throttle Group's configuration cannot be modified, nor can the Egress Throttle Group be deleted from the DSR configuration, if its rate limiting administrative state is Enabled.
Target server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/ratelimitingadminstate/ratelimitingadminstate.json",
"properties": {
"adminState": {
"description": "An Egress Throttle Group's rate limiting administrative state can be either Enabled or Disabled. An Egress Throttle Group's configuration cannot be modified, nor can the Egress Throttle Group be deleted from the DSR configuration, if its rate limiting administrative state is Enabled.",
"enum": [
"Enabled",
"Disabled"
],
"example": "Enabled",
"type": "string"
}
},
"required": [
"adminState"
],
"type": "object"
}
Example
{
"adminState": "Enabled"
}
/diameter/egressthrottlegroups/{name}/pendingtransactionlimitingadminstate
get /diameter/egressthrottlegroups/{name}/pendingtransactionlimitingadminstate
Retrieves the pending transaction limiting administrative state for the specified Egress Throttle Group, which can be Enabled or Disabled.
Target server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/pendingtransactionlimitingadminstateItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/pendingtransactionlimitingadminstate/pendingtransactionlimitingadminstate.json",
"properties": {
"adminState": {
"description": "An Egress Throttle Group's pending transaction limiting administrative state can be either Enabled or Disabled. An Egress Throttle Group's configuration cannot be modified, nor can the Egress Throttle Group be deleted from the DSR configuration, if its pending transaction limiting administrative state is Enabled.",
"enum": [
"Enabled",
"Disabled"
],
"example": "Enabled",
"type": "string"
}
},
"required": [
"adminState"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"adminState": "Enabled"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/egressthrottlegroups/{name}/pendingtransactionlimitingadminstate
Updates the pending transaction limiting administrative state for the specified Egress Throttle Group to either Enabled or Disabled.
An Egress Throttle Group's configuration cannot be modified, nor can the Egress Throttle Group be deleted from the DSR configuration, if its pending transaction limiting administrative state is Enabled.
Target server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/pendingtransactionlimitingadminstate/pendingtransactionlimitingadminstate.json",
"properties": {
"adminState": {
"description": "An Egress Throttle Group's pending transaction limiting administrative state can be either Enabled or Disabled. An Egress Throttle Group's configuration cannot be modified, nor can the Egress Throttle Group be deleted from the DSR configuration, if its pending transaction limiting administrative state is Enabled.",
"enum": [
"Enabled",
"Disabled"
],
"example": "Enabled",
"type": "string"
}
},
"required": [
"adminState"
],
"type": "object"
}
Example
{
"adminState": "Enabled"
}
/diameter/egressthrottlegroups/{name}/status
get /diameter/egressthrottlegroups/{name}/status
Retrieves the operational status for the specified Egress Throttle Group.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/egressthrottlegroupstatusItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/egressthrottlegroup/egressthrottlegroupstatus.json",
"properties": {
"averagePendTransHoldTime": {
"description": "The average transaction hold time for recently completed egress transactions associated with the ETG/ETL.",
"type": "integer"
},
"egressRequestRate": {
"description": "The egress request rate (in messages/second) to the Peer Nodes (/diameter/peernodes) and Connections (/diameter/connections) that are members of the Egress Throttle Group. If etgControlScope value (/diameter/egressthrottlegroups) is set to Etg, then this attribute value is equal to etgEgressRequestRate attribute value, else if etgControlScope value (/diameter/egressthrottlegroups) is set to Etl, then this attribute value is equal to etlEgressRequestRate attribute value.",
"type": "integer"
},
"etgEgressRequestRate": {
"description": "The egress request rate (in messages/second) to the Peer Nodes (/diameter/peernodes) and Connections (/diameter/connections) that are members of the Egress Throttle Group.",
"type": "integer"
},
"etlEgressRequestRate": {
"description": "The egress request rate (in messages/second) to the Peer Nodes (/diameter/peernodes) and Connections (/diameter/connections) that are members of an Egress Throttle List's (/diameter/egressthrottlelists) component Egress Throttle Groups.",
"type": "integer"
},
"name": {
"description": "The configured name of the Egress Throttle Group.",
"type": "string"
},
"numberActiveSmsConnections": {
"description": "The current number of active SMS connections between signaling routers with Egress Throttle Groups in an Egress Throttle List (/diameter/egressthrottlelists).",
"maximum": 2,
"minimum": 0,
"type": "integer"
},
"numberPendingEtgTransactions": {
"description": "The number of pending transactions for both Peer Nodes (/diameter/peernodes) and Connections (/diameter/connections) configured for this ETG.",
"type": "integer"
},
"numberPendingEtlTransactions": {
"description": "The number of pending transactions for both Peer Nodes (/diameter/peernodes) and Connections (/diameter/connections) configured to each Egress Throttle Group configured for an Egress Throttle List (/diameter/egressthrottlelists).",
"type": "integer"
},
"numberOfPendingTransactions": {
"description": "The number of pending transactions for both Peer Nodes (/diameter/peernodes) and Connections (/diameter/connections) configured for this ETG or to each Egress Throttle Group configured for an Egress Throttle List. If etgControlScope value (/diameter/egressthrottlegroups) is set to Etg, then this attribute value is equal to numberPendingEtgTransactions attribute value, else if etgControlScope value (/diameter/egressthrottlegroups) is set to Etl, then this attribute value is equal to numberPendingEtlTransactions attribute value.",
"type": "integer"
},
"offeredTrafficRate": {
"description": "The rate of transactions which are being routed to the ETG/ETL before diversion is applied.",
"type": "integer"
},
"pendingTransactionLimitingAdminState": {
"description": "The pending transaction limiting administrative state for this Egress Throttle Group. When pendingTransactionLimitingAdminState is set to Disabled, the DSR does not throttle requests based on the current number of pending transactions. pendingTransactionLimitingAdminState must first be set to Enabled before any throttling is performed.",
"enum": [
"Enabled",
"Disabled"
],
"type": "string"
},
"pendingTransactionLimitingOperationalReason": {
"description": "Information elaborating on the current pendingTransactionLimitingOperationalStatus of this Egress Throttle Group.",
"type": "string"
},
"pendingTransactionLimitingOperationalStatus": {
"description": "The pending transaction limiting operational status for this Egress Throttle Group. The pendingTransactionLimitingOperationalReason value contains additional information elaborating on the reported pendingTransactionLimitingOperationalStatus.",
"enum": [
"Available",
"Degraded",
"Inactive",
"Unknown"
],
"type": "string"
},
"percentTransDiverted": {
"description": "The percentage of transactions which are being routed to the ETG/ETL which are being diverted.",
"type": "integer",
"maximum": 100,
"minimum": 0
},
"rateLimitingAdminState": {
"description": "The rate limiting administrative state for this Egress Throttle Group. When rateLimitingAdminState is set to Disabled, the DSR does not throttle traffic based on request rate. rateLimitingAdminState must first be set to Enabled before limiting the rate.",
"enum": [
"Enabled",
"Disabled"
],
"type": "string"
},
"rateLimitingOperationalReason": {
"description": "Information elaborating on the current rateLimitingOperationalStatus of this Egress Throttle Group.",
"type": "string"
},
"rateLimitingOperationalStatus": {
"description": "The current rate limiting operational state of this Egress Throttle Group. The rateLimitingOperationalReason value contains additional information elaborating on the reported rateLimitingOperationalStatus.",
"enum": [
"Available",
"Degraded",
"Unavailable"
],
"type": "string"
},
"statusKnown": {
"description": "When set to false, current values for the run-time status attributes for this ETG are not known by the OAM. This could be due to merge issues within the DSR, or some other cause preventing the OAM from having a current view of the status of this ETG. If the OAM has current status for this ETG, statusKnown is set to true.",
"type": "boolean"
},
"targetEtr": {
"description": "If both rate limiting and pending transaction limiting are enabled for this ETG/ETL, the targetEtr is a computed value that is equal to the lesser of the rate limiting Egress Throttle Rate (ETR) and the pending transaction limiting ETR. If only rate limiting or pending transaction limiting is enabled for this ETG/ETL, then the targetEtr is the target ETR for the type of functionality that is enabled.",
"type": "integer"
},
"timeOfLastUpdate": {
"description": "The date/time the status for this Egress Throttle Group (/diameter/egressthrottlegroups) was last updated by the DSR.",
"pattern": "^[0-9]{4}[-][0-1]{1}[0-9]{1}[-][0-3]{1}[0-9]{1}T[0-2]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}([.][0-9]{1,7})?[+-](?:2[0-3]|[0-1][0-9])[:][0-5][0-9]?$",
"type": "string"
}
},
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"etgEgressRequestRate": 4,
"etlEgressRequestRate": 23,
"name": "egressthrottlegroupstatus1",
"numberActiveSmsConnections": 2,
"numberPendingEtgTransactions": 34,
"numberPendingEtlTransactions": 2,
"pendingTransactionLimitingAdminState": "Enabled",
"pendingTransactionLimitingOperationalReason": "Normal",
"pendingTransactionLimitingOperationalStatus": "Available",
"rateLimitingAdminState": "Enabled",
"rateLimitingOperationalReason": "Normal",
"rateLimitingOperationalStatus": "Available",
"statusKnown": true,
"timeOfLastUpdate": "2016-Aug-25 11:05:05 EDT"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
Diameter: Egress Throttle Lists
An Egress Throttle List (ETL) is a collection of two or three Egress Throttle Groups (/diameter/egressthrottlegroups) (ETGs) configured at different DSR sites within the same network. An ETL controls egress message rate limiting and pending transaction limiting for component ETGs using run-time metrics to throttle request messages to Peer Nodes (/diameter/peernodes) and/or Connections (/diameter/connections) configured to the ETGs.
All Egress Throttle List configuration is done at the NOAM.
/diameter/egressthrottlelists
get /diameter/egressthrottlelists
Returns all Egress Throttle Lists configured at the NOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those Egress Throttle Lists meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section).
Target Server: NOAM
Secured by x-other
Request
Query Parameters
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/egressthrottlelistCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/egressthrottlelist/egressthrottlelist.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name associated with the Egress Throttle List, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"minLength": 1,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"pendingTransLimitingCfgSetName": {
"description": "Name of the Pending Transaction Limiting Configuration Set (/diameter/pendingtransactionlimitingconfigurationsets) assigned to this Egress Throttle List. Note that only Pending Transaction Limiting Configuration Sets configured at the NOAM can be assigned to Egress Throttle Lists.",
"maxLength": 32,
"minLength": 1,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"rateLimitingCfgSetName": {
"description": "Name of the Rate Limiting Configuration Set (/diameter/ratelimitingconfigurationsets) assigned to this Egress Throttle List. Note that only Rate Limiting Configuration Sets configured at the NOAM can be assigned to Egress Throttle Lists.",
"maxLength": 32,
"minLength": 1,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"etg": {
"description": "List of 2-3 Egress Throttle Groups (/diameter/egressthrottlegroups) from different sites. Entries in the Egress Throttle List can have the same egressThrottleGroupName as long as each has a unique siteName.",
"items": {
"properties": {
"connectionFailurePercentReduction": {
"description": "The percentage by which maximum rate and pending transactions are reduced if the connection between two sites in the Egress Throttle List fails. Typical value is 100 divided by the number of Egress Throttle Groups (/diameter/egressthrottlegroups) in ETL.",
"maximum": 50,
"minimum": 0,
"type": "integer"
},
"egressThrottleGroupName": {
"description": "Name of an Egress Throttle Group (/diameter/egressthrottlegroups) associated with the Egress Throttle List.",
"maxLength": 32,
"minLength": 1,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"siteName": {
"description": "The SOAM Server Group name of the site that owns this Egress Throttle Group (/diameter/egressthrottlegroups). No two ETGs in an Egress Throttle List can belong to the same site.",
"maxLength": 32,
"minLength": 1,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"connectionFailurePercentReduction",
"egressThrottleGroupName",
"siteName"
],
"type": "object"
},
"maxItems": 3,
"minItems": 2,
"type": "array"
}
},
"required": [
"name",
"pendingTransLimitingCfgSetName",
"rateLimitingCfgSetName",
"etg"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"configurationLevel": "2",
"name": "EgressThrottleList1",
"pendingTransLimitingCfgSetName": "Default",
"rateLimitingCfgSetName": "Default",
"etg": [
{
"connectionFailurePercentReduction": 50,
"egressThrottleGroupName": "EgressThrottleGroup1",
"siteName": "LEAF_SO_SG"
},
{
"connectionFailurePercentReduction": 30,
"egressThrottleGroupName": "EgressThrottleGroup2",
"siteName": "TREE_SO_SG"
}
]
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/egressthrottlelists
Adds a new Egress Throttle List to the DSR configuration. The new ETL must have a name that is unique across all ETLs at the NOAM's configuration.
Target Server: NOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/egressthrottlelist/egressthrottlelist.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name associated with the Egress Throttle List, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"minLength": 1,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"pendingTransLimitingCfgSetName": {
"description": "Name of the Pending Transaction Limiting Configuration Set (/diameter/pendingtransactionlimitingconfigurationsets) assigned to this Egress Throttle List. Note that only Pending Transaction Limiting Configuration Sets configured at the NOAM can be assigned to Egress Throttle Lists.",
"maxLength": 32,
"minLength": 1,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"rateLimitingCfgSetName": {
"description": "Name of the Rate Limiting Configuration Set (/diameter/ratelimitingconfigurationsets) assigned to this Egress Throttle List. Note that only Rate Limiting Configuration Sets configured at the NOAM can be assigned to Egress Throttle Lists.",
"maxLength": 32,
"minLength": 1,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"etg": {
"description": "List of 2-3 Egress Throttle Groups (/diameter/egressthrottlegroups) from different sites. Entries in the Egress Throttle List can have the same egressThrottleGroupName as long as each has a unique siteName.",
"items": {
"properties": {
"connectionFailurePercentReduction": {
"description": "The percentage by which maximum rate and pending transactions are reduced if the connection between two sites in the Egress Throttle List fails. Typical value is 100 divided by the number of Egress Throttle Groups (/diameter/egressthrottlegroups) in ETL.",
"maximum": 50,
"minimum": 0,
"type": "integer"
},
"egressThrottleGroupName": {
"description": "Name of an Egress Throttle Group (/diameter/egressthrottlegroups) associated with the Egress Throttle List.",
"maxLength": 32,
"minLength": 1,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"siteName": {
"description": "The SOAM Server Group name of the site that owns this Egress Throttle Group (/diameter/egressthrottlegroups). No two ETGs in an Egress Throttle List can belong to the same site.",
"maxLength": 32,
"minLength": 1,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"connectionFailurePercentReduction",
"egressThrottleGroupName",
"siteName"
],
"type": "object"
},
"maxItems": 3,
"minItems": 2,
"type": "array"
}
},
"required": [
"name",
"pendingTransLimitingCfgSetName",
"rateLimitingCfgSetName",
"etg"
],
"type": "object"
}
Example
{
"configurationLevel": "2",
"name": "EgressThrottleList1",
"pendingTransLimitingCfgSetName": "Default",
"rateLimitingCfgSetName": "Default",
"etg": [
{
"connectionFailurePercentReduction": 50,
"egressThrottleGroupName": "EgressThrottleGroup1",
"siteName": "LEAF_SO_SG"
},
{
"connectionFailurePercentReduction": 30,
"egressThrottleGroupName": "EgressThrottleGroup2",
"siteName": "TREE_SO_SG"
}
]
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/egressthrottlelists/{name}
get /diameter/egressthrottlelists/{name}
Returns the configuration details for the specified Egress Throttle List. If the specified ETL does not exist in the NOAM's configuration, an error message is returned within the HTTP response.
Target Server: NOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/egressthrottlelistItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/egressthrottlelist/egressthrottlelist.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name associated with the Egress Throttle List, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"minLength": 1,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"pendingTransLimitingCfgSetName": {
"description": "Name of the Pending Transaction Limiting Configuration Set (/diameter/pendingtransactionlimitingconfigurationsets) assigned to this Egress Throttle List. Note that only Pending Transaction Limiting Configuration Sets configured at the NOAM can be assigned to Egress Throttle Lists.",
"maxLength": 32,
"minLength": 1,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"rateLimitingCfgSetName": {
"description": "Name of the Rate Limiting Configuration Set (/diameter/ratelimitingconfigurationsets) assigned to this Egress Throttle List. Note that only Rate Limiting Configuration Sets configured at the NOAM can be assigned to Egress Throttle Lists.",
"maxLength": 32,
"minLength": 1,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"etg": {
"description": "List of 2-3 Egress Throttle Groups (/diameter/egressthrottlegroups) from different sites. Entries in the Egress Throttle List can have the same egressThrottleGroupName as long as each has a unique siteName.",
"items": {
"properties": {
"connectionFailurePercentReduction": {
"description": "The percentage by which maximum rate and pending transactions are reduced if the connection between two sites in the Egress Throttle List fails. Typical value is 100 divided by the number of Egress Throttle Groups (/diameter/egressthrottlegroups) in ETL.",
"maximum": 50,
"minimum": 0,
"type": "integer"
},
"egressThrottleGroupName": {
"description": "Name of an Egress Throttle Group (/diameter/egressthrottlegroups) associated with the Egress Throttle List.",
"maxLength": 32,
"minLength": 1,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"siteName": {
"description": "The SOAM Server Group name of the site that owns this Egress Throttle Group (/diameter/egressthrottlegroups). No two ETGs in an Egress Throttle List can belong to the same site.",
"maxLength": 32,
"minLength": 1,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"connectionFailurePercentReduction",
"egressThrottleGroupName",
"siteName"
],
"type": "object"
},
"maxItems": 3,
"minItems": 2,
"type": "array"
}
},
"required": [
"name",
"pendingTransLimitingCfgSetName",
"rateLimitingCfgSetName",
"etg"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"configurationLevel": "2",
"name": "EgressThrottleList1",
"pendingTransLimitingCfgSetName": "Default",
"rateLimitingCfgSetName": "Default",
"etg": [
{
"connectionFailurePercentReduction": 50,
"egressThrottleGroupName": "EgressThrottleGroup1",
"siteName": "LEAF_SO_SG"
},
{
"connectionFailurePercentReduction": 30,
"egressThrottleGroupName": "EgressThrottleGroup2",
"siteName": "TREE_SO_SG"
}
]
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/egressthrottlelists/{name}
Updates the configuration for the specified Egress Throttle List. If the provided ETL data is invalid in any way, the update fails, resulting in one or more error messages returned within the HTTP response.
Target Server: NOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/egressthrottlelist/egressthrottlelist.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name associated with the Egress Throttle List, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"minLength": 1,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"pendingTransLimitingCfgSetName": {
"description": "Name of the Pending Transaction Limiting Configuration Set (/diameter/pendingtransactionlimitingconfigurationsets) assigned to this Egress Throttle List. Note that only Pending Transaction Limiting Configuration Sets configured at the NOAM can be assigned to Egress Throttle Lists.",
"maxLength": 32,
"minLength": 1,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"rateLimitingCfgSetName": {
"description": "Name of the Rate Limiting Configuration Set (/diameter/ratelimitingconfigurationsets) assigned to this Egress Throttle List. Note that only Rate Limiting Configuration Sets configured at the NOAM can be assigned to Egress Throttle Lists.",
"maxLength": 32,
"minLength": 1,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"etg": {
"description": "List of 2-3 Egress Throttle Groups (/diameter/egressthrottlegroups) from different sites. Entries in the Egress Throttle List can have the same egressThrottleGroupName as long as each has a unique siteName.",
"items": {
"properties": {
"connectionFailurePercentReduction": {
"description": "The percentage by which maximum rate and pending transactions are reduced if the connection between two sites in the Egress Throttle List fails. Typical value is 100 divided by the number of Egress Throttle Groups (/diameter/egressthrottlegroups) in ETL.",
"maximum": 50,
"minimum": 0,
"type": "integer"
},
"egressThrottleGroupName": {
"description": "Name of an Egress Throttle Group (/diameter/egressthrottlegroups) associated with the Egress Throttle List.",
"maxLength": 32,
"minLength": 1,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"siteName": {
"description": "The SOAM Server Group name of the site that owns this Egress Throttle Group (/diameter/egressthrottlegroups). No two ETGs in an Egress Throttle List can belong to the same site.",
"maxLength": 32,
"minLength": 1,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"connectionFailurePercentReduction",
"egressThrottleGroupName",
"siteName"
],
"type": "object"
},
"maxItems": 3,
"minItems": 2,
"type": "array"
}
},
"required": [
"name",
"pendingTransLimitingCfgSetName",
"rateLimitingCfgSetName",
"etg"
],
"type": "object"
}
Example
{
"configurationLevel": "2",
"name": "EgressThrottleList1",
"pendingTransLimitingCfgSetName": "Default",
"rateLimitingCfgSetName": "Default",
"etg": [
{
"connectionFailurePercentReduction": 50,
"egressThrottleGroupName": "EgressThrottleGroup1",
"siteName": "LEAF_SO_SG"
},
{
"connectionFailurePercentReduction": 30,
"egressThrottleGroupName": "EgressThrottleGroup2",
"siteName": "TREE_SO_SG"
}
]
}
delete /diameter/egressthrottlelists/{name}
Deletes the specified Egress Throttle List (ETL) from the NOAM configuration. An ETL can only be deleted if each of its component Egress Throttle Groups (/diameter/egressthrottlegroups) is scoped to ETG. It is not necessary for the ETGs to be removed from the ETL's configuration before deleting the ETL; however, if any ETG in the ETL is scoped to ETL, that ETG's scope must first be changed to ETG. An attempt to delete an ETL that cannot be deleted results in an error message returned within the HTTP response.
Target Server: NOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Diameter: Local Nodes
A DSR site - the SOAM - is visible within the network as one or more Local Nodes. The Local Node managed object encapsulates all the characteristics of the DSR itself that must be known in order to configure transport connections to Peer Nodes (/diameter/peernodes). Each Local Node must have a unique Fully Qualified Domain Name (FQDN), although two or more Local Nodes may share the same Realm. A Local Node can support Diameter Connections (/diameter/connections), RADIUS Connections (/diameter/connections), or both, based on the role of the DSR within the network.
All Local Node configuration is done at the SOAM.
/diameter/localnodes
get /diameter/localnodes
Returns all Local Nodes configured at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those Local Nodes meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section).
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (one of configurationLevel)
The field being matched
Only the configurationLevel field is supported.
Example:
filter_name=configurationLevel
- filter_op: (one of GREATER_THAN, GREATER_THAN_EQUAL)
The match operation (operator)
Example:
filter_op=GREATER_THAN
- filter_values: (string)
The matched value
The configurationLevel value by which the data is being filtered. Only a single value is supported.
Example:
filter_values=10
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/localnodeCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/localnode/localnode.json",
"properties": {
"certName": {
"description": "A valid security certificate name.",
"maxLength": 255,
"type": "string"
},
"certType": {
"description": "The type of the security certificate identified by certName. DSR only supports certificate type Tls for assignment to a Local Node.",
"enum": [
"Tls"
],
"type": "string"
},
"certVerifyMode": {
"description": "The Certificate Verification Mode used when either a DTLS/SCTP or a TLS/TCP port is configured for this Local Node.",
"enum": [
"SslVerifyNone",
"SslVerifyPeer",
"SslVerifyPeerFailIfNoPeerCert",
"SslVerifyPeerVerifyClientOnce"
],
"type": "string"
},
"cexCfgSetName": {
"description": "The CEX Configuration Set (/diameter/cexconfigurationsets) assigned to a Local Node supplies capabilities exchange parameters, which get applied to any Connection (/diameter/connections) that doesn't have its own CEX Configuration Set explicitly configured.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"connCfgSetName": {
"description": "The Connection Configuration Set (/diameter/connectionconfigurationsets) assigned to a Local Node supplies default values for a variety of transport connection parameters. The only time a Local Node's Connection Configuration Set is used is when a responder-only Connection (/diameter/connections) is initially set up, awaiting establishment from a Peer Node (/diameter/peernodes). Once the responder-only Connection is established, and in all other Connection configuration scenarios, the Connection's own Connection Configuration Set supplies the transport connection parameters.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"dtlsPort": {
"description": "DTLS/SCTP Listen Port number of this Local Node. Omitting this property indicates the Local Node does not listen for DTLS/SCTP Connections from Peer Nodes (/diameter/peernodes). Typical value is 5658.",
"maximum": 16383,
"minimum": 1024,
"type": "integer"
},
"endClientPort": {
"description": "The highest UDP port number that can be used by the Local Node to send RADIUS request messages to a RADIUS server. Typical value is 2499.",
"maximum": 49151,
"minimum": 1024,
"type": "integer"
},
"fqdn": {
"description": "Fully Qualified Domain Name of this Peer Node. fqdn is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and an FQDN must be at most 255 characters long.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
},
"ip": {
"description": "The IP address list for this Local Node. The IP addresses configured for a Local Node may include fixed IP addresses and/or IPFE Target Set Addresses. The list of valid IP addresses that can be assigned to a Local Node is provided in the /diameter/signalingipaddresses GET response.",
"items": {
"properties": {
"ipAddr": {
"description": "A single IP address configured for this Local Node.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"ipType": {
"description": "Each IP address is of type LocalIp or IpfeTsa. A Local IP is a fixed IP address assigned to a specific MP server within the DSR. An IPFE Target Set Address (TSA) is an IP address associated with a group of MP servers, which together are known as a Target Set.",
"enum": [
"LocalIp",
"IpfeTsa"
],
"type": "string"
}
},
"required": [
"ipAddr",
"ipType"
],
"type": "object"
},
"maxItems": 128,
"minItems": 1,
"type": "array"
},
"name": {
"description": "Name for this Local Node, which must be unique within the DSR site. A name is required, and cannot be changed after the Local Node is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"radiusClientPortEnabled": {
"description": "If set to true, this Local Node can send RADIUS request messages to a Peer Node (/diameter/peernodes), configured in the role of RADIUS server, using one of the UDP ports within the range defined by startClientPort and endClientPort.",
"type": "boolean"
},
"realm": {
"description": "Realm of this Local Node. Realm is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and a Realm must be at most 255 characters long.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
},
"sctpPort": {
"description": "SCTP Listen Port number of this Local Node. Omitting this property indicates the Local Node does not listen for SCTP Connections from Peer Nodes (/diameter/peernodes). Typical value is 3868.",
"maximum": 16383,
"minimum": 1024,
"type": "integer"
},
"serverPort": {
"description": "UDP port numbers used by RADIUS clients when sending RADIUS messages to this Local Node. Between zero and 10 (inclusive) UDP port numbers can be defined for a Local Node. If no UDP port numbers are supplied, this Local Node does not receive requests from RADIUS clients.",
"items": {
"maximum": 49151,
"minimum": 1024,
"type": "integer"
},
"maxItems": 10,
"minItems": 0,
"type": "array"
},
"startClientPort": {
"description": "The lowest UDP port number that can be used by the Local Node to send RADIUS request messages to a RADIUS server. Typical value is 2000.",
"maximum": 49151,
"minimum": 1024,
"type": "integer"
},
"tcpPort": {
"description": "TCP Listen Port number of this Local Node. Omitting this property indicates the Local Node does not listen for TCP Connections from Peer Nodes (/diameter/peernodes). Typical value is 3868.",
"maximum": 16383,
"minimum": 1024,
"type": "integer"
},
"tlsPort": {
"description": "TLS/TCP Listen Port number of this Local Node. Omitting this property indicates the Local Node does not listen for TLS/TCP Connections from Peer Nodes (/diameter/peernodes). Typical value is 5658.",
"maximum": 16383,
"minimum": 1024,
"type": "integer"
}
},
"required": [
"certVerifyMode",
"cexCfgSetName",
"connCfgSetName",
"fqdn",
"ip",
"name",
"radiusClientPortEnabled",
"realm"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"name": "LocalNode1",
"ip": [
{
"ipAddr": "fA1:9d262fbA1:541E8f:fadBbDA7F364bD"
}
],
"fqdn": "dp.domain.com",
"realm": "domain.com",
"configurationLevel": "46",
"connCfgSetName": "connCfgSet1",
"cexCfgSetName": "cexCfgSet1",
"startClientPort": 5137,
"certType": "Tls",
"endClientPort": 19097,
"radiusClientPortEnabled": false,
"serverPort": [
42374,
23046
],
"certVerifyMode": "SslVerifyPeerVerifyClientOnce",
"certName": "certName1",
"dtlsPort": 4340
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/localnodes
Adds a new Local Node to the DSR configuration. The new Local Node must have a name that is unique to the SOAM's configuration. A single Local Node can be configured to support Diameter Connections (/diameter/connections), RADIUS Connections (/diameter/connections), or both.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/localnode/localnode.json",
"properties": {
"certName": {
"description": "A valid security certificate name.",
"maxLength": 255,
"type": "string"
},
"certType": {
"description": "The type of the security certificate identified by certName. DSR only supports certificate type Tls for assignment to a Local Node.",
"enum": [
"Tls"
],
"type": "string"
},
"certVerifyMode": {
"description": "The Certificate Verification Mode used when either a DTLS/SCTP or a TLS/TCP port is configured for this Local Node.",
"enum": [
"SslVerifyNone",
"SslVerifyPeer",
"SslVerifyPeerFailIfNoPeerCert",
"SslVerifyPeerVerifyClientOnce"
],
"type": "string"
},
"cexCfgSetName": {
"description": "The CEX Configuration Set (/diameter/cexconfigurationsets) assigned to a Local Node supplies capabilities exchange parameters, which get applied to any Connection (/diameter/connections) that doesn't have its own CEX Configuration Set explicitly configured.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"connCfgSetName": {
"description": "The Connection Configuration Set (/diameter/connectionconfigurationsets) assigned to a Local Node supplies default values for a variety of transport connection parameters. The only time a Local Node's Connection Configuration Set is used is when a responder-only Connection (/diameter/connections) is initially set up, awaiting establishment from a Peer Node (/diameter/peernodes). Once the responder-only Connection is established, and in all other Connection configuration scenarios, the Connection's own Connection Configuration Set supplies the transport connection parameters.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"dtlsPort": {
"description": "DTLS/SCTP Listen Port number of this Local Node. Omitting this property indicates the Local Node does not listen for DTLS/SCTP Connections from Peer Nodes (/diameter/peernodes). Typical value is 5658.",
"maximum": 16383,
"minimum": 1024,
"type": "integer"
},
"endClientPort": {
"description": "The highest UDP port number that can be used by the Local Node to send RADIUS request messages to a RADIUS server. Typical value is 2499.",
"maximum": 49151,
"minimum": 1024,
"type": "integer"
},
"fqdn": {
"description": "Fully Qualified Domain Name of this Peer Node. fqdn is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and an FQDN must be at most 255 characters long.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
},
"ip": {
"description": "The IP address list for this Local Node. The IP addresses configured for a Local Node may include fixed IP addresses and/or IPFE Target Set Addresses. The list of valid IP addresses that can be assigned to a Local Node is provided in the /diameter/signalingipaddresses GET response.",
"items": {
"properties": {
"ipAddr": {
"description": "A single IP address configured for this Local Node.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"ipType": {
"description": "Each IP address is of type LocalIp or IpfeTsa. A Local IP is a fixed IP address assigned to a specific MP server within the DSR. An IPFE Target Set Address (TSA) is an IP address associated with a group of MP servers, which together are known as a Target Set.",
"enum": [
"LocalIp",
"IpfeTsa"
],
"type": "string"
}
},
"required": [
"ipAddr",
"ipType"
],
"type": "object"
},
"maxItems": 128,
"minItems": 1,
"type": "array"
},
"name": {
"description": "Name for this Local Node, which must be unique within the DSR site. A name is required, and cannot be changed after the Local Node is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"radiusClientPortEnabled": {
"description": "If set to true, this Local Node can send RADIUS request messages to a Peer Node (/diameter/peernodes), configured in the role of RADIUS server, using one of the UDP ports within the range defined by startClientPort and endClientPort.",
"type": "boolean"
},
"realm": {
"description": "Realm of this Local Node. Realm is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and a Realm must be at most 255 characters long.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
},
"sctpPort": {
"description": "SCTP Listen Port number of this Local Node. Omitting this property indicates the Local Node does not listen for SCTP Connections from Peer Nodes (/diameter/peernodes). Typical value is 3868.",
"maximum": 16383,
"minimum": 1024,
"type": "integer"
},
"serverPort": {
"description": "UDP port numbers used by RADIUS clients when sending RADIUS messages to this Local Node. Between zero and 10 (inclusive) UDP port numbers can be defined for a Local Node. If no UDP port numbers are supplied, this Local Node does not receive requests from RADIUS clients.",
"items": {
"maximum": 49151,
"minimum": 1024,
"type": "integer"
},
"maxItems": 10,
"minItems": 0,
"type": "array"
},
"startClientPort": {
"description": "The lowest UDP port number that can be used by the Local Node to send RADIUS request messages to a RADIUS server. Typical value is 2000.",
"maximum": 49151,
"minimum": 1024,
"type": "integer"
},
"tcpPort": {
"description": "TCP Listen Port number of this Local Node. Omitting this property indicates the Local Node does not listen for TCP Connections from Peer Nodes (/diameter/peernodes). Typical value is 3868.",
"maximum": 16383,
"minimum": 1024,
"type": "integer"
},
"tlsPort": {
"description": "TLS/TCP Listen Port number of this Local Node. Omitting this property indicates the Local Node does not listen for TLS/TCP Connections from Peer Nodes (/diameter/peernodes). Typical value is 5658.",
"maximum": 16383,
"minimum": 1024,
"type": "integer"
}
},
"required": [
"certVerifyMode",
"cexCfgSetName",
"connCfgSetName",
"fqdn",
"ip",
"name",
"radiusClientPortEnabled",
"realm"
],
"type": "object"
}
Example
{
"name": "LocalNode1",
"ip": [
{
"ipAddr": "fA1:9d262fbA1:541E8f:fadBbDA7F364bD"
}
],
"fqdn": "dp.domain.com",
"realm": "domain.com",
"configurationLevel": "46",
"connCfgSetName": "connCfgSet1",
"cexCfgSetName": "cexCfgSet1",
"startClientPort": 5137,
"certType": "Tls",
"endClientPort": 19097,
"radiusClientPortEnabled": false,
"serverPort": [
42374,
23046
],
"certVerifyMode": "SslVerifyPeerVerifyClientOnce",
"certName": "certName1",
"dtlsPort": 4340
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/localnodes/{name}
get /diameter/localnodes/{name}
Returns the configuration details for the specified Local Node. If the specified Local Node does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/localnodeItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/localnode/localnode.json",
"properties": {
"certName": {
"description": "A valid security certificate name.",
"maxLength": 255,
"type": "string"
},
"certType": {
"description": "The type of the security certificate identified by certName. DSR only supports certificate type Tls for assignment to a Local Node.",
"enum": [
"Tls"
],
"type": "string"
},
"certVerifyMode": {
"description": "The Certificate Verification Mode used when either a DTLS/SCTP or a TLS/TCP port is configured for this Local Node.",
"enum": [
"SslVerifyNone",
"SslVerifyPeer",
"SslVerifyPeerFailIfNoPeerCert",
"SslVerifyPeerVerifyClientOnce"
],
"type": "string"
},
"cexCfgSetName": {
"description": "The CEX Configuration Set (/diameter/cexconfigurationsets) assigned to a Local Node supplies capabilities exchange parameters, which get applied to any Connection (/diameter/connections) that doesn't have its own CEX Configuration Set explicitly configured.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"connCfgSetName": {
"description": "The Connection Configuration Set (/diameter/connectionconfigurationsets) assigned to a Local Node supplies default values for a variety of transport connection parameters. The only time a Local Node's Connection Configuration Set is used is when a responder-only Connection (/diameter/connections) is initially set up, awaiting establishment from a Peer Node (/diameter/peernodes). Once the responder-only Connection is established, and in all other Connection configuration scenarios, the Connection's own Connection Configuration Set supplies the transport connection parameters.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"dtlsPort": {
"description": "DTLS/SCTP Listen Port number of this Local Node. Omitting this property indicates the Local Node does not listen for DTLS/SCTP Connections from Peer Nodes (/diameter/peernodes). Typical value is 5658.",
"maximum": 16383,
"minimum": 1024,
"type": "integer"
},
"endClientPort": {
"description": "The highest UDP port number that can be used by the Local Node to send RADIUS request messages to a RADIUS server. Typical value is 2499.",
"maximum": 49151,
"minimum": 1024,
"type": "integer"
},
"fqdn": {
"description": "Fully Qualified Domain Name of this Peer Node. fqdn is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and an FQDN must be at most 255 characters long.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
},
"ip": {
"description": "The IP address list for this Local Node. The IP addresses configured for a Local Node may include fixed IP addresses and/or IPFE Target Set Addresses. The list of valid IP addresses that can be assigned to a Local Node is provided in the /diameter/signalingipaddresses GET response.",
"items": {
"properties": {
"ipAddr": {
"description": "A single IP address configured for this Local Node.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"ipType": {
"description": "Each IP address is of type LocalIp or IpfeTsa. A Local IP is a fixed IP address assigned to a specific MP server within the DSR. An IPFE Target Set Address (TSA) is an IP address associated with a group of MP servers, which together are known as a Target Set.",
"enum": [
"LocalIp",
"IpfeTsa"
],
"type": "string"
}
},
"required": [
"ipAddr",
"ipType"
],
"type": "object"
},
"maxItems": 128,
"minItems": 1,
"type": "array"
},
"name": {
"description": "Name for this Local Node, which must be unique within the DSR site. A name is required, and cannot be changed after the Local Node is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"radiusClientPortEnabled": {
"description": "If set to true, this Local Node can send RADIUS request messages to a Peer Node (/diameter/peernodes), configured in the role of RADIUS server, using one of the UDP ports within the range defined by startClientPort and endClientPort.",
"type": "boolean"
},
"realm": {
"description": "Realm of this Local Node. Realm is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and a Realm must be at most 255 characters long.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
},
"sctpPort": {
"description": "SCTP Listen Port number of this Local Node. Omitting this property indicates the Local Node does not listen for SCTP Connections from Peer Nodes (/diameter/peernodes). Typical value is 3868.",
"maximum": 16383,
"minimum": 1024,
"type": "integer"
},
"serverPort": {
"description": "UDP port numbers used by RADIUS clients when sending RADIUS messages to this Local Node. Between zero and 10 (inclusive) UDP port numbers can be defined for a Local Node. If no UDP port numbers are supplied, this Local Node does not receive requests from RADIUS clients.",
"items": {
"maximum": 49151,
"minimum": 1024,
"type": "integer"
},
"maxItems": 10,
"minItems": 0,
"type": "array"
},
"startClientPort": {
"description": "The lowest UDP port number that can be used by the Local Node to send RADIUS request messages to a RADIUS server. Typical value is 2000.",
"maximum": 49151,
"minimum": 1024,
"type": "integer"
},
"tcpPort": {
"description": "TCP Listen Port number of this Local Node. Omitting this property indicates the Local Node does not listen for TCP Connections from Peer Nodes (/diameter/peernodes). Typical value is 3868.",
"maximum": 16383,
"minimum": 1024,
"type": "integer"
},
"tlsPort": {
"description": "TLS/TCP Listen Port number of this Local Node. Omitting this property indicates the Local Node does not listen for TLS/TCP Connections from Peer Nodes (/diameter/peernodes). Typical value is 5658.",
"maximum": 16383,
"minimum": 1024,
"type": "integer"
}
},
"required": [
"certVerifyMode",
"cexCfgSetName",
"connCfgSetName",
"fqdn",
"ip",
"name",
"radiusClientPortEnabled",
"realm"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"name": "LocalNode1",
"ip": [
{
"ipAddr": "fA1:9d262fbA1:541E8f:fadBbDA7F364bD"
}
],
"fqdn": "dp.domain.com",
"realm": "domain.com",
"configurationLevel": "46",
"connCfgSetName": "connCfgSet1",
"cexCfgSetName": "cexCfgSet1",
"startClientPort": 5137,
"certType": "Tls",
"endClientPort": 19097,
"radiusClientPortEnabled": false,
"serverPort": [
42374,
23046
],
"certVerifyMode": "SslVerifyPeerVerifyClientOnce",
"certName": "certName1",
"dtlsPort": 4340
}
,
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/localnodes/{name}
Updates the configuration for the specified Local Node. If the provided Local Node data is invalid in any way, the update will fail, resulting in one or more error messages returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/localnode/localnode.json",
"properties": {
"certName": {
"description": "A valid security certificate name.",
"maxLength": 255,
"type": "string"
},
"certType": {
"description": "The type of the security certificate identified by certName. DSR only supports certificate type Tls for assignment to a Local Node.",
"enum": [
"Tls"
],
"type": "string"
},
"certVerifyMode": {
"description": "The Certificate Verification Mode used when either a DTLS/SCTP or a TLS/TCP port is configured for this Local Node.",
"enum": [
"SslVerifyNone",
"SslVerifyPeer",
"SslVerifyPeerFailIfNoPeerCert",
"SslVerifyPeerVerifyClientOnce"
],
"type": "string"
},
"cexCfgSetName": {
"description": "The CEX Configuration Set (/diameter/cexconfigurationsets) assigned to a Local Node supplies capabilities exchange parameters, which get applied to any Connection (/diameter/connections) that doesn't have its own CEX Configuration Set explicitly configured.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"connCfgSetName": {
"description": "The Connection Configuration Set (/diameter/connectionconfigurationsets) assigned to a Local Node supplies default values for a variety of transport connection parameters. The only time a Local Node's Connection Configuration Set is used is when a responder-only Connection (/diameter/connections) is initially set up, awaiting establishment from a Peer Node (/diameter/peernodes). Once the responder-only Connection is established, and in all other Connection configuration scenarios, the Connection's own Connection Configuration Set supplies the transport connection parameters.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"dtlsPort": {
"description": "DTLS/SCTP Listen Port number of this Local Node. Omitting this property indicates the Local Node does not listen for DTLS/SCTP Connections from Peer Nodes (/diameter/peernodes). Typical value is 5658.",
"maximum": 16383,
"minimum": 1024,
"type": "integer"
},
"endClientPort": {
"description": "The highest UDP port number that can be used by the Local Node to send RADIUS request messages to a RADIUS server. Typical value is 2499.",
"maximum": 49151,
"minimum": 1024,
"type": "integer"
},
"fqdn": {
"description": "Fully Qualified Domain Name of this Peer Node. fqdn is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and an FQDN must be at most 255 characters long.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
},
"ip": {
"description": "The IP address list for this Local Node. The IP addresses configured for a Local Node may include fixed IP addresses and/or IPFE Target Set Addresses. The list of valid IP addresses that can be assigned to a Local Node is provided in the /diameter/signalingipaddresses GET response.",
"items": {
"properties": {
"ipAddr": {
"description": "A single IP address configured for this Local Node.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"ipType": {
"description": "Each IP address is of type LocalIp or IpfeTsa. A Local IP is a fixed IP address assigned to a specific MP server within the DSR. An IPFE Target Set Address (TSA) is an IP address associated with a group of MP servers, which together are known as a Target Set.",
"enum": [
"LocalIp",
"IpfeTsa"
],
"type": "string"
}
},
"required": [
"ipAddr",
"ipType"
],
"type": "object"
},
"maxItems": 128,
"minItems": 1,
"type": "array"
},
"name": {
"description": "Name for this Local Node, which must be unique within the DSR site. A name is required, and cannot be changed after the Local Node is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"radiusClientPortEnabled": {
"description": "If set to true, this Local Node can send RADIUS request messages to a Peer Node (/diameter/peernodes), configured in the role of RADIUS server, using one of the UDP ports within the range defined by startClientPort and endClientPort.",
"type": "boolean"
},
"realm": {
"description": "Realm of this Local Node. Realm is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and a Realm must be at most 255 characters long.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
},
"sctpPort": {
"description": "SCTP Listen Port number of this Local Node. Omitting this property indicates the Local Node does not listen for SCTP Connections from Peer Nodes (/diameter/peernodes). Typical value is 3868.",
"maximum": 16383,
"minimum": 1024,
"type": "integer"
},
"serverPort": {
"description": "UDP port numbers used by RADIUS clients when sending RADIUS messages to this Local Node. Between zero and 10 (inclusive) UDP port numbers can be defined for a Local Node. If no UDP port numbers are supplied, this Local Node does not receive requests from RADIUS clients.",
"items": {
"maximum": 49151,
"minimum": 1024,
"type": "integer"
},
"maxItems": 10,
"minItems": 0,
"type": "array"
},
"startClientPort": {
"description": "The lowest UDP port number that can be used by the Local Node to send RADIUS request messages to a RADIUS server. Typical value is 2000.",
"maximum": 49151,
"minimum": 1024,
"type": "integer"
},
"tcpPort": {
"description": "TCP Listen Port number of this Local Node. Omitting this property indicates the Local Node does not listen for TCP Connections from Peer Nodes (/diameter/peernodes). Typical value is 3868.",
"maximum": 16383,
"minimum": 1024,
"type": "integer"
},
"tlsPort": {
"description": "TLS/TCP Listen Port number of this Local Node. Omitting this property indicates the Local Node does not listen for TLS/TCP Connections from Peer Nodes (/diameter/peernodes). Typical value is 5658.",
"maximum": 16383,
"minimum": 1024,
"type": "integer"
}
},
"required": [
"certVerifyMode",
"cexCfgSetName",
"connCfgSetName",
"fqdn",
"ip",
"name",
"radiusClientPortEnabled",
"realm"
],
"type": "object"
}
Example
{
"name": "LocalNode1",
"ip": [
{
"ipAddr": "fA1:9d262fbA1:541E8f:fadBbDA7F364bD"
}
],
"fqdn": "dp.domain.com",
"realm": "domain.com",
"configurationLevel": "46",
"connCfgSetName": "connCfgSet1",
"cexCfgSetName": "cexCfgSet1",
"startClientPort": 5137,
"certType": "Tls",
"endClientPort": 19097,
"radiusClientPortEnabled": false,
"serverPort": [
42374,
23046
],
"certVerifyMode": "SslVerifyPeerVerifyClientOnce",
"certName": "certName1",
"dtlsPort": 4340
}
delete /diameter/localnodes/{name}
Deletes the specified Local Node from the SOAM configuration. A Local Node will only be deleted if all delete validation checks pass. If the Local Node is part of the configuration of some other Managed Object, the Local Node cannot be deleted. For example, if the Local Node is associated with a Connection (/diameter/connections), that association must first be removed (either by editing the Connection and choosing a different Local Node, or deleting the Connection entirely). Then the Local Node can be deleted from the configuration. An attempt to delete a Local Node that cannot be deleted will result in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Diameter: MCCMNC Mapping
The MccMnc mapping provides the mapping between a Mobile country code and a Mobile network code for network identification.
All MccMnc mapping is done at the NOAM.
/diameter/mccmncmappings
get /diameter/mccmncmappings
Returns all MccMnc mapping configured at the NOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those MccMnc mapping data meeting the request parameters are returned in the response.
Target Server: NOAM
Secured by x-other
Request
Query Parameters
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/mccmncmappingCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/mccmncmapping/mccmncmapping.json",
"properties": {
"ccndc": {
"description": "Country Code (CC) plus National Destination Code (NDC) that is associated with the MCC+MNC+optional MSIN prefix digits.",
"pattern": "^[0-9]{0,15}$",
"type": "integer"
},
"country": {
"description": "Country Name corresponding to the MCC",
"maxLength": 128,
"pattern": "^[ -~]+$",
"type": "string"
},
"description": {
"description": "Optional description/note.",
"maxLength": 255,
"pattern": "^[ -~]+$",
"type": "string"
},
"mcc": {
"description": "Mobile Country Code",
"maxLength": 3,
"pattern": "^[0-9]{3}$",
"type": "string"
},
"mccMncMappingId": {
"description": "The natural identifier for the mcc mapping instance. It is a combination of mcc, mnc and prefix field values.",
"readOnly": true,
"type": "string"
},
"mnc": {
"description": "Mobile Network Code",
"maxLength": 3,
"pattern": "^[0-9]{2,3}$",
"type": "string"
},
"networkname": {
"description": "Network Name corresponding to the MNC",
"maxLength": 128,
"pattern": "[ -~]+$",
"type": "string"
},
"prefix": {
"description": "Optional MSIN prefix digits that form a MCC+MNC+MSIN prefix digits string. An empty MSIN prefix digits (0 digits) is used to map MCC+MNC to configuration data. If MSIN prefix digits are specified, it maps MCC+MNC+MSIN prefix digits to configuration data.",
"pattern": "^[0-9]{0,10}$",
"type": "integer"
},
"realm": {
"description": "Diameter Realm that is associated with the MCC+MNC+optional MSIN prefix digits. Realm is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes (-) and underscore (_). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and a Realm must be at most 255 characters long.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
}
},
"required": [
"mcc",
"mnc"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"ccndc": 34,
"country": "Greece",
"description": "Test",
"mcc": "202",
"mnc": "01",
"networkname": "Cosmote",
"prefix": 5,
"realm": "realm.com"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/mccmncmappings
Adds a new MccMnc mapping to the DIAMETER configuration. The Mnc or MccMnc mapping combination shall not already exists in the NOAM's configuration.
Target Server: NOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/mccmncmapping/mccmncmapping.json",
"properties": {
"ccndc": {
"description": "Country Code (CC) plus National Destination Code (NDC) that is associated with the MCC+MNC+optional MSIN prefix digits.",
"pattern": "^[0-9]{0,15}$",
"type": "integer"
},
"country": {
"description": "Country Name corresponding to the MCC",
"maxLength": 128,
"pattern": "^[ -~]+$",
"type": "string"
},
"description": {
"description": "Optional description/note.",
"maxLength": 255,
"pattern": "^[ -~]+$",
"type": "string"
},
"mcc": {
"description": "Mobile Country Code",
"maxLength": 3,
"pattern": "^[0-9]{3}$",
"type": "string"
},
"mccMncMappingId": {
"description": "The natural identifier for the mcc mapping instance. It is a combination of mcc, mnc and prefix field values.",
"readOnly": true,
"type": "string"
},
"mnc": {
"description": "Mobile Network Code",
"maxLength": 3,
"pattern": "^[0-9]{2,3}$",
"type": "string"
},
"networkname": {
"description": "Network Name corresponding to the MNC",
"maxLength": 128,
"pattern": "[ -~]+$",
"type": "string"
},
"prefix": {
"description": "Optional MSIN prefix digits that form a MCC+MNC+MSIN prefix digits string. An empty MSIN prefix digits (0 digits) is used to map MCC+MNC to configuration data. If MSIN prefix digits are specified, it maps MCC+MNC+MSIN prefix digits to configuration data.",
"pattern": "^[0-9]{0,10}$",
"type": "integer"
},
"realm": {
"description": "Diameter Realm that is associated with the MCC+MNC+optional MSIN prefix digits. Realm is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes (-) and underscore (_). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and a Realm must be at most 255 characters long.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
}
},
"required": [
"mcc",
"mnc"
],
"type": "object"
}
Example
{
"ccndc": 34,
"country": "Greece",
"description": "Test",
"mcc": "202",
"mnc": "01",
"networkname": "Cosmote",
"prefix": 5,
"realm": "realm.com"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/mccmncmappings/{MCC}
get /diameter/mccmncmappings/{MCC}
Returns the configuration details for the specified MccMnc mapping data. If the specified MccMnc mapping does not exist in the NOAM's configuration, an error message is returned within the HTTP response.
Target Server: NOAM
Secured by x-other
Request
URI Parameters
- MCC: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/mccmncmappingItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/mccmncmapping/mccmncmapping.json",
"properties": {
"ccndc": {
"description": "Country Code (CC) plus National Destination Code (NDC) that is associated with the MCC+MNC+optional MSIN prefix digits.",
"pattern": "^[0-9]{0,15}$",
"type": "integer"
},
"country": {
"description": "Country Name corresponding to the MCC",
"maxLength": 128,
"pattern": "^[ -~]+$",
"type": "string"
},
"description": {
"description": "Optional description/note.",
"maxLength": 255,
"pattern": "^[ -~]+$",
"type": "string"
},
"mcc": {
"description": "Mobile Country Code",
"maxLength": 3,
"pattern": "^[0-9]{3}$",
"type": "string"
},
"mccMncMappingId": {
"description": "The natural identifier for the mcc mapping instance. It is a combination of mcc, mnc and prefix field values.",
"readOnly": true,
"type": "string"
},
"mnc": {
"description": "Mobile Network Code",
"maxLength": 3,
"pattern": "^[0-9]{2,3}$",
"type": "string"
},
"networkname": {
"description": "Network Name corresponding to the MNC",
"maxLength": 128,
"pattern": "[ -~]+$",
"type": "string"
},
"prefix": {
"description": "Optional MSIN prefix digits that form a MCC+MNC+MSIN prefix digits string. An empty MSIN prefix digits (0 digits) is used to map MCC+MNC to configuration data. If MSIN prefix digits are specified, it maps MCC+MNC+MSIN prefix digits to configuration data.",
"pattern": "^[0-9]{0,10}$",
"type": "integer"
},
"realm": {
"description": "Diameter Realm that is associated with the MCC+MNC+optional MSIN prefix digits. Realm is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes (-) and underscore (_). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and a Realm must be at most 255 characters long.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
}
},
"required": [
"mcc",
"mnc"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"ccndc": 34,
"country": "Greece",
"description": "Test",
"mcc": "202",
"mnc": "01",
"networkname": "Cosmote",
"prefix": 5,
"realm": "realm.com"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/mccmncmappings/{MCC}
Updates the configuration for the specified MccMnc mapping. If the provided MccMnc mapping data is invalid in any way, the update will fail, resulting in an error message returned within the HTTP response.
Target Server: NOAM
Secured by x-other
Request
URI Parameters
- MCC: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/mccmncmapping/mccmncmapping.json",
"properties": {
"ccndc": {
"description": "Country Code (CC) plus National Destination Code (NDC) that is associated with the MCC+MNC+optional MSIN prefix digits.",
"pattern": "^[0-9]{0,15}$",
"type": "integer"
},
"country": {
"description": "Country Name corresponding to the MCC",
"maxLength": 128,
"pattern": "^[ -~]+$",
"type": "string"
},
"description": {
"description": "Optional description/note.",
"maxLength": 255,
"pattern": "^[ -~]+$",
"type": "string"
},
"mcc": {
"description": "Mobile Country Code",
"maxLength": 3,
"pattern": "^[0-9]{3}$",
"type": "string"
},
"mccMncMappingId": {
"description": "The natural identifier for the mcc mapping instance. It is a combination of mcc, mnc and prefix field values.",
"readOnly": true,
"type": "string"
},
"mnc": {
"description": "Mobile Network Code",
"maxLength": 3,
"pattern": "^[0-9]{2,3}$",
"type": "string"
},
"networkname": {
"description": "Network Name corresponding to the MNC",
"maxLength": 128,
"pattern": "[ -~]+$",
"type": "string"
},
"prefix": {
"description": "Optional MSIN prefix digits that form a MCC+MNC+MSIN prefix digits string. An empty MSIN prefix digits (0 digits) is used to map MCC+MNC to configuration data. If MSIN prefix digits are specified, it maps MCC+MNC+MSIN prefix digits to configuration data.",
"pattern": "^[0-9]{0,10}$",
"type": "integer"
},
"realm": {
"description": "Diameter Realm that is associated with the MCC+MNC+optional MSIN prefix digits. Realm is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes (-) and underscore (_). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and a Realm must be at most 255 characters long.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
}
},
"required": [
"mcc",
"mnc"
],
"type": "object"
}
Example
{
"ccndc": 34,
"country": "Greece",
"description": "Test",
"mcc": "202",
"mnc": "01",
"networkname": "Cosmote",
"prefix": 5,
"realm": "realm.com"
}
delete /diameter/mccmncmappings/{MCC}
Deletes the specified MccMnc mapped data from the NOAM configuration. A MccMnc mapped data will only be deleted if all delete validation checks pass.
Target Server: NOAM
Secured by x-other
Request
URI Parameters
- MCC: required (string)
Diameter: MCCMNC
Allows user to access MccMnc table and its associated attributes.
All MccMnc is done at the NOAM.
/diameter/mccmncs
get /diameter/mccmncs
Returns all MccMnc Table configured at the NOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those MccMnc Tables meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section).
Target Server: NOAM
Secured by x-other
Request
Query Parameters
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/mccmncCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/mccmnc/mccmnc.json",
"properties": {
"country": {
"description": "Country Name corresponding to the MCC.",
"maxLength": 128,
"pattern": "^[ -~]+$",
"type": "string"
},
"mcc": {
"description": "Mobile Country Code.",
"maxLength": 3,
"pattern": "^[0-9]{3}$",
"type": "string"
},
"mccMncId": {
"description": "The natural identifier for the mcc mnc instance. It is combination of mcc and mnc field values.",
"readOnly": true,
"type": "string"
},
"mnc": {
"description": "Mobile Network Code.",
"maxLength": 3,
"pattern": "^[0-9]{2,3}$",
"type": "string"
},
"networkname": {
"description": "Network Name corresponding to the MNC.",
"maxLength": 128,
"pattern": "[ -~]+$",
"type": "string"
}
},
"required": [
"country",
"mcc",
"mnc",
"networkname"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"country": "Greece",
"mcc": "202",
"mnc": "01",
"networkname": "Cosmote"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/mccmncs
Adds a new MccMnc Table to the Diameter configuration. The new MccMnc Table must have a Mnc that is unique to the NOAM's configuration.
Target Server: NOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/mccmnc/mccmnc.json",
"properties": {
"country": {
"description": "Country Name corresponding to the MCC.",
"maxLength": 128,
"pattern": "^[ -~]+$",
"type": "string"
},
"mcc": {
"description": "Mobile Country Code.",
"maxLength": 3,
"pattern": "^[0-9]{3}$",
"type": "string"
},
"mccMncId": {
"description": "The natural identifier for the mcc mnc instance. It is combination of mcc and mnc field values.",
"readOnly": true,
"type": "string"
},
"mnc": {
"description": "Mobile Network Code.",
"maxLength": 3,
"pattern": "^[0-9]{2,3}$",
"type": "string"
},
"networkname": {
"description": "Network Name corresponding to the MNC.",
"maxLength": 128,
"pattern": "[ -~]+$",
"type": "string"
}
},
"required": [
"country",
"mcc",
"mnc",
"networkname"
],
"type": "object"
}
Example
{
"country": "Greece",
"mcc": "202",
"mnc": "01",
"networkname": "Cosmote"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/mccmncs/{name}
get /diameter/mccmncs/{name}
Returns the configuration details for the specified MccMnc combination. If the specified MccMnc does not exist in the NOAM's configuration, an error message is returned within the HTTP response.
Target Server: NOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/mccmncItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/mccmnc/mccmnc.json",
"properties": {
"country": {
"description": "Country Name corresponding to the MCC.",
"maxLength": 128,
"pattern": "^[ -~]+$",
"type": "string"
},
"mcc": {
"description": "Mobile Country Code.",
"maxLength": 3,
"pattern": "^[0-9]{3}$",
"type": "string"
},
"mccMncId": {
"description": "The natural identifier for the mcc mnc instance. It is combination of mcc and mnc field values.",
"readOnly": true,
"type": "string"
},
"mnc": {
"description": "Mobile Network Code.",
"maxLength": 3,
"pattern": "^[0-9]{2,3}$",
"type": "string"
},
"networkname": {
"description": "Network Name corresponding to the MNC.",
"maxLength": 128,
"pattern": "[ -~]+$",
"type": "string"
}
},
"required": [
"country",
"mcc",
"mnc",
"networkname"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"country": "Greece",
"mcc": "202",
"mnc": "01",
"networkname": "Cosmote"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/mccmncs/{name}
Updates the configuration for the specified MccMnc combination. If the provided MccMnc data is invalid in any way, the update will fail, resulting in an error message returned within the HTTP response.
Target Server: NOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/mccmnc/mccmnc.json",
"properties": {
"country": {
"description": "Country Name corresponding to the MCC.",
"maxLength": 128,
"pattern": "^[ -~]+$",
"type": "string"
},
"mcc": {
"description": "Mobile Country Code.",
"maxLength": 3,
"pattern": "^[0-9]{3}$",
"type": "string"
},
"mccMncId": {
"description": "The natural identifier for the mcc mnc instance. It is combination of mcc and mnc field values.",
"readOnly": true,
"type": "string"
},
"mnc": {
"description": "Mobile Network Code.",
"maxLength": 3,
"pattern": "^[0-9]{2,3}$",
"type": "string"
},
"networkname": {
"description": "Network Name corresponding to the MNC.",
"maxLength": 128,
"pattern": "[ -~]+$",
"type": "string"
}
},
"required": [
"country",
"mcc",
"mnc",
"networkname"
],
"type": "object"
}
Example
{
"country": "Greece",
"mcc": "202",
"mnc": "01",
"networkname": "Cosmote"
}
delete /diameter/mccmncs/{name}
Deletes the specified MccMnc combination from the NOAM configuration. A MccMnc data will only be deleted if all delete validation checks pass.
Target Server: NOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Diameter: Message Copy Configuration Sets
Message Copy Configuration Sets provide a mechanism for determining which Diameter messages are copied and forwarded to a Diameter Application Server (DAS). The configuration set can be configured to copy request messages and, optionally, associated answer messages; the result-code/experimental result code on which the message copy is initiated; and the number of retries (up to four) to make if the message copy attempt to the Diameter Application Server fails.
The Message Copy Configuration Set named Default is always available. The Default Message Copy Configuration Set can be modified, but it cannot be deleted.
All Message Copy Configuration Set configuration is done at the SOAM.
/diameter/messagecopyconfigurationsets
get /diameter/messagecopyconfigurationsets
Returns all Message Copy Configuration Sets configured at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those Message Copy Configuration Sets meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section).
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/messagecopyconfigurationsetCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/messagecopyconfigurationset/messagecopyconfigurationset.json",
"properties": {
"answerIncluded": {
"description": "If true, and if this rule matches a request, the ingress answer message received in response to a Diameter message is also copied to the Diameter Application Server. Typical value is false.",
"type": "boolean"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"dasAnswerResultCode": {
"description": "The egress message code that should match with the ingress answer message copied to the server. Typical value is 2xxx.",
"enum": [
"2xxx",
"Any"
],
"type": "string"
},
"maxRetryAttempts": {
"description": "The maximum number of retransmission attempts for a Diameter Application Server request. A value of zero indicates there are no retransmission attempts after the first copy attempt. No more than four attempts can be made. Typical value is 0.",
"maximum": 4,
"minimum": 0,
"type": "integer"
},
"name": {
"description": "Name for the Message Copy Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"originalAnswerResultCode": {
"description": "The ingress answer message code that should match with the egress message copied to the server. Typical value is 2xxx.",
"enum": [
"2xxx",
"Any"
],
"type": "string"
},
"requestType": {
"description": "The type of request to copy can be either ingress or egress. Typical value is Ingress.",
"enum": [
"Egress",
"Ingress"
],
"type": "string"
},
"routeListName": {
"description": "The name of the Route List (/diameter/routelists) associated with this rule. A valid routeListName is required to copy a message to a Diameter Application Server.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"answerIncluded",
"dasAnswerResultCode",
"maxRetryAttempts",
"name",
"originalAnswerResultCode",
"requestType"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"answerIncluded": false,
"configurationLevel": "0",
"dasAnswerResultCode": "2xxx",
"maxRetryAttempts": 1,
"name": "MessageCopyConfigurationSet1",
"originalAnswer": "2xxx",
"requestType": "Ingress",
"routeListName": "RL6201"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/messagecopyconfigurationsets
Adds a new Message Copy Configuration Set to the DSR configuration. The Message Copy Configuration Set must have a name that is unique across all Message Copy Configuration Sets at the SOAM.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/messagecopyconfigurationset/messagecopyconfigurationset.json",
"properties": {
"answerIncluded": {
"description": "If true, and if this rule matches a request, the ingress answer message received in response to a Diameter message is also copied to the Diameter Application Server. Typical value is false.",
"type": "boolean"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"dasAnswerResultCode": {
"description": "The egress message code that should match with the ingress answer message copied to the server. Typical value is 2xxx.",
"enum": [
"2xxx",
"Any"
],
"type": "string"
},
"maxRetryAttempts": {
"description": "The maximum number of retransmission attempts for a Diameter Application Server request. A value of zero indicates there are no retransmission attempts after the first copy attempt. No more than four attempts can be made. Typical value is 0.",
"maximum": 4,
"minimum": 0,
"type": "integer"
},
"name": {
"description": "Name for the Message Copy Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"originalAnswerResultCode": {
"description": "The ingress answer message code that should match with the egress message copied to the server. Typical value is 2xxx.",
"enum": [
"2xxx",
"Any"
],
"type": "string"
},
"requestType": {
"description": "The type of request to copy can be either ingress or egress. Typical value is Ingress.",
"enum": [
"Egress",
"Ingress"
],
"type": "string"
},
"routeListName": {
"description": "The name of the Route List (/diameter/routelists) associated with this rule. A valid routeListName is required to copy a message to a Diameter Application Server.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"answerIncluded",
"dasAnswerResultCode",
"maxRetryAttempts",
"name",
"originalAnswerResultCode",
"requestType"
],
"type": "object"
}
Example
{
"answerIncluded": false,
"configurationLevel": "0",
"dasAnswerResultCode": "2xxx",
"maxRetryAttempts": 1,
"name": "MessageCopyConfigurationSet1",
"originalAnswer": "2xxx",
"requestType": "Ingress",
"routeListName": "RL6201"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/messagecopyconfigurationsets/{name}
get /diameter/messagecopyconfigurationsets/{name}
Returns the configuration details for the specified Message Copy Configuration Set. If the Message Copy Configuration Set does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/messagecopyconfigurationsetItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/messagecopyconfigurationset/messagecopyconfigurationset.json",
"properties": {
"answerIncluded": {
"description": "If true, and if this rule matches a request, the ingress answer message received in response to a Diameter message is also copied to the Diameter Application Server. Typical value is false.",
"type": "boolean"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"dasAnswerResultCode": {
"description": "The egress message code that should match with the ingress answer message copied to the server. Typical value is 2xxx.",
"enum": [
"2xxx",
"Any"
],
"type": "string"
},
"maxRetryAttempts": {
"description": "The maximum number of retransmission attempts for a Diameter Application Server request. A value of zero indicates there are no retransmission attempts after the first copy attempt. No more than four attempts can be made. Typical value is 0.",
"maximum": 4,
"minimum": 0,
"type": "integer"
},
"name": {
"description": "Name for the Message Copy Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"originalAnswerResultCode": {
"description": "The ingress answer message code that should match with the egress message copied to the server. Typical value is 2xxx.",
"enum": [
"2xxx",
"Any"
],
"type": "string"
},
"requestType": {
"description": "The type of request to copy can be either ingress or egress. Typical value is Ingress.",
"enum": [
"Egress",
"Ingress"
],
"type": "string"
},
"routeListName": {
"description": "The name of the Route List (/diameter/routelists) associated with this rule. A valid routeListName is required to copy a message to a Diameter Application Server.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"answerIncluded",
"dasAnswerResultCode",
"maxRetryAttempts",
"name",
"originalAnswerResultCode",
"requestType"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"answerIncluded": false,
"configurationLevel": "0",
"dasAnswerResultCode": "2xxx",
"maxRetryAttempts": 1,
"name": "MessageCopyConfigurationSet1",
"originalAnswer": "2xxx",
"requestType": "Ingress",
"routeListName": "RL6201"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/messagecopyconfigurationsets/{name}
Updates the configuration of the specified Message Copy Configuration Set.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/messagecopyconfigurationset/messagecopyconfigurationset.json",
"properties": {
"answerIncluded": {
"description": "If true, and if this rule matches a request, the ingress answer message received in response to a Diameter message is also copied to the Diameter Application Server. Typical value is false.",
"type": "boolean"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"dasAnswerResultCode": {
"description": "The egress message code that should match with the ingress answer message copied to the server. Typical value is 2xxx.",
"enum": [
"2xxx",
"Any"
],
"type": "string"
},
"maxRetryAttempts": {
"description": "The maximum number of retransmission attempts for a Diameter Application Server request. A value of zero indicates there are no retransmission attempts after the first copy attempt. No more than four attempts can be made. Typical value is 0.",
"maximum": 4,
"minimum": 0,
"type": "integer"
},
"name": {
"description": "Name for the Message Copy Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"originalAnswerResultCode": {
"description": "The ingress answer message code that should match with the egress message copied to the server. Typical value is 2xxx.",
"enum": [
"2xxx",
"Any"
],
"type": "string"
},
"requestType": {
"description": "The type of request to copy can be either ingress or egress. Typical value is Ingress.",
"enum": [
"Egress",
"Ingress"
],
"type": "string"
},
"routeListName": {
"description": "The name of the Route List (/diameter/routelists) associated with this rule. A valid routeListName is required to copy a message to a Diameter Application Server.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"answerIncluded",
"dasAnswerResultCode",
"maxRetryAttempts",
"name",
"originalAnswerResultCode",
"requestType"
],
"type": "object"
}
Example
{
"answerIncluded": false,
"configurationLevel": "0",
"dasAnswerResultCode": "2xxx",
"maxRetryAttempts": 1,
"name": "MessageCopyConfigurationSet1",
"originalAnswer": "2xxx",
"requestType": "Ingress",
"routeListName": "RL6201"
}
delete /diameter/messagecopyconfigurationsets/{name}
Deletes the specified Message Copy Configuration Set from the SOAM configuration. The Default Message Copy Configuration Set cannot be deleted. A Message Copy Configuration Set can only be deleted if all delete validation checks pass. In general, if the Message Copy Configuration Set is a part of some other Managed Object, the Message Copy Configuration Set cannot be deleted. For example, if the Message Copy Configuration Set is named by a Peer Route Rule (/diameter/peerrouterules), the Message Copy Configuration Set must first be removed from Peer Route Rule. Then the Message Copy Configuration Set can be deleted from the configuration. An attempt to delete a Message Copy Configuration Set that cannot be deleted results in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Diameter: Message Priority Configuration Sets
A Message Priority Configuration Set provides a way to control how message priority is set for a request message arriving on a Diameter Connection (/diameter/connections). A Message Priority Configuration Set contains one or more Message Priority Rules.
A Message Priority Rule consists of an Application Id (/diameter/applicationids), Command Code (/diameter/commandcodes), and a priority. Ingress messages matching the Application Id and Command Code are assigned the associated priority.
The Message Priority Configuration Set named Default is always available; it can be modified, but it cannot be deleted.
All configuration of Message Priority Configuration Sets is done at the SOAM.
/diameter/messagepriorityconfigurationsets
get /diameter/messagepriorityconfigurationsets
Returns all Message Priority Configuration Sets configured at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those Message Priority Configuration Sets meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section).
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/messagepriorityconfigurationsetCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/messagepriorityconfigurationset/messagepriorityconfigurationset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"messagePriorityRule": {
"description": "The rules associated with this Message Priority Configuration Set. Each rule is defined by appId, cmdCode, and msgPriority.",
"items": {
"properties": {
"appId": {
"description": "appId defines the Diameter Application Id (/diameter/applicationids) to which this rule applies. Whenever the Message Priority Configuration Set is used, the DSR routes request messages, whose Application Id matches the appId and cmdCode values in this rule according to the priority configured in the rule. The value must be an integer in the range 0-4294967295. To include all Application Ids in this rule, set ruleAppliesToAllAppIds to true, and the value for appId is ignored.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"cmdCode": {
"description": "Identifies the Command Code (/diameter/commandcodes) that must be present in an ingress Diameter message (having an Application Id (/diameter/applicationids) value of appId) for this rule to match. The Command Code is an integer (represented as a string), while Extended Command Codes are of the format X.Y.Z, where X is a Command Code; Y and Z are 32-bit unassigned integers; and the dots are literal. To include all Command Codes in this rule, supply the string 'All'.",
"maxLength": 30,
"type": "string"
},
"priority": {
"description": "The priority given to an ingress Diameter message where the Application Id (/diameter/applicationids) and Command Code (/diameter/commandcodes) match the appId and cmdCode values, respectively. The value assigned to priority cannot exceed the ngnPsMaxNormalRequestPriority value (/diameter/options).",
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"ruleAppliesToAllAppIds": {
"description": "When set to true, this Message Priority Rule applies to all Application Ids (/diameter/applicationids), and DSR ignores the specific appId value for this rule.",
"type": "boolean"
}
},
"required": [
"cmdCode",
"priority",
"ruleAppliesToAllAppIds"
],
"type": "object"
},
"maxItems": 50,
"minItems": 1,
"type": "array"
},
"name": {
"description": "Name for the Message Priority Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"name",
"messagePriorityRule"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"configurationLevel": "55555",
"messagePriorityRule": [
{
"appId": 4294967295,
"cmdCode": "258",
"priority": 0,
"ruleAppliesToAllAppIds": false
}, {
"appId": 4,
"cmdCode": "258.258.0",
"priority": 1,
"ruleAppliesToAllAppIds": false
}, {
"appId": 16777216,
"cmdCode": "8388655",
"priority": 2,
"ruleAppliesToAllAppIds": false
}, {
"cmdCode": "All",
"priority": 1,
"ruleAppliesToAllAppIds": true
}
],
"name": "MessagePriorityConfigurationSet1"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/messagepriorityconfigurationsets
Adds a new Message Priority Configuration Set to the DSR configuration. The new Message Priority Configuration Set name must be unique across all Message Priority Configuration Sets at the SOAM.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/messagepriorityconfigurationset/messagepriorityconfigurationset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"messagePriorityRule": {
"description": "The rules associated with this Message Priority Configuration Set. Each rule is defined by appId, cmdCode, and msgPriority.",
"items": {
"properties": {
"appId": {
"description": "appId defines the Diameter Application Id (/diameter/applicationids) to which this rule applies. Whenever the Message Priority Configuration Set is used, the DSR routes request messages, whose Application Id matches the appId and cmdCode values in this rule according to the priority configured in the rule. The value must be an integer in the range 0-4294967295. To include all Application Ids in this rule, set ruleAppliesToAllAppIds to true, and the value for appId is ignored.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"cmdCode": {
"description": "Identifies the Command Code (/diameter/commandcodes) that must be present in an ingress Diameter message (having an Application Id (/diameter/applicationids) value of appId) for this rule to match. The Command Code is an integer (represented as a string), while Extended Command Codes are of the format X.Y.Z, where X is a Command Code; Y and Z are 32-bit unassigned integers; and the dots are literal. To include all Command Codes in this rule, supply the string 'All'.",
"maxLength": 30,
"type": "string"
},
"priority": {
"description": "The priority given to an ingress Diameter message where the Application Id (/diameter/applicationids) and Command Code (/diameter/commandcodes) match the appId and cmdCode values, respectively. The value assigned to priority cannot exceed the ngnPsMaxNormalRequestPriority value (/diameter/options).",
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"ruleAppliesToAllAppIds": {
"description": "When set to true, this Message Priority Rule applies to all Application Ids (/diameter/applicationids), and DSR ignores the specific appId value for this rule.",
"type": "boolean"
}
},
"required": [
"cmdCode",
"priority",
"ruleAppliesToAllAppIds"
],
"type": "object"
},
"maxItems": 50,
"minItems": 1,
"type": "array"
},
"name": {
"description": "Name for the Message Priority Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"name",
"messagePriorityRule"
],
"type": "object"
}
Example
{
"configurationLevel": "55555",
"messagePriorityRule": [
{
"appId": 4294967295,
"cmdCode": "258",
"priority": 0,
"ruleAppliesToAllAppIds": false
}, {
"appId": 4,
"cmdCode": "258.258.0",
"priority": 1,
"ruleAppliesToAllAppIds": false
}, {
"appId": 16777216,
"cmdCode": "8388655",
"priority": 2,
"ruleAppliesToAllAppIds": false
}, {
"cmdCode": "All",
"priority": 1,
"ruleAppliesToAllAppIds": true
}
],
"name": "MessagePriorityConfigurationSet1"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/messagepriorityconfigurationsets/{name}
get /diameter/messagepriorityconfigurationsets/{name}
Returns the configuration details for the specified Message Priority Configuration Set. If the Message Priority Configuration Set does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/messagepriorityconfigurationsetItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/messagepriorityconfigurationset/messagepriorityconfigurationset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"messagePriorityRule": {
"description": "The rules associated with this Message Priority Configuration Set. Each rule is defined by appId, cmdCode, and msgPriority.",
"items": {
"properties": {
"appId": {
"description": "appId defines the Diameter Application Id (/diameter/applicationids) to which this rule applies. Whenever the Message Priority Configuration Set is used, the DSR routes request messages, whose Application Id matches the appId and cmdCode values in this rule according to the priority configured in the rule. The value must be an integer in the range 0-4294967295. To include all Application Ids in this rule, set ruleAppliesToAllAppIds to true, and the value for appId is ignored.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"cmdCode": {
"description": "Identifies the Command Code (/diameter/commandcodes) that must be present in an ingress Diameter message (having an Application Id (/diameter/applicationids) value of appId) for this rule to match. The Command Code is an integer (represented as a string), while Extended Command Codes are of the format X.Y.Z, where X is a Command Code; Y and Z are 32-bit unassigned integers; and the dots are literal. To include all Command Codes in this rule, supply the string 'All'.",
"maxLength": 30,
"type": "string"
},
"priority": {
"description": "The priority given to an ingress Diameter message where the Application Id (/diameter/applicationids) and Command Code (/diameter/commandcodes) match the appId and cmdCode values, respectively. The value assigned to priority cannot exceed the ngnPsMaxNormalRequestPriority value (/diameter/options).",
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"ruleAppliesToAllAppIds": {
"description": "When set to true, this Message Priority Rule applies to all Application Ids (/diameter/applicationids), and DSR ignores the specific appId value for this rule.",
"type": "boolean"
}
},
"required": [
"cmdCode",
"priority",
"ruleAppliesToAllAppIds"
],
"type": "object"
},
"maxItems": 50,
"minItems": 1,
"type": "array"
},
"name": {
"description": "Name for the Message Priority Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"name",
"messagePriorityRule"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"configurationLevel": "55555",
"messagePriorityRule": [
{
"appId": 4294967295,
"cmdCode": "258",
"priority": 0,
"ruleAppliesToAllAppIds": false
}, {
"appId": 4,
"cmdCode": "258.258.0",
"priority": 1,
"ruleAppliesToAllAppIds": false
}, {
"appId": 16777216,
"cmdCode": "8388655",
"priority": 2,
"ruleAppliesToAllAppIds": false
}, {
"cmdCode": "All",
"priority": 1,
"ruleAppliesToAllAppIds": true
}
],
"name": "MessagePriorityConfigurationSet1"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/messagepriorityconfigurationsets/{name}
Updates the configuration of the specified Message Priority Configuration Set.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/messagepriorityconfigurationset/messagepriorityconfigurationset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"messagePriorityRule": {
"description": "The rules associated with this Message Priority Configuration Set. Each rule is defined by appId, cmdCode, and msgPriority.",
"items": {
"properties": {
"appId": {
"description": "appId defines the Diameter Application Id (/diameter/applicationids) to which this rule applies. Whenever the Message Priority Configuration Set is used, the DSR routes request messages, whose Application Id matches the appId and cmdCode values in this rule according to the priority configured in the rule. The value must be an integer in the range 0-4294967295. To include all Application Ids in this rule, set ruleAppliesToAllAppIds to true, and the value for appId is ignored.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"cmdCode": {
"description": "Identifies the Command Code (/diameter/commandcodes) that must be present in an ingress Diameter message (having an Application Id (/diameter/applicationids) value of appId) for this rule to match. The Command Code is an integer (represented as a string), while Extended Command Codes are of the format X.Y.Z, where X is a Command Code; Y and Z are 32-bit unassigned integers; and the dots are literal. To include all Command Codes in this rule, supply the string 'All'.",
"maxLength": 30,
"type": "string"
},
"priority": {
"description": "The priority given to an ingress Diameter message where the Application Id (/diameter/applicationids) and Command Code (/diameter/commandcodes) match the appId and cmdCode values, respectively. The value assigned to priority cannot exceed the ngnPsMaxNormalRequestPriority value (/diameter/options).",
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"ruleAppliesToAllAppIds": {
"description": "When set to true, this Message Priority Rule applies to all Application Ids (/diameter/applicationids), and DSR ignores the specific appId value for this rule.",
"type": "boolean"
}
},
"required": [
"cmdCode",
"priority",
"ruleAppliesToAllAppIds"
],
"type": "object"
},
"maxItems": 50,
"minItems": 1,
"type": "array"
},
"name": {
"description": "Name for the Message Priority Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"name",
"messagePriorityRule"
],
"type": "object"
}
Example
{
"configurationLevel": "55555",
"messagePriorityRule": [
{
"appId": 4294967295,
"cmdCode": "258",
"priority": 0,
"ruleAppliesToAllAppIds": false
}, {
"appId": 4,
"cmdCode": "258.258.0",
"priority": 1,
"ruleAppliesToAllAppIds": false
}, {
"appId": 16777216,
"cmdCode": "8388655",
"priority": 2,
"ruleAppliesToAllAppIds": false
}, {
"cmdCode": "All",
"priority": 1,
"ruleAppliesToAllAppIds": true
}
],
"name": "MessagePriorityConfigurationSet1"
}
delete /diameter/messagepriorityconfigurationsets/{name}
Deletes the specified Message Priority Configuration Set from the SOAM configuration. The Default Message Priority Configuration Set cannot be deleted. A Message Priority Configuration Set can only be deleted if all delete validation checks pass. In general, if the Message Priority Configuration Set is part of the configuration of one or more Connections (/diameter/connections) or Peer Nodes (/diameter/peernodes), the Message Priority Configuration Set cannot be deleted. If the Message Priority Configuration Set is named in a Connection or Peer Node, the Message Priority Configuration Set must first be removed from the Connection or Peer Node. Then the Message Priority Configuration Set can be deleted from the configuration. An attempt to delete a Message Priority Configuration Set that cannot be deleted results in an error message returned within the HTTP response.
Target Set: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Diameter: MP Profile Assignments
An MP Profile is a set of parameters that defines certain capacity and performance characteristics to the software running on the MP, effectively tuning the MP for a specific application and deployment environment. Each DA-MP or SS7-MP server must have a Profile assigned before it can fulfill its role within the DSR. When an MP is first added to a DSR, it has no Profile assigned, and does not come up successfully until a Profile has been assigned and the MP is restarted. If the assigned Profile of a running MP is ever changed, the new Profile does not take effect until the MP is restarted.
Unassigned MPs will default to a configurationLevel of 0. Attempting to filter based on configurationLevel will not return any unassigned MPs.
Assignment of MP Profiles is always done at the SOAM.
/diameter/mpprofileassignments
get /diameter/mpprofileassignments
Returns a list of all MPs configured at the SOAM and the MP Profile assigned to each. MPs that are configured, but for which no Profile has yet been assigned, appear in the response with the Unassigned profile.
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (one of configurationLevel)
The field being matched
Only the configurationLevel field is supported.
Example:
filter_name=configurationLevel
- filter_op: (one of GREATER_THAN, GREATER_THAN_EQUAL)
The match operation (operator)
Example:
filter_op=GREATER_THAN
- filter_values: (string)
The matched value
The configurationLevel value by which the data is being filtered. Only a single value is supported.
Example:
filter_values=10
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/mpprofileassignmentCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/mpprofileassignment/mpprofileassignment.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"hostname": {
"description": "The topology-assiged name for a DA-MP or SS7-MP Server.",
"type": "string"
},
"profileName": {
"type": "string",
"enum": ["Unassigned", "G6_Relay", "G8G9_Relay", "G7_Relay", "G6_Database", "G8G9_Database", "G7_Database", "G6_Session", "G8G9_Session", "G7_Session", "G6_Session_Database", "G8G9_Session_Database", "G7_Session_Database", "VM_Relay", "VM_Database", "UDRVM_Database", "G8G9_MDIWF", "VM_MDIWF", "VM_6K_Mps", "VM_8K_Mps", "VM_10K_Mps", "VM_12K_Mps", "VM_14K_Mps", "VM_16K_Mps", "VM_18K_Mps", "VM_21K_Mps", "VM_24K_Mps", "VM_27K_Mps", "VM_30K_Mps","Gen9V2_Relay","Gen9V2_Database","Gen9V2_Session"],
"description": "The specific MP Profile assigned to the MP server identified by hostname. Valid values are: Unassigned - the MP has not been assigned any Profile *** G6_Relay - G6 DA-MP half height blade running the relay application *** G8G9_Relay - G8/G9 DA-MP half height blade running the relay application *** G7_Relay - G7 DA-MP Full height blade running the relay application *** G6_Database - G6 DA-MP half height blade running relay and database applications *** G8G9_Database - G8/G9 DA-MP half height blade running relay and database applications *** G7_Database - G7 DA-MP Full height blade running relay and database applications *** G6_Session - G6 DA-MP half height blade running relay and session applications *** G8G9_Session - G8/G9 DA-MP half height blade running relay and session applications *** G7_Session - G7 DA-MP Full height blade running relay and session applications *** G6_Session_Database - G6 DA-MP half height blade running relay, session and database applications *** G8G9_Session_Database - G8/G9 DA-MP half height blade running relay, session and database applications *** G7_Session_Database - G7 DA-MP Full height blade running relay, session and database applications *** VM_Relay - Virtualized DA-MP on DL380 TVOE Guest running the relay application *** VM_Database - Virtualized DA-MP on DL380 TVOE Guest running relay and database applications *** UDRVM_Database - Virtualized MP running OCUDR application *** G8G9_MDIWF - G8/G9 half height blade performing MD-IWF application *** VM_MDIWF - Virtualized SS7-MP running MD-IWF application *** VM_6K_Mps - Virtualized DA-MP rated at 6K MPS for all configurations *** VM_8K_Mps - Virtualized DA-MP rated at 8K MPS for all configurations *** VM_10K_Mps - Virtualized DA-MP rated at 10K MPS for all configurations *** VM_12K_Mps - Virtualized DA-MP rated at 12K MPS for all configurations *** VM_14K_Mps - Virtualized DA-MP rated at 14K MPS for all configurations *** VM_16K_Mps - Virtualized DA-MP rated at 16K MPS for all configurations *** VM_18K_Mps - Virtualized DA-MP rated at 18K MPS for all configurations *** VM_21K_Mps - Virtualized DA-MP rated at 21K MPS for all configurations *** VM_24K_Mps - Virtualized DA-MP rated at 24K MPS for all configurations *** VM_27K_Mps - Virtualized DA-MP rated at 27K MPS for all configurations *** VM_30K_Mps - Virtualized DA-MP rated at 30K MPS for all configurations *** Gen9V2_Relay - G9v2 DA-MP blade running the relay application *** Gen9V2_Database - G9v2 DA-MP blade running relay and database applications *** Gen9V2_Session - G9v2 DA-MP blade running relay, database, and session applications "
}
},
"required": [
"hostname",
"profileName"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"configurationLevel": "56",
"hostname": "mpServer3",
"profileName": "G7_Session_Database"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
/diameter/mpprofileassignments/{hostname}
get /diameter/mpprofileassignments/{hostname}
Returns the name of the MP Profile assigned to the specified MP server identified by hostname (the name of the MP server configured in the topology, using /topo/servers). If the specified MP Server does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- hostname: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/mpprofileassignmentItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/mpprofileassignment/mpprofileassignment.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"hostname": {
"description": "The topology-assiged name for a DA-MP or SS7-MP Server.",
"type": "string"
},
"profileName": {
"type": "string",
"enum": ["Unassigned", "G6_Relay", "G8G9_Relay", "G7_Relay", "G6_Database", "G8G9_Database", "G7_Database", "G6_Session", "G8G9_Session", "G7_Session", "G6_Session_Database", "G8G9_Session_Database", "G7_Session_Database", "VM_Relay", "VM_Database", "UDRVM_Database", "G8G9_MDIWF", "VM_MDIWF", "VM_6K_Mps", "VM_8K_Mps", "VM_10K_Mps", "VM_12K_Mps", "VM_14K_Mps", "VM_16K_Mps", "VM_18K_Mps", "VM_21K_Mps", "VM_24K_Mps", "VM_27K_Mps", "VM_30K_Mps","Gen9V2_Relay","Gen9V2_Database","Gen9V2_Session"],
"description": "The specific MP Profile assigned to the MP server identified by hostname. Valid values are: Unassigned - the MP has not been assigned any Profile *** G6_Relay - G6 DA-MP half height blade running the relay application *** G8G9_Relay - G8/G9 DA-MP half height blade running the relay application *** G7_Relay - G7 DA-MP Full height blade running the relay application *** G6_Database - G6 DA-MP half height blade running relay and database applications *** G8G9_Database - G8/G9 DA-MP half height blade running relay and database applications *** G7_Database - G7 DA-MP Full height blade running relay and database applications *** G6_Session - G6 DA-MP half height blade running relay and session applications *** G8G9_Session - G8/G9 DA-MP half height blade running relay and session applications *** G7_Session - G7 DA-MP Full height blade running relay and session applications *** G6_Session_Database - G6 DA-MP half height blade running relay, session and database applications *** G8G9_Session_Database - G8/G9 DA-MP half height blade running relay, session and database applications *** G7_Session_Database - G7 DA-MP Full height blade running relay, session and database applications *** VM_Relay - Virtualized DA-MP on DL380 TVOE Guest running the relay application *** VM_Database - Virtualized DA-MP on DL380 TVOE Guest running relay and database applications *** UDRVM_Database - Virtualized MP running OCUDR application *** G8G9_MDIWF - G8/G9 half height blade performing MD-IWF application *** VM_MDIWF - Virtualized SS7-MP running MD-IWF application *** VM_6K_Mps - Virtualized DA-MP rated at 6K MPS for all configurations *** VM_8K_Mps - Virtualized DA-MP rated at 8K MPS for all configurations *** VM_10K_Mps - Virtualized DA-MP rated at 10K MPS for all configurations *** VM_12K_Mps - Virtualized DA-MP rated at 12K MPS for all configurations *** VM_14K_Mps - Virtualized DA-MP rated at 14K MPS for all configurations *** VM_16K_Mps - Virtualized DA-MP rated at 16K MPS for all configurations *** VM_18K_Mps - Virtualized DA-MP rated at 18K MPS for all configurations *** VM_21K_Mps - Virtualized DA-MP rated at 21K MPS for all configurations *** VM_24K_Mps - Virtualized DA-MP rated at 24K MPS for all configurations *** VM_27K_Mps - Virtualized DA-MP rated at 27K MPS for all configurations *** VM_30K_Mps - Virtualized DA-MP rated at 30K MPS for all configurations *** Gen9V2_Relay - G9v2 DA-MP blade running the relay application *** Gen9V2_Database - G9v2 DA-MP blade running relay and database applications *** Gen9V2_Session - G9v2 DA-MP blade running relay, database, and session applications "
}
},
"required": [
"hostname",
"profileName"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"configurationLevel": "56",
"hostname": "mpServer3",
"profileName": "G7_Session_Database"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/mpprofileassignments/{hostname}
Updates the MP Profile assigned to the MP server identified by hostname (the name of the MP server configured in the topology using /topo/servers). If the specified MP server does not exist in the SOAM's configuration, or the provided MP Profile is not valid, the assignment fails, resulting in an error message returned within the HTTP response. Clients should never specify Unassigned as the Profile to be assigned, as unassigning a Profile from an MP is not a supported operation.
Secured by x-other
Request
URI Parameters
- hostname: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/mpprofileassignment/mpprofileassignment.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"hostname": {
"description": "The topology-assiged name for a DA-MP or SS7-MP Server.",
"type": "string"
},
"profileName": {
"type": "string",
"enum": ["Unassigned", "G6_Relay", "G8G9_Relay", "G7_Relay", "G6_Database", "G8G9_Database", "G7_Database", "G6_Session", "G8G9_Session", "G7_Session", "G6_Session_Database", "G8G9_Session_Database", "G7_Session_Database", "VM_Relay", "VM_Database", "UDRVM_Database", "G8G9_MDIWF", "VM_MDIWF", "VM_6K_Mps", "VM_8K_Mps", "VM_10K_Mps", "VM_12K_Mps", "VM_14K_Mps", "VM_16K_Mps", "VM_18K_Mps", "VM_21K_Mps", "VM_24K_Mps", "VM_27K_Mps", "VM_30K_Mps","Gen9V2_Relay","Gen9V2_Database","Gen9V2_Session"],
"description": "The specific MP Profile assigned to the MP server identified by hostname. Valid values are: Unassigned - the MP has not been assigned any Profile *** G6_Relay - G6 DA-MP half height blade running the relay application *** G8G9_Relay - G8/G9 DA-MP half height blade running the relay application *** G7_Relay - G7 DA-MP Full height blade running the relay application *** G6_Database - G6 DA-MP half height blade running relay and database applications *** G8G9_Database - G8/G9 DA-MP half height blade running relay and database applications *** G7_Database - G7 DA-MP Full height blade running relay and database applications *** G6_Session - G6 DA-MP half height blade running relay and session applications *** G8G9_Session - G8/G9 DA-MP half height blade running relay and session applications *** G7_Session - G7 DA-MP Full height blade running relay and session applications *** G6_Session_Database - G6 DA-MP half height blade running relay, session and database applications *** G8G9_Session_Database - G8/G9 DA-MP half height blade running relay, session and database applications *** G7_Session_Database - G7 DA-MP Full height blade running relay, session and database applications *** VM_Relay - Virtualized DA-MP on DL380 TVOE Guest running the relay application *** VM_Database - Virtualized DA-MP on DL380 TVOE Guest running relay and database applications *** UDRVM_Database - Virtualized MP running OCUDR application *** G8G9_MDIWF - G8/G9 half height blade performing MD-IWF application *** VM_MDIWF - Virtualized SS7-MP running MD-IWF application *** VM_6K_Mps - Virtualized DA-MP rated at 6K MPS for all configurations *** VM_8K_Mps - Virtualized DA-MP rated at 8K MPS for all configurations *** VM_10K_Mps - Virtualized DA-MP rated at 10K MPS for all configurations *** VM_12K_Mps - Virtualized DA-MP rated at 12K MPS for all configurations *** VM_14K_Mps - Virtualized DA-MP rated at 14K MPS for all configurations *** VM_16K_Mps - Virtualized DA-MP rated at 16K MPS for all configurations *** VM_18K_Mps - Virtualized DA-MP rated at 18K MPS for all configurations *** VM_21K_Mps - Virtualized DA-MP rated at 21K MPS for all configurations *** VM_24K_Mps - Virtualized DA-MP rated at 24K MPS for all configurations *** VM_27K_Mps - Virtualized DA-MP rated at 27K MPS for all configurations *** VM_30K_Mps - Virtualized DA-MP rated at 30K MPS for all configurations *** Gen9V2_Relay - G9v2 DA-MP blade running the relay application *** Gen9V2_Database - G9v2 DA-MP blade running relay and database applications *** Gen9V2_Session - G9v2 DA-MP blade running relay, database, and session applications "
}
},
"required": [
"hostname",
"profileName"
],
"type": "object"
}
Example
{
"configurationLevel": "56",
"hostname": "mpServer3",
"profileName": "G7_Session_Database"
}
Diameter: Options
Options (sometimes referred to as System Options) is a collection of parameters that govern various aspects of the DSR's operation. The parameters found here tend to relate to specific features of the DSR, rather than to any particular Managed Object. The Options fall into the following categories/features:
- General options (system-wide parameters not necessarily related to any one feature of DSR operation)
- Alarm Threshold options
- Message Copy options
- RADIUS UDP options
- Dynamic Peer Discovery options
- Priority Service options
There is a single instance of this resource, which contains all of the individual options that can be retrieved and set. Because there is no collection of instances, there is no collection GET action. No new Options resource can be created, so there is no POST action, and the single instance cannot be removed, so there is no DELETE action. The single instance GET is used to retrieve the options, and PUT is used to update one or more values within the set of options. A name for this single, non-deletable instance is neither required nor expected.
All Options configuration is done at the SOAM.
/diameter/options
get /diameter/options
Returns the set of current values for the Options.
Target Server: SOAM
Response
HTTP status code 200
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/optionItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/option/option.json",
"properties": {
"alarmBudget": {
"description": "The total number of alarms allowed in the alarm budget. This is a fixed value. The sum of (connMajorAggAlarmThreshold * # DA-MPs), ipfeConnMajorAggAlarmThreshold, peerNodeCriticalAggAlarmThreshold, and routeListCriticalAggAlarmThreshold cannot exceed alarmBudget.",
"readOnly": true,
"type": "integer"
},
"congestionDiscardPolicy": {
"description": "The order of priority and/or color-based traffic segments when determining which messages should continue routing and which should be diverted or discarded during times of congestion. Typical value is 2",
"enum": [0, 1, 2],
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"connCriticalAggAlarmThreshold": {
"description": "When the number of fixed Connection (/diameter/connections) failure alarms raised by a single DA-MP exceeds this threshold: 1) the already-raised major aggregate fixed Connection failure alarm for that DA-MP is cleared, and 2) a single aggregate fixed Connection failure alarm of critical severity is raised by the SOAM against that DA-MP. The value of connCriticalAggAlarmThreshold is not included in the available alarm budget. Set connCriticalAggAlarmThreshold to zero to prevent entirely the raising of a critical aggregate alarm for fixed Connection failures.",
"minimum": 0,
"type": "integer"
},
"connMajorAggAlarmThreshold": {
"description": "When the number of fixed Connection (/diameter/connections) failure alarms raised by a single DA-MP exceeds this threshold: 1) all individual fixed Connection failure alarms raised to that point are cleared, and 2) a single aggregate fixed Connection failure alarm of major severity is raised by the SOAM against that DA-MP. The value of connMajorAggAlarmThreshold is included in the available alarm budget, multiplied by the number of DA-MP in the DSR. So the sum of (connMajorAggAlarmThreshold * # DA-MPs), ipfeConnMajorAggAlarmThreshold, peerNodeCriticalAggAlarmThreshold, and routeListCriticalAggAlarmThreshold cannot exceed the alarm budget.",
"minimum": 1,
"type": "integer"
},
"connReservedIngressMpsScaling": {
"description": "Percent of DA-MP engineered Ingress MPS used by each DA-MP when validating the Reserved Ingress MPS for a newly received Connection (/diameter/connections). A newly received Connection is rejected if the total Connection Reserved Ingress MPS for fixed and already-established IPFE Connections would exceed the DA-MP's Engineering Ingress MPS, scaled by connReservedIngressMpsScaling. Typical value is 50.",
"readOnly": true,
"type": "integer"
},
"diameterEngMessageSize": {
"description": "The engineered message size of Diameter messages supported by the DSR.",
"readOnly": true,
"type": "integer"
},
"dpdRealmExpiryMajAlarmThresholdHrs": {
"description": "The time, in hours, before the expiration of a dynamically-discovered Realm, at which a major alarm is raised to indicate that Realm expiration is approaching. A value of zero means no major alarm is raised to alert of the pending Realm expiration. If both dpdRealmExpiryMinAlarmThresholdHrs and dpdRealmExpiryMajAlarmThresholdHrs are non-zero, the value for dpdRealmExpiryMinAlarmThresholdHrs must be greater than the value for dpdRealmExpiryMajAlarmThresholdHrs. Typical value is 1.",
"maximum": 167,
"minimum": 0,
"type": "integer"
},
"dpdRealmExpiryMinAlarmThresholdHrs": {
"description": "The time, in hours, before the expiration of a dynamically-discovered Realm, at which a minor alarm is raised to indicate that Realm expiration is approaching. A value of zero means no minor alarm is raised to alert of the pending Realm expiration. If both dpdRealmExpiryMinAlarmThresholdHrs and dpdRealmExpiryMajAlarmThresholdHrs are non-zero, the value for dpdRealmExpiryMinAlarmThresholdHrs must be greater than the value for dpdRealmExpiryMajAlarmThresholdHrs. Typical value is 6.",
"maximum": 168,
"minimum": 0,
"type": "integer"
},
"encodeFqdnInLowerCase": {
"description": "If false, FQDNs are encoded as configured. Otherwise, they are encoded in all lower case. Typical value is true.",
"type": "boolean"
},
"etgMode": {
"description": "Defines the type of message throttling that the system will support for all ETGs (/diameter/egressthrottlegroups). When set to Threshold (legacy mode), Requests are enforced based on the congestion level of the ETG. When set to Limit , the egress message rate is shaped according to the maximum message and pending transaction rate, the system discard policy, and the current mix of requests by message color and priority. Typical value is Threshold.",
"enum": [
"Threshold",
"Limit"
],
"type": "string"
},
"excessiveRerouteAbateThreshold": {
"description": "Excessive Reroute Alarm is cleared when percentage of sum of rerouted messages due to Answer Response and/or Answer Timeout to the total requests forwarded is less than excessiveRerouteAbateThreshold for configured Abatement Time. Typical value is 15.",
"maximum": 99,
"minimum": 0,
"type": "integer"
},
"excessiveRerouteOnsetThreshold": {
"description": "Excessive Reroute Alarm is raised when percentage of sum of rerouted messages due to Answer Response and/or Answer Timeout to the total requests forwarded exceeds the excessiveRerouteOnsetThreshold value. Typical value is 20.",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"ipfeConnCriticalAggAlarmThreshold": {
"description": "When the number of IPFE (floating) Connection (/diameter/connections) failure alarms raised exceeds this threshold: 1) the already-raised major aggregate IPFE Connection failure alarm is cleared, and 2) a single aggregate IPFE Connection failure alarm of critical severity is raised by the SOAM. The value of ipfeCriticalAggAlarmThreshold is not included in the available alarm budget. Set ipfeCriticalAggAlarmThreshold to zero to prevent entirely the raising of a critical aggregate alarm for IPFE Connection failures.",
"minimum": 0,
"type": "integer"
},
"ipfeConnMajorAggAlarmThreshold": {
"description": "When the number of IPFE (floating) Connection (/diameter/connections) failure alarms exceeds this threshold: 1) all individual IPFE Connection failure alarms raised to that point are cleared, and 2) a single aggregate IPFE Connection failure alarm of major severity is raised by the SOAM. The value of ipfeMajorAggAlarmThreshold is included in the available alarm budget. So the sum of (connMajorAggAlarmThreshold * # DA-MPs), ipfeConnMajorAggAlarmThreshold, peerNodeCriticalAggAlarmThreshold, and routeListCriticalAggAlarmThreshold cannot exceed the alarm budget.",
"minimum": 1,
"type": "integer"
},
"msgCopyDisableCongLevel": {
"description": "If a MP is at or above the congestion level specified by msgCopyDisableCongLevel, the message copy functionality is disabled on that MP. Typical value is Cl1.",
"enum": [
"Cl1",
"Cl2"
],
"type": "string"
},
"msgCopyFeatureEnabled": {
"description": "When set to true, the message copy feature is enabled for the DSR. When set to false, the message copy feature is disabled. Typical value is false.",
"type": "boolean"
},
"ngnPs16PriorityAdminStateEnabled": {
"description": "When set to true, system will support 16 internal message priorities (0-15). When set to false, system will support 5 internal message priorities (0-4).",
"type": "boolean"
},
"ngnPsAdminStateEnabled": {
"description": "When set to true, DSR provides NGN-PS treatment to applicable messages. When set to false, the NGN-PS feature is disabled. Typical value is false.",
"type": "boolean"
},
"ngnPsAnswerPriorityMode": {
"description": "Used for assigning priority to Answer messages. When set to HighestPriority, Answers have the highest priority (or 1 lower than Highest when ngnPsAdminStateEnabled is set to true. When this method is selected, DRMP AVPs in Answer messages are ignored. When set to RequestPriority, Answers have the same priority as Requests.",
"enum": [
"HighestPriority",
"RequestPriority"
],
"type": "string"
},
"ngnPsCxAdminStateEnabled": {
"description": "When set to true, the NGN-PS feature is enabled for Cx/Dx messages. When set to false, DSR does not provide NGN-PS treatment to Cx/Dx messages. ngnPsCxAdminStateEnabled is superseded by ngnPsAdminStateEnabled; if ngnPsAdminStateEnabled is false, no Cx/Dx messages is provided NGN-PS treatment even if ngnPsCxAdminStateEnabled is true. Typical value is false.",
"type": "boolean"
},
"ngnPsDhAdminStateEnabled": {
"description": "When set to true, the NGN-PS feature is enabled for Dh/Sh messages. When set to false, DSR is not provided NGN-PS treatment to Dh/Sh messages. ngnPsDhAdminStateEnabled is superseded by ngnPsAdminStateEnabled; if ngnPsAdminStateEnabled is false, no Dh/Sh messages is provided NGN-PS treatment even if ngnPsDhAdminStateEnabled is true. Typical value is false.",
"type": "boolean"
},
"ngnPsGxAdminStateEnabled": {
"description": "When set to true, the NGN-PS feature is enabled for Gx messages. When set to false, DSR is not provided NGN-PS treatment to Gx messages. ngnPsGxAdminStateEnabled is superseded by ngnPsAdminStateEnabled; if ngnPsAdminStateEnabled is false, no Gx messages is provided NGN-PS treatment even if ngnPsGxAdminStateEnabled is true. Typical value is false.",
"type": "boolean"
},
"ngnPsGxAdvancedPriority": {
"description": "The Access Network priority provided to NGN-PS subscribed user equipment. Affects the tagging of Gx CCR messages for NGN-PS treatment. Not applicable if ngnPsGxAdminStateEnabled is false.",
"enum": [
"Hss",
"None",
"Spr"
],
"type": "string"
},
"ngnPsGxArp": {
"description": "List of up to five priority levels contained in Gx messages which can be treated as NGN-PS messages. Each array element must be an integer between 1 and 15, inclusive. Not applicable if ngnPsGxAdminStateEnabled is false.",
"items": {
"maximum": 15,
"minimum": 1,
"type": "integer"
},
"maxItems": 5,
"minItems": 0,
"type": "array"
},
"ngnPsMaxMessageRatePercentage": {
"description": "Defines the maximum ingress NGN-PS message rate supported, as a percentage of the engineered DA-MP message rate. NGN-PS traffic in excess of this rate is not considered inviolable. Typical value is 3.",
"maximum": 15,
"minimum": 1,
"type": "integer"
},
"ngnPsMaxNormalRequestPriority": {
"description": "Defines the maximum priority that can be assigned to an ingress normal (i.e., non-NGN-PS) Request message. This value is set by the DSR and is not client configurable.",
"maximum": 15,
"minimum": 0,
"readonly": true,
"type": "integer"
},
"ngnPsMaxPriority0Allowed": {
"description": "Defines the maximum priority that will be converted to priority '0' when a message or stack event is sent from a 16 priority scheme system to a 5-priority scheme system. Typical value is 5.",
"maximum": 13,
"minimum": 0,
"type": "integer"
},
"ngnPsMaxPriority1Allowed": {
"description": "Defines the maximum priority that will be converted to priority '1' when a message or stack event is sent from a 16 priority scheme system to a 5-priority scheme system. Typical value is 10.",
"maximum": 14,
"minimum": 1,
"type": "integer"
},
"ngnPsMaxPriority2Allowed": {
"description": "Defines the maximum priority that will be converted to priority '2' when a message or stack event is sent from a 16 priority scheme system to a 5-priority scheme system. Typical value is 14.",
"maximum": 15,
"minimum": 2,
"type": "integer"
},
"ngnPsMinimumAnswerPriority": {
"description": "Defines the minimum priority which DSR will assign to ingress Diameter Answer message. This value is not user configurable and it's value is derived internally.",
"enum": [
"P0",
"P3",
"P14",
"P15"
],
"readonly": true,
"type": "string"
},
"ngnPsMinimumInviolablePriority": {
"description": "Defines the minimum priority which DSR will consider inviolable from a message priority treatment. A message with a priority greater than or equal to this attribute is not subject to congestion controls. This value is set by the DSR and is not client configurable.",
"enum": [
"P3",
"P4",
"P15",
"P99"
],
"readonly": true,
"type": "string"
},
"ngnPsRxAdminStateEnabled": {
"description": "If true, the NGN-PS feature is enabled for Rx messages. When set to false, DSR is not provided NGN-PS treatment to Rx messages. ngnPsRxAdminStateEnabled is superseded by ngnPsAdminStateEnabled; if ngnPsAdminStateEnabled is false, no Rx messages is provided NGN-PS treatment even if ngnPsRxAdminStateEnabled is true. Typical value is false.",
"type": "boolean"
},
"ngnPsRxMpsAvpValue": {
"description": "An Rx AAR message is considered an NGN-PS message candidate if it contains an MPS-Identifier AVP whose value identical to ngnPsRxMpsAvpValue. Not applicable if ngnPsRxAdminStateEnabled is false.",
"type": "string"
},
"peerNodeCriticalAggAlarmThreshold": {
"description": "When the number of Peer Node (/diameter/peernodes) failure alarms raised by the DSR exceeds this threshold: 1) all individual Peer Node failure alarms raised to that point are cleared, and 2) a single aggregate Peer Node failure alarm of critical severity is raised by the SOAM. The sum of (connMajorAggAlarmThreshold * # DA-MPs), ipfeConnMajorAggAlarmThreshold, peerNodeCriticalAggAlarmThreshold, and routeListCriticalAggAlarmThreshold cannot exceed the alarm budget.",
"minimum": 1,
"type": "integer"
},
"radiusUdpClientSockRecvSize": {
"description": "The socket receive buffer size for incoming UDP messages received from RADIUS servers. Typical value is 126000.",
"maximum": 5000000,
"minimum": 8000,
"type": "integer"
},
"radiusUdpClientSockSendSize": {
"description": "The socket send buffer size for outgoing UDP messages sent to RADIUS servers. Typical value is 126000.",
"maximum": 5000000,
"minimum": 8000,
"type": "integer"
},
"radiusUdpServerSockRecvSize": {
"description": "The socket send buffer size for incoming UDP messages received from RADIUS clients. Typical value is 1000000.",
"maximum": 5000000,
"minimum": 8000,
"type": "integer"
},
"radiusUdpServerSockSendSize": {
"description": "The socket send buffer size for outgoing UDP messages sent to RADIUS clients. Typical value is 1000000.",
"maximum": 5000000,
"minimum": 8000,
"type": "integer"
},
"redirectAnsProcessingEnabled": {
"description": "If true, redirect notification response processing is enabled, and the DSR acts on any redirect information it receives in an answer message from a downstream Peer Node (/diameter/peernodes). If false, any answer message received by the DSR is simply passed through to the upstream Peer Node. Typical value is false.",
"type": "boolean"
},
"redirectApplicationRouteTableName": {
"description": "Name of the Application Route Table used to process a redirected request, if redirectAnsProcessingEnabled is true. Not applicable if redirectAnsProcessingEnabled is false.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"redirectPeerRouteTableName": {
"description": "Name of the Peer Route Table used to process a redirected request, if redirectAnsProcessingEnabled is true. Not applicable if redirectAnsProcessingEnabled is false.",
"maxLength": 32,
"pattern" : "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"routeListCriticalAggAlarmThreshold": {
"description": "When the number of Route List (/diameter/routelists) failure alarms raised by the DSR exceeds this threshold: 1) all individual Route List failure alarms raised to that point are cleared, and 2) a single aggregate Route List failure alarm of critical severity is raised by the SOAM. The sum of (connMajorAggAlarmThreshold * # DA-MPs), ipfeConnMajorAggAlarmThreshold, peerNodeCriticalAggAlarmThreshold, and routeListCriticalAggAlarmThreshold cannot exceed the alarm budget.",
"minimum": 1,
"type": "integer"
},
"peerPingFeatureEnabled": {
"description": "If true, an ICMP ping echo is sent to the next-hop of every remote Peer (/diameter/peernodes) every two minutes. This is useful for keeping switch address tables up to date.",
"type" : "boolean"
}
},
"required": [
"connCriticalAggAlarmThreshold",
"connMajorAggAlarmThreshold",
"dpdRealmExpiryMajAlarmThresholdHrs",
"dpdRealmExpiryMinAlarmThresholdHrs",
"ipfeConnCriticalAggAlarmThreshold",
"ipfeConnMajorAggAlarmThreshold",
"encodeFqdnInLowerCase",
"excessiveRerouteAbateThreshold",
"excessiveRerouteOnsetThreshold",
"msgCopyDisableCongLevel",
"msgCopyFeatureEnabled",
"ngnPsAdminStateEnabled",
"ngnPsMaxMessageRatePercentage",
"peerNodeCriticalAggAlarmThreshold",
"peerPingFeatureEnabled",
"radiusUdpClientSockRecvSize",
"radiusUdpClientSockSendSize",
"radiusUdpServerSockRecvSize",
"radiusUdpServerSockSendSize",
"redirectAnsProcessingEnabled",
"routeListCriticalAggAlarmThreshold"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"alarmBudget": 3000,
"configurationLevel": "390",
"connCriticalAggAlarmThreshold": 100,
"connMajorAggAlarmThreshold": 50,
"connReservedIngressMpsScaling": 100,
"diameterEngMessageSize": 60000,
"dpdRealmExpiryMajAlarmThresholdHrs": 1,
"dpdRealmExpiryMinAlarmThresholdHrs": 6,
"encodeFqdnInLowerCase": true,
"excessiveRerouteAbateThreshold": 15,
"excessiveRerouteOnsetThreshold": 20,
"ipfeConnCriticalAggAlarmThreshold": 200,
"ipfeConnMajorAggAlarmThreshold": 100,
"msgCopyDisableCongLevel": "Cl1",
"msgCopyFeatureEnabled": false,
"ngnPsAdminStateEnabled": false,
"ngnPsCxAdminStateEnabled": false,
"ngnPsDhAdminStateEnabled": false,
"ngnPsGxAdminStateEnabled": true,
"ngnPsGxAdvancedPriority": "None",
"ngnPsGxArp": [
3,
6,
10
],
"ngnPsMaxMessageRatePercentage": 3,
"ngnPsMinimumAnswerPriority": "P3",
"ngnPsMinimumInviolablePriority": "P3",
"ngnPsRxAdminStateEnabled": true,
"ngnPsRxMpsAvpValue": "testValue",
"peerNodeCriticalAggAlarmThreshold": 20,
"peerPingFeatureEnabled" : false,
"radiusUdpClientSockRecvSize": 126000,
"radiusUdpClientSockSendSize": 126000,
"radiusUdpServerSockRecvSize": 1000000,
"radiusUdpServerSockSendSize": 1000000,
"redirectAnsProcessingEnabled": true,
"redirectApplicationRouteTableName": "ARTName",
"redirectPeerRouteTableName": "PRTName",
"routeListCriticalAggAlarmThreshold": 25
},
"messages":
[
],
"links":
{
},
"status":
true
}
put /diameter/options
Updates the Options with the values supplied. To update just one of the individual options, GET the set, modify the value for the option that needs to be changed, and then PUT the Options.
Target Server: SOAM
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/option/option.json",
"properties": {
"alarmBudget": {
"description": "The total number of alarms allowed in the alarm budget. This is a fixed value. The sum of (connMajorAggAlarmThreshold * # DA-MPs), ipfeConnMajorAggAlarmThreshold, peerNodeCriticalAggAlarmThreshold, and routeListCriticalAggAlarmThreshold cannot exceed alarmBudget.",
"readOnly": true,
"type": "integer"
},
"congestionDiscardPolicy": {
"description": "The order of priority and/or color-based traffic segments when determining which messages should continue routing and which should be diverted or discarded during times of congestion. Typical value is 2",
"enum": [0, 1, 2],
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"connCriticalAggAlarmThreshold": {
"description": "When the number of fixed Connection (/diameter/connections) failure alarms raised by a single DA-MP exceeds this threshold: 1) the already-raised major aggregate fixed Connection failure alarm for that DA-MP is cleared, and 2) a single aggregate fixed Connection failure alarm of critical severity is raised by the SOAM against that DA-MP. The value of connCriticalAggAlarmThreshold is not included in the available alarm budget. Set connCriticalAggAlarmThreshold to zero to prevent entirely the raising of a critical aggregate alarm for fixed Connection failures.",
"minimum": 0,
"type": "integer"
},
"connMajorAggAlarmThreshold": {
"description": "When the number of fixed Connection (/diameter/connections) failure alarms raised by a single DA-MP exceeds this threshold: 1) all individual fixed Connection failure alarms raised to that point are cleared, and 2) a single aggregate fixed Connection failure alarm of major severity is raised by the SOAM against that DA-MP. The value of connMajorAggAlarmThreshold is included in the available alarm budget, multiplied by the number of DA-MP in the DSR. So the sum of (connMajorAggAlarmThreshold * # DA-MPs), ipfeConnMajorAggAlarmThreshold, peerNodeCriticalAggAlarmThreshold, and routeListCriticalAggAlarmThreshold cannot exceed the alarm budget.",
"minimum": 1,
"type": "integer"
},
"connReservedIngressMpsScaling": {
"description": "Percent of DA-MP engineered Ingress MPS used by each DA-MP when validating the Reserved Ingress MPS for a newly received Connection (/diameter/connections). A newly received Connection is rejected if the total Connection Reserved Ingress MPS for fixed and already-established IPFE Connections would exceed the DA-MP's Engineering Ingress MPS, scaled by connReservedIngressMpsScaling. Typical value is 50.",
"readOnly": true,
"type": "integer"
},
"diameterEngMessageSize": {
"description": "The engineered message size of Diameter messages supported by the DSR.",
"readOnly": true,
"type": "integer"
},
"dpdRealmExpiryMajAlarmThresholdHrs": {
"description": "The time, in hours, before the expiration of a dynamically-discovered Realm, at which a major alarm is raised to indicate that Realm expiration is approaching. A value of zero means no major alarm is raised to alert of the pending Realm expiration. If both dpdRealmExpiryMinAlarmThresholdHrs and dpdRealmExpiryMajAlarmThresholdHrs are non-zero, the value for dpdRealmExpiryMinAlarmThresholdHrs must be greater than the value for dpdRealmExpiryMajAlarmThresholdHrs. Typical value is 1.",
"maximum": 167,
"minimum": 0,
"type": "integer"
},
"dpdRealmExpiryMinAlarmThresholdHrs": {
"description": "The time, in hours, before the expiration of a dynamically-discovered Realm, at which a minor alarm is raised to indicate that Realm expiration is approaching. A value of zero means no minor alarm is raised to alert of the pending Realm expiration. If both dpdRealmExpiryMinAlarmThresholdHrs and dpdRealmExpiryMajAlarmThresholdHrs are non-zero, the value for dpdRealmExpiryMinAlarmThresholdHrs must be greater than the value for dpdRealmExpiryMajAlarmThresholdHrs. Typical value is 6.",
"maximum": 168,
"minimum": 0,
"type": "integer"
},
"encodeFqdnInLowerCase": {
"description": "If false, FQDNs are encoded as configured. Otherwise, they are encoded in all lower case. Typical value is true.",
"type": "boolean"
},
"etgMode": {
"description": "Defines the type of message throttling that the system will support for all ETGs (/diameter/egressthrottlegroups). When set to Threshold (legacy mode), Requests are enforced based on the congestion level of the ETG. When set to Limit , the egress message rate is shaped according to the maximum message and pending transaction rate, the system discard policy, and the current mix of requests by message color and priority. Typical value is Threshold.",
"enum": [
"Threshold",
"Limit"
],
"type": "string"
},
"excessiveRerouteAbateThreshold": {
"description": "Excessive Reroute Alarm is cleared when percentage of sum of rerouted messages due to Answer Response and/or Answer Timeout to the total requests forwarded is less than excessiveRerouteAbateThreshold for configured Abatement Time. Typical value is 15.",
"maximum": 99,
"minimum": 0,
"type": "integer"
},
"excessiveRerouteOnsetThreshold": {
"description": "Excessive Reroute Alarm is raised when percentage of sum of rerouted messages due to Answer Response and/or Answer Timeout to the total requests forwarded exceeds the excessiveRerouteOnsetThreshold value. Typical value is 20.",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"ipfeConnCriticalAggAlarmThreshold": {
"description": "When the number of IPFE (floating) Connection (/diameter/connections) failure alarms raised exceeds this threshold: 1) the already-raised major aggregate IPFE Connection failure alarm is cleared, and 2) a single aggregate IPFE Connection failure alarm of critical severity is raised by the SOAM. The value of ipfeCriticalAggAlarmThreshold is not included in the available alarm budget. Set ipfeCriticalAggAlarmThreshold to zero to prevent entirely the raising of a critical aggregate alarm for IPFE Connection failures.",
"minimum": 0,
"type": "integer"
},
"ipfeConnMajorAggAlarmThreshold": {
"description": "When the number of IPFE (floating) Connection (/diameter/connections) failure alarms exceeds this threshold: 1) all individual IPFE Connection failure alarms raised to that point are cleared, and 2) a single aggregate IPFE Connection failure alarm of major severity is raised by the SOAM. The value of ipfeMajorAggAlarmThreshold is included in the available alarm budget. So the sum of (connMajorAggAlarmThreshold * # DA-MPs), ipfeConnMajorAggAlarmThreshold, peerNodeCriticalAggAlarmThreshold, and routeListCriticalAggAlarmThreshold cannot exceed the alarm budget.",
"minimum": 1,
"type": "integer"
},
"msgCopyDisableCongLevel": {
"description": "If a MP is at or above the congestion level specified by msgCopyDisableCongLevel, the message copy functionality is disabled on that MP. Typical value is Cl1.",
"enum": [
"Cl1",
"Cl2"
],
"type": "string"
},
"msgCopyFeatureEnabled": {
"description": "When set to true, the message copy feature is enabled for the DSR. When set to false, the message copy feature is disabled. Typical value is false.",
"type": "boolean"
},
"ngnPs16PriorityAdminStateEnabled": {
"description": "When set to true, system will support 16 internal message priorities (0-15). When set to false, system will support 5 internal message priorities (0-4).",
"type": "boolean"
},
"ngnPsAdminStateEnabled": {
"description": "When set to true, DSR provides NGN-PS treatment to applicable messages. When set to false, the NGN-PS feature is disabled. Typical value is false.",
"type": "boolean"
},
"ngnPsAnswerPriorityMode": {
"description": "Used for assigning priority to Answer messages. When set to HighestPriority, Answers have the highest priority (or 1 lower than Highest when ngnPsAdminStateEnabled is set to true. When this method is selected, DRMP AVPs in Answer messages are ignored. When set to RequestPriority, Answers have the same priority as Requests.",
"enum": [
"HighestPriority",
"RequestPriority"
],
"type": "string"
},
"ngnPsCxAdminStateEnabled": {
"description": "When set to true, the NGN-PS feature is enabled for Cx/Dx messages. When set to false, DSR does not provide NGN-PS treatment to Cx/Dx messages. ngnPsCxAdminStateEnabled is superseded by ngnPsAdminStateEnabled; if ngnPsAdminStateEnabled is false, no Cx/Dx messages is provided NGN-PS treatment even if ngnPsCxAdminStateEnabled is true. Typical value is false.",
"type": "boolean"
},
"ngnPsDhAdminStateEnabled": {
"description": "When set to true, the NGN-PS feature is enabled for Dh/Sh messages. When set to false, DSR is not provided NGN-PS treatment to Dh/Sh messages. ngnPsDhAdminStateEnabled is superseded by ngnPsAdminStateEnabled; if ngnPsAdminStateEnabled is false, no Dh/Sh messages is provided NGN-PS treatment even if ngnPsDhAdminStateEnabled is true. Typical value is false.",
"type": "boolean"
},
"ngnPsGxAdminStateEnabled": {
"description": "When set to true, the NGN-PS feature is enabled for Gx messages. When set to false, DSR is not provided NGN-PS treatment to Gx messages. ngnPsGxAdminStateEnabled is superseded by ngnPsAdminStateEnabled; if ngnPsAdminStateEnabled is false, no Gx messages is provided NGN-PS treatment even if ngnPsGxAdminStateEnabled is true. Typical value is false.",
"type": "boolean"
},
"ngnPsGxAdvancedPriority": {
"description": "The Access Network priority provided to NGN-PS subscribed user equipment. Affects the tagging of Gx CCR messages for NGN-PS treatment. Not applicable if ngnPsGxAdminStateEnabled is false.",
"enum": [
"Hss",
"None",
"Spr"
],
"type": "string"
},
"ngnPsGxArp": {
"description": "List of up to five priority levels contained in Gx messages which can be treated as NGN-PS messages. Each array element must be an integer between 1 and 15, inclusive. Not applicable if ngnPsGxAdminStateEnabled is false.",
"items": {
"maximum": 15,
"minimum": 1,
"type": "integer"
},
"maxItems": 5,
"minItems": 0,
"type": "array"
},
"ngnPsMaxMessageRatePercentage": {
"description": "Defines the maximum ingress NGN-PS message rate supported, as a percentage of the engineered DA-MP message rate. NGN-PS traffic in excess of this rate is not considered inviolable. Typical value is 3.",
"maximum": 15,
"minimum": 1,
"type": "integer"
},
"ngnPsMaxNormalRequestPriority": {
"description": "Defines the maximum priority that can be assigned to an ingress normal (i.e., non-NGN-PS) Request message. This value is set by the DSR and is not client configurable.",
"maximum": 15,
"minimum": 0,
"readonly": true,
"type": "integer"
},
"ngnPsMaxPriority0Allowed": {
"description": "Defines the maximum priority that will be converted to priority '0' when a message or stack event is sent from a 16 priority scheme system to a 5-priority scheme system. Typical value is 5.",
"maximum": 13,
"minimum": 0,
"type": "integer"
},
"ngnPsMaxPriority1Allowed": {
"description": "Defines the maximum priority that will be converted to priority '1' when a message or stack event is sent from a 16 priority scheme system to a 5-priority scheme system. Typical value is 10.",
"maximum": 14,
"minimum": 1,
"type": "integer"
},
"ngnPsMaxPriority2Allowed": {
"description": "Defines the maximum priority that will be converted to priority '2' when a message or stack event is sent from a 16 priority scheme system to a 5-priority scheme system. Typical value is 14.",
"maximum": 15,
"minimum": 2,
"type": "integer"
},
"ngnPsMinimumAnswerPriority": {
"description": "Defines the minimum priority which DSR will assign to ingress Diameter Answer message. This value is not user configurable and it's value is derived internally.",
"enum": [
"P0",
"P3",
"P14",
"P15"
],
"readonly": true,
"type": "string"
},
"ngnPsMinimumInviolablePriority": {
"description": "Defines the minimum priority which DSR will consider inviolable from a message priority treatment. A message with a priority greater than or equal to this attribute is not subject to congestion controls. This value is set by the DSR and is not client configurable.",
"enum": [
"P3",
"P4",
"P15",
"P99"
],
"readonly": true,
"type": "string"
},
"ngnPsRxAdminStateEnabled": {
"description": "If true, the NGN-PS feature is enabled for Rx messages. When set to false, DSR is not provided NGN-PS treatment to Rx messages. ngnPsRxAdminStateEnabled is superseded by ngnPsAdminStateEnabled; if ngnPsAdminStateEnabled is false, no Rx messages is provided NGN-PS treatment even if ngnPsRxAdminStateEnabled is true. Typical value is false.",
"type": "boolean"
},
"ngnPsRxMpsAvpValue": {
"description": "An Rx AAR message is considered an NGN-PS message candidate if it contains an MPS-Identifier AVP whose value identical to ngnPsRxMpsAvpValue. Not applicable if ngnPsRxAdminStateEnabled is false.",
"type": "string"
},
"peerNodeCriticalAggAlarmThreshold": {
"description": "When the number of Peer Node (/diameter/peernodes) failure alarms raised by the DSR exceeds this threshold: 1) all individual Peer Node failure alarms raised to that point are cleared, and 2) a single aggregate Peer Node failure alarm of critical severity is raised by the SOAM. The sum of (connMajorAggAlarmThreshold * # DA-MPs), ipfeConnMajorAggAlarmThreshold, peerNodeCriticalAggAlarmThreshold, and routeListCriticalAggAlarmThreshold cannot exceed the alarm budget.",
"minimum": 1,
"type": "integer"
},
"radiusUdpClientSockRecvSize": {
"description": "The socket receive buffer size for incoming UDP messages received from RADIUS servers. Typical value is 126000.",
"maximum": 5000000,
"minimum": 8000,
"type": "integer"
},
"radiusUdpClientSockSendSize": {
"description": "The socket send buffer size for outgoing UDP messages sent to RADIUS servers. Typical value is 126000.",
"maximum": 5000000,
"minimum": 8000,
"type": "integer"
},
"radiusUdpServerSockRecvSize": {
"description": "The socket send buffer size for incoming UDP messages received from RADIUS clients. Typical value is 1000000.",
"maximum": 5000000,
"minimum": 8000,
"type": "integer"
},
"radiusUdpServerSockSendSize": {
"description": "The socket send buffer size for outgoing UDP messages sent to RADIUS clients. Typical value is 1000000.",
"maximum": 5000000,
"minimum": 8000,
"type": "integer"
},
"redirectAnsProcessingEnabled": {
"description": "If true, redirect notification response processing is enabled, and the DSR acts on any redirect information it receives in an answer message from a downstream Peer Node (/diameter/peernodes). If false, any answer message received by the DSR is simply passed through to the upstream Peer Node. Typical value is false.",
"type": "boolean"
},
"redirectApplicationRouteTableName": {
"description": "Name of the Application Route Table used to process a redirected request, if redirectAnsProcessingEnabled is true. Not applicable if redirectAnsProcessingEnabled is false.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"redirectPeerRouteTableName": {
"description": "Name of the Peer Route Table used to process a redirected request, if redirectAnsProcessingEnabled is true. Not applicable if redirectAnsProcessingEnabled is false.",
"maxLength": 32,
"pattern" : "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"routeListCriticalAggAlarmThreshold": {
"description": "When the number of Route List (/diameter/routelists) failure alarms raised by the DSR exceeds this threshold: 1) all individual Route List failure alarms raised to that point are cleared, and 2) a single aggregate Route List failure alarm of critical severity is raised by the SOAM. The sum of (connMajorAggAlarmThreshold * # DA-MPs), ipfeConnMajorAggAlarmThreshold, peerNodeCriticalAggAlarmThreshold, and routeListCriticalAggAlarmThreshold cannot exceed the alarm budget.",
"minimum": 1,
"type": "integer"
},
"peerPingFeatureEnabled": {
"description": "If true, an ICMP ping echo is sent to the next-hop of every remote Peer (/diameter/peernodes) every two minutes. This is useful for keeping switch address tables up to date.",
"type" : "boolean"
}
},
"required": [
"connCriticalAggAlarmThreshold",
"connMajorAggAlarmThreshold",
"dpdRealmExpiryMajAlarmThresholdHrs",
"dpdRealmExpiryMinAlarmThresholdHrs",
"ipfeConnCriticalAggAlarmThreshold",
"ipfeConnMajorAggAlarmThreshold",
"encodeFqdnInLowerCase",
"excessiveRerouteAbateThreshold",
"excessiveRerouteOnsetThreshold",
"msgCopyDisableCongLevel",
"msgCopyFeatureEnabled",
"ngnPsAdminStateEnabled",
"ngnPsMaxMessageRatePercentage",
"peerNodeCriticalAggAlarmThreshold",
"peerPingFeatureEnabled",
"radiusUdpClientSockRecvSize",
"radiusUdpClientSockSendSize",
"radiusUdpServerSockRecvSize",
"radiusUdpServerSockSendSize",
"redirectAnsProcessingEnabled",
"routeListCriticalAggAlarmThreshold"
],
"type": "object"
}
Example
{
"alarmBudget": 3000,
"configurationLevel": "390",
"connCriticalAggAlarmThreshold": 100,
"connMajorAggAlarmThreshold": 50,
"connReservedIngressMpsScaling": 100,
"diameterEngMessageSize": 60000,
"dpdRealmExpiryMajAlarmThresholdHrs": 1,
"dpdRealmExpiryMinAlarmThresholdHrs": 6,
"encodeFqdnInLowerCase": true,
"excessiveRerouteAbateThreshold": 15,
"excessiveRerouteOnsetThreshold": 20,
"ipfeConnCriticalAggAlarmThreshold": 200,
"ipfeConnMajorAggAlarmThreshold": 100,
"msgCopyDisableCongLevel": "Cl1",
"msgCopyFeatureEnabled": false,
"ngnPsAdminStateEnabled": false,
"ngnPsCxAdminStateEnabled": false,
"ngnPsDhAdminStateEnabled": false,
"ngnPsGxAdminStateEnabled": true,
"ngnPsGxAdvancedPriority": "None",
"ngnPsGxArp": [
3,
6,
10
],
"ngnPsMaxMessageRatePercentage": 3,
"ngnPsMinimumAnswerPriority": "P3",
"ngnPsMinimumInviolablePriority": "P3",
"ngnPsRxAdminStateEnabled": true,
"ngnPsRxMpsAvpValue": "testValue",
"peerNodeCriticalAggAlarmThreshold": 20,
"peerPingFeatureEnabled" : false,
"radiusUdpClientSockRecvSize": 126000,
"radiusUdpClientSockSendSize": 126000,
"radiusUdpServerSockRecvSize": 1000000,
"radiusUdpServerSockSendSize": 1000000,
"redirectAnsProcessingEnabled": true,
"redirectApplicationRouteTableName": "ARTName",
"redirectPeerRouteTableName": "PRTName",
"routeListCriticalAggAlarmThreshold": 25
}
Diameter: Peer Node Groups
A Peer Node Group is a customer-defined set of Peer Nodes (/diameter/peernodegroups) whose Connections (/diameter/connections) (for reasons of redundancy) should not all be owned by the same DA-MP within a single IPFE Target Set (/diameter/ipfetargetsets). The IPFE detects a subsequent Connection is from within the same Peer Node Group and avoids passing that Connection to the same DA-MP. For example, if the Peer Node Group Distribution Threshold (/diameter/ipfetargetsets) has a value of two, then the IPFE avoids assigning more than two Connections to the same DA-MP within an IPFE Target Set.
All Peer Node Group configuration is done at the SOAM.
/diameter/peernodegroups
get /diameter/peernodegroups
Returns all Peer Node Groups configured at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those Peer Node Groups meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section).
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/peernodegroupCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/peernodegroup/peernodegroup.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name for the Peer Node Group, which must be unique within the DSR site. A name is required and cannot be changed after the Peer Node Group is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerNode": {
"description": "List of Peer Nodes (/diameter/peernodes) that are part of this Peer Node Group.",
"items": {
"description": "Name of a Peer Node (/diameter/peernodes). Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"minItems": 0,
"maxItems": 32,
"type": "array"
}
},
"required": [
"name"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"configurationLevel": "123",
"name": "peerNodeGroup1",
"peerNode": [
"PeerNode1",
"PeerNode2",
"PeerNode3"
]
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/peernodegroups
Adds a new Peer Node Group to the DSR configuration. The new Peer Node Group must have a name unique to the SOAM's configuration.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/peernodegroup/peernodegroup.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name for the Peer Node Group, which must be unique within the DSR site. A name is required and cannot be changed after the Peer Node Group is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerNode": {
"description": "List of Peer Nodes (/diameter/peernodes) that are part of this Peer Node Group.",
"items": {
"description": "Name of a Peer Node (/diameter/peernodes). Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"minItems": 0,
"maxItems": 32,
"type": "array"
}
},
"required": [
"name"
],
"type": "object"
}
Example
{
"configurationLevel": "123",
"name": "peerNodeGroup1",
"peerNode": [
"PeerNode1",
"PeerNode2",
"PeerNode3"
]
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/peernodegroups/{name}
get /diameter/peernodegroups/{name}
Returns the configuration details for the specified Peer Node Group. If the specified Peer Node Group does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/peernodegroupItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/peernodegroup/peernodegroup.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name for the Peer Node Group, which must be unique within the DSR site. A name is required and cannot be changed after the Peer Node Group is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerNode": {
"description": "List of Peer Nodes (/diameter/peernodes) that are part of this Peer Node Group.",
"items": {
"description": "Name of a Peer Node (/diameter/peernodes). Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"minItems": 0,
"maxItems": 32,
"type": "array"
}
},
"required": [
"name"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"configurationLevel": "123",
"name": "peerNodeGroup1",
"peerNode": [
"PeerNode1",
"PeerNode2",
"PeerNode3"
]
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/peernodegroups/{name}
Updates the configuration for the specified Peer Node Group. If the provided Peer Node Group data is invalid in any way, the update will fail, resulting in one or more error messages returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/peernodegroup/peernodegroup.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name for the Peer Node Group, which must be unique within the DSR site. A name is required and cannot be changed after the Peer Node Group is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerNode": {
"description": "List of Peer Nodes (/diameter/peernodes) that are part of this Peer Node Group.",
"items": {
"description": "Name of a Peer Node (/diameter/peernodes). Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"minItems": 0,
"maxItems": 32,
"type": "array"
}
},
"required": [
"name"
],
"type": "object"
}
Example
{
"configurationLevel": "123",
"name": "peerNodeGroup1",
"peerNode": [
"PeerNode1",
"PeerNode2",
"PeerNode3"
]
}
delete /diameter/peernodegroups/{name}
Deletes the specified Peer Node Group from the SOAM configuration. A Peer Node Group is only deleted if all delete validation checks pass. If the Peer Node Group is part of the configuration of some other Managed Object, the Peer Node Group cannot be deleted. For example, if the Peer Node Group is associated with a Peer Node, that association must first be removed (either by editing the Peer Node and choosing a different Peer Node Group, or deleting the Peer Node entirely). Then the Peer Node Group can be deleted from the configuration. An attempt to delete a Peer Node Group that cannot be deleted results in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Diameter: Peer Nodes
A Peer Node is the DSR's logical representation of a remote node, accessible over one or more transport connections, with which the DSR can transact Diameter or RADIUS messages. The Peer Node managed object encapsulates all the characteristics of the remote node that the DSR must know about in order to communicate successfully with it.
All Peer Node configuration is done at the SOAM.
/diameter/peernodes
get /diameter/peernodes
Returns all Peer Nodes configured at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those Peer Nodes meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section).
If a property is not explicitly identified as Diameter-only or RADIUS-only, it applies to both Diameter and RADIUS Peer Nodes.
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (one of configurationLevel)
The field being matched
Only the configurationLevel field is supported.
Example:
filter_name=configurationLevel
- filter_op: (one of GREATER_THAN, GREATER_THAN_EQUAL)
The match operation (operator)
Example:
filter_op=GREATER_THAN
- filter_values: (string)
The matched value
The configurationLevel value by which the data is being filtered. Only a single value is supported.
Example:
filter_values=10
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/peernodeCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/peernode/peernode.json",
"properties": {
"aaaProtocol": {
"description": "The AAA protocol for this Peer Node, which defines the Peer Node as either Diameter or Radius. This value is required for all Peer Nodes, and cannot be changed after the Peer Node is initially configured.",
"enum": [
"Diameter",
"Radius"
],
"type": "string"
},
"altRouteName": {
"description": "Route List (/diameter/routelists) to use for routing messages if implicit routing was used to route to this Peer Node and was unsuccessful.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"altRtOnAnswerResultCode": {
"description": "When a Reroute on Answer result code is received, this property defines whether alternate routing is attempted on any alternate Connections (/diameter/connections) to this Peer Node before selecting the next eligible Peer Node within a Peer Route Group (/diameter/peerroutegroups). If this property is set to DifferentPeer, no attempt is made to try alternate Connections to this Peer Node; the next eligible Peer Node within a Peer Route Group is instead attempted. Diameter Peer Nodes only.",
"enum": [
"DifferentPeer",
"SamePeer"
],
"type": "string"
},
"altRtOnAnswerTimeout": {
"description": "When an answer timeout occurs, this property defines whether alternate routing is attempted on the same Connection (/diameter/connections); on an alternate Connection to the same Peer Node; or whether the next eligible Peer Node within a Peer Route Group (/diameter/peerroutegroups) is selected. Diameter Peer Nodes only.",
"enum": [
"DifferentPeer",
"SamePeer",
"SameConnection"
],
"type": "string"
},
"altRtOnConnFailure": {
"description": "When a Connection (/diameter/connections) failure occurs, if this property is set to SamePeer, routing is attempted on any alternate Connections to this Peer Node before selecting the next eligible Peer Node within a Peer Route Group (/diameter/peerroutegroups). If this property is set to DifferentPeer, no attempt is made to try alternate Connections to this Peer Node; the next eligible Peer Node within a Peer Route Group is instead attempted. Diameter Peer Nodes only.",
"enum": [
"DifferentPeer",
"SamePeer"
],
"type": "string"
},
"answerOnAnyEnabledConnection": {
"description": "If true, means the answer can be received on any enabled Connection (/diameter/connections) to this Peer Node. Typical value is false. Diameter Peer Nodes only.",
"type": "boolean"
},
"appRouteTableName": {
"description": "Name of the Application Route Table (/diameter/applicationroutetables) associated with this Peer Node.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"avpRemovalListName": {
"description": "Name of the AVP Removal List (/diameter/avpremovallists) associated with this Peer Node. Diameter Peer Nodes only.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"dtlsPort": {
"description": "DTLS/SCTP Listen Port number of this Peer Node. Omitting this property indicates the Peer Node does not listen for DTLS/SCTP Connections from the DSR. Typical value is 5658. Diameter Peer Nodes only.",
"maximum": 65535,
"minimum": 1024,
"type": "integer"
},
"fqdn": {
"description": "Fully Qualified Domain Name of this Peer Node. fqdn is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and a FQDN must be at most 255 characters long.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
},
"ip": {
"description": "The IP address list of this Peer Node. Between zero and 128 (inclusive) IP addresses can be defined for a Peer Node. Each value provided must be a valid IPv4 or IPv6 address.",
"items": {
"type": "string"
},
"maxItems": 128,
"minItems": 0,
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "array"
},
"isDynamic": {
"description": "If true, means the Peer Node was created dynamically as a result of dynamic peer discovery. isDynamic is read-only. Diameter Peer Nodes only.",
"readOnly": true,
"type": "boolean"
},
"maxAltRouteAttempts": {
"description": "The maximum number of times that a Request can be rerouted to this Peer Node before the next eligible Peer Node is selected.",
"maximum": 4,
"minimum": 1,
"type": "integer"
},
"minConnCapacity": {
"description": "The minimum number of available Connections (/diameter/connections) to the Peer Node in order for it to be Available. Otherwise, if the number of available Connections to the Peer Node is less than minConnCapacity, the Peer Node is considered Degraded. Similarly, if no Connections are available to the Peer Node, it is considered Unavailable.",
"maximum": 64,
"minimum": 1,
"type": "integer"
},
"msgPriorityCfgSetName": {
"description": "The Message Priority Configuration Set (/diameter/messagepriorityconfigurationsets) assigned to a Peer Node supplies rules governing prioritization of request messages sent by the Peer Node to the DSR. Applicable when msgPrioritySetting is UserConfigured. Diameter Peer Nodes only.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"msgPrioritySetting": {
"description": "When receiving a request message and the receiving Connection's (/diameter/connections) msgPrioritySetting (Message Priority Setting) is set to None, the Message Priority Setting determines how priority is assigned to the Request. When set to RequestMessage, the message priority assigned to a request received from the Peer Node is read from the message itself. This option should only be used when the Peer Node is an Oracle Communications DSR. When set to None, the Default Message Priority Configuration Set (/diameter/messagepriorityconfigurationsets) is used. When set to UserConfigured, the Message Priority Configuration Set assigned to this Peer Node is used to determine the priority of request messages received from the Peer Node. Diameter Peer Nodes only.",
"enum": [
"None",
"RequestMessage",
"UserConfigured"
],
"type": "string"
},
"name": {
"description": "Name for the Peer Node, which must be unique within the DSR site. A name is required, and cannot be changed after the Peer Node is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerNodeGroupName": {
"description": "Name of the Peer Node Group (/diameter/peernodegroups) to which this Peer Node is assigned.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerRouteTableName": {
"description": "Name of the Peer Route Table (/diameter/peerroutetables) associated with this Peer Node.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"pendingAnswerTimerName": {
"description": "Name of the Pending Answer Timer (/diameter/pendinganswertimers) associated with this Peer Node.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"realm": {
"description": "Realm of this Peer Node. Realm is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and a Realm must be at most 255 characters long.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
},
"replaceDestHost": {
"description": "If set to true, indicates the Destination-Host AVP of outgoing messages should be overwritten with this Peer Node's Fully Qualified Domain Name. Diameter Peer Nodes only.",
"type": "boolean"
},
"replaceDestRealm": {
"description": "If set to true, indicates that the Destination-Realm AVP of outgoing messages should be overwritten with this Peer Node's Realm. Diameter Peer Nodes only.",
"type": "boolean"
},
"routingOptionSetName": {
"description": "Name of the Routing Option Set (/diameter/routingoptionsets) associated with this Peer Node.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"sctpPort": {
"description": "SCTP Listen Port number of this Peer Node. Omitting this property indicates the Peer Node does not listen for SCTP Connections from the DSR. Typical value is 3868. Diameter Peer Nodes only.",
"maximum": 65535,
"minimum": 1024,
"type": "integer"
},
"serverPort": {
"description": "UDP port(s) that serve(s) as the destination port(s) for messages from the DSR to this Peer Node, which represents a RADIUS Server. Between one and ten (inclusive) UDP server ports must be specified for a RADIUS Peer Node. RADIUS Peer Nodes only.",
"items": {
"maximum": 49151,
"minimum": 1024,
"type": "integer"
},
"maxItems": 10,
"minItems": 0,
"type": "array"
},
"tcpPort": {
"description": "TCP Listen Port number of this Peer Node. Omitting this property indicates the Peer Node does not listen for TCP Connections from the DSR. Typical value is 3868. Diameter Peer Nodes only.",
"maximum": 65535,
"minimum": 1024,
"type": "integer"
},
"tlsPort": {
"description": "TLS/TCP Listen Port number of this Peer Node. Omitting this property indicates the Peer Node does not listen for TLS/TCP Connections from the DSR. Typical value is 5658. Diameter Peer Nodes only.",
"maximum": 65535,
"minimum": 1024,
"type": "integer"
},
"topologyHidingEnabled": {
"description": "If true, indicates Topology Hiding is applicable to this Peer Node. Diameter Peer Nodes only.",
"type": "boolean"
},
"transactionCfgSetName": {
"description": "Name of the Transaction Configuration Set (/diameter/transactionconfigurationsets) associated with this Peer Node.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"aaaProtocol",
"fqdn",
"maxAltRouteAttempts",
"minConnCapacity",
"name",
"realm"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"aaaProtocol": "Diameter",
"altRtOnAnswerResultCode": "DifferentPeer",
"altRtOnAnswerTimeout": "DifferentPeer",
"altRtOnConnFailure": "DifferentPeer",
"answerOnAnyEnabledConnection": false,
"fqdn": "PeerNode3.realm1.com",
"ip": [
"172.016.001.004",
"fe80:0000:0000:0000:0200:f8ff:fe21:67cf"
],
"isDynamic": false,
"maxAltRouteAttempts": 4,
"minConnCapacity": 1,
"msgPriorityCfgSet": "Default",
"msgPrioritySetting": "None",
"name": "PeerNode4",
"realm": "realm1.com",
"replaceDestHost": false,
"replaceDestRealm": false,
"sctpPort": 1059,
"tcpPort": 1699,
"topologyHidingEnabled": false
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/peernodes
Adds a new Peer Node to the DSR configuration. The new Peer Node must have a name that is unique across all Peer Nodes at the SOAM. In addition, the Peer Node's FQDN must also be unique across all Peer Nodes configured at the SOAM. If the AAA Protocol for the Peer Node is Diameter, no attributes that are unique to RADIUS should be present in the request. Likewise, if the AAA Protocol is RADIUS, no attributes that are unique to Diameter should be present in the request.
If a property is not explicitly identified as Diameter-only or RADIUS-only, it applies to both Diameter and RADIUS Peer Nodes.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/peernode/peernode.json",
"properties": {
"aaaProtocol": {
"description": "The AAA protocol for this Peer Node, which defines the Peer Node as either Diameter or Radius. This value is required for all Peer Nodes, and cannot be changed after the Peer Node is initially configured.",
"enum": [
"Diameter",
"Radius"
],
"type": "string"
},
"altRouteName": {
"description": "Route List (/diameter/routelists) to use for routing messages if implicit routing was used to route to this Peer Node and was unsuccessful.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"altRtOnAnswerResultCode": {
"description": "When a Reroute on Answer result code is received, this property defines whether alternate routing is attempted on any alternate Connections (/diameter/connections) to this Peer Node before selecting the next eligible Peer Node within a Peer Route Group (/diameter/peerroutegroups). If this property is set to DifferentPeer, no attempt is made to try alternate Connections to this Peer Node; the next eligible Peer Node within a Peer Route Group is instead attempted. Diameter Peer Nodes only.",
"enum": [
"DifferentPeer",
"SamePeer"
],
"type": "string"
},
"altRtOnAnswerTimeout": {
"description": "When an answer timeout occurs, this property defines whether alternate routing is attempted on the same Connection (/diameter/connections); on an alternate Connection to the same Peer Node; or whether the next eligible Peer Node within a Peer Route Group (/diameter/peerroutegroups) is selected. Diameter Peer Nodes only.",
"enum": [
"DifferentPeer",
"SamePeer",
"SameConnection"
],
"type": "string"
},
"altRtOnConnFailure": {
"description": "When a Connection (/diameter/connections) failure occurs, if this property is set to SamePeer, routing is attempted on any alternate Connections to this Peer Node before selecting the next eligible Peer Node within a Peer Route Group (/diameter/peerroutegroups). If this property is set to DifferentPeer, no attempt is made to try alternate Connections to this Peer Node; the next eligible Peer Node within a Peer Route Group is instead attempted. Diameter Peer Nodes only.",
"enum": [
"DifferentPeer",
"SamePeer"
],
"type": "string"
},
"answerOnAnyEnabledConnection": {
"description": "If true, means the answer can be received on any enabled Connection (/diameter/connections) to this Peer Node. Typical value is false. Diameter Peer Nodes only.",
"type": "boolean"
},
"appRouteTableName": {
"description": "Name of the Application Route Table (/diameter/applicationroutetables) associated with this Peer Node.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"avpRemovalListName": {
"description": "Name of the AVP Removal List (/diameter/avpremovallists) associated with this Peer Node. Diameter Peer Nodes only.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"dtlsPort": {
"description": "DTLS/SCTP Listen Port number of this Peer Node. Omitting this property indicates the Peer Node does not listen for DTLS/SCTP Connections from the DSR. Typical value is 5658. Diameter Peer Nodes only.",
"maximum": 65535,
"minimum": 1024,
"type": "integer"
},
"fqdn": {
"description": "Fully Qualified Domain Name of this Peer Node. fqdn is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and a FQDN must be at most 255 characters long.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
},
"ip": {
"description": "The IP address list of this Peer Node. Between zero and 128 (inclusive) IP addresses can be defined for a Peer Node. Each value provided must be a valid IPv4 or IPv6 address.",
"items": {
"type": "string"
},
"maxItems": 128,
"minItems": 0,
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "array"
},
"isDynamic": {
"description": "If true, means the Peer Node was created dynamically as a result of dynamic peer discovery. isDynamic is read-only. Diameter Peer Nodes only.",
"readOnly": true,
"type": "boolean"
},
"maxAltRouteAttempts": {
"description": "The maximum number of times that a Request can be rerouted to this Peer Node before the next eligible Peer Node is selected.",
"maximum": 4,
"minimum": 1,
"type": "integer"
},
"minConnCapacity": {
"description": "The minimum number of available Connections (/diameter/connections) to the Peer Node in order for it to be Available. Otherwise, if the number of available Connections to the Peer Node is less than minConnCapacity, the Peer Node is considered Degraded. Similarly, if no Connections are available to the Peer Node, it is considered Unavailable.",
"maximum": 64,
"minimum": 1,
"type": "integer"
},
"msgPriorityCfgSetName": {
"description": "The Message Priority Configuration Set (/diameter/messagepriorityconfigurationsets) assigned to a Peer Node supplies rules governing prioritization of request messages sent by the Peer Node to the DSR. Applicable when msgPrioritySetting is UserConfigured. Diameter Peer Nodes only.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"msgPrioritySetting": {
"description": "When receiving a request message and the receiving Connection's (/diameter/connections) msgPrioritySetting (Message Priority Setting) is set to None, the Message Priority Setting determines how priority is assigned to the Request. When set to RequestMessage, the message priority assigned to a request received from the Peer Node is read from the message itself. This option should only be used when the Peer Node is an Oracle Communications DSR. When set to None, the Default Message Priority Configuration Set (/diameter/messagepriorityconfigurationsets) is used. When set to UserConfigured, the Message Priority Configuration Set assigned to this Peer Node is used to determine the priority of request messages received from the Peer Node. Diameter Peer Nodes only.",
"enum": [
"None",
"RequestMessage",
"UserConfigured"
],
"type": "string"
},
"name": {
"description": "Name for the Peer Node, which must be unique within the DSR site. A name is required, and cannot be changed after the Peer Node is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerNodeGroupName": {
"description": "Name of the Peer Node Group (/diameter/peernodegroups) to which this Peer Node is assigned.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerRouteTableName": {
"description": "Name of the Peer Route Table (/diameter/peerroutetables) associated with this Peer Node.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"pendingAnswerTimerName": {
"description": "Name of the Pending Answer Timer (/diameter/pendinganswertimers) associated with this Peer Node.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"realm": {
"description": "Realm of this Peer Node. Realm is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and a Realm must be at most 255 characters long.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
},
"replaceDestHost": {
"description": "If set to true, indicates the Destination-Host AVP of outgoing messages should be overwritten with this Peer Node's Fully Qualified Domain Name. Diameter Peer Nodes only.",
"type": "boolean"
},
"replaceDestRealm": {
"description": "If set to true, indicates that the Destination-Realm AVP of outgoing messages should be overwritten with this Peer Node's Realm. Diameter Peer Nodes only.",
"type": "boolean"
},
"routingOptionSetName": {
"description": "Name of the Routing Option Set (/diameter/routingoptionsets) associated with this Peer Node.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"sctpPort": {
"description": "SCTP Listen Port number of this Peer Node. Omitting this property indicates the Peer Node does not listen for SCTP Connections from the DSR. Typical value is 3868. Diameter Peer Nodes only.",
"maximum": 65535,
"minimum": 1024,
"type": "integer"
},
"serverPort": {
"description": "UDP port(s) that serve(s) as the destination port(s) for messages from the DSR to this Peer Node, which represents a RADIUS Server. Between one and ten (inclusive) UDP server ports must be specified for a RADIUS Peer Node. RADIUS Peer Nodes only.",
"items": {
"maximum": 49151,
"minimum": 1024,
"type": "integer"
},
"maxItems": 10,
"minItems": 0,
"type": "array"
},
"tcpPort": {
"description": "TCP Listen Port number of this Peer Node. Omitting this property indicates the Peer Node does not listen for TCP Connections from the DSR. Typical value is 3868. Diameter Peer Nodes only.",
"maximum": 65535,
"minimum": 1024,
"type": "integer"
},
"tlsPort": {
"description": "TLS/TCP Listen Port number of this Peer Node. Omitting this property indicates the Peer Node does not listen for TLS/TCP Connections from the DSR. Typical value is 5658. Diameter Peer Nodes only.",
"maximum": 65535,
"minimum": 1024,
"type": "integer"
},
"topologyHidingEnabled": {
"description": "If true, indicates Topology Hiding is applicable to this Peer Node. Diameter Peer Nodes only.",
"type": "boolean"
},
"transactionCfgSetName": {
"description": "Name of the Transaction Configuration Set (/diameter/transactionconfigurationsets) associated with this Peer Node.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"aaaProtocol",
"fqdn",
"maxAltRouteAttempts",
"minConnCapacity",
"name",
"realm"
],
"type": "object"
}
Example
{
"aaaProtocol": "Diameter",
"altRtOnAnswerResultCode": "DifferentPeer",
"altRtOnAnswerTimeout": "DifferentPeer",
"altRtOnConnFailure": "DifferentPeer",
"answerOnAnyEnabledConnection": false,
"fqdn": "PeerNode3.realm1.com",
"ip": [
"172.016.001.004",
"fe80:0000:0000:0000:0200:f8ff:fe21:67cf"
],
"isDynamic": false,
"maxAltRouteAttempts": 4,
"minConnCapacity": 1,
"msgPriorityCfgSet": "Default",
"msgPrioritySetting": "None",
"name": "PeerNode4",
"realm": "realm1.com",
"replaceDestHost": false,
"replaceDestRealm": false,
"sctpPort": 1059,
"tcpPort": 1699,
"topologyHidingEnabled": false
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/peernodes/{name}
get /diameter/peernodes/{name}
Returns the configuration details for the specified Peer Node. If the specified Peer Node does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
If a property is not explicitly identified as Diameter-only or RADIUS-only, it applies to both Diameter and RADIUS Peer Nodes.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/peernodeItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/peernode/peernode.json",
"properties": {
"aaaProtocol": {
"description": "The AAA protocol for this Peer Node, which defines the Peer Node as either Diameter or Radius. This value is required for all Peer Nodes, and cannot be changed after the Peer Node is initially configured.",
"enum": [
"Diameter",
"Radius"
],
"type": "string"
},
"altRouteName": {
"description": "Route List (/diameter/routelists) to use for routing messages if implicit routing was used to route to this Peer Node and was unsuccessful.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"altRtOnAnswerResultCode": {
"description": "When a Reroute on Answer result code is received, this property defines whether alternate routing is attempted on any alternate Connections (/diameter/connections) to this Peer Node before selecting the next eligible Peer Node within a Peer Route Group (/diameter/peerroutegroups). If this property is set to DifferentPeer, no attempt is made to try alternate Connections to this Peer Node; the next eligible Peer Node within a Peer Route Group is instead attempted. Diameter Peer Nodes only.",
"enum": [
"DifferentPeer",
"SamePeer"
],
"type": "string"
},
"altRtOnAnswerTimeout": {
"description": "When an answer timeout occurs, this property defines whether alternate routing is attempted on the same Connection (/diameter/connections); on an alternate Connection to the same Peer Node; or whether the next eligible Peer Node within a Peer Route Group (/diameter/peerroutegroups) is selected. Diameter Peer Nodes only.",
"enum": [
"DifferentPeer",
"SamePeer",
"SameConnection"
],
"type": "string"
},
"altRtOnConnFailure": {
"description": "When a Connection (/diameter/connections) failure occurs, if this property is set to SamePeer, routing is attempted on any alternate Connections to this Peer Node before selecting the next eligible Peer Node within a Peer Route Group (/diameter/peerroutegroups). If this property is set to DifferentPeer, no attempt is made to try alternate Connections to this Peer Node; the next eligible Peer Node within a Peer Route Group is instead attempted. Diameter Peer Nodes only.",
"enum": [
"DifferentPeer",
"SamePeer"
],
"type": "string"
},
"answerOnAnyEnabledConnection": {
"description": "If true, means the answer can be received on any enabled Connection (/diameter/connections) to this Peer Node. Typical value is false. Diameter Peer Nodes only.",
"type": "boolean"
},
"appRouteTableName": {
"description": "Name of the Application Route Table (/diameter/applicationroutetables) associated with this Peer Node.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"avpRemovalListName": {
"description": "Name of the AVP Removal List (/diameter/avpremovallists) associated with this Peer Node. Diameter Peer Nodes only.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"dtlsPort": {
"description": "DTLS/SCTP Listen Port number of this Peer Node. Omitting this property indicates the Peer Node does not listen for DTLS/SCTP Connections from the DSR. Typical value is 5658. Diameter Peer Nodes only.",
"maximum": 65535,
"minimum": 1024,
"type": "integer"
},
"fqdn": {
"description": "Fully Qualified Domain Name of this Peer Node. fqdn is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and a FQDN must be at most 255 characters long.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
},
"ip": {
"description": "The IP address list of this Peer Node. Between zero and 128 (inclusive) IP addresses can be defined for a Peer Node. Each value provided must be a valid IPv4 or IPv6 address.",
"items": {
"type": "string"
},
"maxItems": 128,
"minItems": 0,
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "array"
},
"isDynamic": {
"description": "If true, means the Peer Node was created dynamically as a result of dynamic peer discovery. isDynamic is read-only. Diameter Peer Nodes only.",
"readOnly": true,
"type": "boolean"
},
"maxAltRouteAttempts": {
"description": "The maximum number of times that a Request can be rerouted to this Peer Node before the next eligible Peer Node is selected.",
"maximum": 4,
"minimum": 1,
"type": "integer"
},
"minConnCapacity": {
"description": "The minimum number of available Connections (/diameter/connections) to the Peer Node in order for it to be Available. Otherwise, if the number of available Connections to the Peer Node is less than minConnCapacity, the Peer Node is considered Degraded. Similarly, if no Connections are available to the Peer Node, it is considered Unavailable.",
"maximum": 64,
"minimum": 1,
"type": "integer"
},
"msgPriorityCfgSetName": {
"description": "The Message Priority Configuration Set (/diameter/messagepriorityconfigurationsets) assigned to a Peer Node supplies rules governing prioritization of request messages sent by the Peer Node to the DSR. Applicable when msgPrioritySetting is UserConfigured. Diameter Peer Nodes only.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"msgPrioritySetting": {
"description": "When receiving a request message and the receiving Connection's (/diameter/connections) msgPrioritySetting (Message Priority Setting) is set to None, the Message Priority Setting determines how priority is assigned to the Request. When set to RequestMessage, the message priority assigned to a request received from the Peer Node is read from the message itself. This option should only be used when the Peer Node is an Oracle Communications DSR. When set to None, the Default Message Priority Configuration Set (/diameter/messagepriorityconfigurationsets) is used. When set to UserConfigured, the Message Priority Configuration Set assigned to this Peer Node is used to determine the priority of request messages received from the Peer Node. Diameter Peer Nodes only.",
"enum": [
"None",
"RequestMessage",
"UserConfigured"
],
"type": "string"
},
"name": {
"description": "Name for the Peer Node, which must be unique within the DSR site. A name is required, and cannot be changed after the Peer Node is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerNodeGroupName": {
"description": "Name of the Peer Node Group (/diameter/peernodegroups) to which this Peer Node is assigned.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerRouteTableName": {
"description": "Name of the Peer Route Table (/diameter/peerroutetables) associated with this Peer Node.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"pendingAnswerTimerName": {
"description": "Name of the Pending Answer Timer (/diameter/pendinganswertimers) associated with this Peer Node.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"realm": {
"description": "Realm of this Peer Node. Realm is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and a Realm must be at most 255 characters long.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
},
"replaceDestHost": {
"description": "If set to true, indicates the Destination-Host AVP of outgoing messages should be overwritten with this Peer Node's Fully Qualified Domain Name. Diameter Peer Nodes only.",
"type": "boolean"
},
"replaceDestRealm": {
"description": "If set to true, indicates that the Destination-Realm AVP of outgoing messages should be overwritten with this Peer Node's Realm. Diameter Peer Nodes only.",
"type": "boolean"
},
"routingOptionSetName": {
"description": "Name of the Routing Option Set (/diameter/routingoptionsets) associated with this Peer Node.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"sctpPort": {
"description": "SCTP Listen Port number of this Peer Node. Omitting this property indicates the Peer Node does not listen for SCTP Connections from the DSR. Typical value is 3868. Diameter Peer Nodes only.",
"maximum": 65535,
"minimum": 1024,
"type": "integer"
},
"serverPort": {
"description": "UDP port(s) that serve(s) as the destination port(s) for messages from the DSR to this Peer Node, which represents a RADIUS Server. Between one and ten (inclusive) UDP server ports must be specified for a RADIUS Peer Node. RADIUS Peer Nodes only.",
"items": {
"maximum": 49151,
"minimum": 1024,
"type": "integer"
},
"maxItems": 10,
"minItems": 0,
"type": "array"
},
"tcpPort": {
"description": "TCP Listen Port number of this Peer Node. Omitting this property indicates the Peer Node does not listen for TCP Connections from the DSR. Typical value is 3868. Diameter Peer Nodes only.",
"maximum": 65535,
"minimum": 1024,
"type": "integer"
},
"tlsPort": {
"description": "TLS/TCP Listen Port number of this Peer Node. Omitting this property indicates the Peer Node does not listen for TLS/TCP Connections from the DSR. Typical value is 5658. Diameter Peer Nodes only.",
"maximum": 65535,
"minimum": 1024,
"type": "integer"
},
"topologyHidingEnabled": {
"description": "If true, indicates Topology Hiding is applicable to this Peer Node. Diameter Peer Nodes only.",
"type": "boolean"
},
"transactionCfgSetName": {
"description": "Name of the Transaction Configuration Set (/diameter/transactionconfigurationsets) associated with this Peer Node.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"aaaProtocol",
"fqdn",
"maxAltRouteAttempts",
"minConnCapacity",
"name",
"realm"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"aaaProtocol": "Diameter",
"altRtOnAnswerResultCode": "DifferentPeer",
"altRtOnAnswerTimeout": "DifferentPeer",
"altRtOnConnFailure": "DifferentPeer",
"answerOnAnyEnabledConnection": false,
"fqdn": "PeerNode3.realm1.com",
"ip": [
"172.016.001.004",
"fe80:0000:0000:0000:0200:f8ff:fe21:67cf"
],
"isDynamic": false,
"maxAltRouteAttempts": 4,
"minConnCapacity": 1,
"msgPriorityCfgSet": "Default",
"msgPrioritySetting": "None",
"name": "PeerNode4",
"realm": "realm1.com",
"replaceDestHost": false,
"replaceDestRealm": false,
"sctpPort": 1059,
"tcpPort": 1699,
"topologyHidingEnabled": false
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/peernodes/{name}
Updates the configuration for the specified Peer Node. If the provided Peer Node data is invalid in any way, the update will fail, resulting in one or more error messages returned within the HTTP response.
If a property is not explicitly identified as Diameter-only or RADIUS-only, it applies to both Diameter and RADIUS Peer Nodes.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/peernode/peernode.json",
"properties": {
"aaaProtocol": {
"description": "The AAA protocol for this Peer Node, which defines the Peer Node as either Diameter or Radius. This value is required for all Peer Nodes, and cannot be changed after the Peer Node is initially configured.",
"enum": [
"Diameter",
"Radius"
],
"type": "string"
},
"altRouteName": {
"description": "Route List (/diameter/routelists) to use for routing messages if implicit routing was used to route to this Peer Node and was unsuccessful.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"altRtOnAnswerResultCode": {
"description": "When a Reroute on Answer result code is received, this property defines whether alternate routing is attempted on any alternate Connections (/diameter/connections) to this Peer Node before selecting the next eligible Peer Node within a Peer Route Group (/diameter/peerroutegroups). If this property is set to DifferentPeer, no attempt is made to try alternate Connections to this Peer Node; the next eligible Peer Node within a Peer Route Group is instead attempted. Diameter Peer Nodes only.",
"enum": [
"DifferentPeer",
"SamePeer"
],
"type": "string"
},
"altRtOnAnswerTimeout": {
"description": "When an answer timeout occurs, this property defines whether alternate routing is attempted on the same Connection (/diameter/connections); on an alternate Connection to the same Peer Node; or whether the next eligible Peer Node within a Peer Route Group (/diameter/peerroutegroups) is selected. Diameter Peer Nodes only.",
"enum": [
"DifferentPeer",
"SamePeer",
"SameConnection"
],
"type": "string"
},
"altRtOnConnFailure": {
"description": "When a Connection (/diameter/connections) failure occurs, if this property is set to SamePeer, routing is attempted on any alternate Connections to this Peer Node before selecting the next eligible Peer Node within a Peer Route Group (/diameter/peerroutegroups). If this property is set to DifferentPeer, no attempt is made to try alternate Connections to this Peer Node; the next eligible Peer Node within a Peer Route Group is instead attempted. Diameter Peer Nodes only.",
"enum": [
"DifferentPeer",
"SamePeer"
],
"type": "string"
},
"answerOnAnyEnabledConnection": {
"description": "If true, means the answer can be received on any enabled Connection (/diameter/connections) to this Peer Node. Typical value is false. Diameter Peer Nodes only.",
"type": "boolean"
},
"appRouteTableName": {
"description": "Name of the Application Route Table (/diameter/applicationroutetables) associated with this Peer Node.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"avpRemovalListName": {
"description": "Name of the AVP Removal List (/diameter/avpremovallists) associated with this Peer Node. Diameter Peer Nodes only.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"dtlsPort": {
"description": "DTLS/SCTP Listen Port number of this Peer Node. Omitting this property indicates the Peer Node does not listen for DTLS/SCTP Connections from the DSR. Typical value is 5658. Diameter Peer Nodes only.",
"maximum": 65535,
"minimum": 1024,
"type": "integer"
},
"fqdn": {
"description": "Fully Qualified Domain Name of this Peer Node. fqdn is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and a FQDN must be at most 255 characters long.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
},
"ip": {
"description": "The IP address list of this Peer Node. Between zero and 128 (inclusive) IP addresses can be defined for a Peer Node. Each value provided must be a valid IPv4 or IPv6 address.",
"items": {
"type": "string"
},
"maxItems": 128,
"minItems": 0,
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "array"
},
"isDynamic": {
"description": "If true, means the Peer Node was created dynamically as a result of dynamic peer discovery. isDynamic is read-only. Diameter Peer Nodes only.",
"readOnly": true,
"type": "boolean"
},
"maxAltRouteAttempts": {
"description": "The maximum number of times that a Request can be rerouted to this Peer Node before the next eligible Peer Node is selected.",
"maximum": 4,
"minimum": 1,
"type": "integer"
},
"minConnCapacity": {
"description": "The minimum number of available Connections (/diameter/connections) to the Peer Node in order for it to be Available. Otherwise, if the number of available Connections to the Peer Node is less than minConnCapacity, the Peer Node is considered Degraded. Similarly, if no Connections are available to the Peer Node, it is considered Unavailable.",
"maximum": 64,
"minimum": 1,
"type": "integer"
},
"msgPriorityCfgSetName": {
"description": "The Message Priority Configuration Set (/diameter/messagepriorityconfigurationsets) assigned to a Peer Node supplies rules governing prioritization of request messages sent by the Peer Node to the DSR. Applicable when msgPrioritySetting is UserConfigured. Diameter Peer Nodes only.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"msgPrioritySetting": {
"description": "When receiving a request message and the receiving Connection's (/diameter/connections) msgPrioritySetting (Message Priority Setting) is set to None, the Message Priority Setting determines how priority is assigned to the Request. When set to RequestMessage, the message priority assigned to a request received from the Peer Node is read from the message itself. This option should only be used when the Peer Node is an Oracle Communications DSR. When set to None, the Default Message Priority Configuration Set (/diameter/messagepriorityconfigurationsets) is used. When set to UserConfigured, the Message Priority Configuration Set assigned to this Peer Node is used to determine the priority of request messages received from the Peer Node. Diameter Peer Nodes only.",
"enum": [
"None",
"RequestMessage",
"UserConfigured"
],
"type": "string"
},
"name": {
"description": "Name for the Peer Node, which must be unique within the DSR site. A name is required, and cannot be changed after the Peer Node is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerNodeGroupName": {
"description": "Name of the Peer Node Group (/diameter/peernodegroups) to which this Peer Node is assigned.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerRouteTableName": {
"description": "Name of the Peer Route Table (/diameter/peerroutetables) associated with this Peer Node.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"pendingAnswerTimerName": {
"description": "Name of the Pending Answer Timer (/diameter/pendinganswertimers) associated with this Peer Node.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"realm": {
"description": "Realm of this Peer Node. Realm is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and a Realm must be at most 255 characters long.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
},
"replaceDestHost": {
"description": "If set to true, indicates the Destination-Host AVP of outgoing messages should be overwritten with this Peer Node's Fully Qualified Domain Name. Diameter Peer Nodes only.",
"type": "boolean"
},
"replaceDestRealm": {
"description": "If set to true, indicates that the Destination-Realm AVP of outgoing messages should be overwritten with this Peer Node's Realm. Diameter Peer Nodes only.",
"type": "boolean"
},
"routingOptionSetName": {
"description": "Name of the Routing Option Set (/diameter/routingoptionsets) associated with this Peer Node.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"sctpPort": {
"description": "SCTP Listen Port number of this Peer Node. Omitting this property indicates the Peer Node does not listen for SCTP Connections from the DSR. Typical value is 3868. Diameter Peer Nodes only.",
"maximum": 65535,
"minimum": 1024,
"type": "integer"
},
"serverPort": {
"description": "UDP port(s) that serve(s) as the destination port(s) for messages from the DSR to this Peer Node, which represents a RADIUS Server. Between one and ten (inclusive) UDP server ports must be specified for a RADIUS Peer Node. RADIUS Peer Nodes only.",
"items": {
"maximum": 49151,
"minimum": 1024,
"type": "integer"
},
"maxItems": 10,
"minItems": 0,
"type": "array"
},
"tcpPort": {
"description": "TCP Listen Port number of this Peer Node. Omitting this property indicates the Peer Node does not listen for TCP Connections from the DSR. Typical value is 3868. Diameter Peer Nodes only.",
"maximum": 65535,
"minimum": 1024,
"type": "integer"
},
"tlsPort": {
"description": "TLS/TCP Listen Port number of this Peer Node. Omitting this property indicates the Peer Node does not listen for TLS/TCP Connections from the DSR. Typical value is 5658. Diameter Peer Nodes only.",
"maximum": 65535,
"minimum": 1024,
"type": "integer"
},
"topologyHidingEnabled": {
"description": "If true, indicates Topology Hiding is applicable to this Peer Node. Diameter Peer Nodes only.",
"type": "boolean"
},
"transactionCfgSetName": {
"description": "Name of the Transaction Configuration Set (/diameter/transactionconfigurationsets) associated with this Peer Node.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"aaaProtocol",
"fqdn",
"maxAltRouteAttempts",
"minConnCapacity",
"name",
"realm"
],
"type": "object"
}
Example
{
"aaaProtocol": "Diameter",
"altRtOnAnswerResultCode": "DifferentPeer",
"altRtOnAnswerTimeout": "DifferentPeer",
"altRtOnConnFailure": "DifferentPeer",
"answerOnAnyEnabledConnection": false,
"fqdn": "PeerNode3.realm1.com",
"ip": [
"172.016.001.004",
"fe80:0000:0000:0000:0200:f8ff:fe21:67cf"
],
"isDynamic": false,
"maxAltRouteAttempts": 4,
"minConnCapacity": 1,
"msgPriorityCfgSet": "Default",
"msgPrioritySetting": "None",
"name": "PeerNode4",
"realm": "realm1.com",
"replaceDestHost": false,
"replaceDestRealm": false,
"sctpPort": 1059,
"tcpPort": 1699,
"topologyHidingEnabled": false
}
delete /diameter/peernodes/{name}
Deletes the specified Peer Node from the SOAM configuration. A Peer Node will only be deleted if all delete validation checks pass. In general, if the Peer Node is part of the configuration of some other Managed Object, the Peer Node cannot be deleted. For example, if the Peer Node is named in a Peer Route Group (/diameter/routegroups), the Peer Node must first be removed from the Route Group. Then the Peer Node can be deleted from the configuration. An attempt to delete a Peer Node that cannot be deleted will result in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Diameter: Peer Route Rules
Peer Route Rules are the individual rules that specify how ingress request messages are routed by the DSR. Each Peer Route Rule is associated with exactly one Peer Route Table (/diameter/peerroutetables). Whenever a request message is processed by the DSR, one of the configured Peer Route Tables is selected (based on the DSR's general routing behavior, tailored by the DSR's specific configuration), and then the Peer Route Rules owned by the selected Peer Route Table are evaluated to see which Rule is applied to the request message. All Peer Route Rules associated with a Peer Route Table form the prioritized set of rules against which the request message is compared. The request is then routed based on the configuration of the selected Rule.
Each Peer Route Rule specifies criteria, called conditions, against which the request message is compared. Each Rule also has a defined priority. The action taken by the DSR in response to the request message is based on the highest-priority Peer Route Rule whose conditions match the request message information. The possible actions are: route to a destination Peer Node (/diameter/peernodes) (which occurs when the Route List specified in the Rule is evaluated and a Peer Node is selected); send an answer message to the ingress Peer Node that transmitted the request message; or abandon the request message.
All Peer Route Rule configuration is done at the SOAM.
/diameter/peerrouterules
get /diameter/peerrouterules
Returns all Peer Route Rules configured at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those Peer Route Rules meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section).
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (one of configurationLevel)
The field being matched
Only the configurationLevel field is supported.
Example:
filter_name=configurationLevel
- filter_op: (one of GREATER_THAN, GREATER_THAN_EQUAL)
The match operation (operator)
Example:
filter_op=GREATER_THAN
- filter_values: (string)
The matched value
The configurationLevel value by which the data is being filtered. Only a single value is supported.
Example:
filter_values=10
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/peerrouteruleCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/peerrouterule/peerrouterule.json",
"properties": {
"action": {
"description": "Action associated with this Rule. When set to RouteToPeer, DSR routes the message to a Peer Node (/diameter/peernodes) using the Route List (/diameter/routelists) associated with this Rule. When set to SendAnswer, DSR abandons message routing and sends an Answer response containing the Answer Result-Code Value associated with this Rule. When set to AbandonWithNoAns, DSR discards the message and an Answer is not sent to the originating Peer Node. When set to RouteToPrt, DSR routes the message to the Peer Route Table (/diameter/peerroutetables) for further processing.",
"enum": [
"AbandonWithNoAns",
"RouteToPeer",
"RouteToPrt",
"SendAnswer"
],
"type": "string"
},
"conditions": {
"description": "The conditions associated with this Peer Route Rule. There are six conditions, and because DSR logically ANDs them, all six must be present in the Rule definition. However, any individual condition, which does not apply to the Rule, should simply have the DontCare operator assigned. The six conditions are Destination-Realm, Destination-Host, Application-Id, Command-Code, Origin-Realm, and Origin-Host. Application-Id and Command-Code refer to values found in the Diameter request message header, while the other four conditions apply to AVPs within the Diameter message body.",
"properties": {
"appId": {
"description": "The appId condition is used when it is necessary to examine the Application-Id value in the Diameter request message. The Equal operator is used to match the message's Application-ID value exactly. The NotEqual operator is used to exclude a specific Application-Id value. In either the Equal or NotEqual case, the supplied value must be an integer in the range 0-4294967295. If Application-Id is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"DontCare",
"Equal",
"NotEqual"
],
"type": "string"
},
"value": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"required": [
"operator"
],
"type": "object"
},
"cmdCode": {
"description": "The cmdCode condition is used when it is necessary to examine the Command-Code value in the Diameter request message. The Equal operator is used to match the message's Command-Code value exactly. The NotEqual operator is used to exclude a specific Command-Code value. In either the Equal or NotEqual case, the supplied value must be a configured Command Code or Extended Command Code. Command Codes are integers in the range 0-16777215, while Extended Command Codes have the form X.Y.Z, where each of X (the Command Code), Y (the AVP code), and Z (the AVP value) are integers in the range 0-16777215. If Command-Code is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"DontCare",
"Equal",
"NotEqual"
],
"type": "string"
},
"value": {
"maxLength": 30,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
},
"destHost": {
"description": "The destHost condition is used when it is necessary to examine the Destination-Host AVP value in the Diameter request message. The Equal operator is used to match the message's Destination-Host AVP value exactly. The NotEqual operator is used to exclude a specific Destination-Host value. In these two cases, the supplied value must be a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label can be no longer than 63 characters and the string can be no longer than 255 characters. If Destination-Host is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored. The StartsWith, EndsWith, and Contains operators are used as their names infer, to match the beginning, end, or any contiguous part of the Destination-Host AVP value. In any of these cases, the supplied value is a case-insensitive string limited to alphanumeric, dash ('-'), dot ('.'), and underscore ('_') characters. For EndsWith or StartsWith, the string can be no longer than 255 characters. For Contains, the string can be no longer than 50 characters. In addition, the Present and Absent operators can be used with Destination-Host. Neither Present nor Absent takes a value. If Present is used, there is a match when the Destination-Host AVP is present in the request message. If Absent is used, there is a match when the Destination-Host AVP is not present in the request message.",
"properties": {
"operator": {
"enum": [
"Absent",
"Contains",
"DontCare",
"EndsWith",
"Equal",
"NotEqual",
"Present",
"StartsWith"
],
"type": "string"
},
"value": {
"maxLength": 255,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
},
"destRealm": {
"description": "The destRealm condition is used when it is necessary to examine the Destination-Realm AVP value in the Diameter request message. The Equal operator is used to match the message's Destination-Realm AVP value exactly. The NotEqual operator is used to exclude a specific Destination-Realm value. In these two cases, the supplied value must be a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label can be no longer than 63 characters and the string can be no longer than 255 characters. The StartsWith, EndsWith, and Contains operators are used as their names infer, to match the beginning, end, or any contiguous part of the Destination-Realm AVP value. In any of these cases, the supplied value is a case-insensitive string limited to alphanumeric, dash ('-'), dot ('.'), and underscore ('_') characters. For EndsWith or StartsWith, the string can be no longer than 255 characters. For Contains, the string can be no longer than 50 characters. If Destination-Realm is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"Contains",
"DontCare",
"EndsWith",
"Equal",
"NotEqual",
"StartsWith"
],
"type": "string"
},
"value": {
"maxLength": 255,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
},
"origHost": {
"description": "The origHost condition is used when it is necessary to examine the Origin-Host AVP value in the Diameter request message. The Equal operator is used to match the message's Origin-Host AVP value exactly. The NotEqual operator is used to exclude a specific Origin-Host value. In these two cases, the supplied value must be a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label can be no longer than 63 characters and the string can be no longer than 255 characters. The StartsWith, EndsWith, and Contains operators are used as their names infer, to match the beginning, end, or any contiguous part of the Origin-Host AVP value. In any of these cases, the supplied value is a case-insensitive string limited to alphanumeric, dash ('-'), dot ('.'), and underscore ('_') characters. For EndsWith or StartsWith, the string can be no longer than 255 characters. For Contains, the string can be no longer than 50 characters. If Origin-Host is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"Contains",
"DontCare",
"EndsWith",
"Equal",
"NotEqual",
"StartsWith"
],
"type": "string"
},
"value": {
"maxLength": 255,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
},
"origRealm": {
"description": "The origRealm condition is used when it is necessary to examine the Origin-Realm AVP value in the Diameter request message. The Equal operator is used to match the message's Origin-Realm AVP value exactly. The NotEqual operator is used to exclude a specific Origin-Realm value. In these two cases, the supplied value must be a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label can be no longer than 63 characters and the string can be no longer than 255 characters. The StartsWith, EndsWith, and Contains operators are used as their names infer, to match the beginning, end, or any contiguous part of the Origin-Realm AVP value. In any of these cases, the supplied value is a case-insensitive string limited to alphanumeric, dash ('-'), dot ('.'), and underscore ('_') characters. For EndsWith or StartsWith, the string can be no longer than 255 characters. For Contains, the string can be no longer than 50 characters. If Origin-Realm is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"Contains",
"DontCare",
"EndsWith",
"Equal",
"NotEqual",
"StartsWith"
],
"type": "string"
},
"value": {
"maxLength": 255,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
}
},
"required": [
"appId",
"destRealm",
"origRealm",
"origHost",
"destHost",
"cmdCode"
],
"type": "object"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"diamAnsCode": {
"description": "The value placed in the Result-Code AVP of the Answer message sent whenever the action is set to SendAnswer.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"errorMessage": {
"description": "The string placed in the Error-Message AVP of the Answer message whenever the action is set to SendAnswer.",
"maxLength": 64,
"type": "string"
},
"msgCpyCfgSetName": {
"description": "The name of the Message Copy Configuration Set (/diameter/messagecopyconfigurationsets) used for copying the messages to the Diameter Application Server (DAS) when the action property is RouteToPeer. A valid msgCpyCfgSetName causes messages matched by this Peer Route Rule to be marked for copy to the DAS. If no message copy is required as a result of this Rule being hit, msgCpyCfgSetName can be omitted.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"msgPriority": {
"description": "The priority given to a Request message forwarded as the result of this Rule when the action property is set to RouteToPeer. When msgPriority is set to Nc (no change), the priority value within the forwarded request message is left unchanged. When set to a value other than Nc, the priority value within the ingress request message is explicitly set to the specified value, where Pr0 (priority 0) is the lowest priority.",
"enum": [
"Nc",
"Pr0",
"Pr1",
"Pr2",
"Pr3",
"Pr4",
"Pr5",
"Pr6",
"Pr7",
"Pr8",
"Pr9",
"Pr10",
"Pr11",
"Pr12",
"Pr13",
"Pr14",
"Pr15"
],
"type": "string"
},
"name": {
"description": "Name for the Rule, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerRouteTableName": {
"description": "The name of the Peer Route Table (/diameter/peerroutetables) to which this Peer Route Rule belongs.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"priority": {
"description": "Priority of this Rule within the Peer Route Table (/diameter/peerroutetables). A lower value means a higher priority, so a Rule whose priority is a smaller integer is preferred over a Rule whose priority is a larger integer when the two Rules are being compared for selection.",
"maximum": 1000,
"minimum": 1,
"type": "integer"
},
"routeListName": {
"description": "The name of the Route List (/diameter/routelists) associated with this Rule. A valid Route List name is required whenever the action is RouteToPeer.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"targetPrtName": {
"description": "Name of the Peer Route Table (/diameter/peerroutetables) where the message is forwarded for further processing. Clients supply a value for this attribute only when this Peer Route Rule's action is RouteToPrt.",
"type": "string"
},
"vendorId": {
"description": "The value placed in the Vendor-Id AVP of the Answer message sent whenever the action is set to SendAnswer.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
}
},
"required": [
"action",
"conditions",
"name",
"peerRouteTableName",
"priority"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"action":"SendAnswer",
"conditions":
{
"appId":
{
"operator":"DontCare"
} ,
"cmdCode":
{
"operator":"Equal",
"value":"1"
},
"destHost":
{
"operator":"EndsWith",
"value":"domain.com"
},
"destRealm":
{
"operator":"EndsWith",
"value":"domain.com"
},
"origHost":
{
"operator":"DontCare"
},
"origRealm":
{
"operator":"NotEqual",
"value":"dp.domain.com"
}
},
"diamAnsCode": 1000,
"errorMessage": "ErrorMessage",
"msgPriority": "Nc",
"name": "PeerRouteRule31",
"peerRouteTableName": "Default",
"priority": 1
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/peerrouterules
Adds a new Peer Route Rule to the specified Peer Route Table (/diameter/peerroutetables). Even though a Peer Route Rule is owned by a single Peer Route Table, each Peer Route Rule must have a name that is unique across all Peer Route Tables configured at the SOAM.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/peerrouterule/peerrouterule.json",
"properties": {
"action": {
"description": "Action associated with this Rule. When set to RouteToPeer, DSR routes the message to a Peer Node (/diameter/peernodes) using the Route List (/diameter/routelists) associated with this Rule. When set to SendAnswer, DSR abandons message routing and sends an Answer response containing the Answer Result-Code Value associated with this Rule. When set to AbandonWithNoAns, DSR discards the message and an Answer is not sent to the originating Peer Node. When set to RouteToPrt, DSR routes the message to the Peer Route Table (/diameter/peerroutetables) for further processing.",
"enum": [
"AbandonWithNoAns",
"RouteToPeer",
"RouteToPrt",
"SendAnswer"
],
"type": "string"
},
"conditions": {
"description": "The conditions associated with this Peer Route Rule. There are six conditions, and because DSR logically ANDs them, all six must be present in the Rule definition. However, any individual condition, which does not apply to the Rule, should simply have the DontCare operator assigned. The six conditions are Destination-Realm, Destination-Host, Application-Id, Command-Code, Origin-Realm, and Origin-Host. Application-Id and Command-Code refer to values found in the Diameter request message header, while the other four conditions apply to AVPs within the Diameter message body.",
"properties": {
"appId": {
"description": "The appId condition is used when it is necessary to examine the Application-Id value in the Diameter request message. The Equal operator is used to match the message's Application-ID value exactly. The NotEqual operator is used to exclude a specific Application-Id value. In either the Equal or NotEqual case, the supplied value must be an integer in the range 0-4294967295. If Application-Id is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"DontCare",
"Equal",
"NotEqual"
],
"type": "string"
},
"value": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"required": [
"operator"
],
"type": "object"
},
"cmdCode": {
"description": "The cmdCode condition is used when it is necessary to examine the Command-Code value in the Diameter request message. The Equal operator is used to match the message's Command-Code value exactly. The NotEqual operator is used to exclude a specific Command-Code value. In either the Equal or NotEqual case, the supplied value must be a configured Command Code or Extended Command Code. Command Codes are integers in the range 0-16777215, while Extended Command Codes have the form X.Y.Z, where each of X (the Command Code), Y (the AVP code), and Z (the AVP value) are integers in the range 0-16777215. If Command-Code is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"DontCare",
"Equal",
"NotEqual"
],
"type": "string"
},
"value": {
"maxLength": 30,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
},
"destHost": {
"description": "The destHost condition is used when it is necessary to examine the Destination-Host AVP value in the Diameter request message. The Equal operator is used to match the message's Destination-Host AVP value exactly. The NotEqual operator is used to exclude a specific Destination-Host value. In these two cases, the supplied value must be a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label can be no longer than 63 characters and the string can be no longer than 255 characters. If Destination-Host is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored. The StartsWith, EndsWith, and Contains operators are used as their names infer, to match the beginning, end, or any contiguous part of the Destination-Host AVP value. In any of these cases, the supplied value is a case-insensitive string limited to alphanumeric, dash ('-'), dot ('.'), and underscore ('_') characters. For EndsWith or StartsWith, the string can be no longer than 255 characters. For Contains, the string can be no longer than 50 characters. In addition, the Present and Absent operators can be used with Destination-Host. Neither Present nor Absent takes a value. If Present is used, there is a match when the Destination-Host AVP is present in the request message. If Absent is used, there is a match when the Destination-Host AVP is not present in the request message.",
"properties": {
"operator": {
"enum": [
"Absent",
"Contains",
"DontCare",
"EndsWith",
"Equal",
"NotEqual",
"Present",
"StartsWith"
],
"type": "string"
},
"value": {
"maxLength": 255,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
},
"destRealm": {
"description": "The destRealm condition is used when it is necessary to examine the Destination-Realm AVP value in the Diameter request message. The Equal operator is used to match the message's Destination-Realm AVP value exactly. The NotEqual operator is used to exclude a specific Destination-Realm value. In these two cases, the supplied value must be a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label can be no longer than 63 characters and the string can be no longer than 255 characters. The StartsWith, EndsWith, and Contains operators are used as their names infer, to match the beginning, end, or any contiguous part of the Destination-Realm AVP value. In any of these cases, the supplied value is a case-insensitive string limited to alphanumeric, dash ('-'), dot ('.'), and underscore ('_') characters. For EndsWith or StartsWith, the string can be no longer than 255 characters. For Contains, the string can be no longer than 50 characters. If Destination-Realm is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"Contains",
"DontCare",
"EndsWith",
"Equal",
"NotEqual",
"StartsWith"
],
"type": "string"
},
"value": {
"maxLength": 255,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
},
"origHost": {
"description": "The origHost condition is used when it is necessary to examine the Origin-Host AVP value in the Diameter request message. The Equal operator is used to match the message's Origin-Host AVP value exactly. The NotEqual operator is used to exclude a specific Origin-Host value. In these two cases, the supplied value must be a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label can be no longer than 63 characters and the string can be no longer than 255 characters. The StartsWith, EndsWith, and Contains operators are used as their names infer, to match the beginning, end, or any contiguous part of the Origin-Host AVP value. In any of these cases, the supplied value is a case-insensitive string limited to alphanumeric, dash ('-'), dot ('.'), and underscore ('_') characters. For EndsWith or StartsWith, the string can be no longer than 255 characters. For Contains, the string can be no longer than 50 characters. If Origin-Host is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"Contains",
"DontCare",
"EndsWith",
"Equal",
"NotEqual",
"StartsWith"
],
"type": "string"
},
"value": {
"maxLength": 255,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
},
"origRealm": {
"description": "The origRealm condition is used when it is necessary to examine the Origin-Realm AVP value in the Diameter request message. The Equal operator is used to match the message's Origin-Realm AVP value exactly. The NotEqual operator is used to exclude a specific Origin-Realm value. In these two cases, the supplied value must be a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label can be no longer than 63 characters and the string can be no longer than 255 characters. The StartsWith, EndsWith, and Contains operators are used as their names infer, to match the beginning, end, or any contiguous part of the Origin-Realm AVP value. In any of these cases, the supplied value is a case-insensitive string limited to alphanumeric, dash ('-'), dot ('.'), and underscore ('_') characters. For EndsWith or StartsWith, the string can be no longer than 255 characters. For Contains, the string can be no longer than 50 characters. If Origin-Realm is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"Contains",
"DontCare",
"EndsWith",
"Equal",
"NotEqual",
"StartsWith"
],
"type": "string"
},
"value": {
"maxLength": 255,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
}
},
"required": [
"appId",
"destRealm",
"origRealm",
"origHost",
"destHost",
"cmdCode"
],
"type": "object"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"diamAnsCode": {
"description": "The value placed in the Result-Code AVP of the Answer message sent whenever the action is set to SendAnswer.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"errorMessage": {
"description": "The string placed in the Error-Message AVP of the Answer message whenever the action is set to SendAnswer.",
"maxLength": 64,
"type": "string"
},
"msgCpyCfgSetName": {
"description": "The name of the Message Copy Configuration Set (/diameter/messagecopyconfigurationsets) used for copying the messages to the Diameter Application Server (DAS) when the action property is RouteToPeer. A valid msgCpyCfgSetName causes messages matched by this Peer Route Rule to be marked for copy to the DAS. If no message copy is required as a result of this Rule being hit, msgCpyCfgSetName can be omitted.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"msgPriority": {
"description": "The priority given to a Request message forwarded as the result of this Rule when the action property is set to RouteToPeer. When msgPriority is set to Nc (no change), the priority value within the forwarded request message is left unchanged. When set to a value other than Nc, the priority value within the ingress request message is explicitly set to the specified value, where Pr0 (priority 0) is the lowest priority.",
"enum": [
"Nc",
"Pr0",
"Pr1",
"Pr2",
"Pr3",
"Pr4",
"Pr5",
"Pr6",
"Pr7",
"Pr8",
"Pr9",
"Pr10",
"Pr11",
"Pr12",
"Pr13",
"Pr14",
"Pr15"
],
"type": "string"
},
"name": {
"description": "Name for the Rule, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerRouteTableName": {
"description": "The name of the Peer Route Table (/diameter/peerroutetables) to which this Peer Route Rule belongs.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"priority": {
"description": "Priority of this Rule within the Peer Route Table (/diameter/peerroutetables). A lower value means a higher priority, so a Rule whose priority is a smaller integer is preferred over a Rule whose priority is a larger integer when the two Rules are being compared for selection.",
"maximum": 1000,
"minimum": 1,
"type": "integer"
},
"routeListName": {
"description": "The name of the Route List (/diameter/routelists) associated with this Rule. A valid Route List name is required whenever the action is RouteToPeer.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"targetPrtName": {
"description": "Name of the Peer Route Table (/diameter/peerroutetables) where the message is forwarded for further processing. Clients supply a value for this attribute only when this Peer Route Rule's action is RouteToPrt.",
"type": "string"
},
"vendorId": {
"description": "The value placed in the Vendor-Id AVP of the Answer message sent whenever the action is set to SendAnswer.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
}
},
"required": [
"action",
"conditions",
"name",
"peerRouteTableName",
"priority"
],
"type": "object"
}
Example
{
"action":"SendAnswer",
"conditions":
{
"appId":
{
"operator":"DontCare"
} ,
"cmdCode":
{
"operator":"Equal",
"value":"1"
},
"destHost":
{
"operator":"EndsWith",
"value":"domain.com"
},
"destRealm":
{
"operator":"EndsWith",
"value":"domain.com"
},
"origHost":
{
"operator":"DontCare"
},
"origRealm":
{
"operator":"NotEqual",
"value":"dp.domain.com"
}
},
"diamAnsCode": 1000,
"errorMessage": "ErrorMessage",
"msgPriority": "Nc",
"name": "PeerRouteRule31",
"peerRouteTableName": "Default",
"priority": 1
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/peerrouterules/{name}
get /diameter/peerrouterules/{name}
Returns the configuration details for the specified Peer Route Rule. If the specified Peer Route Rule does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/peerrouteruleItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/peerrouterule/peerrouterule.json",
"properties": {
"action": {
"description": "Action associated with this Rule. When set to RouteToPeer, DSR routes the message to a Peer Node (/diameter/peernodes) using the Route List (/diameter/routelists) associated with this Rule. When set to SendAnswer, DSR abandons message routing and sends an Answer response containing the Answer Result-Code Value associated with this Rule. When set to AbandonWithNoAns, DSR discards the message and an Answer is not sent to the originating Peer Node. When set to RouteToPrt, DSR routes the message to the Peer Route Table (/diameter/peerroutetables) for further processing.",
"enum": [
"AbandonWithNoAns",
"RouteToPeer",
"RouteToPrt",
"SendAnswer"
],
"type": "string"
},
"conditions": {
"description": "The conditions associated with this Peer Route Rule. There are six conditions, and because DSR logically ANDs them, all six must be present in the Rule definition. However, any individual condition, which does not apply to the Rule, should simply have the DontCare operator assigned. The six conditions are Destination-Realm, Destination-Host, Application-Id, Command-Code, Origin-Realm, and Origin-Host. Application-Id and Command-Code refer to values found in the Diameter request message header, while the other four conditions apply to AVPs within the Diameter message body.",
"properties": {
"appId": {
"description": "The appId condition is used when it is necessary to examine the Application-Id value in the Diameter request message. The Equal operator is used to match the message's Application-ID value exactly. The NotEqual operator is used to exclude a specific Application-Id value. In either the Equal or NotEqual case, the supplied value must be an integer in the range 0-4294967295. If Application-Id is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"DontCare",
"Equal",
"NotEqual"
],
"type": "string"
},
"value": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"required": [
"operator"
],
"type": "object"
},
"cmdCode": {
"description": "The cmdCode condition is used when it is necessary to examine the Command-Code value in the Diameter request message. The Equal operator is used to match the message's Command-Code value exactly. The NotEqual operator is used to exclude a specific Command-Code value. In either the Equal or NotEqual case, the supplied value must be a configured Command Code or Extended Command Code. Command Codes are integers in the range 0-16777215, while Extended Command Codes have the form X.Y.Z, where each of X (the Command Code), Y (the AVP code), and Z (the AVP value) are integers in the range 0-16777215. If Command-Code is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"DontCare",
"Equal",
"NotEqual"
],
"type": "string"
},
"value": {
"maxLength": 30,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
},
"destHost": {
"description": "The destHost condition is used when it is necessary to examine the Destination-Host AVP value in the Diameter request message. The Equal operator is used to match the message's Destination-Host AVP value exactly. The NotEqual operator is used to exclude a specific Destination-Host value. In these two cases, the supplied value must be a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label can be no longer than 63 characters and the string can be no longer than 255 characters. If Destination-Host is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored. The StartsWith, EndsWith, and Contains operators are used as their names infer, to match the beginning, end, or any contiguous part of the Destination-Host AVP value. In any of these cases, the supplied value is a case-insensitive string limited to alphanumeric, dash ('-'), dot ('.'), and underscore ('_') characters. For EndsWith or StartsWith, the string can be no longer than 255 characters. For Contains, the string can be no longer than 50 characters. In addition, the Present and Absent operators can be used with Destination-Host. Neither Present nor Absent takes a value. If Present is used, there is a match when the Destination-Host AVP is present in the request message. If Absent is used, there is a match when the Destination-Host AVP is not present in the request message.",
"properties": {
"operator": {
"enum": [
"Absent",
"Contains",
"DontCare",
"EndsWith",
"Equal",
"NotEqual",
"Present",
"StartsWith"
],
"type": "string"
},
"value": {
"maxLength": 255,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
},
"destRealm": {
"description": "The destRealm condition is used when it is necessary to examine the Destination-Realm AVP value in the Diameter request message. The Equal operator is used to match the message's Destination-Realm AVP value exactly. The NotEqual operator is used to exclude a specific Destination-Realm value. In these two cases, the supplied value must be a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label can be no longer than 63 characters and the string can be no longer than 255 characters. The StartsWith, EndsWith, and Contains operators are used as their names infer, to match the beginning, end, or any contiguous part of the Destination-Realm AVP value. In any of these cases, the supplied value is a case-insensitive string limited to alphanumeric, dash ('-'), dot ('.'), and underscore ('_') characters. For EndsWith or StartsWith, the string can be no longer than 255 characters. For Contains, the string can be no longer than 50 characters. If Destination-Realm is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"Contains",
"DontCare",
"EndsWith",
"Equal",
"NotEqual",
"StartsWith"
],
"type": "string"
},
"value": {
"maxLength": 255,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
},
"origHost": {
"description": "The origHost condition is used when it is necessary to examine the Origin-Host AVP value in the Diameter request message. The Equal operator is used to match the message's Origin-Host AVP value exactly. The NotEqual operator is used to exclude a specific Origin-Host value. In these two cases, the supplied value must be a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label can be no longer than 63 characters and the string can be no longer than 255 characters. The StartsWith, EndsWith, and Contains operators are used as their names infer, to match the beginning, end, or any contiguous part of the Origin-Host AVP value. In any of these cases, the supplied value is a case-insensitive string limited to alphanumeric, dash ('-'), dot ('.'), and underscore ('_') characters. For EndsWith or StartsWith, the string can be no longer than 255 characters. For Contains, the string can be no longer than 50 characters. If Origin-Host is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"Contains",
"DontCare",
"EndsWith",
"Equal",
"NotEqual",
"StartsWith"
],
"type": "string"
},
"value": {
"maxLength": 255,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
},
"origRealm": {
"description": "The origRealm condition is used when it is necessary to examine the Origin-Realm AVP value in the Diameter request message. The Equal operator is used to match the message's Origin-Realm AVP value exactly. The NotEqual operator is used to exclude a specific Origin-Realm value. In these two cases, the supplied value must be a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label can be no longer than 63 characters and the string can be no longer than 255 characters. The StartsWith, EndsWith, and Contains operators are used as their names infer, to match the beginning, end, or any contiguous part of the Origin-Realm AVP value. In any of these cases, the supplied value is a case-insensitive string limited to alphanumeric, dash ('-'), dot ('.'), and underscore ('_') characters. For EndsWith or StartsWith, the string can be no longer than 255 characters. For Contains, the string can be no longer than 50 characters. If Origin-Realm is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"Contains",
"DontCare",
"EndsWith",
"Equal",
"NotEqual",
"StartsWith"
],
"type": "string"
},
"value": {
"maxLength": 255,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
}
},
"required": [
"appId",
"destRealm",
"origRealm",
"origHost",
"destHost",
"cmdCode"
],
"type": "object"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"diamAnsCode": {
"description": "The value placed in the Result-Code AVP of the Answer message sent whenever the action is set to SendAnswer.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"errorMessage": {
"description": "The string placed in the Error-Message AVP of the Answer message whenever the action is set to SendAnswer.",
"maxLength": 64,
"type": "string"
},
"msgCpyCfgSetName": {
"description": "The name of the Message Copy Configuration Set (/diameter/messagecopyconfigurationsets) used for copying the messages to the Diameter Application Server (DAS) when the action property is RouteToPeer. A valid msgCpyCfgSetName causes messages matched by this Peer Route Rule to be marked for copy to the DAS. If no message copy is required as a result of this Rule being hit, msgCpyCfgSetName can be omitted.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"msgPriority": {
"description": "The priority given to a Request message forwarded as the result of this Rule when the action property is set to RouteToPeer. When msgPriority is set to Nc (no change), the priority value within the forwarded request message is left unchanged. When set to a value other than Nc, the priority value within the ingress request message is explicitly set to the specified value, where Pr0 (priority 0) is the lowest priority.",
"enum": [
"Nc",
"Pr0",
"Pr1",
"Pr2",
"Pr3",
"Pr4",
"Pr5",
"Pr6",
"Pr7",
"Pr8",
"Pr9",
"Pr10",
"Pr11",
"Pr12",
"Pr13",
"Pr14",
"Pr15"
],
"type": "string"
},
"name": {
"description": "Name for the Rule, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerRouteTableName": {
"description": "The name of the Peer Route Table (/diameter/peerroutetables) to which this Peer Route Rule belongs.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"priority": {
"description": "Priority of this Rule within the Peer Route Table (/diameter/peerroutetables). A lower value means a higher priority, so a Rule whose priority is a smaller integer is preferred over a Rule whose priority is a larger integer when the two Rules are being compared for selection.",
"maximum": 1000,
"minimum": 1,
"type": "integer"
},
"routeListName": {
"description": "The name of the Route List (/diameter/routelists) associated with this Rule. A valid Route List name is required whenever the action is RouteToPeer.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"targetPrtName": {
"description": "Name of the Peer Route Table (/diameter/peerroutetables) where the message is forwarded for further processing. Clients supply a value for this attribute only when this Peer Route Rule's action is RouteToPrt.",
"type": "string"
},
"vendorId": {
"description": "The value placed in the Vendor-Id AVP of the Answer message sent whenever the action is set to SendAnswer.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
}
},
"required": [
"action",
"conditions",
"name",
"peerRouteTableName",
"priority"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"action":"SendAnswer",
"conditions":
{
"appId":
{
"operator":"DontCare"
} ,
"cmdCode":
{
"operator":"Equal",
"value":"1"
},
"destHost":
{
"operator":"EndsWith",
"value":"domain.com"
},
"destRealm":
{
"operator":"EndsWith",
"value":"domain.com"
},
"origHost":
{
"operator":"DontCare"
},
"origRealm":
{
"operator":"NotEqual",
"value":"dp.domain.com"
}
},
"diamAnsCode": 1000,
"errorMessage": "ErrorMessage",
"msgPriority": "Nc",
"name": "PeerRouteRule31",
"peerRouteTableName": "Default",
"priority": 1
}
,
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/peerrouterules/{name}
Updates the configuration for the specified Peer Route Rule. If the provided Peer Route Rule data is invalid in any way, the update fails, resulting in one or more error messages returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/peerrouterule/peerrouterule.json",
"properties": {
"action": {
"description": "Action associated with this Rule. When set to RouteToPeer, DSR routes the message to a Peer Node (/diameter/peernodes) using the Route List (/diameter/routelists) associated with this Rule. When set to SendAnswer, DSR abandons message routing and sends an Answer response containing the Answer Result-Code Value associated with this Rule. When set to AbandonWithNoAns, DSR discards the message and an Answer is not sent to the originating Peer Node. When set to RouteToPrt, DSR routes the message to the Peer Route Table (/diameter/peerroutetables) for further processing.",
"enum": [
"AbandonWithNoAns",
"RouteToPeer",
"RouteToPrt",
"SendAnswer"
],
"type": "string"
},
"conditions": {
"description": "The conditions associated with this Peer Route Rule. There are six conditions, and because DSR logically ANDs them, all six must be present in the Rule definition. However, any individual condition, which does not apply to the Rule, should simply have the DontCare operator assigned. The six conditions are Destination-Realm, Destination-Host, Application-Id, Command-Code, Origin-Realm, and Origin-Host. Application-Id and Command-Code refer to values found in the Diameter request message header, while the other four conditions apply to AVPs within the Diameter message body.",
"properties": {
"appId": {
"description": "The appId condition is used when it is necessary to examine the Application-Id value in the Diameter request message. The Equal operator is used to match the message's Application-ID value exactly. The NotEqual operator is used to exclude a specific Application-Id value. In either the Equal or NotEqual case, the supplied value must be an integer in the range 0-4294967295. If Application-Id is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"DontCare",
"Equal",
"NotEqual"
],
"type": "string"
},
"value": {
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
}
},
"required": [
"operator"
],
"type": "object"
},
"cmdCode": {
"description": "The cmdCode condition is used when it is necessary to examine the Command-Code value in the Diameter request message. The Equal operator is used to match the message's Command-Code value exactly. The NotEqual operator is used to exclude a specific Command-Code value. In either the Equal or NotEqual case, the supplied value must be a configured Command Code or Extended Command Code. Command Codes are integers in the range 0-16777215, while Extended Command Codes have the form X.Y.Z, where each of X (the Command Code), Y (the AVP code), and Z (the AVP value) are integers in the range 0-16777215. If Command-Code is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"DontCare",
"Equal",
"NotEqual"
],
"type": "string"
},
"value": {
"maxLength": 30,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
},
"destHost": {
"description": "The destHost condition is used when it is necessary to examine the Destination-Host AVP value in the Diameter request message. The Equal operator is used to match the message's Destination-Host AVP value exactly. The NotEqual operator is used to exclude a specific Destination-Host value. In these two cases, the supplied value must be a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label can be no longer than 63 characters and the string can be no longer than 255 characters. If Destination-Host is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored. The StartsWith, EndsWith, and Contains operators are used as their names infer, to match the beginning, end, or any contiguous part of the Destination-Host AVP value. In any of these cases, the supplied value is a case-insensitive string limited to alphanumeric, dash ('-'), dot ('.'), and underscore ('_') characters. For EndsWith or StartsWith, the string can be no longer than 255 characters. For Contains, the string can be no longer than 50 characters. In addition, the Present and Absent operators can be used with Destination-Host. Neither Present nor Absent takes a value. If Present is used, there is a match when the Destination-Host AVP is present in the request message. If Absent is used, there is a match when the Destination-Host AVP is not present in the request message.",
"properties": {
"operator": {
"enum": [
"Absent",
"Contains",
"DontCare",
"EndsWith",
"Equal",
"NotEqual",
"Present",
"StartsWith"
],
"type": "string"
},
"value": {
"maxLength": 255,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
},
"destRealm": {
"description": "The destRealm condition is used when it is necessary to examine the Destination-Realm AVP value in the Diameter request message. The Equal operator is used to match the message's Destination-Realm AVP value exactly. The NotEqual operator is used to exclude a specific Destination-Realm value. In these two cases, the supplied value must be a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label can be no longer than 63 characters and the string can be no longer than 255 characters. The StartsWith, EndsWith, and Contains operators are used as their names infer, to match the beginning, end, or any contiguous part of the Destination-Realm AVP value. In any of these cases, the supplied value is a case-insensitive string limited to alphanumeric, dash ('-'), dot ('.'), and underscore ('_') characters. For EndsWith or StartsWith, the string can be no longer than 255 characters. For Contains, the string can be no longer than 50 characters. If Destination-Realm is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"Contains",
"DontCare",
"EndsWith",
"Equal",
"NotEqual",
"StartsWith"
],
"type": "string"
},
"value": {
"maxLength": 255,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
},
"origHost": {
"description": "The origHost condition is used when it is necessary to examine the Origin-Host AVP value in the Diameter request message. The Equal operator is used to match the message's Origin-Host AVP value exactly. The NotEqual operator is used to exclude a specific Origin-Host value. In these two cases, the supplied value must be a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label can be no longer than 63 characters and the string can be no longer than 255 characters. The StartsWith, EndsWith, and Contains operators are used as their names infer, to match the beginning, end, or any contiguous part of the Origin-Host AVP value. In any of these cases, the supplied value is a case-insensitive string limited to alphanumeric, dash ('-'), dot ('.'), and underscore ('_') characters. For EndsWith or StartsWith, the string can be no longer than 255 characters. For Contains, the string can be no longer than 50 characters. If Origin-Host is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"Contains",
"DontCare",
"EndsWith",
"Equal",
"NotEqual",
"StartsWith"
],
"type": "string"
},
"value": {
"maxLength": 255,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
},
"origRealm": {
"description": "The origRealm condition is used when it is necessary to examine the Origin-Realm AVP value in the Diameter request message. The Equal operator is used to match the message's Origin-Realm AVP value exactly. The NotEqual operator is used to exclude a specific Origin-Realm value. In these two cases, the supplied value must be a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label can be no longer than 63 characters and the string can be no longer than 255 characters. The StartsWith, EndsWith, and Contains operators are used as their names infer, to match the beginning, end, or any contiguous part of the Origin-Realm AVP value. In any of these cases, the supplied value is a case-insensitive string limited to alphanumeric, dash ('-'), dot ('.'), and underscore ('_') characters. For EndsWith or StartsWith, the string can be no longer than 255 characters. For Contains, the string can be no longer than 50 characters. If Origin-Realm is not a necessary condition for this Rule, the DontCare operator must be specified, and the value attribute is ignored.",
"properties": {
"operator": {
"enum": [
"Contains",
"DontCare",
"EndsWith",
"Equal",
"NotEqual",
"StartsWith"
],
"type": "string"
},
"value": {
"maxLength": 255,
"type": "string"
}
},
"required": [
"operator"
],
"type": "object"
}
},
"required": [
"appId",
"destRealm",
"origRealm",
"origHost",
"destHost",
"cmdCode"
],
"type": "object"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"diamAnsCode": {
"description": "The value placed in the Result-Code AVP of the Answer message sent whenever the action is set to SendAnswer.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"errorMessage": {
"description": "The string placed in the Error-Message AVP of the Answer message whenever the action is set to SendAnswer.",
"maxLength": 64,
"type": "string"
},
"msgCpyCfgSetName": {
"description": "The name of the Message Copy Configuration Set (/diameter/messagecopyconfigurationsets) used for copying the messages to the Diameter Application Server (DAS) when the action property is RouteToPeer. A valid msgCpyCfgSetName causes messages matched by this Peer Route Rule to be marked for copy to the DAS. If no message copy is required as a result of this Rule being hit, msgCpyCfgSetName can be omitted.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"msgPriority": {
"description": "The priority given to a Request message forwarded as the result of this Rule when the action property is set to RouteToPeer. When msgPriority is set to Nc (no change), the priority value within the forwarded request message is left unchanged. When set to a value other than Nc, the priority value within the ingress request message is explicitly set to the specified value, where Pr0 (priority 0) is the lowest priority.",
"enum": [
"Nc",
"Pr0",
"Pr1",
"Pr2",
"Pr3",
"Pr4",
"Pr5",
"Pr6",
"Pr7",
"Pr8",
"Pr9",
"Pr10",
"Pr11",
"Pr12",
"Pr13",
"Pr14",
"Pr15"
],
"type": "string"
},
"name": {
"description": "Name for the Rule, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerRouteTableName": {
"description": "The name of the Peer Route Table (/diameter/peerroutetables) to which this Peer Route Rule belongs.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"priority": {
"description": "Priority of this Rule within the Peer Route Table (/diameter/peerroutetables). A lower value means a higher priority, so a Rule whose priority is a smaller integer is preferred over a Rule whose priority is a larger integer when the two Rules are being compared for selection.",
"maximum": 1000,
"minimum": 1,
"type": "integer"
},
"routeListName": {
"description": "The name of the Route List (/diameter/routelists) associated with this Rule. A valid Route List name is required whenever the action is RouteToPeer.",
"maxLength": 32,
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"targetPrtName": {
"description": "Name of the Peer Route Table (/diameter/peerroutetables) where the message is forwarded for further processing. Clients supply a value for this attribute only when this Peer Route Rule's action is RouteToPrt.",
"type": "string"
},
"vendorId": {
"description": "The value placed in the Vendor-Id AVP of the Answer message sent whenever the action is set to SendAnswer.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
}
},
"required": [
"action",
"conditions",
"name",
"peerRouteTableName",
"priority"
],
"type": "object"
}
Example
{
"action":"SendAnswer",
"conditions":
{
"appId":
{
"operator":"DontCare"
} ,
"cmdCode":
{
"operator":"Equal",
"value":"1"
},
"destHost":
{
"operator":"EndsWith",
"value":"domain.com"
},
"destRealm":
{
"operator":"EndsWith",
"value":"domain.com"
},
"origHost":
{
"operator":"DontCare"
},
"origRealm":
{
"operator":"NotEqual",
"value":"dp.domain.com"
}
},
"diamAnsCode": 1000,
"errorMessage": "ErrorMessage",
"msgPriority": "Nc",
"name": "PeerRouteRule31",
"peerRouteTableName": "Default",
"priority": 1
}
delete /diameter/peerrouterules/{name}
Deletes the specified Peer Route Rule from the SOAM configuration. A Peer Route Rule can always be deleted - there are no validation checks when deleting a Rule.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Diameter: Peer Route Tables
A Peer Route Table (PRT) is a collection of prioritized Peer Route Rules (/diameter/peerrouterules) the DSR searches to determine how to route a Diameter request message to a specific destination Peer Node (/diameter/peernodes). An SOAM can be configured with multiple Peer Route Tables, each of which covers a partial yet distinct subset of routing scenarios. The number and content of Peer Route Tables configured at an SOAM depends entirely on the DSR's required role within the larger Diameter network.
A given PRT can be associated with a particular Peer Node, with a particular Diameter Application ID (/diameter/applicationids), or with a Diameter Application ID/Command Code (/diameter/commandcodes) combination.
Request messages received by the DSR are compared against the Peer Route Rules within the applicable PRT. The action taken by the DSR in response to the request message is based on the highest-priority Peer Route Rule that matches the request message information. The possible actions are: route to a destination Peer Node, send an answer message to the ingress Peer Node that originated the Diameter request message, or abandon the request message.
All Peer Route Table configuration is done at the SOAM.
/diameter/peerroutetables
get /diameter/peerroutetables
Returns all Peer Route Tables configured at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those Peer Route Tables meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section).
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (one of configurationLevel)
The field being matched
Only the configurationLevel field is supported.
Example:
filter_name=configurationLevel
- filter_op: (one of GREATER_THAN, GREATER_THAN_EQUAL)
The match operation (operator)
Example:
filter_op=GREATER_THAN
- filter_values: (string)
The matched value
The configurationLevel value by which the data is being filtered. Only a single value is supported.
Example:
filter_values=10
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/peerroutetableCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/peerroutetable/peerroutetable.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name for the Peer Route Table, which must be unique within the DSR site. A name is required, and cannot be changed after the PRT is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"configurationLevel": "387",
"name": "peerRouteTable1"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/peerroutetables
Adds a new Peer Route Table to the DSR configuration. The new Peer Route Table must have a name unique to the SOAM's configuration.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/peerroutetable/peerroutetable.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name for the Peer Route Table, which must be unique within the DSR site. A name is required, and cannot be changed after the PRT is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
Example
{
"configurationLevel": "387",
"name": "peerRouteTable1"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/peerroutetables/{name}
get /diameter/peerroutetables/{name}
Returns the configuration details for the specified Peer Route Table. If the specified Peer Route Table does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/peerroutetableItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/peerroutetable/peerroutetable.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name for the Peer Route Table, which must be unique within the DSR site. A name is required, and cannot be changed after the PRT is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"configurationLevel": "387",
"name": "peerRouteTable1"
}
,
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
delete /diameter/peerroutetables/{name}
Deletes the specified Peer Route Table from the SOAM configuration. A Peer Route Table is only deleted if all delete validation checks pass. If the Peer Route Table is part of the configuration of some other Managed Object, the Peer Route Table cannot be deleted. For example, if the Peer Route Table is associated with a Peer Node (/diameter/peernodes), that association must first be removed (either by editing the Peer Node and choosing a different PRT, or deleting the Peer Node entirely). Then the Peer Route Table can be deleted from the configuration. An attempt to delete a Peer Route Table that cannot be deleted results in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Diameter: Pending Answer Timers
A Pending Answer Timer (PAT) is simply a named time duration, in milliseconds, which defines how long the DSR waits before it considers a Diameter or RADIUS request message to have timed out. A PAT can be associated directly with a Peer Node (/diameter/peernodes); it can be configured in a Routing Option Set (/diameter/routingoptionsets); or it can be configured as part of a Transaction Configuration Set (/diameter/transactionconfigurationsets) rule. The action the DSR takes when a request message times out depends on other routing configuration; the Pending Answer Timer simply identifies how long the DSR waits before a request message associated with a particular Peer Node, Routing Option Set, or Transaction Configuration Set rule is considered to have timed out.
Note that a new Pending Answer Timer is used each time a request is sent to a Peer Node. If the request is sent multiple times, a new PAT is used each time the message is sent. This distinguishes PATs from the transactionLifetime attribute of a Routing Option Set, which spans the total time allowed for all attempts to send a particular message.
/diameter/pendinganswertimers
get /diameter/pendinganswertimers
Returns all configured Pending Answer Timers.
Target Server: SOAM
Secured by x-other
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/pendinganswertimerCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/pendinganswertimer/pendinganswertimer.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name for the Pending Answer Timer, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"value": {
"description": "This value indicates how long, in milliseconds, the DSR waits to receive an answer message from the upstream Peer Node (/diameter/peernodes) after forwarding a request message. Typical value is 1000.",
"maximum": 180000,
"minimum": 100,
"type": "integer"
}
},
"required": [
"name",
"value"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"configurationLevel": "321",
"name": "Default_123",
"value": 1000
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/pendinganswertimers
Adds a new Pending Answer Timer to the DSR configuration. The new PAT must have a name that is unique across all PATs at the SOAM.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/pendinganswertimer/pendinganswertimer.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name for the Pending Answer Timer, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"value": {
"description": "This value indicates how long, in milliseconds, the DSR waits to receive an answer message from the upstream Peer Node (/diameter/peernodes) after forwarding a request message. Typical value is 1000.",
"maximum": 180000,
"minimum": 100,
"type": "integer"
}
},
"required": [
"name",
"value"
],
"type": "object"
}
Example
{
"configurationLevel": "321",
"name": "Default_123",
"value": 1000
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/pendinganswertimers/{name}
get /diameter/pendinganswertimers/{name}
Returns the configuration details for the specified Pending Answer Timer. If the specified PAT does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/pendinganswertimerItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/pendinganswertimer/pendinganswertimer.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name for the Pending Answer Timer, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"value": {
"description": "This value indicates how long, in milliseconds, the DSR waits to receive an answer message from the upstream Peer Node (/diameter/peernodes) after forwarding a request message. Typical value is 1000.",
"maximum": 180000,
"minimum": 100,
"type": "integer"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"configurationLevel": "321",
"name": "Default_123",
"value": 1000
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/pendinganswertimers/{name}
Updates the configuration for the specified Pending Answer Timer. If the provided PAT data is invalid in any way, the update will fail, resulting in one or more error messages returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/pendinganswertimer/pendinganswertimer.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name for the Pending Answer Timer, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"value": {
"description": "This value indicates how long, in milliseconds, the DSR waits to receive an answer message from the upstream Peer Node (/diameter/peernodes) after forwarding a request message. Typical value is 1000.",
"maximum": 180000,
"minimum": 100,
"type": "integer"
}
},
"required": [
"name",
"value"
],
"type": "object"
}
Example
{
"configurationLevel": "321",
"name": "Default_123",
"value": 1000
}
delete /diameter/pendinganswertimers/{name}
Deletes the specified Pending Answer Timer from the SOAM configuration. A PAT will only be deleted if all delete validation checks pass. In general, if the PAT is part of the configuration of some other Managed Object, the PAT cannot be deleted. For example, if the PAT is named by a Transaction Configuration Set (/diameter/transactionconfigurationset) rule, the PAT must first be removed from the rule. Then the PAT can be deleted from the configuration. An attempt to delete a PAT that cannot be deleted will result in an error message returned within the HTTP response.
Secured by x-other
Request
URI Parameters
- name: required (string)
Diameter: Pending Transaction Limiting Configuration Sets
Pending Transaction Limiting Configuration Sets provide the mechanism to enter configuration data needed by Egress Throttle Groups (ETGs) (/diameter/egressthrottlegroups) (on the SOAM) and Egress Throttle Lists (ETLs) (/diameter/egressthrottlelists) (on the NOAM) to determine when to start throttling for pending transactions.
Pending Transaction Limiting Configuration Sets can be configured at either the NOAM or the SOAM. When configured at the NOAM, the Pending Transaction Limiting Configuration Set can be applied to any ETL also configured at the NOAM. When configured at the SOAM, the Pending Transaction Limiting Configuration Set can be applied to any ETG also configured at the same SOAM. Under no circumstance can a Pending Transaction Limiting Configuration Set configured at the NOAM be assigned to an ETG, nor can a Configuration Set configured at an SOAM be assigned to an ETL.
/diameter/pendingtransactionlimitingconfigurationsets
get /diameter/pendingtransactionlimitingconfigurationsets
Returns all Pending Transaction Limiting Configuration Sets configured at the NOAM or SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those Pending Transaction Limiting Configuration Sets meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section).
Target Servers: NOAM or SOAM
Secured by x-other
Request
Query Parameters
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/pendingtransactionlimitingconfigurationsetCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/pendingtransactionlimitingconfigurationset/pendingtransactionlimitingconfigurationset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"maxPendTrans": {
"description": "The maximum allowed egress pending transactions shared by associated members.",
"maximum": 1000000,
"minimum": 100,
"type": "integer"
},
"name": {
"description": "Name for the Pending Transaction Limiting Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit. This value is required for all Pending Transaction Limiting Configuration Sets.",
"maxLength": 32,
"minLength": 1,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"pendConvergenceTime": {
"description": "The time, in milliseconds, it takes to converge on a per second rate. If the convergence time is less than 1000 msec, the rate is extrapolated. If the convergence time is greater than 1000 msec, the rate is averaged. Typical value is 1000.",
"enum": [250, 500, 1000, 2000, 4000],
"type": "integer"
},
"pendTransAbateThresh1": {
"description": "A percentage of maxPendTrans. When the number of egress pending transactions falls below the pendTransAbateThresh1, the congestion level is set to 0. Typical value is 55. Abatement Threshold Level 1 will be ignored if ETG Mode is Limit.",
"maximum": 99,
"minimum": 1,
"type": "integer"
},
"pendTransAbateThresh2": {
"description": "A percentage of maxPendTrans. When the number of egress pending transactions falls below the pendTransAbateThresh2, the congestion level is set to 1. Abatement Threshold Level 2 will be ignored if ETG Mode is Limit.",
"maximum": 99,
"minimum": 3,
"type": "integer"
},
"pendTransAbateThresh3": {
"description": "A percentage of maxPendTrans. When the number of egress pending transactions falls below the pendTransAbateThresh3, the congestion level is set to 2. Abatement Threshold Level 3 will be ignored if ETG Mode is Limit.",
"maximum": 99,
"minimum": 5,
"type": "integer"
},
"pendTransAbateTime": {
"description": "The time, in milliseconds, the egress pending transactions must remain below an abatement threshold before the Congestion Level is lowered. Typical value is 50.",
"maximum": 10000,
"minimum": 50,
"type": "integer"
},
"pendTransOnsetThresh1": {
"description": "A percentage of maxPendTrans. When the number of egress pending transactions exceeds the pendTransOnsetThresh1, the congestion level is set to 1. Typical value is 60. Onset Threshold Level 1 will be ignored if ETG Mode is Limit.",
"maximum": 100,
"minimum": 2,
"type": "integer"
},
"pendTransOnsetThresh2": {
"description": "A percentage of maxPendTrans. When the number of egress pending transactions exceeds the pendTransOnsetThresh2, the congestion level is set to 2. Onset Threshold Level 2 will be ignored if ETG Mode is Limit.",
"maximum": 100,
"minimum": 4,
"type": "integer"
},
"pendTransOnsetThresh3": {
"description": "A percentage of maxPendTrans. When the number of egress pending transactions exceeds the pendTransOnsetThresh3, the congestion level is set to 3. Onset Threshold Level 3 will be ignored if ETG Mode is Limit.",
"maximum": 100,
"minimum": 6,
"type": "integer"
}
},
"required": [
"maxPendTrans",
"name",
"pendTransAbateThresh1",
"pendTransAbateTime",
"pendTransOnsetThresh1"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"configurationLevel": "47",
"maxPendTrans": 6000,
"name": "PendingTransactionLimitingConfiguration1",
"pendTransAbateThresh1": 55,
"pendTransAbateThresh2": 65,
"pendTransAbateThresh3": 80,
"pendTransAbateTime": 50,
"pendTransOnsetThresh1": 60,
"pendTransOnsetThresh2": 70,
"pendTransOnsetThresh3": 90
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/pendingtransactionlimitingconfigurationsets
Adds a new Pending Transaction Limiting Configuration Set to the configuration of the NOAM or SOAM that receives the POST request. The new Pending Transaction Limiting Configuration Set name must be unique to the OAM server that receives the POST request.
Target Servers: NOAM or SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/pendingtransactionlimitingconfigurationset/pendingtransactionlimitingconfigurationset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"maxPendTrans": {
"description": "The maximum allowed egress pending transactions shared by associated members.",
"maximum": 1000000,
"minimum": 100,
"type": "integer"
},
"name": {
"description": "Name for the Pending Transaction Limiting Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit. This value is required for all Pending Transaction Limiting Configuration Sets.",
"maxLength": 32,
"minLength": 1,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"pendConvergenceTime": {
"description": "The time, in milliseconds, it takes to converge on a per second rate. If the convergence time is less than 1000 msec, the rate is extrapolated. If the convergence time is greater than 1000 msec, the rate is averaged. Typical value is 1000.",
"enum": [250, 500, 1000, 2000, 4000],
"type": "integer"
},
"pendTransAbateThresh1": {
"description": "A percentage of maxPendTrans. When the number of egress pending transactions falls below the pendTransAbateThresh1, the congestion level is set to 0. Typical value is 55. Abatement Threshold Level 1 will be ignored if ETG Mode is Limit.",
"maximum": 99,
"minimum": 1,
"type": "integer"
},
"pendTransAbateThresh2": {
"description": "A percentage of maxPendTrans. When the number of egress pending transactions falls below the pendTransAbateThresh2, the congestion level is set to 1. Abatement Threshold Level 2 will be ignored if ETG Mode is Limit.",
"maximum": 99,
"minimum": 3,
"type": "integer"
},
"pendTransAbateThresh3": {
"description": "A percentage of maxPendTrans. When the number of egress pending transactions falls below the pendTransAbateThresh3, the congestion level is set to 2. Abatement Threshold Level 3 will be ignored if ETG Mode is Limit.",
"maximum": 99,
"minimum": 5,
"type": "integer"
},
"pendTransAbateTime": {
"description": "The time, in milliseconds, the egress pending transactions must remain below an abatement threshold before the Congestion Level is lowered. Typical value is 50.",
"maximum": 10000,
"minimum": 50,
"type": "integer"
},
"pendTransOnsetThresh1": {
"description": "A percentage of maxPendTrans. When the number of egress pending transactions exceeds the pendTransOnsetThresh1, the congestion level is set to 1. Typical value is 60. Onset Threshold Level 1 will be ignored if ETG Mode is Limit.",
"maximum": 100,
"minimum": 2,
"type": "integer"
},
"pendTransOnsetThresh2": {
"description": "A percentage of maxPendTrans. When the number of egress pending transactions exceeds the pendTransOnsetThresh2, the congestion level is set to 2. Onset Threshold Level 2 will be ignored if ETG Mode is Limit.",
"maximum": 100,
"minimum": 4,
"type": "integer"
},
"pendTransOnsetThresh3": {
"description": "A percentage of maxPendTrans. When the number of egress pending transactions exceeds the pendTransOnsetThresh3, the congestion level is set to 3. Onset Threshold Level 3 will be ignored if ETG Mode is Limit.",
"maximum": 100,
"minimum": 6,
"type": "integer"
}
},
"required": [
"maxPendTrans",
"name",
"pendTransAbateThresh1",
"pendTransAbateTime",
"pendTransOnsetThresh1"
],
"type": "object"
}
Example
{
"configurationLevel": "47",
"maxPendTrans": 6000,
"name": "PendingTransactionLimitingConfiguration1",
"pendTransAbateThresh1": 55,
"pendTransAbateThresh2": 65,
"pendTransAbateThresh3": 80,
"pendTransAbateTime": 50,
"pendTransOnsetThresh1": 60,
"pendTransOnsetThresh2": 70,
"pendTransOnsetThresh3": 90
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/pendingtransactionlimitingconfigurationsets/{name}
get /diameter/pendingtransactionlimitingconfigurationsets/{name}
Returns the configuration details for the Pending Transaction Limiting Configuration Set. If the Pending Transaction Limiting Configuration Set does not exist in the target SOAM's or NOAM's configuration, an error message is returned within the HTTP response.
Target Servers: NOAM or SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/pendingtransactionlimitingconfigurationsetItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/pendingtransactionlimitingconfigurationset/pendingtransactionlimitingconfigurationset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"maxPendTrans": {
"description": "The maximum allowed egress pending transactions shared by associated members.",
"maximum": 1000000,
"minimum": 100,
"type": "integer"
},
"name": {
"description": "Name for the Pending Transaction Limiting Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit. This value is required for all Pending Transaction Limiting Configuration Sets.",
"maxLength": 32,
"minLength": 1,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"pendConvergenceTime": {
"description": "The time, in milliseconds, it takes to converge on a per second rate. If the convergence time is less than 1000 msec, the rate is extrapolated. If the convergence time is greater than 1000 msec, the rate is averaged. Typical value is 1000.",
"enum": [250, 500, 1000, 2000, 4000],
"type": "integer"
},
"pendTransAbateThresh1": {
"description": "A percentage of maxPendTrans. When the number of egress pending transactions falls below the pendTransAbateThresh1, the congestion level is set to 0. Typical value is 55. Abatement Threshold Level 1 will be ignored if ETG Mode is Limit.",
"maximum": 99,
"minimum": 1,
"type": "integer"
},
"pendTransAbateThresh2": {
"description": "A percentage of maxPendTrans. When the number of egress pending transactions falls below the pendTransAbateThresh2, the congestion level is set to 1. Abatement Threshold Level 2 will be ignored if ETG Mode is Limit.",
"maximum": 99,
"minimum": 3,
"type": "integer"
},
"pendTransAbateThresh3": {
"description": "A percentage of maxPendTrans. When the number of egress pending transactions falls below the pendTransAbateThresh3, the congestion level is set to 2. Abatement Threshold Level 3 will be ignored if ETG Mode is Limit.",
"maximum": 99,
"minimum": 5,
"type": "integer"
},
"pendTransAbateTime": {
"description": "The time, in milliseconds, the egress pending transactions must remain below an abatement threshold before the Congestion Level is lowered. Typical value is 50.",
"maximum": 10000,
"minimum": 50,
"type": "integer"
},
"pendTransOnsetThresh1": {
"description": "A percentage of maxPendTrans. When the number of egress pending transactions exceeds the pendTransOnsetThresh1, the congestion level is set to 1. Typical value is 60. Onset Threshold Level 1 will be ignored if ETG Mode is Limit.",
"maximum": 100,
"minimum": 2,
"type": "integer"
},
"pendTransOnsetThresh2": {
"description": "A percentage of maxPendTrans. When the number of egress pending transactions exceeds the pendTransOnsetThresh2, the congestion level is set to 2. Onset Threshold Level 2 will be ignored if ETG Mode is Limit.",
"maximum": 100,
"minimum": 4,
"type": "integer"
},
"pendTransOnsetThresh3": {
"description": "A percentage of maxPendTrans. When the number of egress pending transactions exceeds the pendTransOnsetThresh3, the congestion level is set to 3. Onset Threshold Level 3 will be ignored if ETG Mode is Limit.",
"maximum": 100,
"minimum": 6,
"type": "integer"
}
},
"required": [
"maxPendTrans",
"name",
"pendTransAbateThresh1",
"pendTransAbateTime",
"pendTransOnsetThresh1"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"configurationLevel": "47",
"maxPendTrans": 6000,
"name": "PendingTransactionLimitingConfiguration1",
"pendTransAbateThresh1": 55,
"pendTransAbateThresh2": 65,
"pendTransAbateThresh3": 80,
"pendTransAbateTime": 50,
"pendTransOnsetThresh1": 60,
"pendTransOnsetThresh2": 70,
"pendTransOnsetThresh3": 90
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/pendingtransactionlimitingconfigurationsets/{name}
Updates the configuration of the specified Pending Transaction Limiting Configuration Set.
Target Servers: NOAM or SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/pendingtransactionlimitingconfigurationset/pendingtransactionlimitingconfigurationset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"maxPendTrans": {
"description": "The maximum allowed egress pending transactions shared by associated members.",
"maximum": 1000000,
"minimum": 100,
"type": "integer"
},
"name": {
"description": "Name for the Pending Transaction Limiting Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit. This value is required for all Pending Transaction Limiting Configuration Sets.",
"maxLength": 32,
"minLength": 1,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"pendConvergenceTime": {
"description": "The time, in milliseconds, it takes to converge on a per second rate. If the convergence time is less than 1000 msec, the rate is extrapolated. If the convergence time is greater than 1000 msec, the rate is averaged. Typical value is 1000.",
"enum": [250, 500, 1000, 2000, 4000],
"type": "integer"
},
"pendTransAbateThresh1": {
"description": "A percentage of maxPendTrans. When the number of egress pending transactions falls below the pendTransAbateThresh1, the congestion level is set to 0. Typical value is 55. Abatement Threshold Level 1 will be ignored if ETG Mode is Limit.",
"maximum": 99,
"minimum": 1,
"type": "integer"
},
"pendTransAbateThresh2": {
"description": "A percentage of maxPendTrans. When the number of egress pending transactions falls below the pendTransAbateThresh2, the congestion level is set to 1. Abatement Threshold Level 2 will be ignored if ETG Mode is Limit.",
"maximum": 99,
"minimum": 3,
"type": "integer"
},
"pendTransAbateThresh3": {
"description": "A percentage of maxPendTrans. When the number of egress pending transactions falls below the pendTransAbateThresh3, the congestion level is set to 2. Abatement Threshold Level 3 will be ignored if ETG Mode is Limit.",
"maximum": 99,
"minimum": 5,
"type": "integer"
},
"pendTransAbateTime": {
"description": "The time, in milliseconds, the egress pending transactions must remain below an abatement threshold before the Congestion Level is lowered. Typical value is 50.",
"maximum": 10000,
"minimum": 50,
"type": "integer"
},
"pendTransOnsetThresh1": {
"description": "A percentage of maxPendTrans. When the number of egress pending transactions exceeds the pendTransOnsetThresh1, the congestion level is set to 1. Typical value is 60. Onset Threshold Level 1 will be ignored if ETG Mode is Limit.",
"maximum": 100,
"minimum": 2,
"type": "integer"
},
"pendTransOnsetThresh2": {
"description": "A percentage of maxPendTrans. When the number of egress pending transactions exceeds the pendTransOnsetThresh2, the congestion level is set to 2. Onset Threshold Level 2 will be ignored if ETG Mode is Limit.",
"maximum": 100,
"minimum": 4,
"type": "integer"
},
"pendTransOnsetThresh3": {
"description": "A percentage of maxPendTrans. When the number of egress pending transactions exceeds the pendTransOnsetThresh3, the congestion level is set to 3. Onset Threshold Level 3 will be ignored if ETG Mode is Limit.",
"maximum": 100,
"minimum": 6,
"type": "integer"
}
},
"required": [
"maxPendTrans",
"name",
"pendTransAbateThresh1",
"pendTransAbateTime",
"pendTransOnsetThresh1"
],
"type": "object"
}
Example
{
"configurationLevel": "47",
"maxPendTrans": 6000,
"name": "PendingTransactionLimitingConfiguration1",
"pendTransAbateThresh1": 55,
"pendTransAbateThresh2": 65,
"pendTransAbateThresh3": 80,
"pendTransAbateTime": 50,
"pendTransOnsetThresh1": 60,
"pendTransOnsetThresh2": 70,
"pendTransOnsetThresh3": 90
}
delete /diameter/pendingtransactionlimitingconfigurationsets/{name}
Deletes the specified Pending Transaction Limiting Configuration Set from the SOAM or NOAM configuration. A Pending Transaction Limiting Configuration Set can only be deleted if all delete validation checks pass. In general, if the Pending Transaction Limiting Configuration Set is part of the configuration of some other Managed Object, the Pending Transaction Limiting Configuration Set cannot be deleted. For example, if the Pending Transaction Limiting Configuration Set is named in an Egress Throttle Group (/diameter/egressthrottlegroups), the Pending Transaction Limiting Configuration Set must be removed from the Egress Throttle Group. Then the Pending Transaction Limiting Configuration Set can be deleted from the configuration. An attempt to delete a Pending Transaction Limiting Configuration Set that cannot be deleted results in an error message returned within the HTTP response.
Target Servers: NOAM or SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Diameter: Rate Limiting Configuration Sets
Rate Limiting Configuration Sets provide the mechanism to enter configuration data needed by Egress Throttle Groups (ETGs) (/diameter/egressthrottlegroups) (on the SOAM) and Egress Throttle Lists (ETLs) (/diameter/egressthrottlelists) (on the NOAM) to perform egress throttling by egress message rate.
Rate Limiting Configuration Sets can be configured at either the NOAM or the SOAM. When configured at the NOAM, the Rate Limiting Configuration Set can be applied to any ETL also configured at the NOAM. When configured at the SOAM, the Rate Limiting Configuration Set can be applied to any ETG also configured at the same SOAM. Under no circumstance can a Rate Limiting Configuration Set configured at the NOAM be assigned to an ETG, nor can a Configuration Set configured at an SOAM be assigned to an ETL.
/diameter/ratelimitingconfigurationsets
get /diameter/ratelimitingconfigurationsets
Returns all Rate Limiting Configuration Sets configured at the NOAM or SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those Rate Limiting Configuration Sets meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section).
Target Servers: NOAM or SOAM
Secured by x-other
Request
Query Parameters
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/ratelimitingconfigurationsetCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/ratelimitingconfigurationset/ratelimitingconfigurationset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"maxRate": {
"description": "The maximum allowed egress request rate shared by associated members. Typical value is 6000.",
"maximum": 250000,
"minimum": 100,
"type": "integer"
},
"name": {
"description": "Name for the Rate Limiting Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit. This value is required for all Rate Limiting Configuration Sets.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"rateAbateThresh1": {
"description": "A percentage of maxRate. When the egress request rate falls below the rateAbateThresh1, the congestion level is set to 0. Typical value is 55. Abatement Threshold Level 1 will be ignored if ETG Mode is Limit.",
"maximum": 99,
"minimum": 1,
"type": "integer"
},
"rateAbateThresh2": {
"description": "A percentage of maxRate. When the egress request rate falls below the rateAbateThresh2, the congestion level is set to 1. Abatement Threshold Level 2 will be ignored if ETG Mode is Limit.",
"maximum": 99,
"minimum": 3,
"type": "integer"
},
"rateAbateThresh3": {
"description": "A percentage of maxRate. When the egress request rate falls below the rateAbateThresh3, the congestion level is set to 2. Abatement Threshold Level 3 will be ignored if ETG Mode is Limit.",
"maximum": 99,
"minimum": 5,
"type": "integer"
},
"rateAbateTime": {
"description": "The time, in milliseconds, the egress request rate must remain below an abatement threshold before the Congestion Level is lowered. Typical value is 50.",
"maximum": 10000,
"minimum": 50,
"type": "integer"
},
"rateConvergenceTime": {
"description": "The time, in milliseconds, it takes to converge on a per second rate. If the convergence time is less than 1000 msec, the rate is extrapolated. If the convergence time is greater than 1000 msec, the rate is averaged. Typical value is 1000.",
"enum": [250, 500, 1000, 2000, 4000],
"type": "integer"
},
"rateOnsetThresh1": {
"description": "A percentage of maxRate. When the egress request rate exceeds the rateOnsetThresh1, the congestion level is set to 1. Typical value is 60. Onset Threshold Level 1 will be ignored if ETG Mode is Limit.",
"maximum": 100,
"minimum": 2,
"type": "integer"
},
"rateOnsetThresh2": {
"description": "A percentage of maxRate. When the egress request rate exceeds the rateOnsetThresh2, the congestion level is set to 2. Onset Threshold Level 2 will be ignored if ETG Mode is Limit.",
"maximum": 100,
"minimum": 4,
"type": "integer"
},
"rateOnsetThresh3": {
"description": "A percentage of maxRate. When the egress request rate exceeds the rateOnsetThresh3, the congestion level is set to 3. Onset Threshold Level 3 will be ignored if ETG Mode is Limit.",
"maximum": 100,
"minimum": 6,
"type": "integer"
}
},
"required": [
"maxRate",
"name",
"rateOnsetThresh1",
"rateAbateTime",
"rateAbateThresh1",
"rateConvergenceTime"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"configurationLevel": "47",
"maxRate": 6000,
"name": "RateLimitingConfigurationSet1",
"rateAbateThresh1": 55,
"rateAbateThresh2": 65,
"rateAbateThresh3": 80,
"rateAbateTime": 50,
"rateConvergenceTime": 250,
"rateOnsetThresh1": 60,
"rateOnsetThresh2": 70,
"rateOnsetThresh3": 90
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/ratelimitingconfigurationsets
Adds a new Rate Limiting Configuration Set to the configuration of the NOAM or SOAM that receives the POST request. The new Rate Limiting Configuration Set name must be unique to the OAM server that receives the PSOT request.
Target Servers: NOAM or SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/ratelimitingconfigurationset/ratelimitingconfigurationset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"maxRate": {
"description": "The maximum allowed egress request rate shared by associated members. Typical value is 6000.",
"maximum": 250000,
"minimum": 100,
"type": "integer"
},
"name": {
"description": "Name for the Rate Limiting Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit. This value is required for all Rate Limiting Configuration Sets.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"rateAbateThresh1": {
"description": "A percentage of maxRate. When the egress request rate falls below the rateAbateThresh1, the congestion level is set to 0. Typical value is 55. Abatement Threshold Level 1 will be ignored if ETG Mode is Limit.",
"maximum": 99,
"minimum": 1,
"type": "integer"
},
"rateAbateThresh2": {
"description": "A percentage of maxRate. When the egress request rate falls below the rateAbateThresh2, the congestion level is set to 1. Abatement Threshold Level 2 will be ignored if ETG Mode is Limit.",
"maximum": 99,
"minimum": 3,
"type": "integer"
},
"rateAbateThresh3": {
"description": "A percentage of maxRate. When the egress request rate falls below the rateAbateThresh3, the congestion level is set to 2. Abatement Threshold Level 3 will be ignored if ETG Mode is Limit.",
"maximum": 99,
"minimum": 5,
"type": "integer"
},
"rateAbateTime": {
"description": "The time, in milliseconds, the egress request rate must remain below an abatement threshold before the Congestion Level is lowered. Typical value is 50.",
"maximum": 10000,
"minimum": 50,
"type": "integer"
},
"rateConvergenceTime": {
"description": "The time, in milliseconds, it takes to converge on a per second rate. If the convergence time is less than 1000 msec, the rate is extrapolated. If the convergence time is greater than 1000 msec, the rate is averaged. Typical value is 1000.",
"enum": [250, 500, 1000, 2000, 4000],
"type": "integer"
},
"rateOnsetThresh1": {
"description": "A percentage of maxRate. When the egress request rate exceeds the rateOnsetThresh1, the congestion level is set to 1. Typical value is 60. Onset Threshold Level 1 will be ignored if ETG Mode is Limit.",
"maximum": 100,
"minimum": 2,
"type": "integer"
},
"rateOnsetThresh2": {
"description": "A percentage of maxRate. When the egress request rate exceeds the rateOnsetThresh2, the congestion level is set to 2. Onset Threshold Level 2 will be ignored if ETG Mode is Limit.",
"maximum": 100,
"minimum": 4,
"type": "integer"
},
"rateOnsetThresh3": {
"description": "A percentage of maxRate. When the egress request rate exceeds the rateOnsetThresh3, the congestion level is set to 3. Onset Threshold Level 3 will be ignored if ETG Mode is Limit.",
"maximum": 100,
"minimum": 6,
"type": "integer"
}
},
"required": [
"maxRate",
"name",
"rateOnsetThresh1",
"rateAbateTime",
"rateAbateThresh1",
"rateConvergenceTime"
],
"type": "object"
}
Example
{
"configurationLevel": "47",
"maxRate": 6000,
"name": "RateLimitingConfigurationSet1",
"rateAbateThresh1": 55,
"rateAbateThresh2": 65,
"rateAbateThresh3": 80,
"rateAbateTime": 50,
"rateConvergenceTime": 250,
"rateOnsetThresh1": 60,
"rateOnsetThresh2": 70,
"rateOnsetThresh3": 90
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/ratelimitingconfigurationsets/{name}
get /diameter/ratelimitingconfigurationsets/{name}
Returns the configuration details for the Rate Limiting Configuration Set. If the Rate Limiting Configuration Set does not exist in the target SOAM's or NOAM's configuration, an error message is returned within the HTTP response.
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/ratelimitingconfigurationsetItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/ratelimitingconfigurationset/ratelimitingconfigurationset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"maxRate": {
"description": "The maximum allowed egress request rate shared by associated members. Typical value is 6000.",
"maximum": 250000,
"minimum": 100,
"type": "integer"
},
"name": {
"description": "Name for the Rate Limiting Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit. This value is required for all Rate Limiting Configuration Sets.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"rateAbateThresh1": {
"description": "A percentage of maxRate. When the egress request rate falls below the rateAbateThresh1, the congestion level is set to 0. Typical value is 55. Abatement Threshold Level 1 will be ignored if ETG Mode is Limit.",
"maximum": 99,
"minimum": 1,
"type": "integer"
},
"rateAbateThresh2": {
"description": "A percentage of maxRate. When the egress request rate falls below the rateAbateThresh2, the congestion level is set to 1. Abatement Threshold Level 2 will be ignored if ETG Mode is Limit.",
"maximum": 99,
"minimum": 3,
"type": "integer"
},
"rateAbateThresh3": {
"description": "A percentage of maxRate. When the egress request rate falls below the rateAbateThresh3, the congestion level is set to 2. Abatement Threshold Level 3 will be ignored if ETG Mode is Limit.",
"maximum": 99,
"minimum": 5,
"type": "integer"
},
"rateAbateTime": {
"description": "The time, in milliseconds, the egress request rate must remain below an abatement threshold before the Congestion Level is lowered. Typical value is 50.",
"maximum": 10000,
"minimum": 50,
"type": "integer"
},
"rateConvergenceTime": {
"description": "The time, in milliseconds, it takes to converge on a per second rate. If the convergence time is less than 1000 msec, the rate is extrapolated. If the convergence time is greater than 1000 msec, the rate is averaged. Typical value is 1000.",
"enum": [250, 500, 1000, 2000, 4000],
"type": "integer"
},
"rateOnsetThresh1": {
"description": "A percentage of maxRate. When the egress request rate exceeds the rateOnsetThresh1, the congestion level is set to 1. Typical value is 60. Onset Threshold Level 1 will be ignored if ETG Mode is Limit.",
"maximum": 100,
"minimum": 2,
"type": "integer"
},
"rateOnsetThresh2": {
"description": "A percentage of maxRate. When the egress request rate exceeds the rateOnsetThresh2, the congestion level is set to 2. Onset Threshold Level 2 will be ignored if ETG Mode is Limit.",
"maximum": 100,
"minimum": 4,
"type": "integer"
},
"rateOnsetThresh3": {
"description": "A percentage of maxRate. When the egress request rate exceeds the rateOnsetThresh3, the congestion level is set to 3. Onset Threshold Level 3 will be ignored if ETG Mode is Limit.",
"maximum": 100,
"minimum": 6,
"type": "integer"
}
},
"required": [
"maxRate",
"name",
"rateOnsetThresh1",
"rateAbateTime",
"rateAbateThresh1",
"rateConvergenceTime"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"configurationLevel": "47",
"maxRate": 6000,
"name": "RateLimitingConfigurationSet1",
"rateAbateThresh1": 55,
"rateAbateThresh2": 65,
"rateAbateThresh3": 80,
"rateAbateTime": 50,
"rateConvergenceTime": 250,
"rateOnsetThresh1": 60,
"rateOnsetThresh2": 70,
"rateOnsetThresh3": 90
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/ratelimitingconfigurationsets/{name}
Updates the configuration of the specified Rate Limiting Configuration Set.
Target Servers: NOAM or SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/ratelimitingconfigurationset/ratelimitingconfigurationset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"maxRate": {
"description": "The maximum allowed egress request rate shared by associated members. Typical value is 6000.",
"maximum": 250000,
"minimum": 100,
"type": "integer"
},
"name": {
"description": "Name for the Rate Limiting Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit. This value is required for all Rate Limiting Configuration Sets.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"rateAbateThresh1": {
"description": "A percentage of maxRate. When the egress request rate falls below the rateAbateThresh1, the congestion level is set to 0. Typical value is 55. Abatement Threshold Level 1 will be ignored if ETG Mode is Limit.",
"maximum": 99,
"minimum": 1,
"type": "integer"
},
"rateAbateThresh2": {
"description": "A percentage of maxRate. When the egress request rate falls below the rateAbateThresh2, the congestion level is set to 1. Abatement Threshold Level 2 will be ignored if ETG Mode is Limit.",
"maximum": 99,
"minimum": 3,
"type": "integer"
},
"rateAbateThresh3": {
"description": "A percentage of maxRate. When the egress request rate falls below the rateAbateThresh3, the congestion level is set to 2. Abatement Threshold Level 3 will be ignored if ETG Mode is Limit.",
"maximum": 99,
"minimum": 5,
"type": "integer"
},
"rateAbateTime": {
"description": "The time, in milliseconds, the egress request rate must remain below an abatement threshold before the Congestion Level is lowered. Typical value is 50.",
"maximum": 10000,
"minimum": 50,
"type": "integer"
},
"rateConvergenceTime": {
"description": "The time, in milliseconds, it takes to converge on a per second rate. If the convergence time is less than 1000 msec, the rate is extrapolated. If the convergence time is greater than 1000 msec, the rate is averaged. Typical value is 1000.",
"enum": [250, 500, 1000, 2000, 4000],
"type": "integer"
},
"rateOnsetThresh1": {
"description": "A percentage of maxRate. When the egress request rate exceeds the rateOnsetThresh1, the congestion level is set to 1. Typical value is 60. Onset Threshold Level 1 will be ignored if ETG Mode is Limit.",
"maximum": 100,
"minimum": 2,
"type": "integer"
},
"rateOnsetThresh2": {
"description": "A percentage of maxRate. When the egress request rate exceeds the rateOnsetThresh2, the congestion level is set to 2. Onset Threshold Level 2 will be ignored if ETG Mode is Limit.",
"maximum": 100,
"minimum": 4,
"type": "integer"
},
"rateOnsetThresh3": {
"description": "A percentage of maxRate. When the egress request rate exceeds the rateOnsetThresh3, the congestion level is set to 3. Onset Threshold Level 3 will be ignored if ETG Mode is Limit.",
"maximum": 100,
"minimum": 6,
"type": "integer"
}
},
"required": [
"maxRate",
"name",
"rateOnsetThresh1",
"rateAbateTime",
"rateAbateThresh1",
"rateConvergenceTime"
],
"type": "object"
}
Example
{
"configurationLevel": "47",
"maxRate": 6000,
"name": "RateLimitingConfigurationSet1",
"rateAbateThresh1": 55,
"rateAbateThresh2": 65,
"rateAbateThresh3": 80,
"rateAbateTime": 50,
"rateConvergenceTime": 250,
"rateOnsetThresh1": 60,
"rateOnsetThresh2": 70,
"rateOnsetThresh3": 90
}
delete /diameter/ratelimitingconfigurationsets/{name}
Deletes the specified Rate Limiting Configuration Set from the SOAM or NOAM configuration. A Rate Limiting Configuration Set can only be deleted if all delete validation checks pass. In general, if the Rate Limiting Configuration Set is part of the configuration of some other Managed Object, the Rate Limiting Configuration Set cannot be deleted. For example, if the Rate Limiting Configuration Set is named in an Egress Throttle Group (/diameter/egressthrottlegroups), the Rate Limiting Configuration Set must be removed from the Egress Throttle Group. Then the Rate Limiting Configuration Set can be deleted from the configuration. An attempt to delete a Rate Limiting Configuration Set that cannot be deleted results in an error message returned within the HTTP response.
Target Servers: NOAM or SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Diameter: Reroute On Answer
Reroute On Answer controls where the DSR redirects an answer message. The action taken by the DSR in response to an answer message is based on the configured ordered pair of Application Id and Result-Code Attribute-Value Pair (AVP).
All Reroute On Answer configuration is done at the SOAM.
/diameter/reroutesonanswer
get /diameter/reroutesonanswer
Returns all Reroute On Answer values configured at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those Reroute On Answer values meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section).
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (one of configurationLevel)
The field being matched
Only the configurationLevel field is supported.
Example:
filter_name=configurationLevel
- filter_op: (one of GREATER_THAN, GREATER_THAN_EQUAL)
The match operation (operator)
Example:
filter_op=GREATER_THAN
- filter_values: (string)
The matched value
The configurationLevel value by which the data is being filtered. Only a single value is supported.
Example:
filter_values=10
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/reroutesonanswerCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/reroutesonanswer/reroutesonanswer.json",
"properties": {
"ansResultCode": {
"description": "The Result-Code AVP value in the answer.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"appId": {
"description": "The Application Id (/diameter/applicationid) in the answer identifying the Diameter Application. To include all Application Ids, set ruleAppliesToAllAppIds to true, the value for appId is ignored.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"id": {
"description": "The natural identifier for the Reroute On Answer instance (which has no name).",
"readOnly": true,
"maxLength": 21,
"type": "string"
},
"ruleAppliesToAllAppIds": {
"description": "When set to true, this Reroute on Answer instance applies to all Application Ids (/diameter/applicationids), and DSR ignores the specific appId value for this instance.",
"type": "boolean"
}
},
"required": [
"ansResultCode",
"ruleAppliesToAllAppIds"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"ansResultCode": 4292967295,
"appId": 4292967295,
"configurationLevel": "0",
"id": "4292967295-4292967295",
"ruleAppliesToAllAppIds": false
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/reroutesonanswer
Adds a new Reroute On Answer value to the DSR configuration. The new Reroute on Answer value must have an associated Application Id that is unique across all Reroute On Answer configurations.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/reroutesonanswer/reroutesonanswer.json",
"properties": {
"ansResultCode": {
"description": "The Result-Code AVP value in the answer.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"appId": {
"description": "The Application Id (/diameter/applicationid) in the answer identifying the Diameter Application. To include all Application Ids, set ruleAppliesToAllAppIds to true, the value for appId is ignored.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"id": {
"description": "The natural identifier for the Reroute On Answer instance (which has no name).",
"readOnly": true,
"maxLength": 21,
"type": "string"
},
"ruleAppliesToAllAppIds": {
"description": "When set to true, this Reroute on Answer instance applies to all Application Ids (/diameter/applicationids), and DSR ignores the specific appId value for this instance.",
"type": "boolean"
}
},
"required": [
"ansResultCode",
"ruleAppliesToAllAppIds"
],
"type": "object"
}
Example
{
"ansResultCode": 4292967295,
"appId": 4292967295,
"configurationLevel": "0",
"id": "4292967295-4292967295",
"ruleAppliesToAllAppIds": false
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/reroutesonanswer/{id}
get /diameter/reroutesonanswer/{id}
Returns the configuration details for the specified Reroute On Answer value. If the specified Reroute On Answer value does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- id: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/reroutesonanswerItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/reroutesonanswer/reroutesonanswer.json",
"properties": {
"ansResultCode": {
"description": "The Result-Code AVP value in the answer.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"appId": {
"description": "The Application Id (/diameter/applicationid) in the answer identifying the Diameter Application. To include all Application Ids, set ruleAppliesToAllAppIds to true, the value for appId is ignored.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"id": {
"description": "The natural identifier for the Reroute On Answer instance (which has no name).",
"readOnly": true,
"maxLength": 21,
"type": "string"
},
"ruleAppliesToAllAppIds": {
"description": "When set to true, this Reroute on Answer instance applies to all Application Ids (/diameter/applicationids), and DSR ignores the specific appId value for this instance.",
"type": "boolean"
}
},
"required": [
"ansResultCode",
"ruleAppliesToAllAppIds"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"ansResultCode": 4292967295,
"appId": 4292967295,
"configurationLevel": "0",
"id": "4292967295-4292967295",
"ruleAppliesToAllAppIds": false
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
delete /diameter/reroutesonanswer/{id}
Deletes the specified Reroute On Answer value from the SOAM configuration. An attempt to delete a Reroute On Answer value that has already been deleted results in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Diameter: Reserved MCC Ranges
The MCC Ranges provide the range of the Reserved Mobile Country Code Range.
All Reserved MCC Range configuration is done at the SOAM.
/diameter/reservedmccranges
get /diameter/reservedmccranges
Returns all MCC Ranges configured at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those MCC Ranges meeting the request parameters are returned in the response.
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/reservedmccrangeCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/reservedmccrange/reservedmccrange.json",
"properties": {
"endMccRange": {
"description": "End MCC is the end value of the Reserved Mobile Country Code Range. Must be larger than Start MCC." ,
"maximum": 999,
"minimum": 0,
"type": "integer"
},
"mccRangeId": {
"description": "The Mcc Range Id is the numeric value that acts as primary key in the table for update operation.",
"readOnly": true,
"maximum": 99999,
"minimum": 0,
"type": "integer"
},
"startMccRange": {
"description": "Start MCC is the start value of the Reserved Mobile Country Code Range." ,
"maximum": 999,
"minimum": 0,
"type": "integer"
}
},
"required": [
"endMccRange",
"startMccRange"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"endMccRange": 41,
"startMccRange": 11
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/reservedmccranges
Adds a new MCC Range to the RBAR configuration. The Start Address and End Address for MCC Range shall not be overlapping or shall not already exists in the SOAM's configuration.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/reservedmccrange/reservedmccrange.json",
"properties": {
"endMccRange": {
"description": "End MCC is the end value of the Reserved Mobile Country Code Range. Must be larger than Start MCC." ,
"maximum": 999,
"minimum": 0,
"type": "integer"
},
"mccRangeId": {
"description": "The Mcc Range Id is the numeric value that acts as primary key in the table for update operation.",
"readOnly": true,
"maximum": 99999,
"minimum": 0,
"type": "integer"
},
"startMccRange": {
"description": "Start MCC is the start value of the Reserved Mobile Country Code Range." ,
"maximum": 999,
"minimum": 0,
"type": "integer"
}
},
"required": [
"endMccRange",
"startMccRange"
],
"type": "object"
}
Example
{
"endMccRange": 41,
"startMccRange": 11
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/reservedmccranges/{name}
get /diameter/reservedmccranges/{name}
Returns the configuration details for the specified MCC Range. If the specified MCC Range does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/reservedmccrangeItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/reservedmccrange/reservedmccrange.json",
"properties": {
"endMccRange": {
"description": "End MCC is the end value of the Reserved Mobile Country Code Range. Must be larger than Start MCC." ,
"maximum": 999,
"minimum": 0,
"type": "integer"
},
"mccRangeId": {
"description": "The Mcc Range Id is the numeric value that acts as primary key in the table for update operation.",
"readOnly": true,
"maximum": 99999,
"minimum": 0,
"type": "integer"
},
"startMccRange": {
"description": "Start MCC is the start value of the Reserved Mobile Country Code Range." ,
"maximum": 999,
"minimum": 0,
"type": "integer"
}
},
"required": [
"endMccRange",
"startMccRange"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"endMccRange": 41,
"startMccRange": 11
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/reservedmccranges/{name}
Updates the configuration for the specified MCC Range. If the provided MCC Range data is invalid in any way, the update will fail, resulting in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/reservedmccrange/reservedmccrange.json",
"properties": {
"endMccRange": {
"description": "End MCC is the end value of the Reserved Mobile Country Code Range. Must be larger than Start MCC." ,
"maximum": 999,
"minimum": 0,
"type": "integer"
},
"mccRangeId": {
"description": "The Mcc Range Id is the numeric value that acts as primary key in the table for update operation.",
"readOnly": true,
"maximum": 99999,
"minimum": 0,
"type": "integer"
},
"startMccRange": {
"description": "Start MCC is the start value of the Reserved Mobile Country Code Range." ,
"maximum": 999,
"minimum": 0,
"type": "integer"
}
},
"required": [
"endMccRange",
"startMccRange"
],
"type": "object"
}
Example
{
"endMccRange": 41,
"startMccRange": 11
}
delete /diameter/reservedmccranges/{name}
Deletes the specified MCC Range from the SOAM configuration. A MCC Range will only be deleted if all delete validation checks pass.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Diameter: Route Groups
A Route Group is a user-configured collection of either Peer Nodes (/diameter/peernodes) or Connections (/diameter/connections) which is used to determine the distribution of traffic within the Route Group. Traffic is distributed among available Peer Nodes (for a Peer Route Group) or Connections (for a Connection Route Group) based on the configured weight (also known as provisioned capacity) assigned to each Peer Node or Connection.
Using a Peer Route Group as an example, if Peer Node A has a configured weight of 100 and Peer Node B has a configured weight of 150, then 40% of the messages handled by the Route Group will be forwarded to Peer Node A, while the remaining 60% will be forwarded to Peer Node B.
All Route Group configuration is done at the SOAM.
/diameter/routegroups
get /diameter/routegroups
Returns all Route Groups configured at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those Route Groups meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section).
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (one of configurationLevel)
The field being matched
Only the configurationLevel field is supported.
Example:
filter_name=configurationLevel
- filter_op: (one of GREATER_THAN, GREATER_THAN_EQUAL)
The match operation (operator)
Example:
filter_op=GREATER_THAN
- filter_values: (string)
The matched value
The configurationLevel value by which the data is being filtered. Only a single value is supported.
Example:
filter_values=10
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/routegroupCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/routegroup/routegroup.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"connection": {
"description": "The list of Connections (/diameter/connections) associated with a Connection Route Group. If the value of type is Connection, then connection must be a list of 1 to 512 configured Connections and their desired weights, and peerNode should be omitted.",
"items": {
"properties": {
"connectionName": {
"description": "Name of a configured Connection (/diameter/connections).",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"connectionWeight": {
"description": "Weight assigned to this Connection (/diameter/connections). Traffic is distributed to available Connections within a Connection Route Group proportional to the Connection's assigned weight.",
"maximum": 65535,
"minimum": 1,
"type": "integer"
}
},
"required": [
"connectionName",
"connectionWeight"
],
"type": "object"
},
"maxItems": 512,
"type": "array"
},
"isDynamic": {
"description": "If true, means the Route Group was created dynamically as a result of dynamic peer discovery. isDynamic is read-only.",
"readOnly": true,
"type": "boolean"
},
"isTrafficMeasuringEnabled": {
"description": "If true, traffic measurements are pegged for this Route Group. If false, traffic measurements are not pegged for this Route Group. Typical value is false.",
"type": "boolean"
},
"name": {
"description": "Name for the Route Group, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerNode": {
"description": "The list of Peer Nodes (/diameter/peernodes) associated with Route Group of type Peer. When the value of type is Peer, then peerNode must be a list of 1 to 160 configured Peer Nodes and their desired weights, and connection should be omitted.",
"items": {
"properties": {
"peerNodeName": {
"description": "Name of a configured Peer Node (/diameter/peernodes).",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerNodeWeight": {
"description": "Weight assigned to this Peer Node (/diameter/peernodes). Traffic is distributed to available Peer Nodes within a Peer Route Group proportional to the Peer Node's assigned weight.",
"maximum": 65535,
"minimum": 1,
"type": "integer"
}
},
"required": [
"peerNodeName",
"peerNodeWeight"
],
"type": "object"
},
"maxItems": 160,
"type": "array"
},
"type": {
"description": "A Route Group is configured as a set of either: 1) Peers Nodes (/diameter/peernodes), or 2) Connections (/diameter/connections) that have the same priority within the Route Group's parent Route List(s) (/diameter/routelists).",
"enum": [
"Peer",
"Connection"
],
"type": "string"
}
},
"required": [
"name",
"type"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"name": "routeGroup1",
"type": "Connection",
"isTrafficMeasuringEnabled": false,
"connection": [
{
"connectionName": "Connection1",
"connectionWeight": 2
},
{
"connectionName": "Connection2",
"connectionWeight": 27
},
{
"connectionName": "Connection3",
"connectionWeight": 300
},
{
"connectionName": "Connection14",
"connectionWeight": 2457
}
],
"isDynamic": false
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/routegroups
Adds a new Route Group to the DSR configuration. The new Route Group must have a name that is unique across all Route Groups at the SOAM.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/routegroup/routegroup.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"connection": {
"description": "The list of Connections (/diameter/connections) associated with a Connection Route Group. If the value of type is Connection, then connection must be a list of 1 to 512 configured Connections and their desired weights, and peerNode should be omitted.",
"items": {
"properties": {
"connectionName": {
"description": "Name of a configured Connection (/diameter/connections).",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"connectionWeight": {
"description": "Weight assigned to this Connection (/diameter/connections). Traffic is distributed to available Connections within a Connection Route Group proportional to the Connection's assigned weight.",
"maximum": 65535,
"minimum": 1,
"type": "integer"
}
},
"required": [
"connectionName",
"connectionWeight"
],
"type": "object"
},
"maxItems": 512,
"type": "array"
},
"isDynamic": {
"description": "If true, means the Route Group was created dynamically as a result of dynamic peer discovery. isDynamic is read-only.",
"readOnly": true,
"type": "boolean"
},
"isTrafficMeasuringEnabled": {
"description": "If true, traffic measurements are pegged for this Route Group. If false, traffic measurements are not pegged for this Route Group. Typical value is false.",
"type": "boolean"
},
"name": {
"description": "Name for the Route Group, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerNode": {
"description": "The list of Peer Nodes (/diameter/peernodes) associated with Route Group of type Peer. When the value of type is Peer, then peerNode must be a list of 1 to 160 configured Peer Nodes and their desired weights, and connection should be omitted.",
"items": {
"properties": {
"peerNodeName": {
"description": "Name of a configured Peer Node (/diameter/peernodes).",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerNodeWeight": {
"description": "Weight assigned to this Peer Node (/diameter/peernodes). Traffic is distributed to available Peer Nodes within a Peer Route Group proportional to the Peer Node's assigned weight.",
"maximum": 65535,
"minimum": 1,
"type": "integer"
}
},
"required": [
"peerNodeName",
"peerNodeWeight"
],
"type": "object"
},
"maxItems": 160,
"type": "array"
},
"type": {
"description": "A Route Group is configured as a set of either: 1) Peers Nodes (/diameter/peernodes), or 2) Connections (/diameter/connections) that have the same priority within the Route Group's parent Route List(s) (/diameter/routelists).",
"enum": [
"Peer",
"Connection"
],
"type": "string"
}
},
"required": [
"name",
"type"
],
"type": "object"
}
Example
{
"name": "routeGroup1",
"type": "Connection",
"isTrafficMeasuringEnabled": false,
"connection": [
{
"connectionName": "Connection1",
"connectionWeight": 2
},
{
"connectionName": "Connection2",
"connectionWeight": 27
},
{
"connectionName": "Connection3",
"connectionWeight": 300
},
{
"connectionName": "Connection14",
"connectionWeight": 2457
}
],
"isDynamic": false
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/routegroups/{name}
get /diameter/routegroups/{name}
Returns the configuration details for the specified Route Group. If the specified Route Group does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/routegroupItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/routegroup/routegroup.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"connection": {
"description": "The list of Connections (/diameter/connections) associated with a Connection Route Group. If the value of type is Connection, then connection must be a list of 1 to 512 configured Connections and their desired weights, and peerNode should be omitted.",
"items": {
"properties": {
"connectionName": {
"description": "Name of a configured Connection (/diameter/connections).",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"connectionWeight": {
"description": "Weight assigned to this Connection (/diameter/connections). Traffic is distributed to available Connections within a Connection Route Group proportional to the Connection's assigned weight.",
"maximum": 65535,
"minimum": 1,
"type": "integer"
}
},
"required": [
"connectionName",
"connectionWeight"
],
"type": "object"
},
"maxItems": 512,
"type": "array"
},
"isDynamic": {
"description": "If true, means the Route Group was created dynamically as a result of dynamic peer discovery. isDynamic is read-only.",
"readOnly": true,
"type": "boolean"
},
"isTrafficMeasuringEnabled": {
"description": "If true, traffic measurements are pegged for this Route Group. If false, traffic measurements are not pegged for this Route Group. Typical value is false.",
"type": "boolean"
},
"name": {
"description": "Name for the Route Group, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerNode": {
"description": "The list of Peer Nodes (/diameter/peernodes) associated with Route Group of type Peer. When the value of type is Peer, then peerNode must be a list of 1 to 160 configured Peer Nodes and their desired weights, and connection should be omitted.",
"items": {
"properties": {
"peerNodeName": {
"description": "Name of a configured Peer Node (/diameter/peernodes).",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerNodeWeight": {
"description": "Weight assigned to this Peer Node (/diameter/peernodes). Traffic is distributed to available Peer Nodes within a Peer Route Group proportional to the Peer Node's assigned weight.",
"maximum": 65535,
"minimum": 1,
"type": "integer"
}
},
"required": [
"peerNodeName",
"peerNodeWeight"
],
"type": "object"
},
"maxItems": 160,
"type": "array"
},
"type": {
"description": "A Route Group is configured as a set of either: 1) Peers Nodes (/diameter/peernodes), or 2) Connections (/diameter/connections) that have the same priority within the Route Group's parent Route List(s) (/diameter/routelists).",
"enum": [
"Peer",
"Connection"
],
"type": "string"
}
},
"required": [
"name",
"type"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"name": "routeGroup1",
"type": "Connection",
"isTrafficMeasuringEnabled": false,
"connection": [
{
"connectionName": "Connection1",
"connectionWeight": 2
},
{
"connectionName": "Connection2",
"connectionWeight": 27
},
{
"connectionName": "Connection3",
"connectionWeight": 300
},
{
"connectionName": "Connection14",
"connectionWeight": 2457
}
],
"isDynamic": false
}
,
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/routegroups/{name}
Updates the configuration for the specified Route Group. If the provided Route Group data is invalid in any way, the update will fail, resulting in one or more error messages returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/routegroup/routegroup.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"connection": {
"description": "The list of Connections (/diameter/connections) associated with a Connection Route Group. If the value of type is Connection, then connection must be a list of 1 to 512 configured Connections and their desired weights, and peerNode should be omitted.",
"items": {
"properties": {
"connectionName": {
"description": "Name of a configured Connection (/diameter/connections).",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"connectionWeight": {
"description": "Weight assigned to this Connection (/diameter/connections). Traffic is distributed to available Connections within a Connection Route Group proportional to the Connection's assigned weight.",
"maximum": 65535,
"minimum": 1,
"type": "integer"
}
},
"required": [
"connectionName",
"connectionWeight"
],
"type": "object"
},
"maxItems": 512,
"type": "array"
},
"isDynamic": {
"description": "If true, means the Route Group was created dynamically as a result of dynamic peer discovery. isDynamic is read-only.",
"readOnly": true,
"type": "boolean"
},
"isTrafficMeasuringEnabled": {
"description": "If true, traffic measurements are pegged for this Route Group. If false, traffic measurements are not pegged for this Route Group. Typical value is false.",
"type": "boolean"
},
"name": {
"description": "Name for the Route Group, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerNode": {
"description": "The list of Peer Nodes (/diameter/peernodes) associated with Route Group of type Peer. When the value of type is Peer, then peerNode must be a list of 1 to 160 configured Peer Nodes and their desired weights, and connection should be omitted.",
"items": {
"properties": {
"peerNodeName": {
"description": "Name of a configured Peer Node (/diameter/peernodes).",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerNodeWeight": {
"description": "Weight assigned to this Peer Node (/diameter/peernodes). Traffic is distributed to available Peer Nodes within a Peer Route Group proportional to the Peer Node's assigned weight.",
"maximum": 65535,
"minimum": 1,
"type": "integer"
}
},
"required": [
"peerNodeName",
"peerNodeWeight"
],
"type": "object"
},
"maxItems": 160,
"type": "array"
},
"type": {
"description": "A Route Group is configured as a set of either: 1) Peers Nodes (/diameter/peernodes), or 2) Connections (/diameter/connections) that have the same priority within the Route Group's parent Route List(s) (/diameter/routelists).",
"enum": [
"Peer",
"Connection"
],
"type": "string"
}
},
"required": [
"name",
"type"
],
"type": "object"
}
Example
{
"name": "routeGroup1",
"type": "Connection",
"isTrafficMeasuringEnabled": false,
"connection": [
{
"connectionName": "Connection1",
"connectionWeight": 2
},
{
"connectionName": "Connection2",
"connectionWeight": 27
},
{
"connectionName": "Connection3",
"connectionWeight": 300
},
{
"connectionName": "Connection14",
"connectionWeight": 2457
}
],
"isDynamic": false
}
delete /diameter/routegroups/{name}
Deletes the specified Route Group from the SOAM configuration. A Route Group will only be deleted if all delete validation checks pass. In general, if the Route Group is part of the configuration of some other Managed Object, the Route Group cannot be deleted. For example, if the Route Group is named in a Route List (/diameter/routelists), the Route Group must first be removed from the Route List. Then the Route Group can be deleted from the configuration. An attempt to delete a Route Group that cannot be deleted will result in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Diameter: Route Lists
A Route List is a user-configured collection of one to three Route Groups (/diameter/routegroups), which is used when selecting an egress Connection (/diameter/connections) for a message received by the DSR. Route Lists are part of the load sharing and balancing mechanism the DSR supplies in its mission as a router of Diameter and RADIUS messages. If the current available capacity of a Route Group meets or exceeds the Minimum Route Group Availability Weight assigned to the Route List, that Route Group is considered Available, and is a candidate to be selected when the routing decision is made. Any Route Group whose current available capacity is less than the Minimum Route Group Availability Weight is considered Degraded, and can still be selected for routing if other conditions are met (e.g., the absence of any Route Group that is currently Available). Any Route Group whose current available capacity is zero is considered Prohibited, and cannot be selected for routing.
All Route List configuration is done at the SOAM.
/diameter/routelists
get /diameter/routelists
Returns all Route Lists configured at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those Route Lists meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section).
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (one of configurationLevel)
The field being matched
Only the configurationLevel field is supported.
Example:
filter_name=configurationLevel
- filter_op: (one of GREATER_THAN, GREATER_THAN_EQUAL)
The match operation (operator)
Example:
filter_op=GREATER_THAN
- filter_values: (string)
The matched value
The configurationLevel value by which the data is being filtered. Only a single value is supported.
Example:
filter_values=10
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/routelistCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/routelist/routelist.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"isDynamic": {
"description": "If true, means the Route List was created dynamically as a result of dynamic peer discovery. isDynamic is read-only.",
"readOnly": true,
"type": "boolean"
},
"minCapacity": {
"description": "Also known as Minimum Route Group Availability Weight, minCapacity is a threshold that defines whether a Route Group (/diameter/routegroups) is considered Available. If the current available capacity of all the Peer Nodes (/diameter/peernodes) or Connections (/diameter/connections) in a Route Group is greater than or equal to minCapacity, then that Route Group is considered to be Available. If the current available capacity of all the Peer Nodes or Connections is less than minCapacity, but greater than zero, then the Route Group is considered to be Degraded. Available or Degraded Route Groups can be selected by the DSR's routing algorithm when the DSR chooses an egress Connection on which to route a Diameter or RADIUS message. The current available capacity of all the Peer Nodes or Connections is zero, the Route Group is considered Prohibited and cannot be selected for routing.",
"maximum": 1024000,
"minimum": 1,
"type": "integer"
},
"name": {
"description": "Name for this Route List, which must be unique within the DSR site. A name is required, and cannot be changed after the Route List is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"rarg": {
"description": "Route Across Route Groups. For each message to be routed, DSR chooses one of the Route Groups (/diameter/routegroups) configured in this Route List as the primary, and attempts to route the message over one or more Connections (/diameter/connections) within that primary Route Group. If the message cannot be successfully routed via the primary Route Group, and rarg is set to true, then a different Route Group can be selected (assuming more than one Route Group is configured). If rarg is set to false and routing via the primary Route Group fails, then the routing of that message fails.",
"type": "boolean"
},
"routeListRouteGroup": {
"description": "The Route Groups (/diameter/routegroups) associated with this Route List. A Route List must have between one and three Route Groups configured to it.",
"items": {
"properties": {
"priority": {
"description": "The priority of this Route Group (/diameter/routegroups) within the Route List. A value of 1 indicates the highest priority Route Group, while a value of 3 indicates the lowest priority Route Group.",
"maximum": 3,
"minimum": 1,
"type": "integer"
},
"routeGroupName": {
"description": "Name of a Route Group (/diameter/routegroups) configured to the same SOAM as the Route List.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"routeListRouteGroupTtg": {
"description": "Each Route Group (/diameter/routegroups) within a Route List can have zero to ten TTGs (/diameter/trafficthrottlegroups) associated with it.",
"items": {
"description": "A single TTG (/diameter/trafficthrottlegroups) and its loss percent threshold associated with this Route List/Route Group (/diameter/routegroups) pair. A TTG can be configured either at the same site (known as a Local TTG) or at a different site (known as a Shared TTG).",
"properties": {
"lossPercentThreshold": {
"description": "Whenever the current computed loss percentage for the TTG (/diameter/trafficthrottlegroups) named in ttgName exceeds this configured lossPercentThreshold, the DSR does not forward Diameter messages to the Route Group (/diameter/routegroups) specified by routeGroupName.",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"siteName": {
"description": "The SOAM Server Group name of the site that owns this TTG (/diameter/trafficthrottlegroups). If siteName is the same site at which this Route List is being configured, the TTG is known as a Local TTG. If siteName is a site other than where this Route List is being configured, the TTG is known as a Shared TTG.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"ttgName": {
"description": "Name of a TTG (/diameter/trafficthrottlegroups) configured at the site named by siteName.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"siteName",
"ttgName",
"lossPercentThreshold"
],
"type": "object"
},
"maxItems": 10,
"minItems": 0,
"type": "array"
}
},
"required": [
"routeGroupName",
"priority"
],
"type": "object"
},
"maxItems": 3,
"minItems": 1,
"type": "array"
}
},
"required": [
"name",
"minCapacity",
"rarg",
"routeListRouteGroup"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"configurationLevel": "5200",
"isDynamic": false,
"minCapacity": 100000,
"name": "clientRouteList4",
"rarg": false,
"routeListRouteGroup":
[{
"priority": 1,
"routeGroupName": "clientRouteGroup1",
"routeListRouteGroupTtg":
[{
"lossPercentThreshold": 90,
"siteName": "dsrSite4",
"ttgName": "clientTtg1"
},
{
"lossPercentThreshold": 85,
"siteName": "dsrSite3",
"ttgName": "clientTtg2"
}]
},
{
"priority": 2,
"routeGroupName": "clientRouteGroup2"
}]
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/routelists
Adds a new Route List to the DSR configuration. The new Route List must have a name that is unique across all Route Lists at the SOAM.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/routelist/routelist.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"isDynamic": {
"description": "If true, means the Route List was created dynamically as a result of dynamic peer discovery. isDynamic is read-only.",
"readOnly": true,
"type": "boolean"
},
"minCapacity": {
"description": "Also known as Minimum Route Group Availability Weight, minCapacity is a threshold that defines whether a Route Group (/diameter/routegroups) is considered Available. If the current available capacity of all the Peer Nodes (/diameter/peernodes) or Connections (/diameter/connections) in a Route Group is greater than or equal to minCapacity, then that Route Group is considered to be Available. If the current available capacity of all the Peer Nodes or Connections is less than minCapacity, but greater than zero, then the Route Group is considered to be Degraded. Available or Degraded Route Groups can be selected by the DSR's routing algorithm when the DSR chooses an egress Connection on which to route a Diameter or RADIUS message. The current available capacity of all the Peer Nodes or Connections is zero, the Route Group is considered Prohibited and cannot be selected for routing.",
"maximum": 1024000,
"minimum": 1,
"type": "integer"
},
"name": {
"description": "Name for this Route List, which must be unique within the DSR site. A name is required, and cannot be changed after the Route List is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"rarg": {
"description": "Route Across Route Groups. For each message to be routed, DSR chooses one of the Route Groups (/diameter/routegroups) configured in this Route List as the primary, and attempts to route the message over one or more Connections (/diameter/connections) within that primary Route Group. If the message cannot be successfully routed via the primary Route Group, and rarg is set to true, then a different Route Group can be selected (assuming more than one Route Group is configured). If rarg is set to false and routing via the primary Route Group fails, then the routing of that message fails.",
"type": "boolean"
},
"routeListRouteGroup": {
"description": "The Route Groups (/diameter/routegroups) associated with this Route List. A Route List must have between one and three Route Groups configured to it.",
"items": {
"properties": {
"priority": {
"description": "The priority of this Route Group (/diameter/routegroups) within the Route List. A value of 1 indicates the highest priority Route Group, while a value of 3 indicates the lowest priority Route Group.",
"maximum": 3,
"minimum": 1,
"type": "integer"
},
"routeGroupName": {
"description": "Name of a Route Group (/diameter/routegroups) configured to the same SOAM as the Route List.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"routeListRouteGroupTtg": {
"description": "Each Route Group (/diameter/routegroups) within a Route List can have zero to ten TTGs (/diameter/trafficthrottlegroups) associated with it.",
"items": {
"description": "A single TTG (/diameter/trafficthrottlegroups) and its loss percent threshold associated with this Route List/Route Group (/diameter/routegroups) pair. A TTG can be configured either at the same site (known as a Local TTG) or at a different site (known as a Shared TTG).",
"properties": {
"lossPercentThreshold": {
"description": "Whenever the current computed loss percentage for the TTG (/diameter/trafficthrottlegroups) named in ttgName exceeds this configured lossPercentThreshold, the DSR does not forward Diameter messages to the Route Group (/diameter/routegroups) specified by routeGroupName.",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"siteName": {
"description": "The SOAM Server Group name of the site that owns this TTG (/diameter/trafficthrottlegroups). If siteName is the same site at which this Route List is being configured, the TTG is known as a Local TTG. If siteName is a site other than where this Route List is being configured, the TTG is known as a Shared TTG.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"ttgName": {
"description": "Name of a TTG (/diameter/trafficthrottlegroups) configured at the site named by siteName.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"siteName",
"ttgName",
"lossPercentThreshold"
],
"type": "object"
},
"maxItems": 10,
"minItems": 0,
"type": "array"
}
},
"required": [
"routeGroupName",
"priority"
],
"type": "object"
},
"maxItems": 3,
"minItems": 1,
"type": "array"
}
},
"required": [
"name",
"minCapacity",
"rarg",
"routeListRouteGroup"
],
"type": "object"
}
Example
{
"configurationLevel": "5200",
"isDynamic": false,
"minCapacity": 100000,
"name": "clientRouteList4",
"rarg": false,
"routeListRouteGroup":
[{
"priority": 1,
"routeGroupName": "clientRouteGroup1",
"routeListRouteGroupTtg":
[{
"lossPercentThreshold": 90,
"siteName": "dsrSite4",
"ttgName": "clientTtg1"
},
{
"lossPercentThreshold": 85,
"siteName": "dsrSite3",
"ttgName": "clientTtg2"
}]
},
{
"priority": 2,
"routeGroupName": "clientRouteGroup2"
}]
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/routelists/{name}
get /diameter/routelists/{name}
Returns the configuration details for the specified Route List. If the specified Route List does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/routelistItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/routelist/routelist.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"isDynamic": {
"description": "If true, means the Route List was created dynamically as a result of dynamic peer discovery. isDynamic is read-only.",
"readOnly": true,
"type": "boolean"
},
"minCapacity": {
"description": "Also known as Minimum Route Group Availability Weight, minCapacity is a threshold that defines whether a Route Group (/diameter/routegroups) is considered Available. If the current available capacity of all the Peer Nodes (/diameter/peernodes) or Connections (/diameter/connections) in a Route Group is greater than or equal to minCapacity, then that Route Group is considered to be Available. If the current available capacity of all the Peer Nodes or Connections is less than minCapacity, but greater than zero, then the Route Group is considered to be Degraded. Available or Degraded Route Groups can be selected by the DSR's routing algorithm when the DSR chooses an egress Connection on which to route a Diameter or RADIUS message. The current available capacity of all the Peer Nodes or Connections is zero, the Route Group is considered Prohibited and cannot be selected for routing.",
"maximum": 1024000,
"minimum": 1,
"type": "integer"
},
"name": {
"description": "Name for this Route List, which must be unique within the DSR site. A name is required, and cannot be changed after the Route List is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"rarg": {
"description": "Route Across Route Groups. For each message to be routed, DSR chooses one of the Route Groups (/diameter/routegroups) configured in this Route List as the primary, and attempts to route the message over one or more Connections (/diameter/connections) within that primary Route Group. If the message cannot be successfully routed via the primary Route Group, and rarg is set to true, then a different Route Group can be selected (assuming more than one Route Group is configured). If rarg is set to false and routing via the primary Route Group fails, then the routing of that message fails.",
"type": "boolean"
},
"routeListRouteGroup": {
"description": "The Route Groups (/diameter/routegroups) associated with this Route List. A Route List must have between one and three Route Groups configured to it.",
"items": {
"properties": {
"priority": {
"description": "The priority of this Route Group (/diameter/routegroups) within the Route List. A value of 1 indicates the highest priority Route Group, while a value of 3 indicates the lowest priority Route Group.",
"maximum": 3,
"minimum": 1,
"type": "integer"
},
"routeGroupName": {
"description": "Name of a Route Group (/diameter/routegroups) configured to the same SOAM as the Route List.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"routeListRouteGroupTtg": {
"description": "Each Route Group (/diameter/routegroups) within a Route List can have zero to ten TTGs (/diameter/trafficthrottlegroups) associated with it.",
"items": {
"description": "A single TTG (/diameter/trafficthrottlegroups) and its loss percent threshold associated with this Route List/Route Group (/diameter/routegroups) pair. A TTG can be configured either at the same site (known as a Local TTG) or at a different site (known as a Shared TTG).",
"properties": {
"lossPercentThreshold": {
"description": "Whenever the current computed loss percentage for the TTG (/diameter/trafficthrottlegroups) named in ttgName exceeds this configured lossPercentThreshold, the DSR does not forward Diameter messages to the Route Group (/diameter/routegroups) specified by routeGroupName.",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"siteName": {
"description": "The SOAM Server Group name of the site that owns this TTG (/diameter/trafficthrottlegroups). If siteName is the same site at which this Route List is being configured, the TTG is known as a Local TTG. If siteName is a site other than where this Route List is being configured, the TTG is known as a Shared TTG.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"ttgName": {
"description": "Name of a TTG (/diameter/trafficthrottlegroups) configured at the site named by siteName.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"siteName",
"ttgName",
"lossPercentThreshold"
],
"type": "object"
},
"maxItems": 10,
"minItems": 0,
"type": "array"
}
},
"required": [
"routeGroupName",
"priority"
],
"type": "object"
},
"maxItems": 3,
"minItems": 1,
"type": "array"
}
},
"required": [
"name",
"minCapacity",
"rarg",
"routeListRouteGroup"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"configurationLevel": "5200",
"isDynamic": false,
"minCapacity": 100000,
"name": "clientRouteList4",
"rarg": false,
"routeListRouteGroup":
[{
"priority": 1,
"routeGroupName": "clientRouteGroup1",
"routeListRouteGroupTtg":
[{
"lossPercentThreshold": 90,
"siteName": "dsrSite4",
"ttgName": "clientTtg1"
},
{
"lossPercentThreshold": 85,
"siteName": "dsrSite3",
"ttgName": "clientTtg2"
}]
},
{
"priority": 2,
"routeGroupName": "clientRouteGroup2"
}]
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/routelists/{name}
Updates the configuration for the specified Route List. If the provided Route List data is invalid in any way, the update fails, resulting in one or more error messages returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/routelist/routelist.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"isDynamic": {
"description": "If true, means the Route List was created dynamically as a result of dynamic peer discovery. isDynamic is read-only.",
"readOnly": true,
"type": "boolean"
},
"minCapacity": {
"description": "Also known as Minimum Route Group Availability Weight, minCapacity is a threshold that defines whether a Route Group (/diameter/routegroups) is considered Available. If the current available capacity of all the Peer Nodes (/diameter/peernodes) or Connections (/diameter/connections) in a Route Group is greater than or equal to minCapacity, then that Route Group is considered to be Available. If the current available capacity of all the Peer Nodes or Connections is less than minCapacity, but greater than zero, then the Route Group is considered to be Degraded. Available or Degraded Route Groups can be selected by the DSR's routing algorithm when the DSR chooses an egress Connection on which to route a Diameter or RADIUS message. The current available capacity of all the Peer Nodes or Connections is zero, the Route Group is considered Prohibited and cannot be selected for routing.",
"maximum": 1024000,
"minimum": 1,
"type": "integer"
},
"name": {
"description": "Name for this Route List, which must be unique within the DSR site. A name is required, and cannot be changed after the Route List is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"rarg": {
"description": "Route Across Route Groups. For each message to be routed, DSR chooses one of the Route Groups (/diameter/routegroups) configured in this Route List as the primary, and attempts to route the message over one or more Connections (/diameter/connections) within that primary Route Group. If the message cannot be successfully routed via the primary Route Group, and rarg is set to true, then a different Route Group can be selected (assuming more than one Route Group is configured). If rarg is set to false and routing via the primary Route Group fails, then the routing of that message fails.",
"type": "boolean"
},
"routeListRouteGroup": {
"description": "The Route Groups (/diameter/routegroups) associated with this Route List. A Route List must have between one and three Route Groups configured to it.",
"items": {
"properties": {
"priority": {
"description": "The priority of this Route Group (/diameter/routegroups) within the Route List. A value of 1 indicates the highest priority Route Group, while a value of 3 indicates the lowest priority Route Group.",
"maximum": 3,
"minimum": 1,
"type": "integer"
},
"routeGroupName": {
"description": "Name of a Route Group (/diameter/routegroups) configured to the same SOAM as the Route List.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"routeListRouteGroupTtg": {
"description": "Each Route Group (/diameter/routegroups) within a Route List can have zero to ten TTGs (/diameter/trafficthrottlegroups) associated with it.",
"items": {
"description": "A single TTG (/diameter/trafficthrottlegroups) and its loss percent threshold associated with this Route List/Route Group (/diameter/routegroups) pair. A TTG can be configured either at the same site (known as a Local TTG) or at a different site (known as a Shared TTG).",
"properties": {
"lossPercentThreshold": {
"description": "Whenever the current computed loss percentage for the TTG (/diameter/trafficthrottlegroups) named in ttgName exceeds this configured lossPercentThreshold, the DSR does not forward Diameter messages to the Route Group (/diameter/routegroups) specified by routeGroupName.",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"siteName": {
"description": "The SOAM Server Group name of the site that owns this TTG (/diameter/trafficthrottlegroups). If siteName is the same site at which this Route List is being configured, the TTG is known as a Local TTG. If siteName is a site other than where this Route List is being configured, the TTG is known as a Shared TTG.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"ttgName": {
"description": "Name of a TTG (/diameter/trafficthrottlegroups) configured at the site named by siteName.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"siteName",
"ttgName",
"lossPercentThreshold"
],
"type": "object"
},
"maxItems": 10,
"minItems": 0,
"type": "array"
}
},
"required": [
"routeGroupName",
"priority"
],
"type": "object"
},
"maxItems": 3,
"minItems": 1,
"type": "array"
}
},
"required": [
"name",
"minCapacity",
"rarg",
"routeListRouteGroup"
],
"type": "object"
}
Example
{
"configurationLevel": "5200",
"isDynamic": false,
"minCapacity": 100000,
"name": "clientRouteList4",
"rarg": false,
"routeListRouteGroup":
[{
"priority": 1,
"routeGroupName": "clientRouteGroup1",
"routeListRouteGroupTtg":
[{
"lossPercentThreshold": 90,
"siteName": "dsrSite4",
"ttgName": "clientTtg1"
},
{
"lossPercentThreshold": 85,
"siteName": "dsrSite3",
"ttgName": "clientTtg2"
}]
},
{
"priority": 2,
"routeGroupName": "clientRouteGroup2"
}]
}
delete /diameter/routelists/{name}
Deletes the specified Route List from the SOAM configuration. A Route List can only be deleted if all delete validation checks pass. In general, if the Route List is part of the configuration of some other Managed Object, the Route List cannot be deleted. For example, if the Route List is named by a Peer Route Rule (/diameter/peerrouterules), the Route List must first be removed from the Peer Route Rule. Then the Route List can be deleted from the configuration. An attempt to delete a Route List that cannot be deleted results in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Diameter: Routing Option Sets
Each Routing Option Set is a collection of parameters that control how the DSR deals with a set of problems that can cause a request to fail to route to the egress Peer Node (/diameter/peernodes). A configured Routing Option Set can then be assigned to Peer Nodes and/or Transaction Configuration Sets (/diameter/transactionconfigurationsets).
For each Diameter message that enters the DSR for routing, a Routing Option Set is selected based on an algorithm. This algorithm works primarily with the configuration of the Peer Node that sent the message to the DSR. Each Peer Node configured at the SOAM can optionally have: 1) a Routing Option Set assigned to it, and/or 2) a Transaction Configuration Set assigned to it. The Transaction Configuration Set is a collection of rules that specify, for a given Application ID (/diameter/applicationids) and Command Code (/diameter/commandcodes) within an ingress message, which Routing Option Set, Pending Answer Timer (/diameter/pendinganswertimers), Application Route Table (/diameter/applicationroutetables), and Peer Route Table (/diameter/peerroutetables) are to be used to make the routing decision for that message.
If a Transaction Configuration Set is assigned to the Peer Node, and an ingress message matches a rule in the Transaction Configuration Set, then the Routing Option Set associated with the matching rule is selected. If no Transaction Configuration Set is assigned to the Peer Node, or if no rule in the assigned Transaction Configuration Set matches the ingress message, then the Routing Option Set assigned directly to the Peer Node is selected. Finally, if there is no Routing Option Set assigned to the Peer Node, the default Routing Option Set is selected.
All configuration of Routing Option Sets is done at the SOAM.
/diameter/routingoptionsets
get /diameter/routingoptionsets
Returns all configured Routing Option Sets.
Target Server: SOAM
Secured by x-other
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/routingoptionsetCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/routingoptionset/routingoptionset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"connCongestionAction": {
"description": "Action the DSR takes when a received request message cannot be processed because the last egress Connection (/diameter/connections) is congested. When Abandon is specified, the request message will simply be discarded. When SendAnswer is specified, an answer message is sent to the upstream Peer Node (/diameter/peernodes), and that answer message has content based on the values specified for connCongestionErrMsg, connCongestionResultCode, and connCongestionVendorId.",
"enum": [
"Abandon",
"SendAnswer"
],
"type": "string"
},
"connCongestionErrMsg": {
"description": "Error message string to be placed in the Error-Message AVP of the answer message when Connection (/diameter/connections) congestion occurs and connCongestionAction is set to SendAnswer. Not applicable if connCongestionAction is Abandon.",
"maxLength": 64,
"type": "string"
},
"connCongestionResultCode": {
"description": "Value to be placed in the Result-Code AVP of the answer message when Connection (/diameter/connections) congestion occurs. Required if connCongestionAction is SendAnswer, not applicable if connCongestionAction is Abandon.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"connCongestionVendorId": {
"description": "If specified and connCongestionAction is SendAnswer, the answer message includes the Experimental-Result-Code grouped AVP, where the value specified for connCongestionVendorId is placed in the Vendor-Id AVP. Not applicable if connCongestionAction is Abandon.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
},
"connFailureAction": {
"description": "Action the DSR takes when a received request message cannot be processed because the last egress Connection (/diameter/connections) selection fails. When Abandon is specified, the request message is discarded. When SendAnswer is specified, an answer message is sent to the upstream Peer Node (/diameter/peernodes), and that answer message has content based on the values specified for connFailureErrMsg, connFailureResultCode, and connFailureVendorId.",
"enum": [
"Abandon",
"SendAnswer"
],
"type": "string"
},
"connFailureErrMsg": {
"description": "Error message string to be placed in the Error-Message AVP of the answer message when Connection (/diameter/connections) failure occurs and connFailureAction is set to SendAnswer. Not applicable if connFailureAction is Abandon.",
"maxLength": 64,
"type": "string"
},
"connFailureResultCode": {
"description": "Value to be placed in the Result-Code AVP of the answer message when Connection (/diameter/connections) failure occurs. Required if connFailureAction is SendAnswer, not applicable if connFailureAction is Abandon.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"connFailureVendorId": {
"description": "If specified and connFailureAction is SendAnswer, the answer message includes the Experimental-Result-Code grouped AVP, where the value specified for connFailureVendorId is placed in the Vendor-Id AVP. Not applicable if connFailureAction is Abandon.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
},
"destRealmNotServedAction": {
"description": "Action the DSR takes when a received request message cannot be processed because the destination realm is not served. This happens during implicit routing, when the DSR fails to find a realm/Application ID (/diameter/applicationids) match. When Abandon is specified, the request message is discarded. When SendAnswer is specified, an answer message is sent to the upstream Peer Node (/diameter/peernodes), and that answer message has content based on the values specified for destRealmNotServedErrMsg, destRealmNotServedResultCode, and destRealmNotServedVendorId.",
"enum": [
"Abandon",
"SendAnswer"
],
"type": "string"
},
"destRealmNotServedErrMsg": {
"description": "Error message string to be placed in the Error-Message AVP of the answer message when the destination realm is not served and destRealmNotServedAction is set to SendAnswer. Not applicable if destRealmNotServedAction is Abandon.",
"maxLength": 64,
"type": "string"
},
"destRealmNotServedResultCode": {
"description": "Value to be placed in the Result-Code AVP of the answer message when the destination realm is not served. Required if destRealmNotServedAction is SendAnswer, not applicable if destRealmNotServedAction is Abandon.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"destRealmNotServedVendorId": {
"description": "If specified and destRealmNotServedAction is SendAnswer, the answer message includes the Experimental-Result-Code grouped AVP, where the value specified for destRealmNotServedVendorId is placed in the Vendor-Id AVP. Not applicable if destRealmNotServeAction is Abandon.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
},
"maxPerMsgFwdAllowed": {
"description": "The number of times request routing is attempted. Typical value is 1.",
"maximum": 5,
"minimum": 1,
"type": "integer"
},
"name": {
"description": "Name for this Routing Option Set, which must be unique within the DSR site. A name is required, and cannot be changed after the Routing Option Set is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"nestedArtPrtErrorAction": {
"description": "Determines the action DSR takes when a nested Application Route Table or Peer Route Table search results in a loop or exceeds the maximum search depth of five tables. When Abandon is specified, the message is discarded. When SendAnswer is specified, an answer message is sent to the upstream ART or PRT, and that answer message has content based on the values specified for nestedArtPrtErrorErrMsg, nestedArtPrtErrorResultCode, and nestedArtPrtErrorVendorId.",
"enum": [
"Abandon",
"SendAnswer"
],
"type": "string"
},
"nestedArtPrtErrorErrMsg": {
"description": "Error message string placed in the Error-Message AVP of the answer message when the maximum Application Route Table (/diameter/applicationroutetables) or Peer Route Table (/diamter/peerroutetables) search depth is exceeded, or when a nested ART/PRT search results in a loop of searched tables. Not applicable if nestedArtPrtErrorAction is Abandon.",
"maxLength": 64,
"type": "string"
},
"nestedArtPrtErrorResultCode": {
"description": "Value placed in the Result-Code AVP of the answer message when the maximum Application Route Table (/diameter/applicationroutetables) or Peer Route Table (/diamter/peerroutetables) search depth is exceeded, or when a nested ART/PRT search results in a loop of searched tables. Not applicable if nestedArtPrtErrorAction is Abandon.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"nestedArtPrtErrorVendorId": {
"description": "If specified and nestedArtPrtErrorAction is set to SendAnswer, the answer message includes the Experimental-Result-Code grouped AVP, where the value specified for nestedArtPrtErrorVendorId is placed in the Vendor-Id AVP. Not applicable if nestedArtPrtErrorAction is Abandon.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
},
"noPeerResponseAction": {
"description": "Action the DSR takes when a received request message cannot be processed due to an answer timeout or transaction lifetime timeout (i.e., no Peer Node (/diameter/peernodes) response). When Abandon is specified, the request message is discarded. When SendAnswer is specified, an answer message is sent to the upstream Peer Node, and that answer message has content based on the values specified for noPeerResponseErrMsg, noPeerResponseResultCode, and noPeerResponseVendorId.",
"enum": [
"Abandon",
"SendAnswer"
],
"type": "string"
},
"noPeerResponseErrMsg": {
"description": "Error message string to be placed in the Error-Message AVP of the answer message when there is no Peer Node (/diameter/peernodes) response and noPeerResponseAction is set to SendAnswer. Not applicable if noPeerResponseAction is Abandon.",
"maxLength": 64,
"type": "string"
},
"noPeerResponseResultCode": {
"description": "Value to be placed in the Result-Code AVP of the answer message when there is no Peer Node (/diameter/peernodes) response. Required if noPeerResponseAction is SendAnswer, not applicable if noPeerResponseAction is Abandon.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"noPeerResponseVendorId": {
"description": "If specified and noPeerResponseAction is SendAnswer, the answer message includes the Experimental-Result-Code grouped AVP, where the value specified for noPeerResponseVendorId is placed in the Vendor-Id AVP. Not applicable if noPeerResponseAction is Abandon.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
},
"peerRptCongestionAction": {
"description": "Action the DSR takes when a received request message cannot be processed because the egress Peer Node (/diameter/peernodes) reports congestion. When Abandon is specified, the request message is discarded. When SendAnswer is specified, an answer message is sent to the upstream Peer Node, and that answer message has content based on the values specified for peerRptCongestionErrMsg, peerRptCongestionResultCode, and peerRptCongestionVendorId.",
"enum": [
"Abandon",
"SendAnswer"
],
"type": "string"
},
"peerRptCongestionErrMsg": {
"description": "Error message string to be placed in the Error-Message AVP of the answer message when the egress Peer Node (/diameter/peernodes) reports congestion and peerRptCongestionAction is set to SendAnswer. Not applicable if peerRptCongestionAction is Abandon.",
"maxLength": 64,
"type": "string"
},
"peerRptCongestionResultCode": {
"description": "Value to be placed in the Result-Code AVP of the answer message when the egress Peer Node (/diameter/peernodes) reports congestion. Required if peerRptCongestionAction is SendAnswer, not applicable if peerRptCongestionAction is Abandon.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"peerRptCongestionVendorId": {
"description": "If specified and peerRptCongestionAction is SendAnswer, the answer message includes the Experimental-Result-Code grouped AVP, where the value specified for peerRptCongestionVendorId is placed in the Vendor-Id AVP. Not applicable if peerRptCongestionAction is Abandon.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
},
"pendingAnswerTimerName": {
"description": "Name of the Pending Answer Timer (/diameter/pendinganswertimer) associated with this Routing Option Set. If no Pending Answer Timer name is given, the egress Peer Node's (/diameter/peernodes) Pending Answer Timer is used (if it's defined) when processing transactions.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"resExhAction": {
"description": "Action the DSR takes when a received request message cannot be processed because the MP server does not have sufficient free internal resources to process the request. When Abandon is specified, the request message is discarded. When SendAnswer is specified, an answer message is sent to the upstream Peer Node, and that answer message has content based on the values specified for resExhErrMsg, resExhResultCode, and resExhVendorId.",
"enum": [
"Abandon",
"SendAnswer"
],
"type": "string"
},
"resExhErrMsg": {
"description": "Error message string to be placed in the Error-Message AVP of the answer message when resource exhaustion occurs and resExhAction is set to SendAnswer. Not applicable if resExhAction is Abandon.",
"maxLength": 64,
"type": "string"
},
"resExhResultCode": {
"description": "Value to be placed in the Result-Code AVP of the answer message when resource exhaustion occurs. Required if resExhAction is SendAnswer, not applicable if resExhAction is Abandon.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"resExhVendorId": {
"description": "If specified and resExhAction is SendAnswer, the answer message includes the Experimental-Result-Code grouped AVP, where the value specified for resExhVendorId is placed in the Vendor-Id AVP. Not applicable if resExhAction is Abandon.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
},
"transactionLifetime": {
"description": "The total time, in milliseconds, the DSR attempts to forward a request, including the initial and all subsequent routing attempts. Only required if maxPerMsgFwdAllowed is greater than 1. Typical value is 20000 ms.",
"maximum": 540000,
"minimum": 100,
"type": "integer"
}
},
"required": [
"connCongestionAction",
"connFailureAction",
"destRealmNotServedAction",
"maxPerMsgFwdAllowed",
"name",
"noPeerResponseAction",
"peerRptCongestionAction",
"resExhAction"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"configurationLevel": "3986",
"connCongestionAction": "SendAnswer",
"connCongestionErrMsg": "The connection is in congestion.",
"connCongestionResultCode": 3002,
"connCongestionVendorId": 12345,
"connFailureAction": "SendAnswer",
"connFailureErrMsg": "The connection has failed.",
"connFailureResultCode": 3002,
"connFailureVendorId": 23456,
"destRealmNotServedAction": "SendAnswer",
"destRealmNotServedErrMsg": "The destination realm is not known to DSR.",
"destRealmNotServedResultCode": 3002,
"destRealmNotServedVendorId": 12345,
"maxPerMsgFwdAllowed": 1,
"name": "RoutingOptionSet1",
"nestedArtPrtErrorAction": "SendAnswer",
"nestedArtPrtErrorErrMsg": "Table not available.",
"nestedArtPrtErrorResultCode": 3002,
"nestedArtPrtErrorVendorId": 23456,
"noPeerResponseAction": "SendAnswer",
"noPeerResponseErrMsg": "The peer node is not responding.",
"noPeerResponseResultCode": 3002,
"noPeerResponseVendorId": 34567,
"peerRptCongestionAction": "SendAnswer",
"peerRptCongestionErrMsg": "The peer reports congestion.",
"peerRptCongestionResultCode": 3002,
"peerRptCongestionVendorId": 12345,
"pendingAnswerTimerName": "Default",
"resExhAction": "SendAnswer",
"resExhErrMsg": "Unable to process - internal resource exhaustion.",
"resExhResultCode": 5006,
"resExhVendorId": 23456,
"transactionLifetime": 1000
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/routingoptionsets
Adds a new Routing Option Set to the DSR configuration. The new Routing Option Set must have a name that is unique across all Routing Option Sets at the SOAM.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/routingoptionset/routingoptionset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"connCongestionAction": {
"description": "Action the DSR takes when a received request message cannot be processed because the last egress Connection (/diameter/connections) is congested. When Abandon is specified, the request message will simply be discarded. When SendAnswer is specified, an answer message is sent to the upstream Peer Node (/diameter/peernodes), and that answer message has content based on the values specified for connCongestionErrMsg, connCongestionResultCode, and connCongestionVendorId.",
"enum": [
"Abandon",
"SendAnswer"
],
"type": "string"
},
"connCongestionErrMsg": {
"description": "Error message string to be placed in the Error-Message AVP of the answer message when Connection (/diameter/connections) congestion occurs and connCongestionAction is set to SendAnswer. Not applicable if connCongestionAction is Abandon.",
"maxLength": 64,
"type": "string"
},
"connCongestionResultCode": {
"description": "Value to be placed in the Result-Code AVP of the answer message when Connection (/diameter/connections) congestion occurs. Required if connCongestionAction is SendAnswer, not applicable if connCongestionAction is Abandon.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"connCongestionVendorId": {
"description": "If specified and connCongestionAction is SendAnswer, the answer message includes the Experimental-Result-Code grouped AVP, where the value specified for connCongestionVendorId is placed in the Vendor-Id AVP. Not applicable if connCongestionAction is Abandon.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
},
"connFailureAction": {
"description": "Action the DSR takes when a received request message cannot be processed because the last egress Connection (/diameter/connections) selection fails. When Abandon is specified, the request message is discarded. When SendAnswer is specified, an answer message is sent to the upstream Peer Node (/diameter/peernodes), and that answer message has content based on the values specified for connFailureErrMsg, connFailureResultCode, and connFailureVendorId.",
"enum": [
"Abandon",
"SendAnswer"
],
"type": "string"
},
"connFailureErrMsg": {
"description": "Error message string to be placed in the Error-Message AVP of the answer message when Connection (/diameter/connections) failure occurs and connFailureAction is set to SendAnswer. Not applicable if connFailureAction is Abandon.",
"maxLength": 64,
"type": "string"
},
"connFailureResultCode": {
"description": "Value to be placed in the Result-Code AVP of the answer message when Connection (/diameter/connections) failure occurs. Required if connFailureAction is SendAnswer, not applicable if connFailureAction is Abandon.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"connFailureVendorId": {
"description": "If specified and connFailureAction is SendAnswer, the answer message includes the Experimental-Result-Code grouped AVP, where the value specified for connFailureVendorId is placed in the Vendor-Id AVP. Not applicable if connFailureAction is Abandon.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
},
"destRealmNotServedAction": {
"description": "Action the DSR takes when a received request message cannot be processed because the destination realm is not served. This happens during implicit routing, when the DSR fails to find a realm/Application ID (/diameter/applicationids) match. When Abandon is specified, the request message is discarded. When SendAnswer is specified, an answer message is sent to the upstream Peer Node (/diameter/peernodes), and that answer message has content based on the values specified for destRealmNotServedErrMsg, destRealmNotServedResultCode, and destRealmNotServedVendorId.",
"enum": [
"Abandon",
"SendAnswer"
],
"type": "string"
},
"destRealmNotServedErrMsg": {
"description": "Error message string to be placed in the Error-Message AVP of the answer message when the destination realm is not served and destRealmNotServedAction is set to SendAnswer. Not applicable if destRealmNotServedAction is Abandon.",
"maxLength": 64,
"type": "string"
},
"destRealmNotServedResultCode": {
"description": "Value to be placed in the Result-Code AVP of the answer message when the destination realm is not served. Required if destRealmNotServedAction is SendAnswer, not applicable if destRealmNotServedAction is Abandon.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"destRealmNotServedVendorId": {
"description": "If specified and destRealmNotServedAction is SendAnswer, the answer message includes the Experimental-Result-Code grouped AVP, where the value specified for destRealmNotServedVendorId is placed in the Vendor-Id AVP. Not applicable if destRealmNotServeAction is Abandon.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
},
"maxPerMsgFwdAllowed": {
"description": "The number of times request routing is attempted. Typical value is 1.",
"maximum": 5,
"minimum": 1,
"type": "integer"
},
"name": {
"description": "Name for this Routing Option Set, which must be unique within the DSR site. A name is required, and cannot be changed after the Routing Option Set is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"nestedArtPrtErrorAction": {
"description": "Determines the action DSR takes when a nested Application Route Table or Peer Route Table search results in a loop or exceeds the maximum search depth of five tables. When Abandon is specified, the message is discarded. When SendAnswer is specified, an answer message is sent to the upstream ART or PRT, and that answer message has content based on the values specified for nestedArtPrtErrorErrMsg, nestedArtPrtErrorResultCode, and nestedArtPrtErrorVendorId.",
"enum": [
"Abandon",
"SendAnswer"
],
"type": "string"
},
"nestedArtPrtErrorErrMsg": {
"description": "Error message string placed in the Error-Message AVP of the answer message when the maximum Application Route Table (/diameter/applicationroutetables) or Peer Route Table (/diamter/peerroutetables) search depth is exceeded, or when a nested ART/PRT search results in a loop of searched tables. Not applicable if nestedArtPrtErrorAction is Abandon.",
"maxLength": 64,
"type": "string"
},
"nestedArtPrtErrorResultCode": {
"description": "Value placed in the Result-Code AVP of the answer message when the maximum Application Route Table (/diameter/applicationroutetables) or Peer Route Table (/diamter/peerroutetables) search depth is exceeded, or when a nested ART/PRT search results in a loop of searched tables. Not applicable if nestedArtPrtErrorAction is Abandon.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"nestedArtPrtErrorVendorId": {
"description": "If specified and nestedArtPrtErrorAction is set to SendAnswer, the answer message includes the Experimental-Result-Code grouped AVP, where the value specified for nestedArtPrtErrorVendorId is placed in the Vendor-Id AVP. Not applicable if nestedArtPrtErrorAction is Abandon.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
},
"noPeerResponseAction": {
"description": "Action the DSR takes when a received request message cannot be processed due to an answer timeout or transaction lifetime timeout (i.e., no Peer Node (/diameter/peernodes) response). When Abandon is specified, the request message is discarded. When SendAnswer is specified, an answer message is sent to the upstream Peer Node, and that answer message has content based on the values specified for noPeerResponseErrMsg, noPeerResponseResultCode, and noPeerResponseVendorId.",
"enum": [
"Abandon",
"SendAnswer"
],
"type": "string"
},
"noPeerResponseErrMsg": {
"description": "Error message string to be placed in the Error-Message AVP of the answer message when there is no Peer Node (/diameter/peernodes) response and noPeerResponseAction is set to SendAnswer. Not applicable if noPeerResponseAction is Abandon.",
"maxLength": 64,
"type": "string"
},
"noPeerResponseResultCode": {
"description": "Value to be placed in the Result-Code AVP of the answer message when there is no Peer Node (/diameter/peernodes) response. Required if noPeerResponseAction is SendAnswer, not applicable if noPeerResponseAction is Abandon.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"noPeerResponseVendorId": {
"description": "If specified and noPeerResponseAction is SendAnswer, the answer message includes the Experimental-Result-Code grouped AVP, where the value specified for noPeerResponseVendorId is placed in the Vendor-Id AVP. Not applicable if noPeerResponseAction is Abandon.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
},
"peerRptCongestionAction": {
"description": "Action the DSR takes when a received request message cannot be processed because the egress Peer Node (/diameter/peernodes) reports congestion. When Abandon is specified, the request message is discarded. When SendAnswer is specified, an answer message is sent to the upstream Peer Node, and that answer message has content based on the values specified for peerRptCongestionErrMsg, peerRptCongestionResultCode, and peerRptCongestionVendorId.",
"enum": [
"Abandon",
"SendAnswer"
],
"type": "string"
},
"peerRptCongestionErrMsg": {
"description": "Error message string to be placed in the Error-Message AVP of the answer message when the egress Peer Node (/diameter/peernodes) reports congestion and peerRptCongestionAction is set to SendAnswer. Not applicable if peerRptCongestionAction is Abandon.",
"maxLength": 64,
"type": "string"
},
"peerRptCongestionResultCode": {
"description": "Value to be placed in the Result-Code AVP of the answer message when the egress Peer Node (/diameter/peernodes) reports congestion. Required if peerRptCongestionAction is SendAnswer, not applicable if peerRptCongestionAction is Abandon.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"peerRptCongestionVendorId": {
"description": "If specified and peerRptCongestionAction is SendAnswer, the answer message includes the Experimental-Result-Code grouped AVP, where the value specified for peerRptCongestionVendorId is placed in the Vendor-Id AVP. Not applicable if peerRptCongestionAction is Abandon.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
},
"pendingAnswerTimerName": {
"description": "Name of the Pending Answer Timer (/diameter/pendinganswertimer) associated with this Routing Option Set. If no Pending Answer Timer name is given, the egress Peer Node's (/diameter/peernodes) Pending Answer Timer is used (if it's defined) when processing transactions.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"resExhAction": {
"description": "Action the DSR takes when a received request message cannot be processed because the MP server does not have sufficient free internal resources to process the request. When Abandon is specified, the request message is discarded. When SendAnswer is specified, an answer message is sent to the upstream Peer Node, and that answer message has content based on the values specified for resExhErrMsg, resExhResultCode, and resExhVendorId.",
"enum": [
"Abandon",
"SendAnswer"
],
"type": "string"
},
"resExhErrMsg": {
"description": "Error message string to be placed in the Error-Message AVP of the answer message when resource exhaustion occurs and resExhAction is set to SendAnswer. Not applicable if resExhAction is Abandon.",
"maxLength": 64,
"type": "string"
},
"resExhResultCode": {
"description": "Value to be placed in the Result-Code AVP of the answer message when resource exhaustion occurs. Required if resExhAction is SendAnswer, not applicable if resExhAction is Abandon.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"resExhVendorId": {
"description": "If specified and resExhAction is SendAnswer, the answer message includes the Experimental-Result-Code grouped AVP, where the value specified for resExhVendorId is placed in the Vendor-Id AVP. Not applicable if resExhAction is Abandon.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
},
"transactionLifetime": {
"description": "The total time, in milliseconds, the DSR attempts to forward a request, including the initial and all subsequent routing attempts. Only required if maxPerMsgFwdAllowed is greater than 1. Typical value is 20000 ms.",
"maximum": 540000,
"minimum": 100,
"type": "integer"
}
},
"required": [
"connCongestionAction",
"connFailureAction",
"destRealmNotServedAction",
"maxPerMsgFwdAllowed",
"name",
"noPeerResponseAction",
"peerRptCongestionAction",
"resExhAction"
],
"type": "object"
}
Example
{
"configurationLevel": "3986",
"connCongestionAction": "SendAnswer",
"connCongestionErrMsg": "The connection is in congestion.",
"connCongestionResultCode": 3002,
"connCongestionVendorId": 12345,
"connFailureAction": "SendAnswer",
"connFailureErrMsg": "The connection has failed.",
"connFailureResultCode": 3002,
"connFailureVendorId": 23456,
"destRealmNotServedAction": "SendAnswer",
"destRealmNotServedErrMsg": "The destination realm is not known to DSR.",
"destRealmNotServedResultCode": 3002,
"destRealmNotServedVendorId": 12345,
"maxPerMsgFwdAllowed": 1,
"name": "RoutingOptionSet1",
"nestedArtPrtErrorAction": "SendAnswer",
"nestedArtPrtErrorErrMsg": "Table not available.",
"nestedArtPrtErrorResultCode": 3002,
"nestedArtPrtErrorVendorId": 23456,
"noPeerResponseAction": "SendAnswer",
"noPeerResponseErrMsg": "The peer node is not responding.",
"noPeerResponseResultCode": 3002,
"noPeerResponseVendorId": 34567,
"peerRptCongestionAction": "SendAnswer",
"peerRptCongestionErrMsg": "The peer reports congestion.",
"peerRptCongestionResultCode": 3002,
"peerRptCongestionVendorId": 12345,
"pendingAnswerTimerName": "Default",
"resExhAction": "SendAnswer",
"resExhErrMsg": "Unable to process - internal resource exhaustion.",
"resExhResultCode": 5006,
"resExhVendorId": 23456,
"transactionLifetime": 1000
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/routingoptionsets/{name}
get /diameter/routingoptionsets/{name}
Returns the configuration details for the specified Routing Option Set. If the specified Routing Option Set does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/routingoptionsetItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/routingoptionset/routingoptionset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"connCongestionAction": {
"description": "Action the DSR takes when a received request message cannot be processed because the last egress Connection (/diameter/connections) is congested. When Abandon is specified, the request message will simply be discarded. When SendAnswer is specified, an answer message is sent to the upstream Peer Node (/diameter/peernodes), and that answer message has content based on the values specified for connCongestionErrMsg, connCongestionResultCode, and connCongestionVendorId.",
"enum": [
"Abandon",
"SendAnswer"
],
"type": "string"
},
"connCongestionErrMsg": {
"description": "Error message string to be placed in the Error-Message AVP of the answer message when Connection (/diameter/connections) congestion occurs and connCongestionAction is set to SendAnswer. Not applicable if connCongestionAction is Abandon.",
"maxLength": 64,
"type": "string"
},
"connCongestionResultCode": {
"description": "Value to be placed in the Result-Code AVP of the answer message when Connection (/diameter/connections) congestion occurs. Required if connCongestionAction is SendAnswer, not applicable if connCongestionAction is Abandon.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"connCongestionVendorId": {
"description": "If specified and connCongestionAction is SendAnswer, the answer message includes the Experimental-Result-Code grouped AVP, where the value specified for connCongestionVendorId is placed in the Vendor-Id AVP. Not applicable if connCongestionAction is Abandon.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
},
"connFailureAction": {
"description": "Action the DSR takes when a received request message cannot be processed because the last egress Connection (/diameter/connections) selection fails. When Abandon is specified, the request message is discarded. When SendAnswer is specified, an answer message is sent to the upstream Peer Node (/diameter/peernodes), and that answer message has content based on the values specified for connFailureErrMsg, connFailureResultCode, and connFailureVendorId.",
"enum": [
"Abandon",
"SendAnswer"
],
"type": "string"
},
"connFailureErrMsg": {
"description": "Error message string to be placed in the Error-Message AVP of the answer message when Connection (/diameter/connections) failure occurs and connFailureAction is set to SendAnswer. Not applicable if connFailureAction is Abandon.",
"maxLength": 64,
"type": "string"
},
"connFailureResultCode": {
"description": "Value to be placed in the Result-Code AVP of the answer message when Connection (/diameter/connections) failure occurs. Required if connFailureAction is SendAnswer, not applicable if connFailureAction is Abandon.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"connFailureVendorId": {
"description": "If specified and connFailureAction is SendAnswer, the answer message includes the Experimental-Result-Code grouped AVP, where the value specified for connFailureVendorId is placed in the Vendor-Id AVP. Not applicable if connFailureAction is Abandon.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
},
"destRealmNotServedAction": {
"description": "Action the DSR takes when a received request message cannot be processed because the destination realm is not served. This happens during implicit routing, when the DSR fails to find a realm/Application ID (/diameter/applicationids) match. When Abandon is specified, the request message is discarded. When SendAnswer is specified, an answer message is sent to the upstream Peer Node (/diameter/peernodes), and that answer message has content based on the values specified for destRealmNotServedErrMsg, destRealmNotServedResultCode, and destRealmNotServedVendorId.",
"enum": [
"Abandon",
"SendAnswer"
],
"type": "string"
},
"destRealmNotServedErrMsg": {
"description": "Error message string to be placed in the Error-Message AVP of the answer message when the destination realm is not served and destRealmNotServedAction is set to SendAnswer. Not applicable if destRealmNotServedAction is Abandon.",
"maxLength": 64,
"type": "string"
},
"destRealmNotServedResultCode": {
"description": "Value to be placed in the Result-Code AVP of the answer message when the destination realm is not served. Required if destRealmNotServedAction is SendAnswer, not applicable if destRealmNotServedAction is Abandon.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"destRealmNotServedVendorId": {
"description": "If specified and destRealmNotServedAction is SendAnswer, the answer message includes the Experimental-Result-Code grouped AVP, where the value specified for destRealmNotServedVendorId is placed in the Vendor-Id AVP. Not applicable if destRealmNotServeAction is Abandon.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
},
"maxPerMsgFwdAllowed": {
"description": "The number of times request routing is attempted. Typical value is 1.",
"maximum": 5,
"minimum": 1,
"type": "integer"
},
"name": {
"description": "Name for this Routing Option Set, which must be unique within the DSR site. A name is required, and cannot be changed after the Routing Option Set is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"nestedArtPrtErrorAction": {
"description": "Determines the action DSR takes when a nested Application Route Table or Peer Route Table search results in a loop or exceeds the maximum search depth of five tables. When Abandon is specified, the message is discarded. When SendAnswer is specified, an answer message is sent to the upstream ART or PRT, and that answer message has content based on the values specified for nestedArtPrtErrorErrMsg, nestedArtPrtErrorResultCode, and nestedArtPrtErrorVendorId.",
"enum": [
"Abandon",
"SendAnswer"
],
"type": "string"
},
"nestedArtPrtErrorErrMsg": {
"description": "Error message string placed in the Error-Message AVP of the answer message when the maximum Application Route Table (/diameter/applicationroutetables) or Peer Route Table (/diamter/peerroutetables) search depth is exceeded, or when a nested ART/PRT search results in a loop of searched tables. Not applicable if nestedArtPrtErrorAction is Abandon.",
"maxLength": 64,
"type": "string"
},
"nestedArtPrtErrorResultCode": {
"description": "Value placed in the Result-Code AVP of the answer message when the maximum Application Route Table (/diameter/applicationroutetables) or Peer Route Table (/diamter/peerroutetables) search depth is exceeded, or when a nested ART/PRT search results in a loop of searched tables. Not applicable if nestedArtPrtErrorAction is Abandon.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"nestedArtPrtErrorVendorId": {
"description": "If specified and nestedArtPrtErrorAction is set to SendAnswer, the answer message includes the Experimental-Result-Code grouped AVP, where the value specified for nestedArtPrtErrorVendorId is placed in the Vendor-Id AVP. Not applicable if nestedArtPrtErrorAction is Abandon.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
},
"noPeerResponseAction": {
"description": "Action the DSR takes when a received request message cannot be processed due to an answer timeout or transaction lifetime timeout (i.e., no Peer Node (/diameter/peernodes) response). When Abandon is specified, the request message is discarded. When SendAnswer is specified, an answer message is sent to the upstream Peer Node, and that answer message has content based on the values specified for noPeerResponseErrMsg, noPeerResponseResultCode, and noPeerResponseVendorId.",
"enum": [
"Abandon",
"SendAnswer"
],
"type": "string"
},
"noPeerResponseErrMsg": {
"description": "Error message string to be placed in the Error-Message AVP of the answer message when there is no Peer Node (/diameter/peernodes) response and noPeerResponseAction is set to SendAnswer. Not applicable if noPeerResponseAction is Abandon.",
"maxLength": 64,
"type": "string"
},
"noPeerResponseResultCode": {
"description": "Value to be placed in the Result-Code AVP of the answer message when there is no Peer Node (/diameter/peernodes) response. Required if noPeerResponseAction is SendAnswer, not applicable if noPeerResponseAction is Abandon.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"noPeerResponseVendorId": {
"description": "If specified and noPeerResponseAction is SendAnswer, the answer message includes the Experimental-Result-Code grouped AVP, where the value specified for noPeerResponseVendorId is placed in the Vendor-Id AVP. Not applicable if noPeerResponseAction is Abandon.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
},
"peerRptCongestionAction": {
"description": "Action the DSR takes when a received request message cannot be processed because the egress Peer Node (/diameter/peernodes) reports congestion. When Abandon is specified, the request message is discarded. When SendAnswer is specified, an answer message is sent to the upstream Peer Node, and that answer message has content based on the values specified for peerRptCongestionErrMsg, peerRptCongestionResultCode, and peerRptCongestionVendorId.",
"enum": [
"Abandon",
"SendAnswer"
],
"type": "string"
},
"peerRptCongestionErrMsg": {
"description": "Error message string to be placed in the Error-Message AVP of the answer message when the egress Peer Node (/diameter/peernodes) reports congestion and peerRptCongestionAction is set to SendAnswer. Not applicable if peerRptCongestionAction is Abandon.",
"maxLength": 64,
"type": "string"
},
"peerRptCongestionResultCode": {
"description": "Value to be placed in the Result-Code AVP of the answer message when the egress Peer Node (/diameter/peernodes) reports congestion. Required if peerRptCongestionAction is SendAnswer, not applicable if peerRptCongestionAction is Abandon.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"peerRptCongestionVendorId": {
"description": "If specified and peerRptCongestionAction is SendAnswer, the answer message includes the Experimental-Result-Code grouped AVP, where the value specified for peerRptCongestionVendorId is placed in the Vendor-Id AVP. Not applicable if peerRptCongestionAction is Abandon.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
},
"pendingAnswerTimerName": {
"description": "Name of the Pending Answer Timer (/diameter/pendinganswertimer) associated with this Routing Option Set. If no Pending Answer Timer name is given, the egress Peer Node's (/diameter/peernodes) Pending Answer Timer is used (if it's defined) when processing transactions.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"resExhAction": {
"description": "Action the DSR takes when a received request message cannot be processed because the MP server does not have sufficient free internal resources to process the request. When Abandon is specified, the request message is discarded. When SendAnswer is specified, an answer message is sent to the upstream Peer Node, and that answer message has content based on the values specified for resExhErrMsg, resExhResultCode, and resExhVendorId.",
"enum": [
"Abandon",
"SendAnswer"
],
"type": "string"
},
"resExhErrMsg": {
"description": "Error message string to be placed in the Error-Message AVP of the answer message when resource exhaustion occurs and resExhAction is set to SendAnswer. Not applicable if resExhAction is Abandon.",
"maxLength": 64,
"type": "string"
},
"resExhResultCode": {
"description": "Value to be placed in the Result-Code AVP of the answer message when resource exhaustion occurs. Required if resExhAction is SendAnswer, not applicable if resExhAction is Abandon.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"resExhVendorId": {
"description": "If specified and resExhAction is SendAnswer, the answer message includes the Experimental-Result-Code grouped AVP, where the value specified for resExhVendorId is placed in the Vendor-Id AVP. Not applicable if resExhAction is Abandon.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
},
"transactionLifetime": {
"description": "The total time, in milliseconds, the DSR attempts to forward a request, including the initial and all subsequent routing attempts. Only required if maxPerMsgFwdAllowed is greater than 1. Typical value is 20000 ms.",
"maximum": 540000,
"minimum": 100,
"type": "integer"
}
},
"required": [
"connCongestionAction",
"connFailureAction",
"destRealmNotServedAction",
"maxPerMsgFwdAllowed",
"name",
"noPeerResponseAction",
"peerRptCongestionAction",
"resExhAction"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"configurationLevel": "3986",
"connCongestionAction": "SendAnswer",
"connCongestionErrMsg": "The connection is in congestion.",
"connCongestionResultCode": 3002,
"connCongestionVendorId": 12345,
"connFailureAction": "SendAnswer",
"connFailureErrMsg": "The connection has failed.",
"connFailureResultCode": 3002,
"connFailureVendorId": 23456,
"destRealmNotServedAction": "SendAnswer",
"destRealmNotServedErrMsg": "The destination realm is not known to DSR.",
"destRealmNotServedResultCode": 3002,
"destRealmNotServedVendorId": 12345,
"maxPerMsgFwdAllowed": 1,
"name": "RoutingOptionSet1",
"nestedArtPrtErrorAction": "SendAnswer",
"nestedArtPrtErrorErrMsg": "Table not available.",
"nestedArtPrtErrorResultCode": 3002,
"nestedArtPrtErrorVendorId": 23456,
"noPeerResponseAction": "SendAnswer",
"noPeerResponseErrMsg": "The peer node is not responding.",
"noPeerResponseResultCode": 3002,
"noPeerResponseVendorId": 34567,
"peerRptCongestionAction": "SendAnswer",
"peerRptCongestionErrMsg": "The peer reports congestion.",
"peerRptCongestionResultCode": 3002,
"peerRptCongestionVendorId": 12345,
"pendingAnswerTimerName": "Default",
"resExhAction": "SendAnswer",
"resExhErrMsg": "Unable to process - internal resource exhaustion.",
"resExhResultCode": 5006,
"resExhVendorId": 23456,
"transactionLifetime": 1000
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/routingoptionsets/{name}
Updates the configuration for the specified Route Option Set. If the provided Routing Option Set data is invalid in any way, the update fails, resulting in one or more error messages returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/routingoptionset/routingoptionset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"connCongestionAction": {
"description": "Action the DSR takes when a received request message cannot be processed because the last egress Connection (/diameter/connections) is congested. When Abandon is specified, the request message will simply be discarded. When SendAnswer is specified, an answer message is sent to the upstream Peer Node (/diameter/peernodes), and that answer message has content based on the values specified for connCongestionErrMsg, connCongestionResultCode, and connCongestionVendorId.",
"enum": [
"Abandon",
"SendAnswer"
],
"type": "string"
},
"connCongestionErrMsg": {
"description": "Error message string to be placed in the Error-Message AVP of the answer message when Connection (/diameter/connections) congestion occurs and connCongestionAction is set to SendAnswer. Not applicable if connCongestionAction is Abandon.",
"maxLength": 64,
"type": "string"
},
"connCongestionResultCode": {
"description": "Value to be placed in the Result-Code AVP of the answer message when Connection (/diameter/connections) congestion occurs. Required if connCongestionAction is SendAnswer, not applicable if connCongestionAction is Abandon.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"connCongestionVendorId": {
"description": "If specified and connCongestionAction is SendAnswer, the answer message includes the Experimental-Result-Code grouped AVP, where the value specified for connCongestionVendorId is placed in the Vendor-Id AVP. Not applicable if connCongestionAction is Abandon.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
},
"connFailureAction": {
"description": "Action the DSR takes when a received request message cannot be processed because the last egress Connection (/diameter/connections) selection fails. When Abandon is specified, the request message is discarded. When SendAnswer is specified, an answer message is sent to the upstream Peer Node (/diameter/peernodes), and that answer message has content based on the values specified for connFailureErrMsg, connFailureResultCode, and connFailureVendorId.",
"enum": [
"Abandon",
"SendAnswer"
],
"type": "string"
},
"connFailureErrMsg": {
"description": "Error message string to be placed in the Error-Message AVP of the answer message when Connection (/diameter/connections) failure occurs and connFailureAction is set to SendAnswer. Not applicable if connFailureAction is Abandon.",
"maxLength": 64,
"type": "string"
},
"connFailureResultCode": {
"description": "Value to be placed in the Result-Code AVP of the answer message when Connection (/diameter/connections) failure occurs. Required if connFailureAction is SendAnswer, not applicable if connFailureAction is Abandon.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"connFailureVendorId": {
"description": "If specified and connFailureAction is SendAnswer, the answer message includes the Experimental-Result-Code grouped AVP, where the value specified for connFailureVendorId is placed in the Vendor-Id AVP. Not applicable if connFailureAction is Abandon.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
},
"destRealmNotServedAction": {
"description": "Action the DSR takes when a received request message cannot be processed because the destination realm is not served. This happens during implicit routing, when the DSR fails to find a realm/Application ID (/diameter/applicationids) match. When Abandon is specified, the request message is discarded. When SendAnswer is specified, an answer message is sent to the upstream Peer Node (/diameter/peernodes), and that answer message has content based on the values specified for destRealmNotServedErrMsg, destRealmNotServedResultCode, and destRealmNotServedVendorId.",
"enum": [
"Abandon",
"SendAnswer"
],
"type": "string"
},
"destRealmNotServedErrMsg": {
"description": "Error message string to be placed in the Error-Message AVP of the answer message when the destination realm is not served and destRealmNotServedAction is set to SendAnswer. Not applicable if destRealmNotServedAction is Abandon.",
"maxLength": 64,
"type": "string"
},
"destRealmNotServedResultCode": {
"description": "Value to be placed in the Result-Code AVP of the answer message when the destination realm is not served. Required if destRealmNotServedAction is SendAnswer, not applicable if destRealmNotServedAction is Abandon.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"destRealmNotServedVendorId": {
"description": "If specified and destRealmNotServedAction is SendAnswer, the answer message includes the Experimental-Result-Code grouped AVP, where the value specified for destRealmNotServedVendorId is placed in the Vendor-Id AVP. Not applicable if destRealmNotServeAction is Abandon.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
},
"maxPerMsgFwdAllowed": {
"description": "The number of times request routing is attempted. Typical value is 1.",
"maximum": 5,
"minimum": 1,
"type": "integer"
},
"name": {
"description": "Name for this Routing Option Set, which must be unique within the DSR site. A name is required, and cannot be changed after the Routing Option Set is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"nestedArtPrtErrorAction": {
"description": "Determines the action DSR takes when a nested Application Route Table or Peer Route Table search results in a loop or exceeds the maximum search depth of five tables. When Abandon is specified, the message is discarded. When SendAnswer is specified, an answer message is sent to the upstream ART or PRT, and that answer message has content based on the values specified for nestedArtPrtErrorErrMsg, nestedArtPrtErrorResultCode, and nestedArtPrtErrorVendorId.",
"enum": [
"Abandon",
"SendAnswer"
],
"type": "string"
},
"nestedArtPrtErrorErrMsg": {
"description": "Error message string placed in the Error-Message AVP of the answer message when the maximum Application Route Table (/diameter/applicationroutetables) or Peer Route Table (/diamter/peerroutetables) search depth is exceeded, or when a nested ART/PRT search results in a loop of searched tables. Not applicable if nestedArtPrtErrorAction is Abandon.",
"maxLength": 64,
"type": "string"
},
"nestedArtPrtErrorResultCode": {
"description": "Value placed in the Result-Code AVP of the answer message when the maximum Application Route Table (/diameter/applicationroutetables) or Peer Route Table (/diamter/peerroutetables) search depth is exceeded, or when a nested ART/PRT search results in a loop of searched tables. Not applicable if nestedArtPrtErrorAction is Abandon.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"nestedArtPrtErrorVendorId": {
"description": "If specified and nestedArtPrtErrorAction is set to SendAnswer, the answer message includes the Experimental-Result-Code grouped AVP, where the value specified for nestedArtPrtErrorVendorId is placed in the Vendor-Id AVP. Not applicable if nestedArtPrtErrorAction is Abandon.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
},
"noPeerResponseAction": {
"description": "Action the DSR takes when a received request message cannot be processed due to an answer timeout or transaction lifetime timeout (i.e., no Peer Node (/diameter/peernodes) response). When Abandon is specified, the request message is discarded. When SendAnswer is specified, an answer message is sent to the upstream Peer Node, and that answer message has content based on the values specified for noPeerResponseErrMsg, noPeerResponseResultCode, and noPeerResponseVendorId.",
"enum": [
"Abandon",
"SendAnswer"
],
"type": "string"
},
"noPeerResponseErrMsg": {
"description": "Error message string to be placed in the Error-Message AVP of the answer message when there is no Peer Node (/diameter/peernodes) response and noPeerResponseAction is set to SendAnswer. Not applicable if noPeerResponseAction is Abandon.",
"maxLength": 64,
"type": "string"
},
"noPeerResponseResultCode": {
"description": "Value to be placed in the Result-Code AVP of the answer message when there is no Peer Node (/diameter/peernodes) response. Required if noPeerResponseAction is SendAnswer, not applicable if noPeerResponseAction is Abandon.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"noPeerResponseVendorId": {
"description": "If specified and noPeerResponseAction is SendAnswer, the answer message includes the Experimental-Result-Code grouped AVP, where the value specified for noPeerResponseVendorId is placed in the Vendor-Id AVP. Not applicable if noPeerResponseAction is Abandon.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
},
"peerRptCongestionAction": {
"description": "Action the DSR takes when a received request message cannot be processed because the egress Peer Node (/diameter/peernodes) reports congestion. When Abandon is specified, the request message is discarded. When SendAnswer is specified, an answer message is sent to the upstream Peer Node, and that answer message has content based on the values specified for peerRptCongestionErrMsg, peerRptCongestionResultCode, and peerRptCongestionVendorId.",
"enum": [
"Abandon",
"SendAnswer"
],
"type": "string"
},
"peerRptCongestionErrMsg": {
"description": "Error message string to be placed in the Error-Message AVP of the answer message when the egress Peer Node (/diameter/peernodes) reports congestion and peerRptCongestionAction is set to SendAnswer. Not applicable if peerRptCongestionAction is Abandon.",
"maxLength": 64,
"type": "string"
},
"peerRptCongestionResultCode": {
"description": "Value to be placed in the Result-Code AVP of the answer message when the egress Peer Node (/diameter/peernodes) reports congestion. Required if peerRptCongestionAction is SendAnswer, not applicable if peerRptCongestionAction is Abandon.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"peerRptCongestionVendorId": {
"description": "If specified and peerRptCongestionAction is SendAnswer, the answer message includes the Experimental-Result-Code grouped AVP, where the value specified for peerRptCongestionVendorId is placed in the Vendor-Id AVP. Not applicable if peerRptCongestionAction is Abandon.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
},
"pendingAnswerTimerName": {
"description": "Name of the Pending Answer Timer (/diameter/pendinganswertimer) associated with this Routing Option Set. If no Pending Answer Timer name is given, the egress Peer Node's (/diameter/peernodes) Pending Answer Timer is used (if it's defined) when processing transactions.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"resExhAction": {
"description": "Action the DSR takes when a received request message cannot be processed because the MP server does not have sufficient free internal resources to process the request. When Abandon is specified, the request message is discarded. When SendAnswer is specified, an answer message is sent to the upstream Peer Node, and that answer message has content based on the values specified for resExhErrMsg, resExhResultCode, and resExhVendorId.",
"enum": [
"Abandon",
"SendAnswer"
],
"type": "string"
},
"resExhErrMsg": {
"description": "Error message string to be placed in the Error-Message AVP of the answer message when resource exhaustion occurs and resExhAction is set to SendAnswer. Not applicable if resExhAction is Abandon.",
"maxLength": 64,
"type": "string"
},
"resExhResultCode": {
"description": "Value to be placed in the Result-Code AVP of the answer message when resource exhaustion occurs. Required if resExhAction is SendAnswer, not applicable if resExhAction is Abandon.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"resExhVendorId": {
"description": "If specified and resExhAction is SendAnswer, the answer message includes the Experimental-Result-Code grouped AVP, where the value specified for resExhVendorId is placed in the Vendor-Id AVP. Not applicable if resExhAction is Abandon.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
},
"transactionLifetime": {
"description": "The total time, in milliseconds, the DSR attempts to forward a request, including the initial and all subsequent routing attempts. Only required if maxPerMsgFwdAllowed is greater than 1. Typical value is 20000 ms.",
"maximum": 540000,
"minimum": 100,
"type": "integer"
}
},
"required": [
"connCongestionAction",
"connFailureAction",
"destRealmNotServedAction",
"maxPerMsgFwdAllowed",
"name",
"noPeerResponseAction",
"peerRptCongestionAction",
"resExhAction"
],
"type": "object"
}
Example
{
"configurationLevel": "3986",
"connCongestionAction": "SendAnswer",
"connCongestionErrMsg": "The connection is in congestion.",
"connCongestionResultCode": 3002,
"connCongestionVendorId": 12345,
"connFailureAction": "SendAnswer",
"connFailureErrMsg": "The connection has failed.",
"connFailureResultCode": 3002,
"connFailureVendorId": 23456,
"destRealmNotServedAction": "SendAnswer",
"destRealmNotServedErrMsg": "The destination realm is not known to DSR.",
"destRealmNotServedResultCode": 3002,
"destRealmNotServedVendorId": 12345,
"maxPerMsgFwdAllowed": 1,
"name": "RoutingOptionSet1",
"nestedArtPrtErrorAction": "SendAnswer",
"nestedArtPrtErrorErrMsg": "Table not available.",
"nestedArtPrtErrorResultCode": 3002,
"nestedArtPrtErrorVendorId": 23456,
"noPeerResponseAction": "SendAnswer",
"noPeerResponseErrMsg": "The peer node is not responding.",
"noPeerResponseResultCode": 3002,
"noPeerResponseVendorId": 34567,
"peerRptCongestionAction": "SendAnswer",
"peerRptCongestionErrMsg": "The peer reports congestion.",
"peerRptCongestionResultCode": 3002,
"peerRptCongestionVendorId": 12345,
"pendingAnswerTimerName": "Default",
"resExhAction": "SendAnswer",
"resExhErrMsg": "Unable to process - internal resource exhaustion.",
"resExhResultCode": 5006,
"resExhVendorId": 23456,
"transactionLifetime": 1000
}
delete /diameter/routingoptionsets/{name}
Deletes the specified Routing Option Set from the SOAM configuration. A Routing Option Set can only be deleted if all delete validation checks pass. In general, if the Routing Option Set is part of the configuration of some other Managed Object, the Routing Option Set cannot be deleted. For example, if the Routing Option Set is named in a Route List (/diameter/routelists), the Routing Option Set must first be removed from the Route List. Then the Routing Option Set can be deleted from the configuration. An attempt to delete a Routing Option Set that cannot be deleted results in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Diameter: Signaling IP Addresses
The Signaling IP Addresses resource provides all currently-configured signaling IP addresses for a Site, suitable for configuring Local Nodes (/diameter/localnodes) or IPFE Target Sets (/diameter/ipfetargetsets).
/diameter/signalingipaddresses
get /diameter/signalingipaddresses
Retrieves the set of valid signaling IP addresses for the Site. The returned collection includes both DA-MP signaling IP addresses and any Target Set Addresses (TSAs) configured at the SOAM.
Target server: SOAM
Secured by x-other
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/signalingipaddressCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/signalingipaddress/signalingipaddress.json",
"properties": {
"hostname": {
"description": "When ipType is LocalIp, this value is the name of the DA-MP with which the ipAddr is associated. When ipType is IpfeTsa, this value is the empty string.",
"type": "string"
},
"ipAddr": {
"description": "A single IP address, which can be IPv4 or IPv6.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"ipType": {
"description": "Each IP address is of type LocalIp or IpfeTsa. A Local IP is a fixed IP address assigned to a specific MP server within the DSR. An IPFE Target Set Address (TSA) is an IP address associated with a group of MP servers, which together are known as a Target Set.",
"enum": [
"LocalIp",
"IpfeTsa"
],
"type": "string"
},
"networkName": {
"description": "When ipType is LocalIp, this value is the name of the network of which ipAddr is a part. When ipType is IpfeTsa, this value is the empty string.",
"pattern": "^[A-Za-z][A-Za-z0-9]*$",
"maxLength": 31,
"type": "string"
},
"targetSetNumber": {
"description": "When ipType is IpfeTsa, this value is the number of the Target Set the ipAddr is associated with. When ipType is LocalIp, this value is zero.",
"maximum": 32,
"minimum": 0,
"type": "integer"
}
},
"readOnly": true,
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"hostname": "DAMP2",
"ipAddr": "75.40.31.13",
"ipType": LocalIp",
"networkName": "XSI1PV6",
"targetSetNumber": 0
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
Diameter: Traffic Throttle Groups
A Traffic Throttle Group (TTG) is a collection of one to twenty Traffic Throttle Points (TTPs)(/diameter/trafficthrottlepoints), all of which share the same Application ID (/diameter/applicationids). A Traffic Throttle Group can be associated with a Route Group as part of Route List (/diameter/routelists) configuration, and the same TTG can be associated with more than one Route List/Route Group, if desired.
The rate of egress messages having the specified Application ID can be throttled by the DSR, if congestion is occuring among the hosts that make up the TTG. More specifically, DSR periodically calculates a loss percentage for the TTG, based on the current state of the TTPs within the TTG. If the loss percentage for the TTG exceeds the maximum loss percentage threshold specified for the Route List/Route Group (part of the Route List configuration), DSR throttles egress request traffic to the Route Group associated with the TTG.
All configuration of Traffic Throttle Groups is done at the SOAM.
/diameter/trafficthrottlegroups
get /diameter/trafficthrottlegroups
Returns all Traffic Throttle Groups configured at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those Traffic Throttle Groups meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section).
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/trafficthrottlegroupCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schema/trafficthrottlegroup.json",
"properties": {
"appId": {
"description": "The Diameter Application ID (/diameter/applicationids) associated with this Traffic Throttle Group.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name for this Traffic Throttle Group, which must be unique within the DSR site. A name is required, and cannot be changed after the Traffic Throttle Group is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxlength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"shared": {
"description": "When set to true, the Traffic Throttle Group is made visible to the other sites within the DSR network, and can therefore be selected for use by Route Lists (/diameter/routelists) configured at any other SOAM in the network. When set to false, the TTG is only visible to the SOAM at which the TTG is configured, and can only be selected for use by Route Lists configured at that same SOAM.",
"type": "boolean"
},
"trafficThrottlePointName": {
"description": "Array of 1 to 20 valid Traffic Throttle Point (/diameter/trafficthrottlepoints) names. All TTPs associated with a TTG must be configured at the same SOAM as the TTG, even if the TTG's shared value is true.",
"items": {
"description": "Name of a Traffic Throttle Point configured at the same SOAM as this TTG. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"maxItems": 20,
"minItems": 1,
"type": "array"
}
},
"required": [
"appId",
"name",
"shared",
"trafficThrottlePointName"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"appId": 4294967295,
"configurationLevel": "730978",
"name": "TTG1",
"shared": false,
"trafficThrottlePointName": [
"TTP1",
"TTP2",
"TTP3"
]
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/trafficthrottlegroups
Adds a new Traffic Throttle Group to the DSR configuration. The new TTG must have a name that is unique across all TTGs at the SOAM. A TTG configured at one SOAM may duplicate the name of a TTG configured at a second SOAM, even if one or both are shared, since the SOAM name helps to uniquely identify a TTG when it is shared.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schema/trafficthrottlegroup.json",
"properties": {
"appId": {
"description": "The Diameter Application ID (/diameter/applicationids) associated with this Traffic Throttle Group.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name for this Traffic Throttle Group, which must be unique within the DSR site. A name is required, and cannot be changed after the Traffic Throttle Group is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxlength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"shared": {
"description": "When set to true, the Traffic Throttle Group is made visible to the other sites within the DSR network, and can therefore be selected for use by Route Lists (/diameter/routelists) configured at any other SOAM in the network. When set to false, the TTG is only visible to the SOAM at which the TTG is configured, and can only be selected for use by Route Lists configured at that same SOAM.",
"type": "boolean"
},
"trafficThrottlePointName": {
"description": "Array of 1 to 20 valid Traffic Throttle Point (/diameter/trafficthrottlepoints) names. All TTPs associated with a TTG must be configured at the same SOAM as the TTG, even if the TTG's shared value is true.",
"items": {
"description": "Name of a Traffic Throttle Point configured at the same SOAM as this TTG. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"maxItems": 20,
"minItems": 1,
"type": "array"
}
},
"required": [
"appId",
"name",
"shared",
"trafficThrottlePointName"
],
"type": "object"
}
Example
{
"appId": 4294967295,
"configurationLevel": "730978",
"name": "TTG1",
"shared": false,
"trafficThrottlePointName": [
"TTP1",
"TTP2",
"TTP3"
]
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/trafficthrottlegroups/status
get /diameter/trafficthrottlegroups/status
Returns the status of all Traffic Throttle Groups that meet the criteria specified in the request. This API supports filtering on any single attribute returned in the JSON data. Integer attributes can be filtered using EQUAL and NOT_EQUAL. Boolean attributes and enumerated strings can be filtered using only EQUAL. The name attribute can be filtered using EQUAL, NOT_EQUAL, or LIKE, while the Time of Last Update can be filtered using only EQUAL or NOT_EQUAL.
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (string)
Returns the status of all Traffic Throttle Groups that meet the criteria specified in the request. This API supports filtering on any single attribute returned in the JSON data. Integer attributes can be filtered using EQUAL and NOT_EQUAL. Boolean attributes and enumerated strings can be filtered using only EQUAL. The name attribute can be filtered using EQUAL, NOT_EQUAL, or LIKE, while the Time of Last Update can be filtered using only EQUAL or NOT_EQUAL.
Example:
filter_name=adminState
- filter_op: (one of EQUAL, NOT_EQUAL, LIKE)
The filter operator.
Example:
filter_op=EQUAL
- filter_values: (string)
The value being filtered on.
Example:
filter_values=Enabled
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/trafficthrottlegroupstatusCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/trafficthrottlegroup/trafficthrottlegroupstatus.json",
"properties": {
"adminState": {
"description": "The administrative state defines whether the Traffic Throttle Group is active and can be applied to routing. When adminState is set to Disabled, the TTG's currentLossPercent is ignored when making routing decisions.",
"enum": [
"Enabled",
"Disabled"
],
"type": "string"
},
"currentLossPercent": {
"description": "This is a weighted average of the current loss values for the Traffic Throttle Points (/diameter/trafficthrottlepoints) that make up the Traffic Throttle Group.",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"name": {
"description": "The configured name of the Traffice Throttle Group.",
"type": "string"
},
"siteName": {
"description": "The name of the site to which this Traffic Throttle Group is owned and controlled.",
"type": "string"
},
"statusKnown": {
"description": "When set to false, current values for the run-time status attributes for this Traffic Throttle Group are not known by the OAM. This could be due to merge issues within the DSR, or some other cause preventing the OAM from having a current view of the status of this TTG. If the OAM has current status for this TTG, statusKnown is set to true.",
"type": "boolean"
},
"timeOfLastUpdate": {
"description": "The date/time the status for this Traffic Throttle Group was last updated by the DSR.",
"pattern": "^[0-9]{4}[-][a-zA-Z]{3}[-][0-9]{2} [0-9]{2}[:][0-9]{2}[:][0-9]{2} .*$",
"type": "string"
}
},
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"adminState": "Enabled",
"currentLossPercent": 5,
"name": "trafficthrottlegroup1",
"siteName": "siteName1",
"statusKnown": true,
"timeOfLastUpdate": "2016-Aug-25 11:05:05 EDT"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
/diameter/trafficthrottlegroups/{name}
get /diameter/trafficthrottlegroups/{name}
Returns the configuration details for the specified Traffic Throttle Group. If the specified TTG does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/trafficthrottlegroupItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schema/trafficthrottlegroup.json",
"properties": {
"appId": {
"description": "The Diameter Application ID (/diameter/applicationids) associated with this Traffic Throttle Group.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name for this Traffic Throttle Group, which must be unique within the DSR site. A name is required, and cannot be changed after the Traffic Throttle Group is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxlength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"shared": {
"description": "When set to true, the Traffic Throttle Group is made visible to the other sites within the DSR network, and can therefore be selected for use by Route Lists (/diameter/routelists) configured at any other SOAM in the network. When set to false, the TTG is only visible to the SOAM at which the TTG is configured, and can only be selected for use by Route Lists configured at that same SOAM.",
"type": "boolean"
},
"trafficThrottlePointName": {
"description": "Array of 1 to 20 valid Traffic Throttle Point (/diameter/trafficthrottlepoints) names. All TTPs associated with a TTG must be configured at the same SOAM as the TTG, even if the TTG's shared value is true.",
"items": {
"description": "Name of a Traffic Throttle Point configured at the same SOAM as this TTG. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"maxItems": 20,
"minItems": 1,
"type": "array"
}
},
"required": [
"appId",
"name",
"shared",
"trafficThrottlePointName"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"appId": 4294967295,
"configurationLevel": "730978",
"name": "TTG1",
"shared": false,
"trafficThrottlePointName": [
"TTP1",
"TTP2",
"TTP3"
]
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/trafficthrottlegroups/{name}
Updates the configuration for the specified Traffic Throttle Group. If the provided TTG data is invalid in any way, the update fails, resulting in one or more error messages returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schema/trafficthrottlegroup.json",
"properties": {
"appId": {
"description": "The Diameter Application ID (/diameter/applicationids) associated with this Traffic Throttle Group.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name for this Traffic Throttle Group, which must be unique within the DSR site. A name is required, and cannot be changed after the Traffic Throttle Group is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxlength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"shared": {
"description": "When set to true, the Traffic Throttle Group is made visible to the other sites within the DSR network, and can therefore be selected for use by Route Lists (/diameter/routelists) configured at any other SOAM in the network. When set to false, the TTG is only visible to the SOAM at which the TTG is configured, and can only be selected for use by Route Lists configured at that same SOAM.",
"type": "boolean"
},
"trafficThrottlePointName": {
"description": "Array of 1 to 20 valid Traffic Throttle Point (/diameter/trafficthrottlepoints) names. All TTPs associated with a TTG must be configured at the same SOAM as the TTG, even if the TTG's shared value is true.",
"items": {
"description": "Name of a Traffic Throttle Point configured at the same SOAM as this TTG. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"maxItems": 20,
"minItems": 1,
"type": "array"
}
},
"required": [
"appId",
"name",
"shared",
"trafficThrottlePointName"
],
"type": "object"
}
Example
{
"appId": 4294967295,
"configurationLevel": "730978",
"name": "TTG1",
"shared": false,
"trafficThrottlePointName": [
"TTP1",
"TTP2",
"TTP3"
]
}
delete /diameter/trafficthrottlegroups/{name}
Deletes the specified Traffic Throttle Group from the SOAM configuration. A TTG can only be deleted if all delete validation checks pass. In general, if the TTG is part of the configuration of some other Managed Object, the TTG cannot be deleted. For example, if the TTG is named in a Route List (/diameter/routelists), the TTG must first be removed from the Route List. Then the TTG can be deleted from the configuration. An attempt to delete a TTG that cannot be deleted results in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
/diameter/trafficthrottlegroups/{name}/trafficthrottlegroupadminstate
get /diameter/trafficthrottlegroups/{name}/trafficthrottlegroupadminstate
Retrieves the administrative state for the specified Traffic Throttle Group, which can be Enabled or Disabled.
Target server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/trafficthrottlegroupadminstateItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/trafficthrottlegroupadminstate/trafficthrottlegroupadminstate.json",
"properties": {
"adminState": {
"description": "A Traffic Throttle Group's administrative state can be either Enabled or Disabled. A Traffic Throttle Group's configuration cannot be modified or deleted if its administrative state is Enabled.",
"enum": [
"Enabled",
"Disabled"
],
"type": "string"
}
},
"required": [
"adminState"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"adminState": "Enabled"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/trafficthrottlegroups/{name}/trafficthrottlegroupadminstate
Updates the administrative state for the specified Traffic Throttle Group to either Enabled or Disabled.
A Traffic Throttle Group's configuration cannot be modified or deleted if its administrative state is Enabled.
Target server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/trafficthrottlegroupadminstate/trafficthrottlegroupadminstate.json",
"properties": {
"adminState": {
"description": "A Traffic Throttle Group's administrative state can be either Enabled or Disabled. A Traffic Throttle Group's configuration cannot be modified or deleted if its administrative state is Enabled.",
"enum": [
"Enabled",
"Disabled"
],
"type": "string"
}
},
"required": [
"adminState"
],
"type": "object"
}
Example
{
"adminState": "Enabled"
}
/diameter/trafficthrottlegroups/{name}/status
get /diameter/trafficthrottlegroups/{name}/status
Retrieves the operational status for the specified Traffic Throttle Group.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/trafficthrottlegroupstatusItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/trafficthrottlegroup/trafficthrottlegroupstatus.json",
"properties": {
"adminState": {
"description": "The administrative state defines whether the Traffic Throttle Group is active and can be applied to routing. When adminState is set to Disabled, the TTG's currentLossPercent is ignored when making routing decisions.",
"enum": [
"Enabled",
"Disabled"
],
"type": "string"
},
"currentLossPercent": {
"description": "This is a weighted average of the current loss values for the Traffic Throttle Points (/diameter/trafficthrottlepoints) that make up the Traffic Throttle Group.",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"name": {
"description": "The configured name of the Traffice Throttle Group.",
"type": "string"
},
"siteName": {
"description": "The name of the site to which this Traffic Throttle Group is owned and controlled.",
"type": "string"
},
"statusKnown": {
"description": "When set to false, current values for the run-time status attributes for this Traffic Throttle Group are not known by the OAM. This could be due to merge issues within the DSR, or some other cause preventing the OAM from having a current view of the status of this TTG. If the OAM has current status for this TTG, statusKnown is set to true.",
"type": "boolean"
},
"timeOfLastUpdate": {
"description": "The date/time the status for this Traffic Throttle Group was last updated by the DSR.",
"pattern": "^[0-9]{4}[-][a-zA-Z]{3}[-][0-9]{2} [0-9]{2}[:][0-9]{2}[:][0-9]{2} .*$",
"type": "string"
}
},
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"adminState": "Enabled",
"currentLossPercent": 5,
"name": "trafficthrottlegroup1",
"siteName": "siteName1",
"statusKnown": true,
"timeOfLastUpdate": "2016-Aug-25 11:05:05 EDT"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
Diameter: Traffic Throttle Point Configuration Sets
Traffic Throttle Point (TTP) Configuration Sets provide a set of configuration attributes for a TTP (/diameter/trafficthrottlepoints) and can be assigned to one or more TTPs.
All TTP Configuration Set configuration is done at the SOAM.
/diameter/trafficthrottlepointconfigurationsets
get /diameter/trafficthrottlepointconfigurationsets
Returns all Traffic Throttle Point Configuration Sets configured at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those Traffic Throttle Point Configuration Sets meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section).
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/trafficthrottlepointconfigurationsetCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schema/trafficthrottlepointconfigurationset.json",
"properties": {
"abatementRecoveryRate": {
"description": "Once a DOIC overload condition expires, the traffic forwarded by the DSR to the Peer is ramped back up by abatementRecoveryRate percent per second. An example, assuming abatementRecoveryRate is set to 5%: during overload, if 20% of the request messages are being shed, then once the overload condition clears, DSR forwards 5% more traffic per second to the formerly-overloaded Peer Node (diameter/peernodes). Assuming there is no return to an overload condidtion, after four seconds, the DSR again forwards all traffic to the formerly-overloaded Peer Node with no throttling applied. Typical value is 5.",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"defaultReductionPercentage": {
"description": "When a Peer Node (diameter/peernodes) reports overload to the DSR, it optionally includes a value indicating the Peer's desired traffic reduction (in percent). If the Peer Node does not specify the reduction percentage, DSR uses the value specified by default Reduction Percentage. Typical value is zero.",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"defaultValidityDuration": {
"description": "When a Peer Node (/diameter/peernodes) reports overload to the DSR, it optionally includes a value indicating for how long, in seconds, the Peer wants the traffic reduction. If the Peer Node does not specify the duration, DSR uses the value specified by default Validity Duration. Typical value is 30.",
"maximum": 86400,
"minimum": 0,
"type": "integer"
},
"name": {
"description": "Name for the Traffic Throttle Point Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit. This value is required for all Traffic Throttle Point Configuration Sets.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"overrideMessagePriorityThreshold": {
"description": "If a value is supplied for this parameter, and the offered traffic rate to the TTP (/diameter/trafficthrottlepoints) is less than the TTP's maxEtr value, messages whose priority is greater than or equal to override Message Priority Threshold are immune from diversion. If, however, the offered traffic rate to the TTP is at or above the maxEtr value, then DSR can divert messages regardless of their priority.",
"enum": [1, 2],
"type": "integer"
},
"rateConvergenceTime": {
"description": "The DSR uses an algorithm to determine how many request messages are being forwarded to a TTP (/diameter/trafficthrottlepoints) per unit time - the offered rate. The time duration the DSR algorithm uses when calculating the offered rate, which is effectively a sample period - is specified by the rateConvergenceTime value, which is in milliseconds. If rateConvergenceTime is less than 1000 msec - meaning the sample time is less than one full second - the DSR extrapolates the per-second offered rate based on the observed egress request messages during the sample interval. If rateConvergenceTime is 1000 msec, then the offered rate is just the observed egress request messages during that 1000 msec interval. If rateConvergenceTime is 2000 msec, the offered rate is the average of the two one-second intervals. Typical value is 1000.",
"enum": [250, 500, 1000, 2000],
"type": "integer"
}
},
"required": [
"abatementRecoveryRate",
"defaultValidityDuration",
"name",
"rateConvergenceTime"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"abatementRecoveryRate": 5,
"configurationLevel": "47",
"defaultReductionPercentage": 0,
"defaultValidityDuration": 30,
"name": "TrafficThrottlePointConfigurationSet1",
"overrideMessagePriorityThreshold": 1,
"rateConvergenceTime": 1000
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/trafficthrottlepointconfigurationsets
Adds a new TTP Configuration Set to the DSR configuration. The new TTP Configuration Set must have a name that is unique across all TTP Configuration Sets at the SOAM.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schema/trafficthrottlepointconfigurationset.json",
"properties": {
"abatementRecoveryRate": {
"description": "Once a DOIC overload condition expires, the traffic forwarded by the DSR to the Peer is ramped back up by abatementRecoveryRate percent per second. An example, assuming abatementRecoveryRate is set to 5%: during overload, if 20% of the request messages are being shed, then once the overload condition clears, DSR forwards 5% more traffic per second to the formerly-overloaded Peer Node (diameter/peernodes). Assuming there is no return to an overload condidtion, after four seconds, the DSR again forwards all traffic to the formerly-overloaded Peer Node with no throttling applied. Typical value is 5.",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"defaultReductionPercentage": {
"description": "When a Peer Node (diameter/peernodes) reports overload to the DSR, it optionally includes a value indicating the Peer's desired traffic reduction (in percent). If the Peer Node does not specify the reduction percentage, DSR uses the value specified by default Reduction Percentage. Typical value is zero.",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"defaultValidityDuration": {
"description": "When a Peer Node (/diameter/peernodes) reports overload to the DSR, it optionally includes a value indicating for how long, in seconds, the Peer wants the traffic reduction. If the Peer Node does not specify the duration, DSR uses the value specified by default Validity Duration. Typical value is 30.",
"maximum": 86400,
"minimum": 0,
"type": "integer"
},
"name": {
"description": "Name for the Traffic Throttle Point Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit. This value is required for all Traffic Throttle Point Configuration Sets.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"overrideMessagePriorityThreshold": {
"description": "If a value is supplied for this parameter, and the offered traffic rate to the TTP (/diameter/trafficthrottlepoints) is less than the TTP's maxEtr value, messages whose priority is greater than or equal to override Message Priority Threshold are immune from diversion. If, however, the offered traffic rate to the TTP is at or above the maxEtr value, then DSR can divert messages regardless of their priority.",
"enum": [1, 2],
"type": "integer"
},
"rateConvergenceTime": {
"description": "The DSR uses an algorithm to determine how many request messages are being forwarded to a TTP (/diameter/trafficthrottlepoints) per unit time - the offered rate. The time duration the DSR algorithm uses when calculating the offered rate, which is effectively a sample period - is specified by the rateConvergenceTime value, which is in milliseconds. If rateConvergenceTime is less than 1000 msec - meaning the sample time is less than one full second - the DSR extrapolates the per-second offered rate based on the observed egress request messages during the sample interval. If rateConvergenceTime is 1000 msec, then the offered rate is just the observed egress request messages during that 1000 msec interval. If rateConvergenceTime is 2000 msec, the offered rate is the average of the two one-second intervals. Typical value is 1000.",
"enum": [250, 500, 1000, 2000],
"type": "integer"
}
},
"required": [
"abatementRecoveryRate",
"defaultValidityDuration",
"name",
"rateConvergenceTime"
],
"type": "object"
}
Example
{
"abatementRecoveryRate": 5,
"configurationLevel": "47",
"defaultReductionPercentage": 0,
"defaultValidityDuration": 30,
"name": "TrafficThrottlePointConfigurationSet1",
"overrideMessagePriorityThreshold": 1,
"rateConvergenceTime": 1000
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/trafficthrottlepointconfigurationsets/{name}
get /diameter/trafficthrottlepointconfigurationsets/{name}
Returns the configuration details for the specified TTP Configuration Set. If the TTP Configuration Set does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/trafficthrottlepointconfigurationsetItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schema/trafficthrottlepointconfigurationset.json",
"properties": {
"abatementRecoveryRate": {
"description": "Once a DOIC overload condition expires, the traffic forwarded by the DSR to the Peer is ramped back up by abatementRecoveryRate percent per second. An example, assuming abatementRecoveryRate is set to 5%: during overload, if 20% of the request messages are being shed, then once the overload condition clears, DSR forwards 5% more traffic per second to the formerly-overloaded Peer Node (diameter/peernodes). Assuming there is no return to an overload condidtion, after four seconds, the DSR again forwards all traffic to the formerly-overloaded Peer Node with no throttling applied. Typical value is 5.",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"defaultReductionPercentage": {
"description": "When a Peer Node (diameter/peernodes) reports overload to the DSR, it optionally includes a value indicating the Peer's desired traffic reduction (in percent). If the Peer Node does not specify the reduction percentage, DSR uses the value specified by default Reduction Percentage. Typical value is zero.",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"defaultValidityDuration": {
"description": "When a Peer Node (/diameter/peernodes) reports overload to the DSR, it optionally includes a value indicating for how long, in seconds, the Peer wants the traffic reduction. If the Peer Node does not specify the duration, DSR uses the value specified by default Validity Duration. Typical value is 30.",
"maximum": 86400,
"minimum": 0,
"type": "integer"
},
"name": {
"description": "Name for the Traffic Throttle Point Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit. This value is required for all Traffic Throttle Point Configuration Sets.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"overrideMessagePriorityThreshold": {
"description": "If a value is supplied for this parameter, and the offered traffic rate to the TTP (/diameter/trafficthrottlepoints) is less than the TTP's maxEtr value, messages whose priority is greater than or equal to override Message Priority Threshold are immune from diversion. If, however, the offered traffic rate to the TTP is at or above the maxEtr value, then DSR can divert messages regardless of their priority.",
"enum": [1, 2],
"type": "integer"
},
"rateConvergenceTime": {
"description": "The DSR uses an algorithm to determine how many request messages are being forwarded to a TTP (/diameter/trafficthrottlepoints) per unit time - the offered rate. The time duration the DSR algorithm uses when calculating the offered rate, which is effectively a sample period - is specified by the rateConvergenceTime value, which is in milliseconds. If rateConvergenceTime is less than 1000 msec - meaning the sample time is less than one full second - the DSR extrapolates the per-second offered rate based on the observed egress request messages during the sample interval. If rateConvergenceTime is 1000 msec, then the offered rate is just the observed egress request messages during that 1000 msec interval. If rateConvergenceTime is 2000 msec, the offered rate is the average of the two one-second intervals. Typical value is 1000.",
"enum": [250, 500, 1000, 2000],
"type": "integer"
}
},
"required": [
"abatementRecoveryRate",
"defaultValidityDuration",
"name",
"rateConvergenceTime"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"abatementRecoveryRate": 5,
"configurationLevel": "47",
"defaultReductionPercentage": 0,
"defaultValidityDuration": 30,
"name": "TrafficThrottlePointConfigurationSet1",
"overrideMessagePriorityThreshold": 1,
"rateConvergenceTime": 1000
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/trafficthrottlepointconfigurationsets/{name}
Updates the configuration of the specified TTP Configuration Set.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schema/trafficthrottlepointconfigurationset.json",
"properties": {
"abatementRecoveryRate": {
"description": "Once a DOIC overload condition expires, the traffic forwarded by the DSR to the Peer is ramped back up by abatementRecoveryRate percent per second. An example, assuming abatementRecoveryRate is set to 5%: during overload, if 20% of the request messages are being shed, then once the overload condition clears, DSR forwards 5% more traffic per second to the formerly-overloaded Peer Node (diameter/peernodes). Assuming there is no return to an overload condidtion, after four seconds, the DSR again forwards all traffic to the formerly-overloaded Peer Node with no throttling applied. Typical value is 5.",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"defaultReductionPercentage": {
"description": "When a Peer Node (diameter/peernodes) reports overload to the DSR, it optionally includes a value indicating the Peer's desired traffic reduction (in percent). If the Peer Node does not specify the reduction percentage, DSR uses the value specified by default Reduction Percentage. Typical value is zero.",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"defaultValidityDuration": {
"description": "When a Peer Node (/diameter/peernodes) reports overload to the DSR, it optionally includes a value indicating for how long, in seconds, the Peer wants the traffic reduction. If the Peer Node does not specify the duration, DSR uses the value specified by default Validity Duration. Typical value is 30.",
"maximum": 86400,
"minimum": 0,
"type": "integer"
},
"name": {
"description": "Name for the Traffic Throttle Point Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit. This value is required for all Traffic Throttle Point Configuration Sets.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"overrideMessagePriorityThreshold": {
"description": "If a value is supplied for this parameter, and the offered traffic rate to the TTP (/diameter/trafficthrottlepoints) is less than the TTP's maxEtr value, messages whose priority is greater than or equal to override Message Priority Threshold are immune from diversion. If, however, the offered traffic rate to the TTP is at or above the maxEtr value, then DSR can divert messages regardless of their priority.",
"enum": [1, 2],
"type": "integer"
},
"rateConvergenceTime": {
"description": "The DSR uses an algorithm to determine how many request messages are being forwarded to a TTP (/diameter/trafficthrottlepoints) per unit time - the offered rate. The time duration the DSR algorithm uses when calculating the offered rate, which is effectively a sample period - is specified by the rateConvergenceTime value, which is in milliseconds. If rateConvergenceTime is less than 1000 msec - meaning the sample time is less than one full second - the DSR extrapolates the per-second offered rate based on the observed egress request messages during the sample interval. If rateConvergenceTime is 1000 msec, then the offered rate is just the observed egress request messages during that 1000 msec interval. If rateConvergenceTime is 2000 msec, the offered rate is the average of the two one-second intervals. Typical value is 1000.",
"enum": [250, 500, 1000, 2000],
"type": "integer"
}
},
"required": [
"abatementRecoveryRate",
"defaultValidityDuration",
"name",
"rateConvergenceTime"
],
"type": "object"
}
Example
{
"abatementRecoveryRate": 5,
"configurationLevel": "47",
"defaultReductionPercentage": 0,
"defaultValidityDuration": 30,
"name": "TrafficThrottlePointConfigurationSet1",
"overrideMessagePriorityThreshold": 1,
"rateConvergenceTime": 1000
}
delete /diameter/trafficthrottlepointconfigurationsets/{name}
Deletes the specified TTP Configuration Set from the SOAM configuration. The Default TTP Configuration Set cannot be deleted. A TTP Configuration Set can only be deleted if all delete validation checks pass. In general, if the TTP Configuration Set is part of the configuration of some other Managed Object, the TTP Configuration Set cannot be deleted. For example, if the TTP Configuration Set is named by a TTP, the TTP Configuration Set must be removed from the TTP. Then the TTP Configuration Set can be deleted from the configuration. An attempt to delete a TTP Configuration Set that cannot be deleted results in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Diameter: Traffic Throttle Points
A Traffic Throttle Point (TTP) is a logical entity corresponding to a specific Peer Node (/diameter/peernodes) and Diameter Application ID (/diameter/applicationids). When the DSR selects a Peer Node or Connection (/diameter/connections) from a Route Group (/diameter/routegroups), or selects a Peer Node for implicit routing, DSR checks if a TTP has been configured for the selected Peer Node and the Application ID specified in the request message. If a TTP exists and is administratively enabled, transmission of the request message may be subject to throttling, if the conditions prescribed by the TTP and its assigned TTP Configuration Set (/diameter/trafficthrottlepointconfigurationsets) are met.
All configuration of Traffic Throttle Points is done at the SOAM.
/diameter/trafficthrottlepoints
get /diameter/trafficthrottlepoints
Returns all Traffic Throttle Points configured at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those Traffic Throttle Points meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section).
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/trafficthrottlepointCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schema/trafficthrottlepoint.json",
"properties": {
"altImplicitRouteListName": {
"description": "Name of the Route List (/diameter/routelists) used for routing messages when the primary route to the Peer Node (/diameter/peernodes) is unavailable and implicit routing is invoked.",
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"appId": {
"description": "The Diameter Application ID (/diameter/applicationids) associated with this Traffic Throttle Point.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"maxEtr": {
"description": "The maximum allowed Egress Transaction Rate (ETR) for this TTP. Typical value is 6000.",
"maximum": 250000,
"minimum": 100,
"type": "integer"
},
"maxLossPercentThresh": {
"description": "When the current percent loss (as reported by the Peer Node (/diameter/peernodes)) is at or above maxLossPercentThresh, the DSR stops forwarding requests to the Peer Node associated with this TTP. Typical value is 100.",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"name": {
"description": "Name for this Traffic Throttle Point, which must be unique within the DSR site. A name is required, and cannot be changed after the Traffic Throttle Point is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxlength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerNodeName": {
"description": "Name of the Peer Node (/diameter/peernodes) associated with this TTP.",
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"ttpConfigurationSetName": {
"description": "Name of the TTP Configuration Set (/diameter/trafficthrottlepointconfigurationsets) associated with this TTP.",
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"appId",
"maxEtr",
"maxLossPercentThresh",
"name",
"peerNodeName",
"ttpConfigurationSetName"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"altImplicitRouteListName": "RL4",
"appId": 4294967295,
"configurationLevel": "5200",
"maxEtr": 6000,
"maxLossPercentThresh": 100,
"name": "TTP1",
"peerNodeName": "PN123",
"ttpConfigurationSetName": "ttpCfgSet1"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/trafficthrottlepoints
Adds a new Traffic Throttle Point to the DSR configuration. The new TTP must have a name that is unique across all TTPs at the SOAM.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schema/trafficthrottlepoint.json",
"properties": {
"altImplicitRouteListName": {
"description": "Name of the Route List (/diameter/routelists) used for routing messages when the primary route to the Peer Node (/diameter/peernodes) is unavailable and implicit routing is invoked.",
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"appId": {
"description": "The Diameter Application ID (/diameter/applicationids) associated with this Traffic Throttle Point.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"maxEtr": {
"description": "The maximum allowed Egress Transaction Rate (ETR) for this TTP. Typical value is 6000.",
"maximum": 250000,
"minimum": 100,
"type": "integer"
},
"maxLossPercentThresh": {
"description": "When the current percent loss (as reported by the Peer Node (/diameter/peernodes)) is at or above maxLossPercentThresh, the DSR stops forwarding requests to the Peer Node associated with this TTP. Typical value is 100.",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"name": {
"description": "Name for this Traffic Throttle Point, which must be unique within the DSR site. A name is required, and cannot be changed after the Traffic Throttle Point is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxlength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerNodeName": {
"description": "Name of the Peer Node (/diameter/peernodes) associated with this TTP.",
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"ttpConfigurationSetName": {
"description": "Name of the TTP Configuration Set (/diameter/trafficthrottlepointconfigurationsets) associated with this TTP.",
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"appId",
"maxEtr",
"maxLossPercentThresh",
"name",
"peerNodeName",
"ttpConfigurationSetName"
],
"type": "object"
}
Example
{
"altImplicitRouteListName": "RL4",
"appId": 4294967295,
"configurationLevel": "5200",
"maxEtr": 6000,
"maxLossPercentThresh": 100,
"name": "TTP1",
"peerNodeName": "PN123",
"ttpConfigurationSetName": "ttpCfgSet1"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/trafficthrottlepoints/status
get /diameter/trafficthrottlepoints/status
Returns the status of all Traffic Throttle Points that meet the criteria specified in the request. This API supports filtering on any single attribute returned in the JSON data. Integer attributes can be filtered using EQUAL and NOT_EQUAL. Boolean attributes and enumerated strings (except for Operation Reason) can be filtered using only EQUAL. The Operation Reason attribute can be filtered using EQUAL or NOT_EQUAL. The name attribute can be filtered using EQUAL, NOT_EQUAL, or LIKE.
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (string)
The attribute name on which filtering occurs. Non-enumerated string attributes can be filtered using EQUAL, NOT_EQUAL, LIKE, or IN. Enumerated strings and integers can be filtered using EQUAL, NOT_EQUAL, and IN - LIKE is not supported for these data types.
Example:
filter_name=dynamicThrottlingAdminState
- filter_op: (one of EQUAL, NOT_EQUAL, LIKE)
The filter operator.
Example:
filter_op=EQUAL
- filter_values: (string)
The value being filtered on.
Example:
filter_values=Enabled
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/trafficthrottlepointstatusCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/trafficthrottlepoint/trafficthrottlepointstatus.json",
"properties": {
"abatementAlgorithm": {
"description": "Abatement algorithm applied as a result of receiving an Overload Report associated with the Traffic Throttle Point (TTP's Operational Reason = Peer Overload). The abatementAlgorithm is None unless an Overload Report is active, in which case the value is Loss.",
"enum": [
"None",
"Loss"
],
"type": "string"
},
"currentLossPercent": {
"description": "The reduction percentage currently being applied to the traffic routed to this Traffic Throttle Point based upon an Overload Report received from this TTP's egress Peer Node (/diameter/peernodes).",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"dynamicThrottlingAdminState": {
"description": "The dynamicThrottlingAdminState controls DOIC interactions with the egress Peer Node (/diameter/peernodes) configured for the Traffic Throttle Point. If the dynamicThrottlingAdminState is set to Enabled, the DSR appends DCA (DOIC Capability Announcement) AVPs to requests going to the TTP's egress Peer Node, and processes DOIC OLR (Overload Report) AVPs in answer messages coming back from the TTP's egress Peer Node.",
"enum": [
"Enabled",
"Disabled"
],
"type": "string"
},
"egressTransactionsPerSecond": {
"description": "The target number of egress transactions allowed per second based on current static and dynamic overload conditions.",
"type": "integer"
},
"maximumTransactionsPerSecond": {
"description": "The maximum number of egress transactions allowed per second. This value can vary based on dynamic throttling.",
"type": "integer"
},
"name": {
"description": "The configured name of the Traffice Throttle Point.",
"type": "string"
},
"offeredTransactionsPerSecond": {
"description": "The number of transactions per second routed to the Traffic Throttle Point before any diversion is applied.",
"type": "integer"
},
"operationalReason": {
"description": "Information elaborating on the current operationalStatus of the Traffic Throttle Point.",
"enum": [
"NoDampLeader",
"Normal",
"PeerNodeUnavailable",
"PeerOverload",
"PeerOverloadRecovery",
"SmsServiceDegraded",
"StaticRateLimitExceeded",
"TtpDisabled"
],
"type": "string"
},
"operationalStatus": {
"description": "The operational status for this Traffic Throttle Point. The operationalReason value contains additional information elaborating on the reported operationalStatus.",
"enum": [
"Available",
"Degraded",
"Inactive"
],
"type": "string"
},
"percentOfTransactionsDiverted": {
"description": "The percentage of transactions routed to the Traffic Throttle Point that are diverted or abandoned.",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"staticThrottlingAdminState": {
"description": "When staticThrottlingAdminState is set to Enabled, requests are throttled when the egress traffic rate exceeds the maximum egress throttle rate configured against the Traffic Throttle Point. When the staticThrottlingAdminState is disabled, the dynamicThrottlingAdminState cannot be changed or disabled. The staticThrottlingAdminState must first be set to Enabled before the dynamicThrottlingAdminState can be Enabled.",
"enum": [
"Enabled",
"Disabled"
],
"type": "string"
},
"statusKnown": {
"description": "When set to false, current values for the run-time status attributes for this Traffic Throttle Point are not known by the OAM. This could be due to merge issues within the DSR, or some other cause preventing the OAM from having a current view of the status of this TTP. If the OAM has current status for this TTP, statusKnown is set to true.",
"type": "boolean"
},
"timeOfLastUpdate": {
"description": "The date/time the status for this Traffic Throttle Point was last updated by the DSR.",
"pattern": "^[0-9]{4}[-][0-1]{1}[0-9]{1}[-][0-3]{1}[0-9]{1}T[0-2]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}([.][0-9]{1,7})?[+-](?:2[0-3]|[0-1][0-9])[:][0-5][0-9]?$",
"type": "string"
},
"timeAtWhichLossEqualsZeroPercent": {
"description": "The date/time when an active dynamic overload state and abatement are due to expire.",
"pattern": "^[0-9]{4}[-][0-1]{1}[0-9]{1}[-][0-3]{1}[0-9]{1}T[0-2]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}([.][0-9]{1,7})?[+-](?:2[0-3]|[0-1][0-9])[:][0-5][0-9]?$",
"type": "string"
},
"validityDuration": {
"description": "The duration (in seconds) that the loss percentage from an Overload Report should be applied.",
"maximum": 86400,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"abatementAlgorithm": "Loss",
"currentLossPercent": 5,
"dynamicThrottlingAdminState": "Enabled",
"egressTransactionsPerSecond": 285,
"maximumTransactionsPerSecond": 500,
"name": "trafficthrottlepointstatus1",
"offeredTransactionsPerSecond": 300,
"operationalReason": "Normal",
"operationalStatus": "Available",
"percentOfTransactionsDiverted": 5,
"staticThrottlingAdminState": "Enabled",
"statusKnown": true,
"timeOfLastUpdate": "2016-Aug-25 11:05:05 EDT",
"timeAtWhichLossEqualsZeroPercent": "2016-Aug-25 12:47:50 EDT",
"validityDuration": 30
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
/diameter/trafficthrottlepoints/{name}
get /diameter/trafficthrottlepoints/{name}
Returns the configuration details for the specified Traffic Throttle Point. If the specified TTP does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/trafficthrottlepointItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schema/trafficthrottlepoint.json",
"properties": {
"altImplicitRouteListName": {
"description": "Name of the Route List (/diameter/routelists) used for routing messages when the primary route to the Peer Node (/diameter/peernodes) is unavailable and implicit routing is invoked.",
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"appId": {
"description": "The Diameter Application ID (/diameter/applicationids) associated with this Traffic Throttle Point.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"maxEtr": {
"description": "The maximum allowed Egress Transaction Rate (ETR) for this TTP. Typical value is 6000.",
"maximum": 250000,
"minimum": 100,
"type": "integer"
},
"maxLossPercentThresh": {
"description": "When the current percent loss (as reported by the Peer Node (/diameter/peernodes)) is at or above maxLossPercentThresh, the DSR stops forwarding requests to the Peer Node associated with this TTP. Typical value is 100.",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"name": {
"description": "Name for this Traffic Throttle Point, which must be unique within the DSR site. A name is required, and cannot be changed after the Traffic Throttle Point is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxlength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerNodeName": {
"description": "Name of the Peer Node (/diameter/peernodes) associated with this TTP.",
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"ttpConfigurationSetName": {
"description": "Name of the TTP Configuration Set (/diameter/trafficthrottlepointconfigurationsets) associated with this TTP.",
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"appId",
"maxEtr",
"maxLossPercentThresh",
"name",
"peerNodeName",
"ttpConfigurationSetName"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"altImplicitRouteListName": "RL4",
"appId": 4294967295,
"configurationLevel": "5200",
"maxEtr": 6000,
"maxLossPercentThresh": 100,
"name": "TTP1",
"peerNodeName": "PN123",
"ttpConfigurationSetName": "ttpCfgSet1"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/trafficthrottlepoints/{name}
Updates the configuration for the specified Traffic Throttle Point. If the provided TTP data is invalid in any way, the update fails, resulting in one or more error messages returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schema/trafficthrottlepoint.json",
"properties": {
"altImplicitRouteListName": {
"description": "Name of the Route List (/diameter/routelists) used for routing messages when the primary route to the Peer Node (/diameter/peernodes) is unavailable and implicit routing is invoked.",
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"appId": {
"description": "The Diameter Application ID (/diameter/applicationids) associated with this Traffic Throttle Point.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"maxEtr": {
"description": "The maximum allowed Egress Transaction Rate (ETR) for this TTP. Typical value is 6000.",
"maximum": 250000,
"minimum": 100,
"type": "integer"
},
"maxLossPercentThresh": {
"description": "When the current percent loss (as reported by the Peer Node (/diameter/peernodes)) is at or above maxLossPercentThresh, the DSR stops forwarding requests to the Peer Node associated with this TTP. Typical value is 100.",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"name": {
"description": "Name for this Traffic Throttle Point, which must be unique within the DSR site. A name is required, and cannot be changed after the Traffic Throttle Point is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxlength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"peerNodeName": {
"description": "Name of the Peer Node (/diameter/peernodes) associated with this TTP.",
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"ttpConfigurationSetName": {
"description": "Name of the TTP Configuration Set (/diameter/trafficthrottlepointconfigurationsets) associated with this TTP.",
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"appId",
"maxEtr",
"maxLossPercentThresh",
"name",
"peerNodeName",
"ttpConfigurationSetName"
],
"type": "object"
}
Example
{
"altImplicitRouteListName": "RL4",
"appId": 4294967295,
"configurationLevel": "5200",
"maxEtr": 6000,
"maxLossPercentThresh": 100,
"name": "TTP1",
"peerNodeName": "PN123",
"ttpConfigurationSetName": "ttpCfgSet1"
}
delete /diameter/trafficthrottlepoints/{name}
Deletes the specified Traffic Throttle Point from the SOAM configuration. A TTP can only be deleted if all delete validation checks pass. In general, if the TTP is part of the configuration of some other Managed Object, the TTP cannot be deleted. For example, if the TTP is named in a Traffic Throttle Group (/diameter/trafficthrottlegroups), the TTP must first be removed from the TTG. Then the TTP can be deleted from the configuration. An attempt to delete a TTP that cannot be deleted results in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
/diameter/trafficthrottlepoints/{name}/staticthrottlingadminstate
get /diameter/trafficthrottlepoints/{name}/staticthrottlingadminstate
Retrieves the static throttling administrative state for the specified Traffic Throttle Point, which can be Enabled or Disabled.
Target server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/staticthrottlingadminstateItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/staticthrottlingadminstate/staticthrottlingadminstate.json",
"properties": {
"adminState": {
"description": "A Traffic Throttle Point's static throttling administrative state can be either Enabled or Disabled. Static throttling can be enabled to limit the rate of transactions that are forwarded to a particular Peer Node (/diameter/peernodes) which are addressed to a particular Diameter Application ID (/diameter/applicationid). A Traffic Throttle Point's configuration cannot be modified or deleted if its static throttling administrative state is Enabled.",
"enum": [
"Enabled",
"Disabled"
],
"example": "Enabled",
"type": "string"
}
},
"required": [
"adminState"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"adminState": "Enabled"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/trafficthrottlepoints/{name}/staticthrottlingadminstate
Updates the static throttling administrative state for the specified Traffic Throttle Point to either Enabled or Disabled.
A Traffic Throttle Point's configuration cannot be modified or deleted if its static throttling administrative state is Enabled.
Target server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/staticthrottlingadminstate/staticthrottlingadminstate.json",
"properties": {
"adminState": {
"description": "A Traffic Throttle Point's static throttling administrative state can be either Enabled or Disabled. Static throttling can be enabled to limit the rate of transactions that are forwarded to a particular Peer Node (/diameter/peernodes) which are addressed to a particular Diameter Application ID (/diameter/applicationid). A Traffic Throttle Point's configuration cannot be modified or deleted if its static throttling administrative state is Enabled.",
"enum": [
"Enabled",
"Disabled"
],
"example": "Enabled",
"type": "string"
}
},
"required": [
"adminState"
],
"type": "object"
}
Example
{
"adminState": "Enabled"
}
/diameter/trafficthrottlepoints/{name}/dynamicthrottlingadminstate
get /diameter/trafficthrottlepoints/{name}/dynamicthrottlingadminstate
Retrieves the dynamic throttling administrative state for the specified Traffic Throttle Point, which can be Enabled or Disabled.
Target server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/dynamicthrottlingadminstateItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/dynamicthrottlingadminstate/dynamicthrottlingadminstate.json",
"properties": {
"adminState": {
"description": "A Traffic Throttle Point's dynamic throttling administrative state can be either Enabled or Disabled. Dynamic throttling can be enabled to perform Diameter Overload Indication Conveyance(DOIC) throttling. Static Throttling administrative state must be enabled before dynamic throttling administrative state can be enabled. A Traffic Throttle Point's configuration cannot be modified or deleted if its static throttling administrative state is Enabled.",
"enum": [
"Enabled",
"Disabled"
],
"example": "Enabled",
"type": "string"
}
},
"required": [
"adminState"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"adminState": "Enabled"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/trafficthrottlepoints/{name}/dynamicthrottlingadminstate
Updates the dynamic throttling administrative state for the specified Traffic Throttle Point to either Enable or Disabled. The dynamic throttling administrative state of a Traffic Throttle Point cannot be enabled unless the static throttling administrative state is also enabled.
A Traffic Throttle Point's configuration cannot be modified or deleted if its dynamic throttling administrative state is Enabled.
Target server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/dynamicthrottlingadminstate/dynamicthrottlingadminstate.json",
"properties": {
"adminState": {
"description": "A Traffic Throttle Point's dynamic throttling administrative state can be either Enabled or Disabled. Dynamic throttling can be enabled to perform Diameter Overload Indication Conveyance(DOIC) throttling. Static Throttling administrative state must be enabled before dynamic throttling administrative state can be enabled. A Traffic Throttle Point's configuration cannot be modified or deleted if its static throttling administrative state is Enabled.",
"enum": [
"Enabled",
"Disabled"
],
"example": "Enabled",
"type": "string"
}
},
"required": [
"adminState"
],
"type": "object"
}
Example
{
"adminState": "Enabled"
}
/diameter/trafficthrottlepoints/{name}/status
get /diameter/trafficthrottlepoints/{name}/status
Retrieves the operational status for the specified Traffic Throttle Point.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/trafficthrottlepointstatusItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/trafficthrottlepoint/trafficthrottlepointstatus.json",
"properties": {
"abatementAlgorithm": {
"description": "Abatement algorithm applied as a result of receiving an Overload Report associated with the Traffic Throttle Point (TTP's Operational Reason = Peer Overload). The abatementAlgorithm is None unless an Overload Report is active, in which case the value is Loss.",
"enum": [
"None",
"Loss"
],
"type": "string"
},
"currentLossPercent": {
"description": "The reduction percentage currently being applied to the traffic routed to this Traffic Throttle Point based upon an Overload Report received from this TTP's egress Peer Node (/diameter/peernodes).",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"dynamicThrottlingAdminState": {
"description": "The dynamicThrottlingAdminState controls DOIC interactions with the egress Peer Node (/diameter/peernodes) configured for the Traffic Throttle Point. If the dynamicThrottlingAdminState is set to Enabled, the DSR appends DCA (DOIC Capability Announcement) AVPs to requests going to the TTP's egress Peer Node, and processes DOIC OLR (Overload Report) AVPs in answer messages coming back from the TTP's egress Peer Node.",
"enum": [
"Enabled",
"Disabled"
],
"type": "string"
},
"egressTransactionsPerSecond": {
"description": "The target number of egress transactions allowed per second based on current static and dynamic overload conditions.",
"type": "integer"
},
"maximumTransactionsPerSecond": {
"description": "The maximum number of egress transactions allowed per second. This value can vary based on dynamic throttling.",
"type": "integer"
},
"name": {
"description": "The configured name of the Traffice Throttle Point.",
"type": "string"
},
"offeredTransactionsPerSecond": {
"description": "The number of transactions per second routed to the Traffic Throttle Point before any diversion is applied.",
"type": "integer"
},
"operationalReason": {
"description": "Information elaborating on the current operationalStatus of the Traffic Throttle Point.",
"enum": [
"NoDampLeader",
"Normal",
"PeerNodeUnavailable",
"PeerOverload",
"PeerOverloadRecovery",
"SmsServiceDegraded",
"StaticRateLimitExceeded",
"TtpDisabled"
],
"type": "string"
},
"operationalStatus": {
"description": "The operational status for this Traffic Throttle Point. The operationalReason value contains additional information elaborating on the reported operationalStatus.",
"enum": [
"Available",
"Degraded",
"Inactive"
],
"type": "string"
},
"percentOfTransactionsDiverted": {
"description": "The percentage of transactions routed to the Traffic Throttle Point that are diverted or abandoned.",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"staticThrottlingAdminState": {
"description": "When staticThrottlingAdminState is set to Enabled, requests are throttled when the egress traffic rate exceeds the maximum egress throttle rate configured against the Traffic Throttle Point. When the staticThrottlingAdminState is disabled, the dynamicThrottlingAdminState cannot be changed or disabled. The staticThrottlingAdminState must first be set to Enabled before the dynamicThrottlingAdminState can be Enabled.",
"enum": [
"Enabled",
"Disabled"
],
"type": "string"
},
"statusKnown": {
"description": "When set to false, current values for the run-time status attributes for this Traffic Throttle Point are not known by the OAM. This could be due to merge issues within the DSR, or some other cause preventing the OAM from having a current view of the status of this TTP. If the OAM has current status for this TTP, statusKnown is set to true.",
"type": "boolean"
},
"timeOfLastUpdate": {
"description": "The date/time the status for this Traffic Throttle Point was last updated by the DSR.",
"pattern": "^[0-9]{4}[-][0-1]{1}[0-9]{1}[-][0-3]{1}[0-9]{1}T[0-2]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}([.][0-9]{1,7})?[+-](?:2[0-3]|[0-1][0-9])[:][0-5][0-9]?$",
"type": "string"
},
"timeAtWhichLossEqualsZeroPercent": {
"description": "The date/time when an active dynamic overload state and abatement are due to expire.",
"pattern": "^[0-9]{4}[-][0-1]{1}[0-9]{1}[-][0-3]{1}[0-9]{1}T[0-2]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}([.][0-9]{1,7})?[+-](?:2[0-3]|[0-1][0-9])[:][0-5][0-9]?$",
"type": "string"
},
"validityDuration": {
"description": "The duration (in seconds) that the loss percentage from an Overload Report should be applied.",
"maximum": 86400,
"minimum": 0,
"type": "integer"
}
},
"type": "object"
}
,
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"abatementAlgorithm": "Loss",
"currentLossPercent": 5,
"dynamicThrottlingAdminState": "Enabled",
"egressTransactionsPerSecond": 285,
"maximumTransactionsPerSecond": 500,
"name": "trafficthrottlepointstatus1",
"offeredTransactionsPerSecond": 300,
"operationalReason": "Normal",
"operationalStatus": "Available",
"percentOfTransactionsDiverted": 5,
"staticThrottlingAdminState": "Enabled",
"statusKnown": true,
"timeOfLastUpdate": "2016-Aug-25 11:05:05 EDT",
"timeAtWhichLossEqualsZeroPercent": "2016-Aug-25 12:47:50 EDT",
"validityDuration": 30
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
Diameter: Transaction Configuration Sets
A Transaction Configuration Set provides a way to assign routing and transaction attributes, i.e., the Routing Option Set (/diameter/routingoptionsets), Pending Answer Timer (/diameter/pendinganswertimers), Application Route Table (/diameter/applicationroutetables), and Peer Route Table (/diameter/peerroutetables), to an ingress Diameter request message based on the Application Id (/diameter/applicationids) and Command Code (/diameter/commandcodes). A Transaction Configuration Set can be configured to contain one or more Transaction Configuration Rules.
The Transaction Configuration Set named Default is always available. The Default Transaction Configuration Set can be modified, but it cannot be deleted.
All Transaction Configuration Set configuration is done at the SOAM.
/diameter/transactionconfigurationsets
get /diameter/transactionconfigurationsets
Returns all Transaction Configuration Sets configured at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those Transaction Configuration Sets meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section).
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/transactionconfigurationsetCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/transactionconfigurationset/transactionconfigurationset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name for the Transaction Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"transactionRule": {
"description": "The rules associated with this Transaction Configuration Set. Each rule is defined by the appId and, optionally, cmdCode both of which are found in the Diameter request message header. Each rule must have at least one applicationRouteTableName, peerRouteTableName, pendingAnswerTimerName, or routingOptionSetName defined.",
"items": {
"properties": {
"appId": {
"description": "The appId defines the Diameter Application Id (/diameter/applicationids) to which this rule applies. Whenever the Transaction Configuration Set is used, the DSR routes request messages, whose Application Id matches the appId value in this rule (and also matches the cmdCode, if this rule contains a cmdCode value), according to the applicationRouteTableName, peerRouteTableName, pendingAnswerTimerName, and routingOptionSetName values (whichever of the four are specified) configured in the rule. The value must be an integer in the range 0-4294967295.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"applicationRouteTableName": {
"description": "If provided, specifies the Application Route Table (/diameter/applicationroutetables) the DSR uses when routing a Diameter message that matches the appId and optional cmdCode defined for this rule.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"cmdCode": {
"description": "If specified, identifies the Command Code (/diameter/commandcodes) that must be present in an ingress Diameter message (having an Application Id (/diameter/applicationids) value of appId) for this rule to match.",
"maxLength": 30,
"type": "string"
},
"peerRouteTableName": {
"description": "If provided, specifies the Peer Route Table (/diameter/peerroutetables) the DSR uses when routing a Diameter message that matches the appId and optional cmdCode defined for this rule.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"pendingAnswerTimerName": {
"description": "If provided, specifies the Pending Answer Timer (/diameter/pendinganswertimers) the DSR uses when routing a Diameter message that matches the appId and optional cmdCode defined for this rule.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"routingOptionSetName": {
"description": "If provided, specifies the Routing Option Set (/diameter/routingoptionsets) the DSR uses when routing a Diameter message that matches the appId and optional cmdCode defined for this rule.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"appId"
],
"type": "object"
},
"maxItems": 1000,
"minItems": 0,
"type": "array"
}
},
"required": [
"name"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"configurationLevel": "0",
"name": "TransactionConfigurationSet1",
"transactionConfigurationRule": {
"items": [{
"appId": 16777216,
"applicationRouteTableName": "OcdraART",
"cmdCode": "258",
"peerRouteTableName": "NGNPS",
"pendingAnswerTimerName": "sw_PAT_1",
"routingOptionSetName": "sw_ROS_1"
}, {
"appId": 3,
"applicationRouteTableName": "PdraART",
"cmdCode": "300.623.0",
"peerRouteTableName": "Radius",
"routingOptionSetName": "sw_ROS_2"
}, {
"appId": 4294967295,
"cmdCode": "265.274.1",
"pendingAnswerTimerName": "sw_PAT_3",
"routingOptionSetName": "sw_ROS_3"
}]
}
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/transactionconfigurationsets
Adds a new Transaction Configuration Set to the DSR configuration. The Transaction Configuration Set must have a name that is unique across all Transaction Configuration Sets at the SOAM.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/transactionconfigurationset/transactionconfigurationset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name for the Transaction Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"transactionRule": {
"description": "The rules associated with this Transaction Configuration Set. Each rule is defined by the appId and, optionally, cmdCode both of which are found in the Diameter request message header. Each rule must have at least one applicationRouteTableName, peerRouteTableName, pendingAnswerTimerName, or routingOptionSetName defined.",
"items": {
"properties": {
"appId": {
"description": "The appId defines the Diameter Application Id (/diameter/applicationids) to which this rule applies. Whenever the Transaction Configuration Set is used, the DSR routes request messages, whose Application Id matches the appId value in this rule (and also matches the cmdCode, if this rule contains a cmdCode value), according to the applicationRouteTableName, peerRouteTableName, pendingAnswerTimerName, and routingOptionSetName values (whichever of the four are specified) configured in the rule. The value must be an integer in the range 0-4294967295.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"applicationRouteTableName": {
"description": "If provided, specifies the Application Route Table (/diameter/applicationroutetables) the DSR uses when routing a Diameter message that matches the appId and optional cmdCode defined for this rule.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"cmdCode": {
"description": "If specified, identifies the Command Code (/diameter/commandcodes) that must be present in an ingress Diameter message (having an Application Id (/diameter/applicationids) value of appId) for this rule to match.",
"maxLength": 30,
"type": "string"
},
"peerRouteTableName": {
"description": "If provided, specifies the Peer Route Table (/diameter/peerroutetables) the DSR uses when routing a Diameter message that matches the appId and optional cmdCode defined for this rule.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"pendingAnswerTimerName": {
"description": "If provided, specifies the Pending Answer Timer (/diameter/pendinganswertimers) the DSR uses when routing a Diameter message that matches the appId and optional cmdCode defined for this rule.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"routingOptionSetName": {
"description": "If provided, specifies the Routing Option Set (/diameter/routingoptionsets) the DSR uses when routing a Diameter message that matches the appId and optional cmdCode defined for this rule.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"appId"
],
"type": "object"
},
"maxItems": 1000,
"minItems": 0,
"type": "array"
}
},
"required": [
"name"
],
"type": "object"
}
Example
{
"configurationLevel": "0",
"name": "TransactionConfigurationSet1",
"transactionConfigurationRule": {
"items": [{
"appId": 16777216,
"applicationRouteTableName": "OcdraART",
"cmdCode": "258",
"peerRouteTableName": "NGNPS",
"pendingAnswerTimerName": "sw_PAT_1",
"routingOptionSetName": "sw_ROS_1"
}, {
"appId": 3,
"applicationRouteTableName": "PdraART",
"cmdCode": "300.623.0",
"peerRouteTableName": "Radius",
"routingOptionSetName": "sw_ROS_2"
}, {
"appId": 4294967295,
"cmdCode": "265.274.1",
"pendingAnswerTimerName": "sw_PAT_3",
"routingOptionSetName": "sw_ROS_3"
}]
}
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/transactionconfigurationsets/{name}
get /diameter/transactionconfigurationsets/{name}
Returns the configuration details for the specified Transaction Configuration Set. If the Transaction Configuration Set does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/transactionconfigurationsetItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/transactionconfigurationset/transactionconfigurationset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name for the Transaction Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"transactionRule": {
"description": "The rules associated with this Transaction Configuration Set. Each rule is defined by the appId and, optionally, cmdCode both of which are found in the Diameter request message header. Each rule must have at least one applicationRouteTableName, peerRouteTableName, pendingAnswerTimerName, or routingOptionSetName defined.",
"items": {
"properties": {
"appId": {
"description": "The appId defines the Diameter Application Id (/diameter/applicationids) to which this rule applies. Whenever the Transaction Configuration Set is used, the DSR routes request messages, whose Application Id matches the appId value in this rule (and also matches the cmdCode, if this rule contains a cmdCode value), according to the applicationRouteTableName, peerRouteTableName, pendingAnswerTimerName, and routingOptionSetName values (whichever of the four are specified) configured in the rule. The value must be an integer in the range 0-4294967295.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"applicationRouteTableName": {
"description": "If provided, specifies the Application Route Table (/diameter/applicationroutetables) the DSR uses when routing a Diameter message that matches the appId and optional cmdCode defined for this rule.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"cmdCode": {
"description": "If specified, identifies the Command Code (/diameter/commandcodes) that must be present in an ingress Diameter message (having an Application Id (/diameter/applicationids) value of appId) for this rule to match.",
"maxLength": 30,
"type": "string"
},
"peerRouteTableName": {
"description": "If provided, specifies the Peer Route Table (/diameter/peerroutetables) the DSR uses when routing a Diameter message that matches the appId and optional cmdCode defined for this rule.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"pendingAnswerTimerName": {
"description": "If provided, specifies the Pending Answer Timer (/diameter/pendinganswertimers) the DSR uses when routing a Diameter message that matches the appId and optional cmdCode defined for this rule.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"routingOptionSetName": {
"description": "If provided, specifies the Routing Option Set (/diameter/routingoptionsets) the DSR uses when routing a Diameter message that matches the appId and optional cmdCode defined for this rule.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"appId"
],
"type": "object"
},
"maxItems": 1000,
"minItems": 0,
"type": "array"
}
},
"required": [
"name"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"configurationLevel": "0",
"name": "TransactionConfigurationSet1",
"transactionConfigurationRule": {
"items": [{
"appId": 16777216,
"applicationRouteTableName": "OcdraART",
"cmdCode": "258",
"peerRouteTableName": "NGNPS",
"pendingAnswerTimerName": "sw_PAT_1",
"routingOptionSetName": "sw_ROS_1"
}, {
"appId": 3,
"applicationRouteTableName": "PdraART",
"cmdCode": "300.623.0",
"peerRouteTableName": "Radius",
"routingOptionSetName": "sw_ROS_2"
}, {
"appId": 4294967295,
"cmdCode": "265.274.1",
"pendingAnswerTimerName": "sw_PAT_3",
"routingOptionSetName": "sw_ROS_3"
}]
}
}
,
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/transactionconfigurationsets/{name}
Updates the configuration of the specified Transaction Configuration Set.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/transactionconfigurationset/transactionconfigurationset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name for the Transaction Configuration Set, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"transactionRule": {
"description": "The rules associated with this Transaction Configuration Set. Each rule is defined by the appId and, optionally, cmdCode both of which are found in the Diameter request message header. Each rule must have at least one applicationRouteTableName, peerRouteTableName, pendingAnswerTimerName, or routingOptionSetName defined.",
"items": {
"properties": {
"appId": {
"description": "The appId defines the Diameter Application Id (/diameter/applicationids) to which this rule applies. Whenever the Transaction Configuration Set is used, the DSR routes request messages, whose Application Id matches the appId value in this rule (and also matches the cmdCode, if this rule contains a cmdCode value), according to the applicationRouteTableName, peerRouteTableName, pendingAnswerTimerName, and routingOptionSetName values (whichever of the four are specified) configured in the rule. The value must be an integer in the range 0-4294967295.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"applicationRouteTableName": {
"description": "If provided, specifies the Application Route Table (/diameter/applicationroutetables) the DSR uses when routing a Diameter message that matches the appId and optional cmdCode defined for this rule.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"cmdCode": {
"description": "If specified, identifies the Command Code (/diameter/commandcodes) that must be present in an ingress Diameter message (having an Application Id (/diameter/applicationids) value of appId) for this rule to match.",
"maxLength": 30,
"type": "string"
},
"peerRouteTableName": {
"description": "If provided, specifies the Peer Route Table (/diameter/peerroutetables) the DSR uses when routing a Diameter message that matches the appId and optional cmdCode defined for this rule.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"pendingAnswerTimerName": {
"description": "If provided, specifies the Pending Answer Timer (/diameter/pendinganswertimers) the DSR uses when routing a Diameter message that matches the appId and optional cmdCode defined for this rule.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"routingOptionSetName": {
"description": "If provided, specifies the Routing Option Set (/diameter/routingoptionsets) the DSR uses when routing a Diameter message that matches the appId and optional cmdCode defined for this rule.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"appId"
],
"type": "object"
},
"maxItems": 1000,
"minItems": 0,
"type": "array"
}
},
"required": [
"name"
],
"type": "object"
}
Example
{
"configurationLevel": "0",
"name": "TransactionConfigurationSet1",
"transactionConfigurationRule": {
"items": [{
"appId": 16777216,
"applicationRouteTableName": "OcdraART",
"cmdCode": "258",
"peerRouteTableName": "NGNPS",
"pendingAnswerTimerName": "sw_PAT_1",
"routingOptionSetName": "sw_ROS_1"
}, {
"appId": 3,
"applicationRouteTableName": "PdraART",
"cmdCode": "300.623.0",
"peerRouteTableName": "Radius",
"routingOptionSetName": "sw_ROS_2"
}, {
"appId": 4294967295,
"cmdCode": "265.274.1",
"pendingAnswerTimerName": "sw_PAT_3",
"routingOptionSetName": "sw_ROS_3"
}]
}
}
delete /diameter/transactionconfigurationsets/{name}
Deletes the specified Transaction Configuration Set from the SOAM configuration. The Default Transaction Configuration Set cannot be deleted. A Transaction Configuration Set can only be deleted if all delete validation checks pass. In general, if the Transaction Configuration Set is part of the configuration of one or more traffic throttle points (/diameter/trafficthrottlepoints), the Transaction Configuration Set cannot be deleted. If the Transaction Configuration Set is named in a TTP, the Transaction Configuration Set must first be removed from the TTP. Then the Transaction Configuration Set can be deleted from the configuration. An attempt to delete a Transaction Configuration Set that cannot be deleted results in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Diameter: IPFE Options
The IP Front End (IPFE) Options are those configuration values that govern the overall IPFE functionality and are not directly related to any particular Target Set. There is a single instance of this resource, which contains each of the individual options that can be retrieved and set. Because there is no collection of instances, there is no collection GET action. No new IPFE Options resource can be created, so there is no POST action, and the single instance cannot be removed, so there is no DELETE action. The single instance GET is used to retrieve the options, and PUT is used to update one or more values within the set of options. A name for this single, non-deletable instance is neither required nor expected.
All IPFE Options configuration is done at the SOAM.
/diameter/ipfeoptions
get /diameter/ipfeoptions
Returns the set of current values for the IPFE Options.
Target Server: SOAM
Response
HTTP status code 200
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/ipfeoptionItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/ipfeoption/ipfeoption.json",
"properties": {
"clusterRebalancingAndAccounting": {
"description": "When set to true, support for cluster rebalancing and packet accounting in measurements is turned on. When set to false, such support is turned off. Typical value is true.",
"type": "boolean"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"globalPacketRateLimit": {
"description": "Overload throttling occurs whenever the combined packet rate for a single IPFE exceeds this value. Set to zero to disable overload throttling. When enabling overload throttling, the minimum allowable value is 10000 - the DSR rejects values between 1 and 9999, inclusive. Typical value is 500000.",
"maximum": 10000000,
"minimum": 0,
"type": "integer"
},
"gratuitousArpType": {
"description": "Specifies the type of gratuitous ARP broadcast that is sent. Typical value is ArpRequest.",
"enum": [
"ArpRequest",
"ArpReply",
"ArpBoth"
],
"type": "string"
},
"imbalanceDetectionThroughputMinimum": {
"description": "The value, in packets/sec, below which no throughput analysis is performed regarding imbalance detection. Typical value is 20000.",
"maximum": 2147483647,
"minimum": 1,
"type": "integer"
},
"ipfeA1IpAddress": {
"description": "IPv4 or IPv6 address of IPFE-A1. Cannot be modified if any Target Set has IPFE-A1 selected as active. If IPFE functionality is being used, then at least one of the four IpAddress attributes must be set to a valid IPFE server IP address. If both IPFE-A1 and IPFE-A2 are used, they form a mated pair.",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"ipfeA2IpAddress": {
"description": "IPv4 or IPv6 address of IPFE-A2. Cannot be modified if any Target Set has IPFE-A2 selected as active. If IPFE functionality is being used, then at least one of the four IpAddress attributes must be set to a valid IPFE server IP address. If both IPFE-A1 and IPFE-A2 are used, they form a mated pair.",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"ipfeB1IpAddress": {
"description": "IPv4 or IPv6 address of IPFE-B1. Cannot be modified if any Target Set has IPFE-B1 selected as active. If IPFE functionality is being used, then at least one of the four IpAddress attributes must be set to a valid IPFE server IP address. If both IPFE-B1 and IPFE-B2 are used, they form a mated pair.",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"ipfeB2IpAddress": {
"description": "IPv4 or IPv6 address of IPFE-B2. Cannot be modified if any Target Set has IPFE-B2 selected as active. If IPFE functionality is being used, then at least one of the four IpAddress attributes must be set to a valid IPFE server IP address. If both IPFE-B1 and IPFE-B2 are used, they form a mated pair.",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"leastLoadThreshold": {
"description": "The value, in packets/sec, below which least load selection reverts to round robin. Typical value is 1.",
"maximum": 2147483647,
"minimum": 1,
"type": "integer"
},
"monitoringConnectionTimeout": {
"description": "Length of time to wait for a connection to complete when polling application servers for aliveness, in seconds. Typical value is 3.",
"maximum": 255,
"minimum": 2,
"type": "integer"
},
"monitoringConnectionTryInterval": {
"description": "The interval between attempts to periodically connect to application servers and test for aliveness, in seconds. Typical value is 10.",
"maximum": 255,
"minimum": 1,
"type": "integer"
},
"monitoringPort": {
"description": "TCP port to use to attempt periodic connections or monitoring of application servers. Typical value is 9675.",
"maximum": 65535,
"minimum": 1,
"readOnly": true,
"type": "integer"
},
"monitoringProtocol": {
"description": "The protocol used by IPFE to monitor application server aliveness. If any Target Set has load balancing set to least load, monitoringProtocol must be set to Heartbeat due to the need for load information in the monitoring packets. Typical value is Heartbeat.",
"enum": [
"Heartbeat",
"None"
],
"type": "string"
},
"sctpRejectOption": {
"description": "The action taken to reject SCTP connections when no application servers are available. Typical value is IcmpHostUnreachable.",
"enum": [
"Drop",
"IcmpAdminProhibited",
"IcmpHostUnreachable",
"IcmpPortUnreachable"
],
"type": "string"
},
"stateSyncReconnectInterval": {
"description": "The reconnect interval for syncing the kernel state between IPFEs, in seconds. Typical value is 1.",
"maximum": 255,
"minimum": 1,
"type": "integer"
},
"stateSyncTcpPort": {
"description": "The TCP port used for syncing kernel state between IPFEs. Typical value is 19041.",
"maximum": 65535,
"minimum": 1,
"readOnly": true,
"type": "integer"
},
"tcpRejectOption": {
"description": "The action taken to reject TCP connections when no application servers are available. Typical value is TcpReset.",
"enum": [
"Drop",
"IcmpAdminProhibited",
"IcmpHostUnreachable",
"IcmpPortUnreachable",
"TcpReset"
],
"type": "string"
}
},
"required": [
"clusterRebalancingAndAccounting",
"globalPacketRateLimit",
"gratuitousArpType",
"imbalanceDetectionThroughputMinimum",
"leastLoadThreshold",
"monitoringConnectionTimeout",
"monitoringConnectionTryInterval",
"monitoringProtocol",
"sctpRejectOption",
"stateSyncReconnectInterval",
"tcpRejectOption"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"clusterRebalancingAndAccounting": true,
"configurationLevel": "47",
"globalPacketRateLimit": 500000,
"gratuitousArpType": "ArpRequest",
"imbalanceDetectionThroughputMinimum": 20000,
"ipfeA1IpAddress": "100.101.102.103",
"ipfeA2IpAddress": "100.101.102.104",
"ipfeB1IpAddress": "100.101.102.105",
"ipfeB2IpAddress": "100.101.102.106",
"leastLoadThreshold": 1,
"monitoringConnectionTimeout": 3,
"monitoringConnectionTryInterval": 10,
"monitoringPort": 9675,
"monitoringProtocol": "Heartbeat",
"sctpRejectOption": "IcmpPortUnreachable",
"stateSyncReconnectInterval": 1,
"stateSyncTcpPort": 19041,
"tcpRejectOption": "TcpReset"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
put /diameter/ipfeoptions
Updates the IPFE Options with the values supplied. To update just one of the individual options, GET the set, modify the value for the option that needs to be changed, then PUT the options.
Target Server: SOAM
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/ipfeoption/ipfeoption.json",
"properties": {
"clusterRebalancingAndAccounting": {
"description": "When set to true, support for cluster rebalancing and packet accounting in measurements is turned on. When set to false, such support is turned off. Typical value is true.",
"type": "boolean"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"globalPacketRateLimit": {
"description": "Overload throttling occurs whenever the combined packet rate for a single IPFE exceeds this value. Set to zero to disable overload throttling. When enabling overload throttling, the minimum allowable value is 10000 - the DSR rejects values between 1 and 9999, inclusive. Typical value is 500000.",
"maximum": 10000000,
"minimum": 0,
"type": "integer"
},
"gratuitousArpType": {
"description": "Specifies the type of gratuitous ARP broadcast that is sent. Typical value is ArpRequest.",
"enum": [
"ArpRequest",
"ArpReply",
"ArpBoth"
],
"type": "string"
},
"imbalanceDetectionThroughputMinimum": {
"description": "The value, in packets/sec, below which no throughput analysis is performed regarding imbalance detection. Typical value is 20000.",
"maximum": 2147483647,
"minimum": 1,
"type": "integer"
},
"ipfeA1IpAddress": {
"description": "IPv4 or IPv6 address of IPFE-A1. Cannot be modified if any Target Set has IPFE-A1 selected as active. If IPFE functionality is being used, then at least one of the four IpAddress attributes must be set to a valid IPFE server IP address. If both IPFE-A1 and IPFE-A2 are used, they form a mated pair.",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"ipfeA2IpAddress": {
"description": "IPv4 or IPv6 address of IPFE-A2. Cannot be modified if any Target Set has IPFE-A2 selected as active. If IPFE functionality is being used, then at least one of the four IpAddress attributes must be set to a valid IPFE server IP address. If both IPFE-A1 and IPFE-A2 are used, they form a mated pair.",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"ipfeB1IpAddress": {
"description": "IPv4 or IPv6 address of IPFE-B1. Cannot be modified if any Target Set has IPFE-B1 selected as active. If IPFE functionality is being used, then at least one of the four IpAddress attributes must be set to a valid IPFE server IP address. If both IPFE-B1 and IPFE-B2 are used, they form a mated pair.",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"ipfeB2IpAddress": {
"description": "IPv4 or IPv6 address of IPFE-B2. Cannot be modified if any Target Set has IPFE-B2 selected as active. If IPFE functionality is being used, then at least one of the four IpAddress attributes must be set to a valid IPFE server IP address. If both IPFE-B1 and IPFE-B2 are used, they form a mated pair.",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"leastLoadThreshold": {
"description": "The value, in packets/sec, below which least load selection reverts to round robin. Typical value is 1.",
"maximum": 2147483647,
"minimum": 1,
"type": "integer"
},
"monitoringConnectionTimeout": {
"description": "Length of time to wait for a connection to complete when polling application servers for aliveness, in seconds. Typical value is 3.",
"maximum": 255,
"minimum": 2,
"type": "integer"
},
"monitoringConnectionTryInterval": {
"description": "The interval between attempts to periodically connect to application servers and test for aliveness, in seconds. Typical value is 10.",
"maximum": 255,
"minimum": 1,
"type": "integer"
},
"monitoringPort": {
"description": "TCP port to use to attempt periodic connections or monitoring of application servers. Typical value is 9675.",
"maximum": 65535,
"minimum": 1,
"readOnly": true,
"type": "integer"
},
"monitoringProtocol": {
"description": "The protocol used by IPFE to monitor application server aliveness. If any Target Set has load balancing set to least load, monitoringProtocol must be set to Heartbeat due to the need for load information in the monitoring packets. Typical value is Heartbeat.",
"enum": [
"Heartbeat",
"None"
],
"type": "string"
},
"sctpRejectOption": {
"description": "The action taken to reject SCTP connections when no application servers are available. Typical value is IcmpHostUnreachable.",
"enum": [
"Drop",
"IcmpAdminProhibited",
"IcmpHostUnreachable",
"IcmpPortUnreachable"
],
"type": "string"
},
"stateSyncReconnectInterval": {
"description": "The reconnect interval for syncing the kernel state between IPFEs, in seconds. Typical value is 1.",
"maximum": 255,
"minimum": 1,
"type": "integer"
},
"stateSyncTcpPort": {
"description": "The TCP port used for syncing kernel state between IPFEs. Typical value is 19041.",
"maximum": 65535,
"minimum": 1,
"readOnly": true,
"type": "integer"
},
"tcpRejectOption": {
"description": "The action taken to reject TCP connections when no application servers are available. Typical value is TcpReset.",
"enum": [
"Drop",
"IcmpAdminProhibited",
"IcmpHostUnreachable",
"IcmpPortUnreachable",
"TcpReset"
],
"type": "string"
}
},
"required": [
"clusterRebalancingAndAccounting",
"globalPacketRateLimit",
"gratuitousArpType",
"imbalanceDetectionThroughputMinimum",
"leastLoadThreshold",
"monitoringConnectionTimeout",
"monitoringConnectionTryInterval",
"monitoringProtocol",
"sctpRejectOption",
"stateSyncReconnectInterval",
"tcpRejectOption"
],
"type": "object"
}
Example
{
"clusterRebalancingAndAccounting": true,
"configurationLevel": "47",
"globalPacketRateLimit": 500000,
"gratuitousArpType": "ArpRequest",
"imbalanceDetectionThroughputMinimum": 20000,
"ipfeA1IpAddress": "100.101.102.103",
"ipfeA2IpAddress": "100.101.102.104",
"ipfeB1IpAddress": "100.101.102.105",
"ipfeB2IpAddress": "100.101.102.106",
"leastLoadThreshold": 1,
"monitoringConnectionTimeout": 3,
"monitoringConnectionTryInterval": 10,
"monitoringPort": 9675,
"monitoringProtocol": "Heartbeat",
"sctpRejectOption": "IcmpPortUnreachable",
"stateSyncReconnectInterval": 1,
"stateSyncTcpPort": 19041,
"tcpRejectOption": "TcpReset"
}
Diameter: IPFE Target Sets
An IP Front End (IPFE) Target Set (TS) is a collection of DA-MPs (known as application servers within the IPFE context) that share the ingress traffic load associated with a publicly-exposed IP address. This publicly-exposed IP address is known as the Target Set Address (TSA). Each Target Set must have a primary TSA, and can optionally have a secondary TSA as well. The IP addresses of the DA-MP servers within the Target Set are thus hidden from DSR clients; a client knows the TSA(s), and remains unaware that more than one DA-MP could be handling request messages the client forwards to the DSR.
Each DSR can have up to 32 Target Sets configured, and each Target Set can include from one to sixteen DA-MPs. Any single DA-MP can be part of more than one Target Set. If a DA-MP is included in two or more Target Sets, those Target Sets are said to overlap, since they contain a shared application server.
The incoming request traffic is distributed by the IPFE across the DA-MPs in a Target Set according to the load balance algorithm configured for the Target Set.
All IPFE Options configuration is done at the SOAM.
/diameter/ipfetargetsets
get /diameter/ipfetargetsets
Returns all Target Sets that are configured at the SOAM.
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (one of configurationLevel)
The field being matched
Only the configurationLevel field is supported.
Example:
filter_name=configurationLevel
- filter_op: (one of GREATER_THAN, GREATER_THAN_EQUAL)
The match operation (operator)
Example:
filter_op=GREATER_THAN
- filter_values: (string)
The matched value
The configurationLevel value by which the data is being filtered. Only a single value is supported.
Example:
filter_values=10
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/collections/ipfetargetsetCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/ipfetargetset/ipfetargetset.json",
"properties": {
"allowedDeviation": {
"description": "The percentage within which two application servers are considered to be handling approximately equal load. Only applies when the loadBalanceAlgorithm is LeastLoad. Typical value is 5 percent.",
"maximum": 50,
"minimum": 0,
"type": "integer"
},
"alternateIpAddress": {
"description": "A alternate IP address for the Target Set, also known as the alternate Target Set Address (TSA). The alternate TSA is optional. When SCTP is in use, this IP address serves as a non-primary protocol-linked failover address. When TCP is in use, DSR clients can use this an independent IP address with which to send requests. Whenever a alternate TSA is configured, each DA-MP in the Target Set must also provide a alternate IP address. Must be a valid IPv4 or IPv6 address.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"alternatePreferredIpfeServer": {
"description": "The IPFE server that primarily handles traffic for this Target Set's alternate TSA. If this IPFE server fails, then its mate takes over. IPFE-A1 & IPFE-A2 are mates, as are IPFE-B1 & IPFE-B2. The value specified for alternatePreferredIpfeServer should not be the same as the value for primaryPreferredIpfeServer in order to provide an alternative path for SCTP dual-homed traffic. The pair letter (e.g., A, B) must match the pair letter specified by primaryPreferredIpfeServer.",
"enum": [
"IpfeA1",
"IpfeA2",
"IpfeB1",
"IpfeB2"
],
"type": "string"
},
"applicationServerIp": {
"description": "The list of application servers (DA-MPs) that make up this Target Set. The list of valid DA-MP IP addresses is provided in the /diameter/signalingipaddresses GET response. IP addresses having type LocalIp may be assigned as a Target Set's ipAddress or alternateIpAddress value.",
"items": {
"properties": {
"alternateIpAddress": {
"description": "Optional alternate IP address for the application server. The IP version of alternateIpAddress must match the IP version of ipAddress.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"ipAddress": {
"description": "IPv4 or IPv6 signaling address for the application server.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"serverDescription": {
"description": "Optional description for this application server.",
"maxLength": 64,
"type": "string"
},
"weight": {
"description": "Weighting factor, within the Target Set, for the application server associated with ipAddress/alternateIpAddress. Typical value is 100.",
"maximum": 65535,
"minimum": 0,
"type": "integer"
}
},
"required": [
"ipAddress",
"weight"
],
"type": "object"
},
"maxItems": 16,
"type": "array"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"deleteAge": {
"description": "Value used for the Delete Age timer, in seconds. Recommendation is to set deleteAge no less than twice the Diameter watchdog timer value. Typical value is 600 seconds.",
"maximum": 3110400,
"minimum": 10,
"type": "integer"
},
"disabled": {
"description": "If true, the Target Set is disabled, but its configuration is preserved.",
"type": "boolean"
},
"ipAddress": {
"description": "The primary IP address for the Target Set, also known as the primary Target Set Address (TSA). This is the IP address DSR Peer Nodes (/diameter/peernodes) use when forwarding requests to the DSR. Must be a valid IPv4 or IPv6 address.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"loadBalanceAlgorithm": {
"description": "The algorithm used to determine which DA-MP server is assigned each new Connection (/diameter/connections). When Hash is specified, load balancing is achieved by sending a new Connection to a DA-MP server based on hashing the originating port number and IP address. When LeastLoad is specified, load balancing is achieved through a calculation of which application server (DA-MP) currently has the least loading. Typical value is LeastLoad.",
"enum": [
"Hash",
"LeastLoad"
],
"type": "string"
},
"loadFactorConnectionCount": {
"description": "Defines the contribution (weighting factor) of Connection (/diameter/connections) count in the computation of application server load. The sum of loadFactorConnectionCount and loadFactorMps is normalized to 100 by the DSR. Only applies when the loadBalanceAlgorithm is LeastLoad. Typical value is 50.",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"loadFactorMps": {
"description": "Defines the contribution (weighting factor) of Messages per Second in the computation of application server load. The sum of loadFactorConnectionCount and loadFactorMps is normalized to 100 by the DSR. Only applies when the loadBalanceAlgorithm is LeastLoad.Typical value is 50.",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"number": {
"description": "The unique identifier for this Target Set. Must be an integer between 1 and 32, inclusive. Target Sets must be inserted beginning with number 1, and increasing in numerical order.",
"maximum": 32,
"minimum": 1,
"type": "integer"
},
"peerNodeAwareEnabled": {
"description": "When set to true, the IPFE distributes Connections (/diameter/connections) from the same Peer Node Group (/diameter/peernodegroups) across servers in the Target Set to provide server redundancy for that group of Peer Nodes. The IPFE keeps a group count of the Connections from a Peer Node Group to each application server in the Target Set. Application servers with a group count difference that is equal to or greater than peerNodeGroupDistributionThreshold are generally not considered. For example, if peerNodeGroupDistributionThreshold is 1, the effect is to send a new Connection to the application server with the lowest group count. Only applies when the loadBalanceAlgorithm is LeastLoad. Typical value is true.",
"type": "boolean"
},
"peerNodeGroupDistributionThreshold": {
"description": "Threshold used when assessing group count values for application servers. Only applies when the loadBalanceAlgorithm is LeastLoad. Typical value is 1.",
"maximum": 10,
"minimum": 1,
"type": "integer"
},
"preferredIpfeServer": {
"description": "The IPFE server that primarily handles traffic for this Target Set. If this IPFE server fails, then its mate takes over. IPFE-A1 & IPFE-A2 are mates, as are IPFE-B1 & IPFE-B2.",
"enum": [
"IpfeA1",
"IpfeA2",
"IpfeB1",
"IpfeB2"
],
"type": "string"
},
"protocols": {
"description": "The protocol(s) the Target Set supports. If SctpAndTcp is specified, both SCTP and TCP are supported.",
"enum": [
"Sctp",
"Tcp",
"SctpAndTcp"
],
"type": "string"
}
},
"required": [
"deleteAge",
"disabled",
"loadBalanceAlgorithm",
"number",
"ipAddress",
"preferredIpfeServer",
"protocols"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"allowedDeviation": 5,
"alternateIpAddress": "101.102.103.11",
"alternatePreferredIpfeServer": "IpfeB1",
"applicationServerIp": [
{
"alternateIpAddress": "101.102.103.114",
"ipAddress": "101.102.103.104",
"serverDescription": "DAMP1",
"weight": 50
},
{
"alternateIpAddress": "101.102.103.115",
"ipAddress": "101.102.103.105",
"serverDescription": "DAMP2",
"weight": 50
}
],
"configurationLevel": "397",
"deleteAge": 600,
"disabled": false,
"ipAddress": "101.102.103.10",
"loadBalanceAlgorithm": "LeastLoad",
"loadFactorConnectionCount": 20,
"loadFactorMps": 80,
"number": 7,
"peerNodeAwareEnabled": false,
"peerNodeGroupDistributionThreshold": 1,
"preferredIpfeServer": "IpfeA2",
"protocols": "SctpAndTcp"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /diameter/ipfetargetsets
Adds a new Target Set to the DSR configuration. Target Sets do not have names; a Target Set's ID is an integer between 1 and 32, inclusive.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/ipfetargetset/ipfetargetset.json",
"properties": {
"allowedDeviation": {
"description": "The percentage within which two application servers are considered to be handling approximately equal load. Only applies when the loadBalanceAlgorithm is LeastLoad. Typical value is 5 percent.",
"maximum": 50,
"minimum": 0,
"type": "integer"
},
"alternateIpAddress": {
"description": "A alternate IP address for the Target Set, also known as the alternate Target Set Address (TSA). The alternate TSA is optional. When SCTP is in use, this IP address serves as a non-primary protocol-linked failover address. When TCP is in use, DSR clients can use this an independent IP address with which to send requests. Whenever a alternate TSA is configured, each DA-MP in the Target Set must also provide a alternate IP address. Must be a valid IPv4 or IPv6 address.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"alternatePreferredIpfeServer": {
"description": "The IPFE server that primarily handles traffic for this Target Set's alternate TSA. If this IPFE server fails, then its mate takes over. IPFE-A1 & IPFE-A2 are mates, as are IPFE-B1 & IPFE-B2. The value specified for alternatePreferredIpfeServer should not be the same as the value for primaryPreferredIpfeServer in order to provide an alternative path for SCTP dual-homed traffic. The pair letter (e.g., A, B) must match the pair letter specified by primaryPreferredIpfeServer.",
"enum": [
"IpfeA1",
"IpfeA2",
"IpfeB1",
"IpfeB2"
],
"type": "string"
},
"applicationServerIp": {
"description": "The list of application servers (DA-MPs) that make up this Target Set. The list of valid DA-MP IP addresses is provided in the /diameter/signalingipaddresses GET response. IP addresses having type LocalIp may be assigned as a Target Set's ipAddress or alternateIpAddress value.",
"items": {
"properties": {
"alternateIpAddress": {
"description": "Optional alternate IP address for the application server. The IP version of alternateIpAddress must match the IP version of ipAddress.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"ipAddress": {
"description": "IPv4 or IPv6 signaling address for the application server.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"serverDescription": {
"description": "Optional description for this application server.",
"maxLength": 64,
"type": "string"
},
"weight": {
"description": "Weighting factor, within the Target Set, for the application server associated with ipAddress/alternateIpAddress. Typical value is 100.",
"maximum": 65535,
"minimum": 0,
"type": "integer"
}
},
"required": [
"ipAddress",
"weight"
],
"type": "object"
},
"maxItems": 16,
"type": "array"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"deleteAge": {
"description": "Value used for the Delete Age timer, in seconds. Recommendation is to set deleteAge no less than twice the Diameter watchdog timer value. Typical value is 600 seconds.",
"maximum": 3110400,
"minimum": 10,
"type": "integer"
},
"disabled": {
"description": "If true, the Target Set is disabled, but its configuration is preserved.",
"type": "boolean"
},
"ipAddress": {
"description": "The primary IP address for the Target Set, also known as the primary Target Set Address (TSA). This is the IP address DSR Peer Nodes (/diameter/peernodes) use when forwarding requests to the DSR. Must be a valid IPv4 or IPv6 address.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"loadBalanceAlgorithm": {
"description": "The algorithm used to determine which DA-MP server is assigned each new Connection (/diameter/connections). When Hash is specified, load balancing is achieved by sending a new Connection to a DA-MP server based on hashing the originating port number and IP address. When LeastLoad is specified, load balancing is achieved through a calculation of which application server (DA-MP) currently has the least loading. Typical value is LeastLoad.",
"enum": [
"Hash",
"LeastLoad"
],
"type": "string"
},
"loadFactorConnectionCount": {
"description": "Defines the contribution (weighting factor) of Connection (/diameter/connections) count in the computation of application server load. The sum of loadFactorConnectionCount and loadFactorMps is normalized to 100 by the DSR. Only applies when the loadBalanceAlgorithm is LeastLoad. Typical value is 50.",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"loadFactorMps": {
"description": "Defines the contribution (weighting factor) of Messages per Second in the computation of application server load. The sum of loadFactorConnectionCount and loadFactorMps is normalized to 100 by the DSR. Only applies when the loadBalanceAlgorithm is LeastLoad.Typical value is 50.",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"number": {
"description": "The unique identifier for this Target Set. Must be an integer between 1 and 32, inclusive. Target Sets must be inserted beginning with number 1, and increasing in numerical order.",
"maximum": 32,
"minimum": 1,
"type": "integer"
},
"peerNodeAwareEnabled": {
"description": "When set to true, the IPFE distributes Connections (/diameter/connections) from the same Peer Node Group (/diameter/peernodegroups) across servers in the Target Set to provide server redundancy for that group of Peer Nodes. The IPFE keeps a group count of the Connections from a Peer Node Group to each application server in the Target Set. Application servers with a group count difference that is equal to or greater than peerNodeGroupDistributionThreshold are generally not considered. For example, if peerNodeGroupDistributionThreshold is 1, the effect is to send a new Connection to the application server with the lowest group count. Only applies when the loadBalanceAlgorithm is LeastLoad. Typical value is true.",
"type": "boolean"
},
"peerNodeGroupDistributionThreshold": {
"description": "Threshold used when assessing group count values for application servers. Only applies when the loadBalanceAlgorithm is LeastLoad. Typical value is 1.",
"maximum": 10,
"minimum": 1,
"type": "integer"
},
"preferredIpfeServer": {
"description": "The IPFE server that primarily handles traffic for this Target Set. If this IPFE server fails, then its mate takes over. IPFE-A1 & IPFE-A2 are mates, as are IPFE-B1 & IPFE-B2.",
"enum": [
"IpfeA1",
"IpfeA2",
"IpfeB1",
"IpfeB2"
],
"type": "string"
},
"protocols": {
"description": "The protocol(s) the Target Set supports. If SctpAndTcp is specified, both SCTP and TCP are supported.",
"enum": [
"Sctp",
"Tcp",
"SctpAndTcp"
],
"type": "string"
}
},
"required": [
"deleteAge",
"disabled",
"loadBalanceAlgorithm",
"number",
"ipAddress",
"preferredIpfeServer",
"protocols"
],
"type": "object"
}
Example
{
"allowedDeviation": 5,
"alternateIpAddress": "101.102.103.11",
"alternatePreferredIpfeServer": "IpfeB1",
"applicationServerIp": [
{
"alternateIpAddress": "101.102.103.114",
"ipAddress": "101.102.103.104",
"serverDescription": "DAMP1",
"weight": 50
},
{
"alternateIpAddress": "101.102.103.115",
"ipAddress": "101.102.103.105",
"serverDescription": "DAMP2",
"weight": 50
}
],
"configurationLevel": "397",
"deleteAge": 600,
"disabled": false,
"ipAddress": "101.102.103.10",
"loadBalanceAlgorithm": "LeastLoad",
"loadFactorConnectionCount": 20,
"loadFactorMps": 80,
"number": 7,
"peerNodeAwareEnabled": false,
"peerNodeGroupDistributionThreshold": 1,
"preferredIpfeServer": "IpfeA2",
"protocols": "SctpAndTcp"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/diameter/ipfetargetsets/{id}
get /diameter/ipfetargetsets/{id}
Returns the configuration details for the specified Target Set. If the specified Target Set does not exist in the SOAM's configuration, an error message is returned within the HTTP response. This could happen if a request is made for Target Set 11, for example, but Target Set 11 is not part of the DSR configuration.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- id: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/items/ipfetargetsetItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/ipfetargetset/ipfetargetset.json",
"properties": {
"allowedDeviation": {
"description": "The percentage within which two application servers are considered to be handling approximately equal load. Only applies when the loadBalanceAlgorithm is LeastLoad. Typical value is 5 percent.",
"maximum": 50,
"minimum": 0,
"type": "integer"
},
"alternateIpAddress": {
"description": "A alternate IP address for the Target Set, also known as the alternate Target Set Address (TSA). The alternate TSA is optional. When SCTP is in use, this IP address serves as a non-primary protocol-linked failover address. When TCP is in use, DSR clients can use this an independent IP address with which to send requests. Whenever a alternate TSA is configured, each DA-MP in the Target Set must also provide a alternate IP address. Must be a valid IPv4 or IPv6 address.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"alternatePreferredIpfeServer": {
"description": "The IPFE server that primarily handles traffic for this Target Set's alternate TSA. If this IPFE server fails, then its mate takes over. IPFE-A1 & IPFE-A2 are mates, as are IPFE-B1 & IPFE-B2. The value specified for alternatePreferredIpfeServer should not be the same as the value for primaryPreferredIpfeServer in order to provide an alternative path for SCTP dual-homed traffic. The pair letter (e.g., A, B) must match the pair letter specified by primaryPreferredIpfeServer.",
"enum": [
"IpfeA1",
"IpfeA2",
"IpfeB1",
"IpfeB2"
],
"type": "string"
},
"applicationServerIp": {
"description": "The list of application servers (DA-MPs) that make up this Target Set. The list of valid DA-MP IP addresses is provided in the /diameter/signalingipaddresses GET response. IP addresses having type LocalIp may be assigned as a Target Set's ipAddress or alternateIpAddress value.",
"items": {
"properties": {
"alternateIpAddress": {
"description": "Optional alternate IP address for the application server. The IP version of alternateIpAddress must match the IP version of ipAddress.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"ipAddress": {
"description": "IPv4 or IPv6 signaling address for the application server.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"serverDescription": {
"description": "Optional description for this application server.",
"maxLength": 64,
"type": "string"
},
"weight": {
"description": "Weighting factor, within the Target Set, for the application server associated with ipAddress/alternateIpAddress. Typical value is 100.",
"maximum": 65535,
"minimum": 0,
"type": "integer"
}
},
"required": [
"ipAddress",
"weight"
],
"type": "object"
},
"maxItems": 16,
"type": "array"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"deleteAge": {
"description": "Value used for the Delete Age timer, in seconds. Recommendation is to set deleteAge no less than twice the Diameter watchdog timer value. Typical value is 600 seconds.",
"maximum": 3110400,
"minimum": 10,
"type": "integer"
},
"disabled": {
"description": "If true, the Target Set is disabled, but its configuration is preserved.",
"type": "boolean"
},
"ipAddress": {
"description": "The primary IP address for the Target Set, also known as the primary Target Set Address (TSA). This is the IP address DSR Peer Nodes (/diameter/peernodes) use when forwarding requests to the DSR. Must be a valid IPv4 or IPv6 address.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"loadBalanceAlgorithm": {
"description": "The algorithm used to determine which DA-MP server is assigned each new Connection (/diameter/connections). When Hash is specified, load balancing is achieved by sending a new Connection to a DA-MP server based on hashing the originating port number and IP address. When LeastLoad is specified, load balancing is achieved through a calculation of which application server (DA-MP) currently has the least loading. Typical value is LeastLoad.",
"enum": [
"Hash",
"LeastLoad"
],
"type": "string"
},
"loadFactorConnectionCount": {
"description": "Defines the contribution (weighting factor) of Connection (/diameter/connections) count in the computation of application server load. The sum of loadFactorConnectionCount and loadFactorMps is normalized to 100 by the DSR. Only applies when the loadBalanceAlgorithm is LeastLoad. Typical value is 50.",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"loadFactorMps": {
"description": "Defines the contribution (weighting factor) of Messages per Second in the computation of application server load. The sum of loadFactorConnectionCount and loadFactorMps is normalized to 100 by the DSR. Only applies when the loadBalanceAlgorithm is LeastLoad.Typical value is 50.",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"number": {
"description": "The unique identifier for this Target Set. Must be an integer between 1 and 32, inclusive. Target Sets must be inserted beginning with number 1, and increasing in numerical order.",
"maximum": 32,
"minimum": 1,
"type": "integer"
},
"peerNodeAwareEnabled": {
"description": "When set to true, the IPFE distributes Connections (/diameter/connections) from the same Peer Node Group (/diameter/peernodegroups) across servers in the Target Set to provide server redundancy for that group of Peer Nodes. The IPFE keeps a group count of the Connections from a Peer Node Group to each application server in the Target Set. Application servers with a group count difference that is equal to or greater than peerNodeGroupDistributionThreshold are generally not considered. For example, if peerNodeGroupDistributionThreshold is 1, the effect is to send a new Connection to the application server with the lowest group count. Only applies when the loadBalanceAlgorithm is LeastLoad. Typical value is true.",
"type": "boolean"
},
"peerNodeGroupDistributionThreshold": {
"description": "Threshold used when assessing group count values for application servers. Only applies when the loadBalanceAlgorithm is LeastLoad. Typical value is 1.",
"maximum": 10,
"minimum": 1,
"type": "integer"
},
"preferredIpfeServer": {
"description": "The IPFE server that primarily handles traffic for this Target Set. If this IPFE server fails, then its mate takes over. IPFE-A1 & IPFE-A2 are mates, as are IPFE-B1 & IPFE-B2.",
"enum": [
"IpfeA1",
"IpfeA2",
"IpfeB1",
"IpfeB2"
],
"type": "string"
},
"protocols": {
"description": "The protocol(s) the Target Set supports. If SctpAndTcp is specified, both SCTP and TCP are supported.",
"enum": [
"Sctp",
"Tcp",
"SctpAndTcp"
],
"type": "string"
}
},
"required": [
"deleteAge",
"disabled",
"loadBalanceAlgorithm",
"number",
"ipAddress",
"preferredIpfeServer",
"protocols"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"allowedDeviation": 5,
"alternateIpAddress": "101.102.103.11",
"alternatePreferredIpfeServer": "IpfeB1",
"applicationServerIp": [
{
"alternateIpAddress": "101.102.103.114",
"ipAddress": "101.102.103.104",
"serverDescription": "DAMP1",
"weight": 50
},
{
"alternateIpAddress": "101.102.103.115",
"ipAddress": "101.102.103.105",
"serverDescription": "DAMP2",
"weight": 50
}
],
"configurationLevel": "397",
"deleteAge": 600,
"disabled": false,
"ipAddress": "101.102.103.10",
"loadBalanceAlgorithm": "LeastLoad",
"loadFactorConnectionCount": 20,
"loadFactorMps": 80,
"number": 7,
"peerNodeAwareEnabled": false,
"peerNodeGroupDistributionThreshold": 1,
"preferredIpfeServer": "IpfeA2",
"protocols": "SctpAndTcp"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /diameter/ipfetargetsets/{id}
Updates the configuration for the specified Target Set. If the provided Target Set data is invalid in any way, the update will fail, resulting in one or more error messages returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- id: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/diameter/ipfetargetset/ipfetargetset.json",
"properties": {
"allowedDeviation": {
"description": "The percentage within which two application servers are considered to be handling approximately equal load. Only applies when the loadBalanceAlgorithm is LeastLoad. Typical value is 5 percent.",
"maximum": 50,
"minimum": 0,
"type": "integer"
},
"alternateIpAddress": {
"description": "A alternate IP address for the Target Set, also known as the alternate Target Set Address (TSA). The alternate TSA is optional. When SCTP is in use, this IP address serves as a non-primary protocol-linked failover address. When TCP is in use, DSR clients can use this an independent IP address with which to send requests. Whenever a alternate TSA is configured, each DA-MP in the Target Set must also provide a alternate IP address. Must be a valid IPv4 or IPv6 address.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"alternatePreferredIpfeServer": {
"description": "The IPFE server that primarily handles traffic for this Target Set's alternate TSA. If this IPFE server fails, then its mate takes over. IPFE-A1 & IPFE-A2 are mates, as are IPFE-B1 & IPFE-B2. The value specified for alternatePreferredIpfeServer should not be the same as the value for primaryPreferredIpfeServer in order to provide an alternative path for SCTP dual-homed traffic. The pair letter (e.g., A, B) must match the pair letter specified by primaryPreferredIpfeServer.",
"enum": [
"IpfeA1",
"IpfeA2",
"IpfeB1",
"IpfeB2"
],
"type": "string"
},
"applicationServerIp": {
"description": "The list of application servers (DA-MPs) that make up this Target Set. The list of valid DA-MP IP addresses is provided in the /diameter/signalingipaddresses GET response. IP addresses having type LocalIp may be assigned as a Target Set's ipAddress or alternateIpAddress value.",
"items": {
"properties": {
"alternateIpAddress": {
"description": "Optional alternate IP address for the application server. The IP version of alternateIpAddress must match the IP version of ipAddress.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"ipAddress": {
"description": "IPv4 or IPv6 signaling address for the application server.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"serverDescription": {
"description": "Optional description for this application server.",
"maxLength": 64,
"type": "string"
},
"weight": {
"description": "Weighting factor, within the Target Set, for the application server associated with ipAddress/alternateIpAddress. Typical value is 100.",
"maximum": 65535,
"minimum": 0,
"type": "integer"
}
},
"required": [
"ipAddress",
"weight"
],
"type": "object"
},
"maxItems": 16,
"type": "array"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"deleteAge": {
"description": "Value used for the Delete Age timer, in seconds. Recommendation is to set deleteAge no less than twice the Diameter watchdog timer value. Typical value is 600 seconds.",
"maximum": 3110400,
"minimum": 10,
"type": "integer"
},
"disabled": {
"description": "If true, the Target Set is disabled, but its configuration is preserved.",
"type": "boolean"
},
"ipAddress": {
"description": "The primary IP address for the Target Set, also known as the primary Target Set Address (TSA). This is the IP address DSR Peer Nodes (/diameter/peernodes) use when forwarding requests to the DSR. Must be a valid IPv4 or IPv6 address.",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"loadBalanceAlgorithm": {
"description": "The algorithm used to determine which DA-MP server is assigned each new Connection (/diameter/connections). When Hash is specified, load balancing is achieved by sending a new Connection to a DA-MP server based on hashing the originating port number and IP address. When LeastLoad is specified, load balancing is achieved through a calculation of which application server (DA-MP) currently has the least loading. Typical value is LeastLoad.",
"enum": [
"Hash",
"LeastLoad"
],
"type": "string"
},
"loadFactorConnectionCount": {
"description": "Defines the contribution (weighting factor) of Connection (/diameter/connections) count in the computation of application server load. The sum of loadFactorConnectionCount and loadFactorMps is normalized to 100 by the DSR. Only applies when the loadBalanceAlgorithm is LeastLoad. Typical value is 50.",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"loadFactorMps": {
"description": "Defines the contribution (weighting factor) of Messages per Second in the computation of application server load. The sum of loadFactorConnectionCount and loadFactorMps is normalized to 100 by the DSR. Only applies when the loadBalanceAlgorithm is LeastLoad.Typical value is 50.",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"number": {
"description": "The unique identifier for this Target Set. Must be an integer between 1 and 32, inclusive. Target Sets must be inserted beginning with number 1, and increasing in numerical order.",
"maximum": 32,
"minimum": 1,
"type": "integer"
},
"peerNodeAwareEnabled": {
"description": "When set to true, the IPFE distributes Connections (/diameter/connections) from the same Peer Node Group (/diameter/peernodegroups) across servers in the Target Set to provide server redundancy for that group of Peer Nodes. The IPFE keeps a group count of the Connections from a Peer Node Group to each application server in the Target Set. Application servers with a group count difference that is equal to or greater than peerNodeGroupDistributionThreshold are generally not considered. For example, if peerNodeGroupDistributionThreshold is 1, the effect is to send a new Connection to the application server with the lowest group count. Only applies when the loadBalanceAlgorithm is LeastLoad. Typical value is true.",
"type": "boolean"
},
"peerNodeGroupDistributionThreshold": {
"description": "Threshold used when assessing group count values for application servers. Only applies when the loadBalanceAlgorithm is LeastLoad. Typical value is 1.",
"maximum": 10,
"minimum": 1,
"type": "integer"
},
"preferredIpfeServer": {
"description": "The IPFE server that primarily handles traffic for this Target Set. If this IPFE server fails, then its mate takes over. IPFE-A1 & IPFE-A2 are mates, as are IPFE-B1 & IPFE-B2.",
"enum": [
"IpfeA1",
"IpfeA2",
"IpfeB1",
"IpfeB2"
],
"type": "string"
},
"protocols": {
"description": "The protocol(s) the Target Set supports. If SctpAndTcp is specified, both SCTP and TCP are supported.",
"enum": [
"Sctp",
"Tcp",
"SctpAndTcp"
],
"type": "string"
}
},
"required": [
"deleteAge",
"disabled",
"loadBalanceAlgorithm",
"number",
"ipAddress",
"preferredIpfeServer",
"protocols"
],
"type": "object"
}
Example
{
"allowedDeviation": 5,
"alternateIpAddress": "101.102.103.11",
"alternatePreferredIpfeServer": "IpfeB1",
"applicationServerIp": [
{
"alternateIpAddress": "101.102.103.114",
"ipAddress": "101.102.103.104",
"serverDescription": "DAMP1",
"weight": 50
},
{
"alternateIpAddress": "101.102.103.115",
"ipAddress": "101.102.103.105",
"serverDescription": "DAMP2",
"weight": 50
}
],
"configurationLevel": "397",
"deleteAge": 600,
"disabled": false,
"ipAddress": "101.102.103.10",
"loadBalanceAlgorithm": "LeastLoad",
"loadFactorConnectionCount": 20,
"loadFactorMps": 80,
"number": 7,
"peerNodeAwareEnabled": false,
"peerNodeGroupDistributionThreshold": 1,
"preferredIpfeServer": "IpfeA2",
"protocols": "SctpAndTcp"
}
delete /diameter/ipfetargetsets/{id}
Deletes the specified Target Set from the SOAM configuration.
Target Server: SOAM
Secured by x-other
Mon: Active Alarms
Alarms are possibly service-impacting system events, and are classified into four severities: critical, major, minor, clear.
There is no natural identifier for an alarm. Typically a unique alarm can be isolated in the collection using its hostname, timestamp, and sequence number (seqno). The alarm service provides a generated identifier consisting of a hash of these three piece of information.
Alarm data is scoped to a server. When performing an unfiltered GET request at the NOAM, A-scoped alarms for all servers in the entire topology are visible. Performing an unfiltered GET request at an SOAM retrieves B-scoped alarms for the servers located at that site, as well as any A-scoped alarms generated by that site's servers.
/mon/alarms
get /mon/alarms
Retrieves all active alarms that meet the request parameters.
Target server: NOAM or SOAM
Secured by x-other
Request
Query Parameters
- time_unit: (one of minutes, hours, days)
The unit of time associated with time_count, which defines the total interval of time relative to time_date for which data is returned. For example, if time_unit is hours, and time_count is +5, then data is returned for the five hour period beginning with and subsequent to time_date.
Example:
?time_unit=minutes&time_count=-5&time_date=now
- time_count: (integer)
Specifies the number of time_units for which data is returned, relative to time_date. A - preceding the time_count integer means the data is returned for time preceding time_date; a + preceding the time_count integer means the data is returned for time following time_date. For example, if time_count is -10 and time_unit is minutes, then data is returned for the ten minute period preceding (and thus ending with) time_date.
Example:
?time_date=now&time_count=-2&time_unit=days - time_date: (string - pattern: ^(now|([0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}))$)
The point in time that defines the fixed endpoint for which data is returned. The values for time_count and time_unit define the total interval of time for which data is returned, relative to the time_date value. time_date can be specified by the string "now", or as a specific date date/time using the ISO 8601 format: YYYY-MM-DD[T]hh:mm. e.g. 2016-11-21T11:34 For example if time_date is "2017-01-30T12:00" then data is returned for the items which occurred prior to "2017-01-30T12:00". If time_date is not supplied as a query parameter, its value defaults to "now".
Example:
...&time_date=2015-08-15T14:34&...
- scope_type: (one of Server, ServerGroup, NetworkElement)
Identifies the type of Server collection the results are limited to.
Example:
?scope_type=Server&scope_name=mynoa
- scope_name: (string)
Names the specific Server collection the results are limited to.
Example:
?scope_type=ServerGroup&scope_name=NO_SG
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/mon/collections/alarmCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/mon/alarm/alarm.json",
"type" : "object",
"required": [
"id", "server", "timestamp", "severity", "eventNumber",
"seqNum", "name", "description", "product",
"type", "process", "instance", "errInfo"
],
"properties" : {
"id" : {
"type": "string",
"description": "Base 64 encoded alarm ID (generated)",
"pattern": "^[a-zA-Z0-9+/=]+$"
},
"server" : {
"type": "string",
"description": "Server on which the alarm was raised"
},
"timestamp" : {
"type": "string",
"description": "Timestamp of when the alarm was raised in an ISO 8601 format"
},
"index" : {
"type": "integer",
"description": "the position of this record in the data stream"
},
"severity" : {
"type": "string",
"description": "The severity of the alarm",
"enum": [
"Critical",
"Major",
"Minor"
]
},
"eventNumber" : {
"type": "integer",
"description": "Alarm description"
},
"seqNum" : {
"type": "integer",
"description": "Alarm sequence number"
},
"name" : {
"type": "string",
"description": "Alarm name"
},
"description" : {
"type": "string",
"description": "Alarm description"
},
"product" : {
"type": "string",
"description": "Alarm product"
},
"type" : {
"type": "string",
"description": "Type of the alarm"
},
"process" : {
"type": "string",
"description": "Alarm process"
},
"instance" : {
"type": "string",
"description": "Alarm instance"
},
"errInfo" : {
"type": "string",
"description": "Detailed info"
}
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"id": "cnVieS1ub2IsMTU4MDUxMTMxMTcwMTI3ODgwMQ==",
"server": "ruby-nob",
"timestamp": "2016-08-23T11:24:24.024182865-04:00",
"index": 1580776586674232864,
"severity": "Minor",
"eventNumber": 10075,
"seqNum": 8,
"name": "Application processes have been manually stopped",
"description": "The server is no longer providing services because application processes have been manually stopped",
"product": "OAM",
"type": "HA",
"process": "oampAgent",
"instance": "oampAgent",
"errInfo": "\n GN_WARNING/WRN Application is Stopped Manually.\n ^^ [17702:ProcCtlResponder.C:703]\n\n"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
/mon/alarms/{id}
get /mon/alarms/{id}
Retrieves a specific active alarm. Attempting to retrieve an alarm that has cleared, or which has cleared and been reasserted does not return anything, because the second instance has a different timestamp than the original instance, and thus has a different instance identifier.
Target server: NOAM or SOAM
Secured by x-other
Request
URI Parameters
- id: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/mon/items/alarmItem.json",
"type": "object",
"properties": {
"data":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/mon/alarm/alarm.json",
"type" : "object",
"required": [
"id", "server", "timestamp", "severity", "eventNumber",
"seqNum", "name", "description", "product",
"type", "process", "instance", "errInfo"
],
"properties" : {
"id" : {
"type": "string",
"description": "Base 64 encoded alarm ID (generated)",
"pattern": "^[a-zA-Z0-9+/=]+$"
},
"server" : {
"type": "string",
"description": "Server on which the alarm was raised"
},
"timestamp" : {
"type": "string",
"description": "Timestamp of when the alarm was raised in an ISO 8601 format"
},
"index" : {
"type": "integer",
"description": "the position of this record in the data stream"
},
"severity" : {
"type": "string",
"description": "The severity of the alarm",
"enum": [
"Critical",
"Major",
"Minor"
]
},
"eventNumber" : {
"type": "integer",
"description": "Alarm description"
},
"seqNum" : {
"type": "integer",
"description": "Alarm sequence number"
},
"name" : {
"type": "string",
"description": "Alarm name"
},
"description" : {
"type": "string",
"description": "Alarm description"
},
"product" : {
"type": "string",
"description": "Alarm product"
},
"type" : {
"type": "string",
"description": "Type of the alarm"
},
"process" : {
"type": "string",
"description": "Alarm process"
},
"instance" : {
"type": "string",
"description": "Alarm instance"
},
"errInfo" : {
"type": "string",
"description": "Detailed info"
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"id": "cnVieS1ub2IsMTU4MDUxMTMxMTcwMTI3ODgwMQ==",
"server": "ruby-nob",
"timestamp": "2016-08-23T11:24:24.024182865-04:00",
"index": 1580776586674232864,
"severity": "Minor",
"eventNumber": 10075,
"seqNum": 8,
"name": "Application processes have been manually stopped",
"description": "The server is no longer providing services because application processes have been manually stopped",
"product": "OAM",
"type": "HA",
"process": "oampAgent",
"instance": "oampAgent",
"errInfo": "\n GN_WARNING/WRN Application is Stopped Manually.\n ^^ [17702:ProcCtlResponder.C:703]\n\n"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
Mon: KPI Data
Key Performance Indiciators (KPIs) are point-in-time indicators of system performance and health. KPI data is scoped to a server. When performing a GET request at the NOAM, A-Scoped KPIs for all servers in the topology are returned. Performing a GET request at the SOAM returns only the A and B-Scoped KPIs for the servers located at that site.
/mon/kpis/data
get /mon/kpis/data
Retrieveis all KPI data matching the provided query parameters.
Target server: NOAM or SOAM
Secured by x-other
Request
Query Parameters
- scope_type: (one of Server, ServerGroup, NetworkElement)
Identifies the type of Server collection the results are limited to.
Example:
?scope_type=Server&scope_name=mynoa
- scope_name: (string)
Names the specific Server collection the results are limited to.
Example:
?scope_type=ServerGroup&scope_name=NO_SG
- ids: (string)
A comma-separated list of KPI IDs to include.
Example:
ids=31000,31001,31002
- group: (string)
The name of a KPI group to include in the returned results.
Example:
group=System
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/mon/collections/kpiCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/mon/kpidata/kpi.json",
"type": "object",
"required": ["hostname","subgroups"],
"description": "The per-server KPI value(s)",
"properties" : {
"hostname" : {
"description": "The server producing this set of KPI values",
"type": "string",
"example": "ruby-noa"
},
"subgroups" : {
"type": "array",
"required": ["name","kpis"],
"description": "Scalar and Arrayed subgroups of KPI values",
"items": {
"type": "object",
"description": "A subgroups of KPI values",
"properties" : {
"name" : { "type": "string", "description": "The name of the KPIs subgroup" },
"kpis" : {
"description": "The values for each of the KPIs in the subgroup",
"type" : "array",
"items": {
"type": "object",
"description": "A per-host, per sub-group KPI value",
"properties" : {
"name": { "type": "string", "description": "The KPI Name" },
"value": { "type": "string", "description": "The KPI Value" },
"desc": { "type": "string", "description": "The KPI Description" }
}
},
"minItems": 1
}
}
},
"minItems": 0
}
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"hostname": "sapphire-noa",
"kpis": [
{
"name": "NonArrayed",
"items": [
{
"name": "CPU_UtilPct",
"value": "27.27 %",
"desc": "Percentage utilization of all processors on the server by all software as measured by the operating system."
},
{
"name": "RAM_UtilPct",
"value": "62.30 %",
"desc": "Percentage utilization of physical memory on the server by all software as measured by the operating system."
},
{
"name": "Swap_UtilPct",
"value": "0.00 %",
"desc": "Percentage utilization of swap space on the server by all software as measured by the operating system."
},
{
"name": "Disk_UtilPct",
"value": "6.29 %",
"desc": "Percentage utilization of disk space on the server by all software as measured by the operating system."
},
{
"name": "ShMem_UtilPct",
"value": "3.18 %",
"desc": "Percentage utilization of shared memory on the server by all software as measured by the operating system."
},
{
"name": "Uptime_Srv",
"value": "1.63 days",
"desc": "The total amount of time(days HH:MM:SS) the server has been running."
}
]
},
{
"name": "CPU_CoreUtilPct",
"items": [
{
"name": "0",
"value": "26.64 %",
"desc": "Percentage utilization of each processor core on the server as measured by the operating system."
},
{
"name": "1",
"value": "27.91 %",
"desc": "Percentage utilization of each processor core on the server as measured by the operating system."
}
]
}
]
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
Mon: KPI Data Definitions
The KPI data dictionary is a catalog of available Key Performance Indicators (KPIs). It includes a description of each KPI. The identifier for a KPI data dictionary item can either be its numerical identifier (id) or its name.
/mon/kpis/defs
get /mon/kpis/defs
Returns the data dictionary definitions for all Key Performance Indicators (KPIs) that match the request parameters.
Target server: NOAM or SOAM
Secured by x-other
Request
Query Parameters
- group: (string)
The name of a KPI group to match.
Example:
group=System
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/mon/collections/kpidefCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/mon/kpidef/kpidef.json",
"type": "object",
"required": ["id","name","description","scope","merged"],
"properties": {
"id": {
"description": "The KPI ID",
"type": "string",
"example":"31000",
"pattern" : "^[0-9]+$"
},
"name": {
"description": "The KPI name",
"type": "string",
"example": "System.CPU_UtilPct"
},
"description": {
"type": "string",
"description": "The KPI description",
"example": "Percentage utilization of all processors on the server by all software as measured by the operating system."
},
"scope": {
"type": "string",
"description": "The KPI scope",
"enum": [ "A", "B" ],
"example": "A"
},
"merged": {
"description": "true if the KPI is merged, false otherwise",
"type": "boolean",
"example": true
}
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"id": "31000",
"name": "System.CPU_UtilPct",
"description": "Percentage utilization of all processors on the server by all software as measured by the operating system.",
"merged": "Yes",
"scope": "A"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
/mon/kpis/defs/{idOrName}
get /mon/kpis/defs/{idOrName}
Returns the data dictionary definition for the specified Key Performance Indicator (KPI).
Target server: NOAM or SOAM
Secured by x-other
Request
URI Parameters
- idOrName: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/mon/items/kpidefItem.json",
"type": "object",
"properties": {
"data":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/mon/kpidef/kpidef.json",
"type": "object",
"required": ["id","name","description","scope","merged"],
"properties": {
"id": {
"description": "The KPI ID",
"type": "string",
"example":"31000",
"pattern" : "^[0-9]+$"
},
"name": {
"description": "The KPI name",
"type": "string",
"example": "System.CPU_UtilPct"
},
"description": {
"type": "string",
"description": "The KPI description",
"example": "Percentage utilization of all processors on the server by all software as measured by the operating system."
},
"scope": {
"type": "string",
"description": "The KPI scope",
"enum": [ "A", "B" ],
"example": "A"
},
"merged": {
"description": "true if the KPI is merged, false otherwise",
"type": "boolean",
"example": true
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"id": "31000",
"name": "System.CPU_UtilPct",
"description": "Percentage utilization of all processors on the server by all software as measured by the operating system.",
"merged": "Yes",
"scope": "A"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
Mon: KPI Groups
A KPI group is a named collection of Key Performance Indicators (KPIs). This API provides a simple listing of the KPI group names, along with an indicator of whether each group is available at the NOAM, SOAM, or both. The KPI group name is the natural identifier for this collection.
/mon/kpis/groups
get /mon/kpis/groups
Returns a list of all defined KPI groups.
Target server: NOAM or SOAM
Secured by x-other
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/mon/collections/kpigrpCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/mon/kpigrp/kpigrp.json",
"type": "object",
"required": ["name","visibility"],
"properties": {
"name": {
"description": "The KPI group name",
"type": "string",
"example": "Server"
},
"visibility": {
"description": "The KPI group visibility",
"enum": [ "A", "B", "AB" ],
"type": "string",
"example": "AB"
}
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"name": "Server",
"visibility": "AB"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
/mon/kpis/groups/{group}
get /mon/kpis/groups/{group}
Returns the details for the specified KPI group.
Target server: NOAM or SOAM
Secured by x-other
Request
URI Parameters
- group: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/mon/items/kpigrpItem.json",
"type": "object",
"properties": {
"data":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/mon/kpigrp/kpigrp.json",
"type": "object",
"required": ["name","visibility"],
"properties": {
"name": {
"description": "The KPI group name",
"type": "string",
"example": "Server"
},
"visibility": {
"description": "The KPI group visibility",
"enum": [ "A", "B", "AB" ],
"type": "string",
"example": "AB"
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"name": "Server",
"visibility": "AB"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
Mon: KPI Scopes
Provides a list of valid Key Performance Indicator (KPI) group / scope combinations.
This can be used to:
- determine what scopes and KPI groups are valid.
- determine what scopes are valid for a named KPI group.
- determine what KPI groups are valid for a named scope.
- determine what nodes are valid for a named KPI group and scope.
/mon/kpis/scopes
get /mon/kpis/scopes
Expands the request into lists of valid KPI groups and scopes that match the request parameters.
Target server: NOAM or SOAM
Secured by x-other
Request
Query Parameters
- scope_type: (one of Server, ServerGroup, NetworkElement)
Identifies the type of Server collection the results are limited to.
Example:
?scope_type=Server&scope_name=mynoa
- scope_name: (string)
Names the specific Server collection the results are limited to.
Example:
?scope_type=ServerGroup&scope_name=NO_SG
- group: (string)
The name of a KPI group to match.
Example:
group=System
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/mon/collections/kpiscopeCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/mon/kpiscope/kpiscope.json",
"type": "object",
"required": ["group","groups","scope","scopes"],
"properties": {
"group": {
"description": "The selected KPI group.",
"type": "string",
"example":"Server"
},
"groups": {
"description": "The valid KPI groups.",
"type": "array",
"items": {
"type": "string"
},
"minItems": 0
},
"scope": {
"description": "The selected KPI scope by scope type.",
"type": "object",
"additionalProperties" : {
"description": "A list scope names for this scope type.",
"type": "array",
"items": {
"type": "string"
},
"minItems": 0
}
},
"scopes": {
"description": "The available KPI scopes by scope type.",
"type": "object",
"additionalProperties" : {
"description": "A list of scope names for this scope type.",
"type": "array",
"items": {
"type": "string"
},
"minItems": 0
}
}
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"group": "Server",
"groups": [
"ALEXA01",
"ALEXA03",
"ALEXA04",
"ALEXA05",
"ALEXA06",
"ALEXA07",
"ALEXA08",
"Server",
"ALEXA10"
],
"scope": {
"ServerGroup": [
"NO_SG"
]
},
"scopes": {
"NetworkElement": [
"NO_NE",
"SO_NE1"
],
"ServerGroup": [
"NO_SG",
"NO_SG2",
"SO1MP_SG1",
"SO_SG1"
]
}
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
Mon: KPI Stats
Key Performance Indicators (KPIs) are point-in-time indicators of system performance and health. KPI stats provide a set of statistics for the selected scope. The KPI data from each of the servers in the selected scope is processed to create a set of overview statistics including max, min, median, average, and sum.
/mon/kpis/stats
get /mon/kpis/stats
Retrieves KPI statistics matching the request parameters.
Statistics provide max, min, median, average, and sum calculations across all the nodes in the selected scope. If the KPI is arrayed, then KPIs with the same array index will be used to calculate the statistics.
Target server: NOAM or SOAM
Secured by x-other
Request
Query Parameters
- scope_type: (one of Server, ServerGroup, NetworkElement)
Identifies the type of Server collection the results are limited to.
Example:
?scope_type=Server&scope_name=mynoa
- scope_name: (string)
Names the specific Server collection the results are limited to.
Example:
?scope_type=ServerGroup&scope_name=NO_SG
- ids: (string)
A comma-seperated list of measurement IDs to include.
Example:
ids=31000,31001,31002
- group: (string)
The name of a measurement group to include.
Example:
group=System
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/mon/collections/kpistatCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/mon/kpistat/kpistat.json",
"type": "object",
"required": ["name","stats"],
"description": "The set of KPI statistics for the selected scope.",
"properties" : {
"name" : {
"description": "The name for this statistic subgroup.",
"type": "string",
"example": "NonArrayed"
},
"stats" : {
"type": "array",
"description": "The set of KPI statistics for this subgroup.",
"items": {
"type": "object",
"required": ["name","max","min","average","median","sum","desc"],
"description": "The KPI statistics for individual subgroup items.",
"properties" : {
"name" : { "type": "string", "description": "The name of the KPI" },
"max" : { "type": "string", "description": "The max value across the selected scope" },
"min" : { "type": "string", "description": "The min value across the selected scope" },
"average" : { "type": "string", "description": "The average value across the selected scope" },
"median" : { "type": "string", "description": "The median value across the selected scope" },
"sum" : { "type": "string", "description": "The sum of the values across the selected scope" },
"desc" : { "type": "string", "description": "A short description of the KPI" }
}
},
"minItems": 0
}
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"name": "NonArrayed",
"stats": [
{
"name": "System.CPU_UtilPct",
"max": "12.12 %",
"min": "10.64 %",
"sum": "65.74 %",
"median": "11.23 %",
"average": "10.96 %",
"desc": "Percentage utilization of all processors on the server by all software as measured by the operating system."
},
{
"name": "System.RAM_UtilPct",
"max": "58.59 %",
"min": "48.62 %",
"sum": "305.59 %",
"median": "49.59 %",
"average": "50.93 %",
"desc": "Percentage utilization of physical memory on the server by all software as measured by the operating system."
},
{
"name": "System.Swap_UtilPct",
"max": "0.00 %",
"min": "0.00 %",
"sum": "0.00 %",
"median": "0.00 %",
"average": "0.00 %",
"desc": "Percentage utilization of swap space on the server by all software as measured by the operating system."
},
{
"name": "System.Disk_UtilPct",
"max": "4.65 %",
"min": "4.59 %",
"sum": "27.69 %",
"median": "4.62 %",
"average": "4.62 %",
"desc": "Percentage utilization of disk space on the server by all software as measured by the operating system."
},
{
"name": "System.ShMem_UtilPct",
"max": "1.37 %",
"min": "1.29 %",
"sum": "8.03 %",
"median": "1.33 %",
"average": "1.34 %",
"desc": "Percentage utilization of shared memory on the server by all software as measured by the operating system."
},
{
"name": "System.Uptime_Srv",
"max": "1.01 hrs",
"min": "1.01 hrs",
"sum": "6.08 hrs",
"median": "1.01 hrs",
"average": "1.01 hrs",
"desc": "The total amount of time(days HH:MM:SS) the server has been running."
}
]
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
Mon: Measurements Budget
Access to the measurements (/mon/measurements/data) interface is rate limited. Every request for measurements data has an associated cost and there is a budget that cannot be exceeded in any given time interval.
This measurements budget API provides access to the budget details for the measurement interface including:
- budget: the cost per interval that cannot be exceeded
- interval: the costing interval in minutes
- available: how much budget is left to be spent in the current interval
Costing intervals always begin on an even time boundary. For example, a 5 minute interval would begin on the hour, 5 minutes after the hour, 10 minutes after the hour, etc.
/mon/measurements/budget
get /mon/measurements/budget
Retrieves the measurement budget details.
Target server: NOAM or SOAM
Secured by x-other
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/mon/items/measbudgetItem.json",
"type": "object",
"properties": {
"data":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/mon/measbudget/measbudget.json",
"type": "object",
"required": ["budget","interval","available"],
"properties": {
"budget": {
"description": "The per interval budget.",
"type": "integer"
},
"interval": {
"description": "The budget interval in minutes.",
"type": "integer",
"example": 5,
"default": 5
},
"available": {
"description": "The amount of budget remaining.",
"type": "integer"
}
}
}
,
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"budget": 123412334,
"interval": "05:00",
"available": 123884
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
Mon: Measurements Data
Measurements are collected on a wide variety of internal system behaviors. Measurements provide insight into processing rates and performance, and can be used to predict resource exhaustion.
Unlike most other collection GET operations, the /measurements collection requires that a query be provided to restrict the results to a specific set of measurement ids. If a time range is not specified, then only the most recently completed interval will be returned. If a scope is provided, then the measurements will be returned for all the servers identified by the named scope.
Measurements data returned from a /mon/measurements/data request is always Server-scoped. Clients wishing to retreive summary(rolled-up) measurement data must use the /mon/measurements/summary resource. Measurement data is scoped to a server. When performing a GET request at the NOAM, A-Scoped measurements for all servers in the topology are visible. Performing a GET request at the SOAM only returns A and B-Scoped measurements for the servers located at that site.
/mon/measurements/data
get /mon/measurements/data
Retrieve measurement data matching the supplied request parameters. Note that the /mon/measurements resource is rate limited. Every measurement retrieved has an associated cost, and every server processing the request has a cost budget. Requests that will exceed the budget are denied with an HTTP status code of 429. In this release of the DSR software, there are certain arrayed measurements for which a cost value is not currently calculated. For these arrayed measurements, the DSR reports a cost value of zero.
If no date parameters are provided in the request, only data for the last complete measurement collection interval is returned.
At least one measurement ID must be supplied in the request parameters.
Note that all times related to measurements are rounded back to fall on even 5 minute boundaries. For example, if the request asks for 8 minutes of measurement data ending at 10:43, the response will include 10 minutes of data ending at 10:40.
Target server: NOAM or SOAM
Secured by x-other
Request
Query Parameters
- time_unit: (one of minutes, hours, days)
The unit of time associated with time_count, which defines the total interval of time relative to time_date for which data is returned. For example, if time_unit is hours, and time_count is +5, then data is returned for the five hour period beginning with and subsequent to time_date.
Example:
?time_unit=minutes&time_count=-5&time_date=now
- time_count: (integer)
Specifies the number of time_units for which data is returned, relative to time_date. A - preceding the time_count integer means the data is returned for time preceding time_date; a + preceding the time_count integer means the data is returned for time following time_date. For example, if time_count is -10 and time_unit is minutes, then data is returned for the ten minute period preceding (and thus ending with) time_date.
Example:
?time_date=now&time_count=-2&time_unit=days - time_date: (string - pattern: ^(now|([0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}))$)
The point in time that defines the fixed endpoint for which data is returned. The values for time_count and time_unit define the total interval of time for which data is returned, relative to the time_date value. time_date can be specified by the string "now", or as a specific date date/time using the ISO 8601 format: YYYY-MM-DD[T]hh:mm. e.g. 2016-11-21T11:34 For example if time_date is "2017-01-30T12:00" then data is returned for the items which occurred prior to "2017-01-30T12:00". If time_date is not supplied as a query parameter, its value defaults to "now".
Example:
...&time_date=2015-08-15T14:34&...
- scope_type: (one of ServerGroup, NetworkElement)
Identifies the type of Server collection the results are limited to.
Example:
?scope_type=ServerGroup&scope_name=NO_SG
- scope_name: (string)
Names the specific Server collection the results are limited to.
Example:
?scope_type=ServerGroup&scope_name=NO_SG
- ids: (string)
A comma-separated list of measurement IDs to include. Measurement IDs can be retrived from resource /mon/measurements/defs.
Example:
32011,32010
- interval: (one of 1Day, 12Hours, 1Hour, 30Min, 15Min, 5Min - default: 5Min)
Specifies the time interval between measurements returned by the OAM server, within the measurement report window defined by time_date/time_unit/time_count. For example, if the value for interval is 30Min, and the overall report window is 12 hours, then the response includes two data points per hour, for a total of 24 data points, for each measurement included in the response.
Example:
Hour
- pattern: (string)
The value for pattern is used to filter arrayed measurements which have indexes of string format, so the OAM server only return values for arrayed measurement instances that match the specified pattern with index of the measurement. The valid index value of an arrayed measurement is based on configuration and can be retrieved from resource /mon/measurements/summary.
Example:
Peer*
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/mon/items/measurementItem.json",
"type": "object",
"properties": {
"data":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/mon/measdata/measurement.json",
"type": "object",
"properties": {
"cost": {
"description": "The measurement report generation cost (cell count)",
"example": 1032423,
"type": "integer"
},
"endTime": {
"description": "The measurement report end time. This time will be rounded to fit the measurement interval",
"example":"2016-09-01T07:58:48-04:00",
"pattern": "^[0-9]{4}[-][0-1]{1}[0-9]{1}[-][0-3]{1}[0-9]{1}T[0-2]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}([.][0-9]{1,7})?[+-](?:2[0-3]|[0-1][0-9])[:][0-5][0-9]?$",
"type": "string"
},
"interval": {
"default": "5Min",
"description": "The measurement reporting interval",
"enum": [ "5Min", "15Min", "30Min", "1Hour", "12Hours", "1Day" ],
"example": "5Min",
"type": "string"
},
"scopeName": {
"default": "All",
"description": "Scope name corresponding to the scopeType value",
"example": "NO_SG",
"type": "string"
},
"scopeType": {
"default": "Network",
"description": "A scope that bounds the returned measurement data",
"enum": [ "Network", "Server", "NetworkElement", "ServerGroup", "ResourceDomain", "Place", "PlaceAssociation" ],
"example": "ServerGroup",
"type": "string"
},
"servers":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/mon/meascollection/meascollection.json",
"description": "A collection of measurements",
"type" : "array",
"items": {
"description": "Individual collections of measurements with similar indexes",
"properties": {
"hostname": {
"description": "The name of the server for the measurements",
"example": "NO1",
"type" : "string"
},
"metrics": {
"description": "Metrics set for the server",
"items": {
"description": "The measurement data for the server",
"properties": {
"collection": {
"description": "The name of the measurement collection, the expected values can be Single, Arrayed or the collection name if it exists",
"example": "Audits",
"type" : "string"
},
"names": {
"description": "An array of sets of name index, collection for a measurement",
"items": {
"properties": {
"index": {
"description": "The index value for the measurement. This value is applicable only for arrayed measurements",
"type" : "string"
},
"name": {
"description": "The index names for the measurement",
"type" : "string"
}
},
"type" :"object"
},
"type": "array"
} ,
"timestampValues":{
"description": "A set of timestamp and mapped measurement values",
"items": {
"description": "The timestamp value",
"properties": {
"timestamp": {
"example":"2016-09-01T07:38:48-04:00",
"pattern": "^[0-9]{4}[-][0-1]{1}[0-9]{1}[-][0-3]{1}[0-9]{1}T[0-2]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}([.][0-9]{1,7})?[+-](?:2[0-3]|[0-1][0-9])[:][0-5][0-9]?$",
"type": "string"
},
"values" :{
"description": "An array of measurement values",
"items": {
"type" :"string"
},
"type" :"array"
}
},
"type": "object"
},
"type": "array"
}
},
"type" :"object"
},
"type": "array"
}
},
"type" : "object"
}
},
"startTime": {
"description": "The measurement report start time. This time will be rounded to fit the measurement interval",
"example":"2016-09-01T07:38:48-04:00",
"pattern": "^[0-9]{4}[-][0-1]{1}[0-9]{1}[-][0-3]{1}[0-9]{1}T[0-2]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}([.][0-9]{1,7})?[+-](?:2[0-3]|[0-1][0-9])[:][0-5][0-9]?$",
"type": "string"
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"cost": 133,
"endTime": "2016-09-01T07:38:48-04:00",
"interval": "15Min",
"scopeName": "All",
"scopeType": "Network",
"servers": [
{
"hostname": "SO1",
"metrics": [
{
"collection": "Single",
"names": [
{
"name": "Alarm.Crit"
},
{
"name": "Alarm.Major"
},
{
"name": "appworks.totalGuiReqAvg"
},
{
"name": "appworks.totalGuiReqCount"
},
{
"name": "appworks.totalGuiReqMax"
},
{
"name": "appworks.totalMmiReqAvg"
},
{
"name": "appworks.totalMmiReqCount"
},
{
"name": "appworks.totalMmiReqMax"
},
{
"name": "apwSoapServer.auditSkip"
},
{
"name": "apwSoapServer.cacheClear"
},
{
"name": "apwSoapServer.cacheHit"
},
{
"name": "apwSoapServer.cacheMiss"
},
{
"name": "apwSoapServer.procSig"
},
{
"name": "apwSoapServer.procStart"
},
{
"name": "apwSoapServer.soapClient"
},
{
"name": "apwSoapServer.soapReqAvg"
},
{
"name": "apwSoapServer.soapReqCount"
},
{
"name": "apwSoapServer.soapReqEnQ"
},
{
"name": "apwSoapServer.soapReqMax"
}
],
"timestampValues": [
{
"timestamp": "2016-09-01T06:30:48-04:00",
"values": [
"48",
"0",
"275.788136",
"236",
"4709",
"n/a",
"0",
"0",
"0",
"35",
"0",
"35",
"0",
"0",
"65",
"15.837294",
"547",
"547",
"186"
]
},
{
"timestamp": "2016-09-01T06:35:48-04:00",
"values": [
"49",
"0",
"357.913793",
"232",
"8641",
"2699.500000",
"2",
"3923",
"0",
"34",
"4",
"33",
"0",
"0",
"63",
"21.650255",
"589",
"589",
"224"
]
},
{
"timestamp": "2016-09-01T06:40:48-04:00",
"values": [
"45",
"0",
"389.060606",
"231",
"9096",
"3151.500000",
"4",
"6295",
"0",
"35",
"3",
"34",
"0",
"0",
"64",
"21.797251",
"582",
"582",
"264"
]
}
]
},
{
"collection": "CmSoap",
"names": [
{
"index": "getActiveVips",
"name": "apwSoapServer.cmSoapOutAvg"
},
{
"index": "getHaResourceStates",
"name": "apwSoapServer.cmSoapOutAvg"
},
{
"index": "getReplicationStatus",
"name": "apwSoapServer.cmSoapOutAvg"
},
{
"index": "getAddressPair",
"name": "apwSoapServer.cmSoapOutAvg"
},
{
"index": "getActiveVips",
"name": "apwSoapServer.cmSoapOutCount"
},
{
"index": "getHaResourceStates",
"name": "apwSoapServer.cmSoapOutCount"
},
{
"index": "getReplicationStatus",
"name": "apwSoapServer.cmSoapOutCount"
},
{
"index": "getAddressPair",
"name": "apwSoapServer.cmSoapOutCount"
},
{
"index": "getActiveVips",
"name": "apwSoapServer.cmSoapOutMax"
},
{
"index": "getHaResourceStates",
"name": "apwSoapServer.cmSoapOutMax"
},
{
"index": "getReplicationStatus",
"name": "apwSoapServer.cmSoapOutMax"
},
{
"index": "getAddressPair",
"name": "apwSoapServer.cmSoapOutMax"
}
],
"timestampValues": [
{
"timestamp": "2016-09-01T06:30:48-04:00",
"values": [
"34.466667",
"29.300000",
"30.100000",
"48.750000",
"15",
"20",
"10",
"20",
"135",
"97",
"51",
"282"
]
},
{
"timestamp": "2016-09-01T06:35:48-04:00",
"values": [
"36.562500",
"30.619048",
"35.700000",
"30.250000",
"16",
"21",
"10",
"20",
"121",
"93",
"69",
"60"
]
},
{
"timestamp": "2016-09-01T06:40:48-04:00",
"values": [
"38.250000",
"42.285714",
"21.400000",
"24.500000",
"16",
"21",
"10",
"20",
"129",
"131",
"26",
"37"
]
}
]
}
]
}
],
"startTime": "2016-09-01T06:20:48-04:00"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 429
request budget exceeded
Mon: Measurement Data Definitions
The measurement data dictionary is a catalog of available measurements. It includes a description of each measurement. The natural identifier for this collection is either the id or name field.
/mon/measurements/defs
get /mon/measurements/defs
Retrieves the measurement data dictionary items that match the request parameters.
Target server: NOAM or SOAM
Secured by x-other
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/mon/collections/measdefCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/mon/measdef/measdef.json",
"type": "object",
"properties": {
"id": {
"description": "The measurement ID",
"type": "string",
"example":"32000",
"pattern" : "^[0-9]+$"
},
"name": {
"description": "The measurement name",
"type": "string",
"example": "appworks.guiReqAvg"
},
"description": {
"description": "The measurement description",
"example": "Average AppWorks GUI request time",
"type": "string"
},
"collection": {
"description": "The indexed measurement name or 'Arrayed' for arrayed measurement and 'Single' for Simple type of measurement.",
"type": "string",
"example": "Single"
},
"maxCost": {
"description": "For a non-arrayed measurement, the maxCost value is 1. For arrayed measurements, the maxCost value is the sum of the costs associated with each indexed measurement within the array. The more indexed measurement values there are within an arrayed measurement, the higher the maxCost is for that arrayed measurement.",
"type": "integer",
"example": 30
},
"scope": {
"description": "The measurement scope",
"enum": [ "A", "B" ],
"example": "A"
},
"dim": {
"description": "The measurement dimension",
"enum": [ "Arrayed", "Single" ],
"example": "Arrayed"
},
"type": {
"description": "The measurement type",
"enum": [ "Average", "Simple", "Min", "Max" ],
"example": "Average"
},
"interval": {
"description": "The measurement collection interval",
"enum": [
"30Sec",
"1Min",
"5Min",
"15Min",
"30Min",
"1Hour",
"2Hours",
"4Hours"
],
"example": "5Min"
}
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"id": "32000",
"name": "appworks.guiReqAvg",
"scope": "A",
"dim": "Arrayed",
"type": "Average",
"interval": "5Min",
"description": "Average AppWOrks GUI request time",
"collection": "Arrayed",
"maxCost": 356
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
/mon/measurements/defs/{idOrName}
get /mon/measurements/defs/{idOrName}
Retrives the measurement details for a specific measurement ID or name.
Target server: NOAM or SOAM
Secured by x-other
Request
URI Parameters
- idOrName: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/mon/items/measdefItem.json",
"type": "object",
"properties": {
"data":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/mon/measdef/measdef.json",
"type": "object",
"properties": {
"id": {
"description": "The measurement ID",
"type": "string",
"example":"32000",
"pattern" : "^[0-9]+$"
},
"name": {
"description": "The measurement name",
"type": "string",
"example": "appworks.guiReqAvg"
},
"description": {
"description": "The measurement description",
"example": "Average AppWorks GUI request time",
"type": "string"
},
"collection": {
"description": "The indexed measurement name or 'Arrayed' for arrayed measurement and 'Single' for Simple type of measurement.",
"type": "string",
"example": "Single"
},
"maxCost": {
"description": "For a non-arrayed measurement, the maxCost value is 1. For arrayed measurements, the maxCost value is the sum of the costs associated with each indexed measurement within the array. The more indexed measurement values there are within an arrayed measurement, the higher the maxCost is for that arrayed measurement.",
"type": "integer",
"example": 30
},
"scope": {
"description": "The measurement scope",
"enum": [ "A", "B" ],
"example": "A"
},
"dim": {
"description": "The measurement dimension",
"enum": [ "Arrayed", "Single" ],
"example": "Arrayed"
},
"type": {
"description": "The measurement type",
"enum": [ "Average", "Simple", "Min", "Max" ],
"example": "Average"
},
"interval": {
"description": "The measurement collection interval",
"enum": [
"30Sec",
"1Min",
"5Min",
"15Min",
"30Min",
"1Hour",
"2Hours",
"4Hours"
],
"example": "5Min"
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"id": "32000",
"name": "appworks.guiReqAvg",
"scope": "A",
"dim": "Arrayed",
"type": "Average",
"interval": "5Min",
"description": "Average AppWOrks GUI request time",
"collection": "Arrayed",
"maxCost": 356
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
Mon: Measurement Groups
A measurement group is a named collection of measurements. This API provides a simple listing of the measurement group names, along with an indicator of whether each group is available at the NOAM, SOAM, or both. The measurement group name is the natural identifier for this collection.
/mon/measurements/groups
get /mon/measurements/groups
Returns a list of all defined measurement groups that match the request parameters.
Target server: NOAM or SOAM
Secured by x-other
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/mon/collections/measgrpCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/mon/measgrp/measgrp.json",
"type": "object",
"properties": {
"name": {
"description": "The measurement group name.",
"type": "string",
"example": "OAM.PERF"
},
"maxCost": {
"description": "The maxCost for a measurement group is the sum of the maxCost values for all measurements that are included in the group.",
"type": "integer",
"example": 5
},
"visibility": {
"description": "The measurement group visibility.",
"enum": [ "A", "B", "AB" ],
"type": "string",
"example": "AB"
}
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"name": "OAM.PERF",
"visibility": "AB",
"maxCost": 45834
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
/mon/measurements/groups/{name}
get /mon/measurements/groups/{name}
Returns the details for the specified measurement group.
Target server: NOAM or SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/mon/items/measgrpItem.json",
"type": "object",
"properties": {
"data":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/mon/measgrp/measgrp.json",
"type": "object",
"properties": {
"name": {
"description": "The measurement group name.",
"type": "string",
"example": "OAM.PERF"
},
"maxCost": {
"description": "The maxCost for a measurement group is the sum of the maxCost values for all measurements that are included in the group.",
"type": "integer",
"example": 5
},
"visibility": {
"description": "The measurement group visibility.",
"enum": [ "A", "B", "AB" ],
"type": "string",
"example": "AB"
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"name": "OAM.PERF",
"visibility": "AB",
"maxCost": 45834
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
Mon: Measurements Summary
Measurements are collected on a wide variety of internal system behaviors. Measurements provide insight into processing rates and performance, and can be used to predict resource exhaustion.
Unlike most other collection GET operations, the /measurements collection requires that a query be provided to restrict the results to a specific set of measurement ids. If a time range is not specified, then only the most recently completed interval will be returned. If a scope is provided, then the measurements will be returned for all the servers identified by the named scope.
Measurement data returned from /mon/measurements/summary is a summary ("rollup") - a single aggregated data set across the servers in the requested scope.
/mon/measurements/summary
get /mon/measurements/summary
Retrieve measurement data matching the supplied request parameters. Note that the /mon/measurements resource is rate limited. Every measurement retrieved has an associated cost, and every server processing the request has a cost budget. Requests that will exceed the budget are denied with an HTTP status code of 429. In this release of the DSR software, there are certain arrayed measurements for which a cost value is not currently calculated. For these arrayed measurements, the DSR reports a cost value of zero.
If no date parameters are provided in the request, only data for the last complete measurement collection interval is returned.
At least one measurement ID must be supplied in the request parameters.
Note that all times related to measurements are rounded back to fall on even 5 minute boundaries. For example, if the request asks for 8 minutes of measurement data ending at 10:43, the response will include 10 minutes of data ending at 10:40.
Target server: NOAM or SOAM
Secured by x-other
Request
Query Parameters
- time_unit: (one of minutes, hours, days)
The unit of time associated with time_count, which defines the total interval of time relative to time_date for which data is returned. For example, if time_unit is hours, and time_count is +5, then data is returned for the five hour period beginning with and subsequent to time_date.
Example:
?time_unit=minutes&time_count=-5&time_date=now
- time_count: (integer)
Specifies the number of time_units for which data is returned, relative to time_date. A - preceding the time_count integer means the data is returned for time preceding time_date; a + preceding the time_count integer means the data is returned for time following time_date. For example, if time_count is -10 and time_unit is minutes, then data is returned for the ten minute period preceding (and thus ending with) time_date.
Example:
?time_date=now&time_count=-2&time_unit=days - time_date: (string - pattern: ^(now|([0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}))$)
The point in time that defines the fixed endpoint for which data is returned. The values for time_count and time_unit define the total interval of time for which data is returned, relative to the time_date value. time_date can be specified by the string "now", or as a specific date date/time using the ISO 8601 format: YYYY-MM-DD[T]hh:mm. e.g. 2016-11-21T11:34 For example if time_date is "2017-01-30T12:00" then data is returned for the items which occurred prior to "2017-01-30T12:00". If time_date is not supplied as a query parameter, its value defaults to "now".
Example:
...&time_date=2015-08-15T14:34&...
- scope_type: (one of ServerGroup, NetworkElement)
Identifies the type of Server collection the results are limited to.
Example:
?scope_type=ServerGroup&scope_name=NO_SG
- scope_name: (string)
Names the specific Server collection the results are limited to.
Example:
?scope_type=ServerGroup&scope_name=NO_SG
- ids: (string)
A comma-separated list of measurement IDs to include. Measurement IDs can be retrived from resource /mon/measurements/defs.
Example:
32011,32010
- interval: (one of 1Day, 12Hours, 1Hour, 30Min, 15Min, 5Min - default: 5Min)
Specifies the time interval between measurements returned by the OAM server, within the measurement report window defined by time_date/time_unit/time_count. For example, if the value for interval is 30Min, and the overall report window is 12 hours, then the response includes two data points per hour, for a total of 24 data points, for each measurement included in the response.
Example:
Hour
- pattern: (string)
The value for pattern is used to filter arrayed measurements which have indexes of string format, so the OAM server only return values for arrayed measurement instances that match the specified pattern with index of the measurement. The valid index value of an arrayed measurement is based on configuration and can be retrieved from resource /mon/measurements/summary.
Example:
Peer*
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/mon/items/meassummaryItem.json",
"type": "object",
"properties": {
"data":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/mon/meassummary/meassummary.json",
"type": "object",
"properties": {
"cost": {
"description": "The measurement report generation cost (cell count)",
"example": 1032423,
"type": "integer"
},
"endTime": {
"description": "The measurement report end time. This time will be rounded to fit the measurement interval",
"example":"2016-09-01T07:58:48-04:00",
"pattern": "^[0-9]{4}[-][0-1]{1}[0-9]{1}[-][0-3]{1}[0-9]{1}T[0-2]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}([.][0-9]{1,7})?[+-](?:2[0-3]|[0-1][0-9])[:][0-5][0-9]?$",
"type": "string"
},
"interval": {
"default": "5Min",
"description": "The measurement reporting interval",
"enum": [ "5Min", "15Min", "30Min", "1Hour", "12Hours", "1Day" ],
"example": "5Min",
"type": "string"
},
"scopeName": {
"default": "All",
"description": "Scope name corresponding to the scopeType value",
"example": "NO_SG",
"type": "string"
},
"scopeType": {
"default": "Network",
"description": "A scope that bounds the returned measurement data",
"enum": [ "Network", "Server", "NetworkElement", "ServerGroup", "ResourceDomain", "Place", "PlaceAssociation" ],
"example": "ServerGroup",
"type": "string"
},
"startTime": {
"description": "The measurement report start time. This time will be rounded to fit the measurement interval",
"example":"2016-09-01T07:38:48-04:00",
"pattern": "^[0-9]{4}[-][0-1]{1}[0-9]{1}[-][0-3]{1}[0-9]{1}T[0-2]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}([.][0-9]{1,7})?[+-](?:2[0-3]|[0-1][0-9])[:][0-5][0-9]?$",
"type": "string"
},
"summary":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/mon/meascollection/meascollection.json",
"description": "A collection of measurements",
"type" : "array",
"items": {
"description": "Individual collections of measurements with similar indexes",
"properties": {
"hostname": {
"description": "The name of the server for the measurements",
"example": "NO1",
"type" : "string"
},
"metrics": {
"description": "Metrics set for the server",
"items": {
"description": "The measurement data for the server",
"properties": {
"collection": {
"description": "The name of the measurement collection, the expected values can be Single, Arrayed or the collection name if it exists",
"example": "Audits",
"type" : "string"
},
"names": {
"description": "An array of sets of name index, collection for a measurement",
"items": {
"properties": {
"index": {
"description": "The index value for the measurement. This value is applicable only for arrayed measurements",
"type" : "string"
},
"name": {
"description": "The index names for the measurement",
"type" : "string"
}
},
"type" :"object"
},
"type": "array"
} ,
"timestampValues":{
"description": "A set of timestamp and mapped measurement values",
"items": {
"description": "The timestamp value",
"properties": {
"timestamp": {
"example":"2016-09-01T07:38:48-04:00",
"pattern": "^[0-9]{4}[-][0-1]{1}[0-9]{1}[-][0-3]{1}[0-9]{1}T[0-2]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}([.][0-9]{1,7})?[+-](?:2[0-3]|[0-1][0-9])[:][0-5][0-9]?$",
"type": "string"
},
"values" :{
"description": "An array of measurement values",
"items": {
"type" :"string"
},
"type" :"array"
}
},
"type": "object"
},
"type": "array"
}
},
"type" :"object"
},
"type": "array"
}
},
"type" : "object"
}
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"cost": 36,
"endTime": "2016-09-01T07:38:48-04:00",
"interval": "15Min",
"scopeName": "All",
"scopeType": "Network",
"startTime": "2016-09-01T05:38:48-04:00",
"summary": [
{
"hostname": "ALL",
"metrics": [
{
"collection": "Single",
"names": [
{
"name": "Alarm.Crit"
},
{
"name": "Alarm.Major"
},
{
"name": "System.CPU_UtilPct_Average"
},
{
"name": "System.CPU_UtilPct_Peak"
},
{
"name": "System.Disk_UtilPct_Average"
},
{
"name": "System.Disk_UtilPct_Peak"
},
{
"name": "System.RAM_UtilPct_Average"
},
{
"name": "System.RAM_UtilPct_Peak"
},
{
"name": "System.ShMem_UtilPct_Average"
},
{
"name": "System.ShMem_UtilPct_Peak"
},
{
"name": "System.SwapIn_Rate_Average"
},
{
"name": "System.SwapIn_Rate_Peak"
},
{
"name": "System.SwapOut_Rate_Average"
},
{
"name": "System.SwapOut_Rate_Peak"
},
{
"name": "System.Swap_UtilPct_Average"
},
{
"name": "System.Swap_UtilPct_Peak"
}
],
"timestampValues": [
{
"timestamp": "2016-09-01T06:38:48-04:00",
"values": [
"161",
"0",
"45.077033",
"100",
"1.340956",
"2",
"25.953233",
"27",
"0.408722",
"1",
"0.000000",
"0",
"0.000000",
"0",
"0.000000",
"0"
]
}
]
},
{
"collection": "Arrayed",
"names": [
{
"index": "0",
"name": "System.CPU_CoreUtilPct_Average"
},
{
"index": "0",
"name": "System.CPU_CoreUtilPct_Peak"
}
],
"timestampValues": [
{
"timestamp": "2016-09-01T06:38:48-04:00",
"values": [
"45.077033",
"100"
]
}
]
}
]
}
]
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 429
request budget exceeded
Mon: Tasks
Tasks are used to perform longer running or periodically scheduled activities. This API allows the status of all running and recently run tasks to be examined. The id field provides the unique identifier for each task.
/mon/tasks
get /mon/tasks
Retrieves the task details for all tasks that match the GET request criteria. The request must supply a query parameter specifying a scope.
Target server: NOAM or SOAM
Secured by x-other
Request
Query Parameters
- scope_type: (one of Server, ServerGroup, NetworkElement)
Identifies the type of Server collection the results are limited to.
Example:
?scope_type=Server&scope_name=mynoa
- scope_name: (string)
Names the specific Server collection the results are limited to.
Example:
?scope_type=ServerGroup&scope_name=NO_SG
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/mon/collections/taskCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/mon/task/task.json",
"type" :"object",
"required": [
"name"
],
"properties": {
"id": {
"type": "string",
"description": "Task identifier"
},
"hostname": {
"type": "string",
"description": "Server running task"
},
"name": {
"type": "string",
"description": "Task Name"
},
"status": {
"type": "string",
"description": "Admin Status",
"enum": [ "Running", "Stopped", "Paused", "Completed", "Exception" ]
},
"startTime": {
"description": "The task start time",
"type": "string",
"example":"2015-08-12T14:46:13-04:00",
"pattern": "^[0-9]{4}[-][0-1]{1}[0-9]{1}[-][0-3]{1}[0-9]{1}T[0-2]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}([.][0-9]{1,7})?[+-](?:2[0-3]|[0-1][0-9])[:][0-5][0-9]?$"
},
"updateTime": {
"description": "The task status last update time",
"type": "string",
"example":"2015-08-12T14:47:43-04:00",
"pattern": "^[0-9]{4}[-][0-1]{1}[0-9]{1}[-][0-3]{1}[0-9]{1}T[0-2]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}([.][0-9]{1,7})?[+-](?:2[0-3]|[0-1][0-9])[:][0-5][0-9]?$"
},
"progress": {
"description": "The task progress",
"type": "integer",
"example":"100",
"minimum" : 0,
"maximum" : 100
},
"details": {
"description": "Task Details",
"type": "string",
"example": "Lots of interesting details..."
}
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"id": "ruby-noa:0",
"server": "ruby-noa",
"name": "joe",
"status": "completed",
"startTime": "2015-09-28T13:33:05-04:00",
"updateTime": "2015-09-28T13:34:11-04:00",
"progress": 100,
"details": "Lots of task details..."
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
/mon/tasks/{id}
get /mon/tasks/{id}
Returns the details for the specified task.
Target server: NOAM or SOAM
Secured by x-other
Request
URI Parameters
- id: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/mon/items/taskItem.json",
"type": "object",
"properties": {
"data":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/mon/task/task.json",
"type" :"object",
"required": [
"name"
],
"properties": {
"id": {
"type": "string",
"description": "Task identifier"
},
"hostname": {
"type": "string",
"description": "Server running task"
},
"name": {
"type": "string",
"description": "Task Name"
},
"status": {
"type": "string",
"description": "Admin Status",
"enum": [ "Running", "Stopped", "Paused", "Completed", "Exception" ]
},
"startTime": {
"description": "The task start time",
"type": "string",
"example":"2015-08-12T14:46:13-04:00",
"pattern": "^[0-9]{4}[-][0-1]{1}[0-9]{1}[-][0-3]{1}[0-9]{1}T[0-2]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}([.][0-9]{1,7})?[+-](?:2[0-3]|[0-1][0-9])[:][0-5][0-9]?$"
},
"updateTime": {
"description": "The task status last update time",
"type": "string",
"example":"2015-08-12T14:47:43-04:00",
"pattern": "^[0-9]{4}[-][0-1]{1}[0-9]{1}[-][0-3]{1}[0-9]{1}T[0-2]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}([.][0-9]{1,7})?[+-](?:2[0-3]|[0-1][0-9])[:][0-5][0-9]?$"
},
"progress": {
"description": "The task progress",
"type": "integer",
"example":"100",
"minimum" : 0,
"maximum" : 100
},
"details": {
"description": "Task Details",
"type": "string",
"example": "Lots of interesting details..."
}
}
}
,
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"id": "ruby-noa:0",
"server": "ruby-noa",
"name": "joe",
"status": "completed",
"startTime": "2015-09-28T13:33:05-04:00",
"updateTime": "2015-09-28T13:34:11-04:00",
"progress": 100,
"details": "Lots of task details..."
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
/mon/tasks/{id}/status
get /mon/tasks/{id}/status
Returns the current state of a running task, which can be Running, Paused, or Stopped.
Target server: NOAM or SOAM
Secured by x-other
Request
URI Parameters
- id: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema",
"id" : "http://dsr.cgbu.oracle.com/schemas/mon/task/taskstatus.json",
"type": "object",
"required": ["taskState"],
"properties": {
"taskState": {
"description": "Task State",
"enum": [ "Running", "Paused", "Stopped" ],
"example": "Running"
}
}
}
Example
{
"taskState": "Stopped"
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
Rbar: Addresses Range
The Address Range provides the mapping between a single address range and a Destination for routing.
/rbar/addressranges
get /rbar/addressranges
Returns all Address Ranges configured at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those Address Ranges meeting the request parameters are returned in the response.
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/collections/addressrangeCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/addressrange/addressrange.json",
"properties": {
"routingEntity": {
"description": "Type of Routing Entity. A Routing Entity can be a User Identity (Imsi, Msisdn, Impi, Impu or External Identifier) or an IP Address associated with the User Equipment (Ipv4, Ipv6PfxAddr or Unsigned16).",
"enum": [
"Imsi",
"Msisdn",
"Impi",
"Impu",
"Ipv4",
"Ipv6PfxAddr",
"Unsigned16",
"ExternalId"
],
"type": "string"
},
"routingEntityComp": {
"description": "Routing Entity Component of the Address which is required only if Routing Entity Type is External Identifier.",
"enum": [
"LocalIdentifier",
"DomainIdentifier"
],
"type": "string"
},
"destination": {
"description": "Destination name of the address (/rbar/destinations)",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"endAddr": {
"description": "End Address of the range.",
"type": "string",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^([0-9]){1,15}$"
},
"id": {
"description": "The natural identifier for the Address Range instance (which has no name).",
"readOnly": true,
"type": "string"
},
"ipv6PfxLength": {
"description": "Prefix length of IPv6-prefix address. This is applicable when routing entity is Ipv6PfxAddr.",
"maximum": 128,
"minimum": 1,
"type": "integer"
},
"startAddr": {
"description": "Start Address of the range.",
"type": "string",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^([0-9]){1,15}$"
},
"tableName": {
"description": "Table name of the address table (/rbar/addresstables)",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"nestedTableName": {
"description": "Address Table for next level search using the local Identifier of External Identifier AVP.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"routingEntity",
"destination",
"endAddr",
"startAddr",
"tableName"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"routingEntity": "Imsi",
"startAddr": "111111111111111",
"endAddr": "222222222222222",
"tableName": "AutImsi",
"destination": "AutDestination1"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /rbar/addressranges
Adds a new Address Range to the RBAR configuration. The Start Address and End Address for an Address Range shall not be overlapping or shall not already exists in the SOAM's configuration.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/addressrange/addressrange.json",
"properties": {
"routingEntity": {
"description": "Type of Routing Entity. A Routing Entity can be a User Identity (Imsi, Msisdn, Impi, Impu or External Identifier) or an IP Address associated with the User Equipment (Ipv4, Ipv6PfxAddr or Unsigned16).",
"enum": [
"Imsi",
"Msisdn",
"Impi",
"Impu",
"Ipv4",
"Ipv6PfxAddr",
"Unsigned16",
"ExternalId"
],
"type": "string"
},
"routingEntityComp": {
"description": "Routing Entity Component of the Address which is required only if Routing Entity Type is External Identifier.",
"enum": [
"LocalIdentifier",
"DomainIdentifier"
],
"type": "string"
},
"destination": {
"description": "Destination name of the address (/rbar/destinations)",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"endAddr": {
"description": "End Address of the range.",
"type": "string",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^([0-9]){1,15}$"
},
"id": {
"description": "The natural identifier for the Address Range instance (which has no name).",
"readOnly": true,
"type": "string"
},
"ipv6PfxLength": {
"description": "Prefix length of IPv6-prefix address. This is applicable when routing entity is Ipv6PfxAddr.",
"maximum": 128,
"minimum": 1,
"type": "integer"
},
"startAddr": {
"description": "Start Address of the range.",
"type": "string",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^([0-9]){1,15}$"
},
"tableName": {
"description": "Table name of the address table (/rbar/addresstables)",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"nestedTableName": {
"description": "Address Table for next level search using the local Identifier of External Identifier AVP.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"routingEntity",
"destination",
"endAddr",
"startAddr",
"tableName"
],
"type": "object"
}
Example
{
"routingEntity": "Imsi",
"startAddr": "111111111111111",
"endAddr": "222222222222222",
"tableName": "AutImsi",
"destination": "AutDestination1"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/rbar/addressranges/{TableName}
get /rbar/addressranges/{TableName}
Returns the configuration details for the specified Address Range. If the specified Address Range does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- TableName: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/items/addressrangeItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/addressrange/addressrange.json",
"properties": {
"routingEntity": {
"description": "Type of Routing Entity. A Routing Entity can be a User Identity (Imsi, Msisdn, Impi, Impu or External Identifier) or an IP Address associated with the User Equipment (Ipv4, Ipv6PfxAddr or Unsigned16).",
"enum": [
"Imsi",
"Msisdn",
"Impi",
"Impu",
"Ipv4",
"Ipv6PfxAddr",
"Unsigned16",
"ExternalId"
],
"type": "string"
},
"routingEntityComp": {
"description": "Routing Entity Component of the Address which is required only if Routing Entity Type is External Identifier.",
"enum": [
"LocalIdentifier",
"DomainIdentifier"
],
"type": "string"
},
"destination": {
"description": "Destination name of the address (/rbar/destinations)",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"endAddr": {
"description": "End Address of the range.",
"type": "string",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^([0-9]){1,15}$"
},
"id": {
"description": "The natural identifier for the Address Range instance (which has no name).",
"readOnly": true,
"type": "string"
},
"ipv6PfxLength": {
"description": "Prefix length of IPv6-prefix address. This is applicable when routing entity is Ipv6PfxAddr.",
"maximum": 128,
"minimum": 1,
"type": "integer"
},
"startAddr": {
"description": "Start Address of the range.",
"type": "string",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^([0-9]){1,15}$"
},
"tableName": {
"description": "Table name of the address table (/rbar/addresstables)",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"nestedTableName": {
"description": "Address Table for next level search using the local Identifier of External Identifier AVP.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"routingEntity",
"destination",
"endAddr",
"startAddr",
"tableName"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"routingEntity": "Imsi",
"startAddr": "111111111111111",
"endAddr": "222222222222222",
"tableName": "AutImsi",
"destination": "AutDestination1"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /rbar/addressranges/{TableName}
Updates the configuration for the specified Address Range. If the provided Address Range data is invalid in any way, the update will fail, resulting in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- TableName: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/addressrange/addressrange.json",
"properties": {
"routingEntity": {
"description": "Type of Routing Entity. A Routing Entity can be a User Identity (Imsi, Msisdn, Impi, Impu or External Identifier) or an IP Address associated with the User Equipment (Ipv4, Ipv6PfxAddr or Unsigned16).",
"enum": [
"Imsi",
"Msisdn",
"Impi",
"Impu",
"Ipv4",
"Ipv6PfxAddr",
"Unsigned16",
"ExternalId"
],
"type": "string"
},
"routingEntityComp": {
"description": "Routing Entity Component of the Address which is required only if Routing Entity Type is External Identifier.",
"enum": [
"LocalIdentifier",
"DomainIdentifier"
],
"type": "string"
},
"destination": {
"description": "Destination name of the address (/rbar/destinations)",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"endAddr": {
"description": "End Address of the range.",
"type": "string",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^([0-9]){1,15}$"
},
"id": {
"description": "The natural identifier for the Address Range instance (which has no name).",
"readOnly": true,
"type": "string"
},
"ipv6PfxLength": {
"description": "Prefix length of IPv6-prefix address. This is applicable when routing entity is Ipv6PfxAddr.",
"maximum": 128,
"minimum": 1,
"type": "integer"
},
"startAddr": {
"description": "Start Address of the range.",
"type": "string",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^([0-9]){1,15}$"
},
"tableName": {
"description": "Table name of the address table (/rbar/addresstables)",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"nestedTableName": {
"description": "Address Table for next level search using the local Identifier of External Identifier AVP.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"routingEntity",
"destination",
"endAddr",
"startAddr",
"tableName"
],
"type": "object"
}
Example
{
"routingEntity": "Imsi",
"startAddr": "111111111111111",
"endAddr": "222222222222222",
"tableName": "AutImsi",
"destination": "AutDestination1"
}
delete /rbar/addressranges/{TableName}
Deletes the specified Address Range from the SOAM configuration. An Address Range will only be deleted if all delete validation checks pass.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- TableName: required (string)
Rbar: Address Resolutions
Address Resolutions allows to define the routing relationship between message content and an address by mapping a Diameter Application ID, Command Code, and Routing Entity Type to a user-configured address (a range or individual address). An Address Resolution supports up to three prioritized Routing Entity Types for each Application ID and Command Code (highest priority - Primary Routing Entity Type - and lowest priority - Tertiary Routing Entity Type).
/rbar/addressresolutions
get /rbar/addressresolutions
Returns all Address Resolutions configured at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those Address Resolutions meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section).
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/collections/addressresolutionCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/addressresolution/addressresolution.json",
"properties": {
"applId": {
"description": "The Application Id is the numeric value used to identify a Diameter Application.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"cmdCode": {
"description": "Command Code value in Diameter message.",
"maxLength": 30,
"type": "string"
},
"id": {
"description": "The natural identifier for the Address Resolution instance (which has no name).",
"readOnly": true,
"type": "string"
},
"primaryRoutingEntity": {
"description": "Type of Routing Entity. A Routing Entity can be a User Identity (Imsi, Msisdn, Impi or Impu) or an IP Address associated with the User Equipment (Ipv4, Ipv6PfxAddr or Unsigned16).",
"enum": [
"Imsi",
"Msisdn",
"Impi",
"Impu",
"Ipv4",
"Ipv6PfxAddr",
"Unsigned16",
"ExternalId"
],
"type": "string"
},
"primaryRoutingEntityAddrTableName": {
"description": "Address Table name (/rbar/addresstables) for primary routing entity type.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"primaryRoutingEntityPrimaryAvp": {
"description": "Primary AVP which will be used for extracting the Primary Routing Entity address.",
"enum": [
"PublicIdentity",
"SvcInfoSubscrId0",
"SvcInfoSubscrId1",
"SvcInfoSubscrId2",
"SvcInfoSubscrId3",
"SvcInfoSubscrId4",
"SubscriptionId0",
"SubscriptionId1",
"SubscriptionId2",
"SubscriptionId3",
"SubscriptionId4",
"UserIdentityMsisdn",
"UserIdentityPublic",
"UserName",
"FramedIpAddress",
"FramedIpv6Prefix",
"SvcInfoPsInfo3gppcc",
"Msisdn",
"UserIdentifierMsisdn",
"UserIdentifierUserName",
"UserIdentifierExternalId",
"DeviceActionExternalId"
],
"type": "string"
},
"primaryRoutingEntitySecondaryAvp": {
"description": "Secondary AVP which will be used for extracting the Primary Routing Entity address.",
"enum": [
"PublicIdentity",
"SvcInfoSubscrId0",
"SvcInfoSubscrId1",
"SvcInfoSubscrId2",
"SvcInfoSubscrId3",
"SvcInfoSubscrId4",
"SubscriptionId0",
"SubscriptionId1",
"SubscriptionId2",
"SubscriptionId3",
"SubscriptionId4",
"UserIdentityMsisdn",
"UserIdentityPublic",
"UserName",
"FramedIpAddress",
"FramedIpv6Prefix",
"SvcInfoPsInfo3gppcc",
"Msisdn",
"UserIdentifierMsisdn",
"UserIdentifierUserName",
"UserIdentifierExternalId",
"DeviceActionExternalId"
],
"type": "string"
},
"secondaryRoutingEntity": {
"description": "Type of Routing Entity. A Routing Entity can be a User Identity (Imsi, Msisdn, Impi or Impu) or an IP Address associated with the User Equipment (Ipv4, Ipv6PfxAddr or Unsigned16).",
"enum": [
"Imsi",
"Msisdn",
"Impi",
"Impu",
"Ipv4",
"Ipv6PfxAddr",
"Unsigned16",
"ExternalId"
],
"type": "string"
},
"secondaryRoutingEntityAddrTableName": {
"description": "Address Table name (/rbar/addresstables) for secondary routing entity type.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"secondaryRoutingEntityPrimaryAvp": {
"description": "Primary AVP which will be used for extracting the Secondary Routing Entity address.",
"enum": [
"PublicIdentity",
"SvcInfoSubscrId0",
"SvcInfoSubscrId1",
"SvcInfoSubscrId2",
"SvcInfoSubscrId3",
"SvcInfoSubscrId4",
"SubscriptionId0",
"SubscriptionId1",
"SubscriptionId2",
"SubscriptionId3",
"SubscriptionId4",
"UserIdentityMsisdn",
"UserIdentityPublic",
"UserName",
"FramedIpAddress",
"FramedIpv6Prefix",
"SvcInfoPsInfo3gppcc",
"Msisdn",
"UserIdentifierMsisdn",
"UserIdentifierUserName",
"UserIdentifierExternalId",
"DeviceActionExternalId"
],
"type": "string"
},
"secondaryRoutingEntitySecondaryAvp": {
"description": "Secondary AVP which will be used for extracting the Secondary Routing Entity address.",
"enum": [
"PublicIdentity",
"SvcInfoSubscrId0",
"SvcInfoSubscrId1",
"SvcInfoSubscrId2",
"SvcInfoSubscrId3",
"SvcInfoSubscrId4",
"SubscriptionId0",
"SubscriptionId1",
"SubscriptionId2",
"SubscriptionId3",
"SubscriptionId4",
"UserIdentityMsisdn",
"UserIdentityPublic",
"UserName",
"FramedIpAddress",
"FramedIpv6Prefix",
"SvcInfoPsInfo3gppcc",
"Msisdn",
"UserIdentifierMsisdn",
"UserIdentifierUserName",
"UserIdentifierExternalId",
"DeviceActionExternalId"
],
"type": "string"
},
"tertiaryRoutingEntity": {
"description": "Type of Routing Entity. A Routing Entity can be a User Identity (Imsi, Msisdn, Impi or Impu) or an IP Address associated with the User Equipment (Ipv4, Ipv6PfxAddr or Unsigned16).",
"enum": [
"Imsi",
"Msisdn",
"Impi",
"Impu",
"Ipv4",
"Ipv6PfxAddr",
"Unsigned16",
"ExternalId"
],
"type": "string"
},
"tertiaryRoutingEntityAddrTableName": {
"description": "Address Table name (/rbar/addresstables) for tertiary routing entity type.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"tertiaryRoutingEntityPrimaryAvp": {
"description": "Primary AVP which will be used for extracting the Tertiary Routing Entity address.",
"enum": [
"PublicIdentity",
"SvcInfoSubscrId0",
"SvcInfoSubscrId1",
"SvcInfoSubscrId2",
"SvcInfoSubscrId3",
"SvcInfoSubscrId4",
"SubscriptionId0",
"SubscriptionId1",
"SubscriptionId2",
"SubscriptionId3",
"SubscriptionId4",
"UserIdentityMsisdn",
"UserIdentityPublic",
"UserName",
"FramedIpAddress",
"FramedIpv6Prefix",
"SvcInfoPsInfo3gppcc",
"Msisdn",
"UserIdentifierMsisdn",
"UserIdentifierUserName",
"UserIdentifierExternalId",
"DeviceActionExternalId"
],
"type": "string"
},
"tertiaryRoutingEntitySecondaryAvp": {
"description": "Secondary AVP which will be used for extracting the Tertiary Routing Entity address.",
"enum": [
"PublicIdentity",
"SvcInfoSubscrId0",
"SvcInfoSubscrId1",
"SvcInfoSubscrId2",
"SvcInfoSubscrId3",
"SvcInfoSubscrId4",
"SubscriptionId0",
"SubscriptionId1",
"SubscriptionId2",
"SubscriptionId3",
"SubscriptionId4",
"UserIdentityMsisdn",
"UserIdentityPublic",
"UserName",
"FramedIpAddress",
"FramedIpv6Prefix",
"SvcInfoPsInfo3gppcc",
"Msisdn",
"UserIdentifierMsisdn",
"UserIdentifierUserName",
"UserIdentifierExternalId",
"DeviceActionExternalId"
],
"type": "string"
}
},
"required": [
"applId",
"cmdCode",
"primaryRoutingEntity",
"primaryRoutingEntityAddrTableName",
"primaryRoutingEntityPrimaryAvp"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"applId": 167777251,
"cmdCode": "316",
"primaryRoutingEntity": "Imsi",
"primaryRoutingEntityPrimaryAvp": "SvcInfoSubscrId1",
"primaryRoutingEntityAddrTableName": "AutImsi",
"secondaryRoutingEntity": "Msisdn",
"secondaryRoutingEntityPrimaryAvp": "UserIdentityMsisdn",
"secondaryRoutingEntityAddrTableName": "AutMsisdn",
"tertiaryRoutingEntity": "ExternalId",
"tertiaryRoutingEntityPrimaryAvp": "UserIdentifierExternalId",
"tertiaryRoutingEntityAddrTableName": "AutExtDomainId"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /rbar/addressresolutions
Adds a new Address resolution to the DSR configuration. The new Address resolution must have an Application Id and Command Code combination that is unique to the SOAM's configuration
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/addressresolution/addressresolution.json",
"properties": {
"applId": {
"description": "The Application Id is the numeric value used to identify a Diameter Application.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"cmdCode": {
"description": "Command Code value in Diameter message.",
"maxLength": 30,
"type": "string"
},
"id": {
"description": "The natural identifier for the Address Resolution instance (which has no name).",
"readOnly": true,
"type": "string"
},
"primaryRoutingEntity": {
"description": "Type of Routing Entity. A Routing Entity can be a User Identity (Imsi, Msisdn, Impi or Impu) or an IP Address associated with the User Equipment (Ipv4, Ipv6PfxAddr or Unsigned16).",
"enum": [
"Imsi",
"Msisdn",
"Impi",
"Impu",
"Ipv4",
"Ipv6PfxAddr",
"Unsigned16",
"ExternalId"
],
"type": "string"
},
"primaryRoutingEntityAddrTableName": {
"description": "Address Table name (/rbar/addresstables) for primary routing entity type.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"primaryRoutingEntityPrimaryAvp": {
"description": "Primary AVP which will be used for extracting the Primary Routing Entity address.",
"enum": [
"PublicIdentity",
"SvcInfoSubscrId0",
"SvcInfoSubscrId1",
"SvcInfoSubscrId2",
"SvcInfoSubscrId3",
"SvcInfoSubscrId4",
"SubscriptionId0",
"SubscriptionId1",
"SubscriptionId2",
"SubscriptionId3",
"SubscriptionId4",
"UserIdentityMsisdn",
"UserIdentityPublic",
"UserName",
"FramedIpAddress",
"FramedIpv6Prefix",
"SvcInfoPsInfo3gppcc",
"Msisdn",
"UserIdentifierMsisdn",
"UserIdentifierUserName",
"UserIdentifierExternalId",
"DeviceActionExternalId"
],
"type": "string"
},
"primaryRoutingEntitySecondaryAvp": {
"description": "Secondary AVP which will be used for extracting the Primary Routing Entity address.",
"enum": [
"PublicIdentity",
"SvcInfoSubscrId0",
"SvcInfoSubscrId1",
"SvcInfoSubscrId2",
"SvcInfoSubscrId3",
"SvcInfoSubscrId4",
"SubscriptionId0",
"SubscriptionId1",
"SubscriptionId2",
"SubscriptionId3",
"SubscriptionId4",
"UserIdentityMsisdn",
"UserIdentityPublic",
"UserName",
"FramedIpAddress",
"FramedIpv6Prefix",
"SvcInfoPsInfo3gppcc",
"Msisdn",
"UserIdentifierMsisdn",
"UserIdentifierUserName",
"UserIdentifierExternalId",
"DeviceActionExternalId"
],
"type": "string"
},
"secondaryRoutingEntity": {
"description": "Type of Routing Entity. A Routing Entity can be a User Identity (Imsi, Msisdn, Impi or Impu) or an IP Address associated with the User Equipment (Ipv4, Ipv6PfxAddr or Unsigned16).",
"enum": [
"Imsi",
"Msisdn",
"Impi",
"Impu",
"Ipv4",
"Ipv6PfxAddr",
"Unsigned16",
"ExternalId"
],
"type": "string"
},
"secondaryRoutingEntityAddrTableName": {
"description": "Address Table name (/rbar/addresstables) for secondary routing entity type.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"secondaryRoutingEntityPrimaryAvp": {
"description": "Primary AVP which will be used for extracting the Secondary Routing Entity address.",
"enum": [
"PublicIdentity",
"SvcInfoSubscrId0",
"SvcInfoSubscrId1",
"SvcInfoSubscrId2",
"SvcInfoSubscrId3",
"SvcInfoSubscrId4",
"SubscriptionId0",
"SubscriptionId1",
"SubscriptionId2",
"SubscriptionId3",
"SubscriptionId4",
"UserIdentityMsisdn",
"UserIdentityPublic",
"UserName",
"FramedIpAddress",
"FramedIpv6Prefix",
"SvcInfoPsInfo3gppcc",
"Msisdn",
"UserIdentifierMsisdn",
"UserIdentifierUserName",
"UserIdentifierExternalId",
"DeviceActionExternalId"
],
"type": "string"
},
"secondaryRoutingEntitySecondaryAvp": {
"description": "Secondary AVP which will be used for extracting the Secondary Routing Entity address.",
"enum": [
"PublicIdentity",
"SvcInfoSubscrId0",
"SvcInfoSubscrId1",
"SvcInfoSubscrId2",
"SvcInfoSubscrId3",
"SvcInfoSubscrId4",
"SubscriptionId0",
"SubscriptionId1",
"SubscriptionId2",
"SubscriptionId3",
"SubscriptionId4",
"UserIdentityMsisdn",
"UserIdentityPublic",
"UserName",
"FramedIpAddress",
"FramedIpv6Prefix",
"SvcInfoPsInfo3gppcc",
"Msisdn",
"UserIdentifierMsisdn",
"UserIdentifierUserName",
"UserIdentifierExternalId",
"DeviceActionExternalId"
],
"type": "string"
},
"tertiaryRoutingEntity": {
"description": "Type of Routing Entity. A Routing Entity can be a User Identity (Imsi, Msisdn, Impi or Impu) or an IP Address associated with the User Equipment (Ipv4, Ipv6PfxAddr or Unsigned16).",
"enum": [
"Imsi",
"Msisdn",
"Impi",
"Impu",
"Ipv4",
"Ipv6PfxAddr",
"Unsigned16",
"ExternalId"
],
"type": "string"
},
"tertiaryRoutingEntityAddrTableName": {
"description": "Address Table name (/rbar/addresstables) for tertiary routing entity type.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"tertiaryRoutingEntityPrimaryAvp": {
"description": "Primary AVP which will be used for extracting the Tertiary Routing Entity address.",
"enum": [
"PublicIdentity",
"SvcInfoSubscrId0",
"SvcInfoSubscrId1",
"SvcInfoSubscrId2",
"SvcInfoSubscrId3",
"SvcInfoSubscrId4",
"SubscriptionId0",
"SubscriptionId1",
"SubscriptionId2",
"SubscriptionId3",
"SubscriptionId4",
"UserIdentityMsisdn",
"UserIdentityPublic",
"UserName",
"FramedIpAddress",
"FramedIpv6Prefix",
"SvcInfoPsInfo3gppcc",
"Msisdn",
"UserIdentifierMsisdn",
"UserIdentifierUserName",
"UserIdentifierExternalId",
"DeviceActionExternalId"
],
"type": "string"
},
"tertiaryRoutingEntitySecondaryAvp": {
"description": "Secondary AVP which will be used for extracting the Tertiary Routing Entity address.",
"enum": [
"PublicIdentity",
"SvcInfoSubscrId0",
"SvcInfoSubscrId1",
"SvcInfoSubscrId2",
"SvcInfoSubscrId3",
"SvcInfoSubscrId4",
"SubscriptionId0",
"SubscriptionId1",
"SubscriptionId2",
"SubscriptionId3",
"SubscriptionId4",
"UserIdentityMsisdn",
"UserIdentityPublic",
"UserName",
"FramedIpAddress",
"FramedIpv6Prefix",
"SvcInfoPsInfo3gppcc",
"Msisdn",
"UserIdentifierMsisdn",
"UserIdentifierUserName",
"UserIdentifierExternalId",
"DeviceActionExternalId"
],
"type": "string"
}
},
"required": [
"applId",
"cmdCode",
"primaryRoutingEntity",
"primaryRoutingEntityAddrTableName",
"primaryRoutingEntityPrimaryAvp"
],
"type": "object"
}
Example
{
"applId": 167777251,
"cmdCode": "316",
"primaryRoutingEntity": "Imsi",
"primaryRoutingEntityPrimaryAvp": "SvcInfoSubscrId1",
"primaryRoutingEntityAddrTableName": "AutImsi",
"secondaryRoutingEntity": "Msisdn",
"secondaryRoutingEntityPrimaryAvp": "UserIdentityMsisdn",
"secondaryRoutingEntityAddrTableName": "AutMsisdn",
"tertiaryRoutingEntity": "ExternalId",
"tertiaryRoutingEntityPrimaryAvp": "UserIdentifierExternalId",
"tertiaryRoutingEntityAddrTableName": "AutExtDomainId"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/rbar/addressresolutions/{id}
get /rbar/addressresolutions/{id}
Returns the configuration details for the specified Address resolution. If the specified Address resolution does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- id: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/items/addressresolutionItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/addressresolution/addressresolution.json",
"properties": {
"applId": {
"description": "The Application Id is the numeric value used to identify a Diameter Application.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"cmdCode": {
"description": "Command Code value in Diameter message.",
"maxLength": 30,
"type": "string"
},
"id": {
"description": "The natural identifier for the Address Resolution instance (which has no name).",
"readOnly": true,
"type": "string"
},
"primaryRoutingEntity": {
"description": "Type of Routing Entity. A Routing Entity can be a User Identity (Imsi, Msisdn, Impi or Impu) or an IP Address associated with the User Equipment (Ipv4, Ipv6PfxAddr or Unsigned16).",
"enum": [
"Imsi",
"Msisdn",
"Impi",
"Impu",
"Ipv4",
"Ipv6PfxAddr",
"Unsigned16",
"ExternalId"
],
"type": "string"
},
"primaryRoutingEntityAddrTableName": {
"description": "Address Table name (/rbar/addresstables) for primary routing entity type.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"primaryRoutingEntityPrimaryAvp": {
"description": "Primary AVP which will be used for extracting the Primary Routing Entity address.",
"enum": [
"PublicIdentity",
"SvcInfoSubscrId0",
"SvcInfoSubscrId1",
"SvcInfoSubscrId2",
"SvcInfoSubscrId3",
"SvcInfoSubscrId4",
"SubscriptionId0",
"SubscriptionId1",
"SubscriptionId2",
"SubscriptionId3",
"SubscriptionId4",
"UserIdentityMsisdn",
"UserIdentityPublic",
"UserName",
"FramedIpAddress",
"FramedIpv6Prefix",
"SvcInfoPsInfo3gppcc",
"Msisdn",
"UserIdentifierMsisdn",
"UserIdentifierUserName",
"UserIdentifierExternalId",
"DeviceActionExternalId"
],
"type": "string"
},
"primaryRoutingEntitySecondaryAvp": {
"description": "Secondary AVP which will be used for extracting the Primary Routing Entity address.",
"enum": [
"PublicIdentity",
"SvcInfoSubscrId0",
"SvcInfoSubscrId1",
"SvcInfoSubscrId2",
"SvcInfoSubscrId3",
"SvcInfoSubscrId4",
"SubscriptionId0",
"SubscriptionId1",
"SubscriptionId2",
"SubscriptionId3",
"SubscriptionId4",
"UserIdentityMsisdn",
"UserIdentityPublic",
"UserName",
"FramedIpAddress",
"FramedIpv6Prefix",
"SvcInfoPsInfo3gppcc",
"Msisdn",
"UserIdentifierMsisdn",
"UserIdentifierUserName",
"UserIdentifierExternalId",
"DeviceActionExternalId"
],
"type": "string"
},
"secondaryRoutingEntity": {
"description": "Type of Routing Entity. A Routing Entity can be a User Identity (Imsi, Msisdn, Impi or Impu) or an IP Address associated with the User Equipment (Ipv4, Ipv6PfxAddr or Unsigned16).",
"enum": [
"Imsi",
"Msisdn",
"Impi",
"Impu",
"Ipv4",
"Ipv6PfxAddr",
"Unsigned16",
"ExternalId"
],
"type": "string"
},
"secondaryRoutingEntityAddrTableName": {
"description": "Address Table name (/rbar/addresstables) for secondary routing entity type.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"secondaryRoutingEntityPrimaryAvp": {
"description": "Primary AVP which will be used for extracting the Secondary Routing Entity address.",
"enum": [
"PublicIdentity",
"SvcInfoSubscrId0",
"SvcInfoSubscrId1",
"SvcInfoSubscrId2",
"SvcInfoSubscrId3",
"SvcInfoSubscrId4",
"SubscriptionId0",
"SubscriptionId1",
"SubscriptionId2",
"SubscriptionId3",
"SubscriptionId4",
"UserIdentityMsisdn",
"UserIdentityPublic",
"UserName",
"FramedIpAddress",
"FramedIpv6Prefix",
"SvcInfoPsInfo3gppcc",
"Msisdn",
"UserIdentifierMsisdn",
"UserIdentifierUserName",
"UserIdentifierExternalId",
"DeviceActionExternalId"
],
"type": "string"
},
"secondaryRoutingEntitySecondaryAvp": {
"description": "Secondary AVP which will be used for extracting the Secondary Routing Entity address.",
"enum": [
"PublicIdentity",
"SvcInfoSubscrId0",
"SvcInfoSubscrId1",
"SvcInfoSubscrId2",
"SvcInfoSubscrId3",
"SvcInfoSubscrId4",
"SubscriptionId0",
"SubscriptionId1",
"SubscriptionId2",
"SubscriptionId3",
"SubscriptionId4",
"UserIdentityMsisdn",
"UserIdentityPublic",
"UserName",
"FramedIpAddress",
"FramedIpv6Prefix",
"SvcInfoPsInfo3gppcc",
"Msisdn",
"UserIdentifierMsisdn",
"UserIdentifierUserName",
"UserIdentifierExternalId",
"DeviceActionExternalId"
],
"type": "string"
},
"tertiaryRoutingEntity": {
"description": "Type of Routing Entity. A Routing Entity can be a User Identity (Imsi, Msisdn, Impi or Impu) or an IP Address associated with the User Equipment (Ipv4, Ipv6PfxAddr or Unsigned16).",
"enum": [
"Imsi",
"Msisdn",
"Impi",
"Impu",
"Ipv4",
"Ipv6PfxAddr",
"Unsigned16",
"ExternalId"
],
"type": "string"
},
"tertiaryRoutingEntityAddrTableName": {
"description": "Address Table name (/rbar/addresstables) for tertiary routing entity type.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"tertiaryRoutingEntityPrimaryAvp": {
"description": "Primary AVP which will be used for extracting the Tertiary Routing Entity address.",
"enum": [
"PublicIdentity",
"SvcInfoSubscrId0",
"SvcInfoSubscrId1",
"SvcInfoSubscrId2",
"SvcInfoSubscrId3",
"SvcInfoSubscrId4",
"SubscriptionId0",
"SubscriptionId1",
"SubscriptionId2",
"SubscriptionId3",
"SubscriptionId4",
"UserIdentityMsisdn",
"UserIdentityPublic",
"UserName",
"FramedIpAddress",
"FramedIpv6Prefix",
"SvcInfoPsInfo3gppcc",
"Msisdn",
"UserIdentifierMsisdn",
"UserIdentifierUserName",
"UserIdentifierExternalId",
"DeviceActionExternalId"
],
"type": "string"
},
"tertiaryRoutingEntitySecondaryAvp": {
"description": "Secondary AVP which will be used for extracting the Tertiary Routing Entity address.",
"enum": [
"PublicIdentity",
"SvcInfoSubscrId0",
"SvcInfoSubscrId1",
"SvcInfoSubscrId2",
"SvcInfoSubscrId3",
"SvcInfoSubscrId4",
"SubscriptionId0",
"SubscriptionId1",
"SubscriptionId2",
"SubscriptionId3",
"SubscriptionId4",
"UserIdentityMsisdn",
"UserIdentityPublic",
"UserName",
"FramedIpAddress",
"FramedIpv6Prefix",
"SvcInfoPsInfo3gppcc",
"Msisdn",
"UserIdentifierMsisdn",
"UserIdentifierUserName",
"UserIdentifierExternalId",
"DeviceActionExternalId"
],
"type": "string"
}
},
"required": [
"applId",
"cmdCode",
"primaryRoutingEntity",
"primaryRoutingEntityAddrTableName",
"primaryRoutingEntityPrimaryAvp"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"applId": 167777251,
"cmdCode": "316",
"primaryRoutingEntity": "Imsi",
"primaryRoutingEntityPrimaryAvp": "SvcInfoSubscrId1",
"primaryRoutingEntityAddrTableName": "AutImsi",
"secondaryRoutingEntity": "Msisdn",
"secondaryRoutingEntityPrimaryAvp": "UserIdentityMsisdn",
"secondaryRoutingEntityAddrTableName": "AutMsisdn",
"tertiaryRoutingEntity": "ExternalId",
"tertiaryRoutingEntityPrimaryAvp": "UserIdentifierExternalId",
"tertiaryRoutingEntityAddrTableName": "AutExtDomainId"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /rbar/addressresolutions/{id}
Updates the configuration for the specified Address Resolution. If the provided Address Resolution data is invalid in any way, the update will fail, resulting in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- id: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/addressresolution/addressresolution.json",
"properties": {
"applId": {
"description": "The Application Id is the numeric value used to identify a Diameter Application.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"cmdCode": {
"description": "Command Code value in Diameter message.",
"maxLength": 30,
"type": "string"
},
"id": {
"description": "The natural identifier for the Address Resolution instance (which has no name).",
"readOnly": true,
"type": "string"
},
"primaryRoutingEntity": {
"description": "Type of Routing Entity. A Routing Entity can be a User Identity (Imsi, Msisdn, Impi or Impu) or an IP Address associated with the User Equipment (Ipv4, Ipv6PfxAddr or Unsigned16).",
"enum": [
"Imsi",
"Msisdn",
"Impi",
"Impu",
"Ipv4",
"Ipv6PfxAddr",
"Unsigned16",
"ExternalId"
],
"type": "string"
},
"primaryRoutingEntityAddrTableName": {
"description": "Address Table name (/rbar/addresstables) for primary routing entity type.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"primaryRoutingEntityPrimaryAvp": {
"description": "Primary AVP which will be used for extracting the Primary Routing Entity address.",
"enum": [
"PublicIdentity",
"SvcInfoSubscrId0",
"SvcInfoSubscrId1",
"SvcInfoSubscrId2",
"SvcInfoSubscrId3",
"SvcInfoSubscrId4",
"SubscriptionId0",
"SubscriptionId1",
"SubscriptionId2",
"SubscriptionId3",
"SubscriptionId4",
"UserIdentityMsisdn",
"UserIdentityPublic",
"UserName",
"FramedIpAddress",
"FramedIpv6Prefix",
"SvcInfoPsInfo3gppcc",
"Msisdn",
"UserIdentifierMsisdn",
"UserIdentifierUserName",
"UserIdentifierExternalId",
"DeviceActionExternalId"
],
"type": "string"
},
"primaryRoutingEntitySecondaryAvp": {
"description": "Secondary AVP which will be used for extracting the Primary Routing Entity address.",
"enum": [
"PublicIdentity",
"SvcInfoSubscrId0",
"SvcInfoSubscrId1",
"SvcInfoSubscrId2",
"SvcInfoSubscrId3",
"SvcInfoSubscrId4",
"SubscriptionId0",
"SubscriptionId1",
"SubscriptionId2",
"SubscriptionId3",
"SubscriptionId4",
"UserIdentityMsisdn",
"UserIdentityPublic",
"UserName",
"FramedIpAddress",
"FramedIpv6Prefix",
"SvcInfoPsInfo3gppcc",
"Msisdn",
"UserIdentifierMsisdn",
"UserIdentifierUserName",
"UserIdentifierExternalId",
"DeviceActionExternalId"
],
"type": "string"
},
"secondaryRoutingEntity": {
"description": "Type of Routing Entity. A Routing Entity can be a User Identity (Imsi, Msisdn, Impi or Impu) or an IP Address associated with the User Equipment (Ipv4, Ipv6PfxAddr or Unsigned16).",
"enum": [
"Imsi",
"Msisdn",
"Impi",
"Impu",
"Ipv4",
"Ipv6PfxAddr",
"Unsigned16",
"ExternalId"
],
"type": "string"
},
"secondaryRoutingEntityAddrTableName": {
"description": "Address Table name (/rbar/addresstables) for secondary routing entity type.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"secondaryRoutingEntityPrimaryAvp": {
"description": "Primary AVP which will be used for extracting the Secondary Routing Entity address.",
"enum": [
"PublicIdentity",
"SvcInfoSubscrId0",
"SvcInfoSubscrId1",
"SvcInfoSubscrId2",
"SvcInfoSubscrId3",
"SvcInfoSubscrId4",
"SubscriptionId0",
"SubscriptionId1",
"SubscriptionId2",
"SubscriptionId3",
"SubscriptionId4",
"UserIdentityMsisdn",
"UserIdentityPublic",
"UserName",
"FramedIpAddress",
"FramedIpv6Prefix",
"SvcInfoPsInfo3gppcc",
"Msisdn",
"UserIdentifierMsisdn",
"UserIdentifierUserName",
"UserIdentifierExternalId",
"DeviceActionExternalId"
],
"type": "string"
},
"secondaryRoutingEntitySecondaryAvp": {
"description": "Secondary AVP which will be used for extracting the Secondary Routing Entity address.",
"enum": [
"PublicIdentity",
"SvcInfoSubscrId0",
"SvcInfoSubscrId1",
"SvcInfoSubscrId2",
"SvcInfoSubscrId3",
"SvcInfoSubscrId4",
"SubscriptionId0",
"SubscriptionId1",
"SubscriptionId2",
"SubscriptionId3",
"SubscriptionId4",
"UserIdentityMsisdn",
"UserIdentityPublic",
"UserName",
"FramedIpAddress",
"FramedIpv6Prefix",
"SvcInfoPsInfo3gppcc",
"Msisdn",
"UserIdentifierMsisdn",
"UserIdentifierUserName",
"UserIdentifierExternalId",
"DeviceActionExternalId"
],
"type": "string"
},
"tertiaryRoutingEntity": {
"description": "Type of Routing Entity. A Routing Entity can be a User Identity (Imsi, Msisdn, Impi or Impu) or an IP Address associated with the User Equipment (Ipv4, Ipv6PfxAddr or Unsigned16).",
"enum": [
"Imsi",
"Msisdn",
"Impi",
"Impu",
"Ipv4",
"Ipv6PfxAddr",
"Unsigned16",
"ExternalId"
],
"type": "string"
},
"tertiaryRoutingEntityAddrTableName": {
"description": "Address Table name (/rbar/addresstables) for tertiary routing entity type.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"tertiaryRoutingEntityPrimaryAvp": {
"description": "Primary AVP which will be used for extracting the Tertiary Routing Entity address.",
"enum": [
"PublicIdentity",
"SvcInfoSubscrId0",
"SvcInfoSubscrId1",
"SvcInfoSubscrId2",
"SvcInfoSubscrId3",
"SvcInfoSubscrId4",
"SubscriptionId0",
"SubscriptionId1",
"SubscriptionId2",
"SubscriptionId3",
"SubscriptionId4",
"UserIdentityMsisdn",
"UserIdentityPublic",
"UserName",
"FramedIpAddress",
"FramedIpv6Prefix",
"SvcInfoPsInfo3gppcc",
"Msisdn",
"UserIdentifierMsisdn",
"UserIdentifierUserName",
"UserIdentifierExternalId",
"DeviceActionExternalId"
],
"type": "string"
},
"tertiaryRoutingEntitySecondaryAvp": {
"description": "Secondary AVP which will be used for extracting the Tertiary Routing Entity address.",
"enum": [
"PublicIdentity",
"SvcInfoSubscrId0",
"SvcInfoSubscrId1",
"SvcInfoSubscrId2",
"SvcInfoSubscrId3",
"SvcInfoSubscrId4",
"SubscriptionId0",
"SubscriptionId1",
"SubscriptionId2",
"SubscriptionId3",
"SubscriptionId4",
"UserIdentityMsisdn",
"UserIdentityPublic",
"UserName",
"FramedIpAddress",
"FramedIpv6Prefix",
"SvcInfoPsInfo3gppcc",
"Msisdn",
"UserIdentifierMsisdn",
"UserIdentifierUserName",
"UserIdentifierExternalId",
"DeviceActionExternalId"
],
"type": "string"
}
},
"required": [
"applId",
"cmdCode",
"primaryRoutingEntity",
"primaryRoutingEntityAddrTableName",
"primaryRoutingEntityPrimaryAvp"
],
"type": "object"
}
Example
{
"applId": 167777251,
"cmdCode": "316",
"primaryRoutingEntity": "Imsi",
"primaryRoutingEntityPrimaryAvp": "SvcInfoSubscrId1",
"primaryRoutingEntityAddrTableName": "AutImsi",
"secondaryRoutingEntity": "Msisdn",
"secondaryRoutingEntityPrimaryAvp": "UserIdentityMsisdn",
"secondaryRoutingEntityAddrTableName": "AutMsisdn",
"tertiaryRoutingEntity": "ExternalId",
"tertiaryRoutingEntityPrimaryAvp": "UserIdentifierExternalId",
"tertiaryRoutingEntityAddrTableName": "AutExtDomainId"
}
delete /rbar/addressresolutions/{id}
Deletes the specified Address Resolution from the SOAM configuration. An Address resolution will only be deleted if all delete validation checks pass. If the Address resolution is part of the configuration of some other Managed Object, the Address Resolution cannot be deleted.
Target Server: SOAM
Secured by x-other
Rbar: Address Tables
Allows user to access an Address Table and its associated attributes.
/rbar/addresstables
get /rbar/addresstables
Returns all Address Table configured at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those Address Tables meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section).
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/collections/addresstableCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/addresstable/addresstable.json",
"properties": {
"name": {
"description": "Unique name of the Address Table. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"comment": {
"description": "Purpose of the Address Table. Valid comments are strings between one and 64 characters, inclusive.",
"maxLength": 64,
"type": "string"
},
"comment": {
"description": "Purpose of the Address Table. Valid comments are strings between one and 64 characters, inclusive.",
"maxLength": 64,
"type": "string"
},
"routingEntity": {
"description": "Type of Routing Entity. A Routing Entity can be a User Identity (Imsi, Msisdn, Impi, Impu or External Identifier) or an IP Address associated with the User Equipment (Ipv4, Ipv6PfxAddr or Unsigned16).",
"enum": [
"Imsi",
"Msisdn",
"Impi",
"Impu",
"Ipv4",
"Ipv6PfxAddr",
"Unsigned16",
"ExternalId"
],
"type": "string"
},
"routingEntityComp": {
"description": "Routing Entity Component of the Address which is required only if Routing Entity Type is External Identifier.",
"enum": [
"LocalIdentifier",
"DomainIdentifier"
],
"type": "string"
}
},
"required": [
"name",
"routingEntity"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"name": "AutImsi1",
"comment": "Comment1",
"routingEntity": 'Imsi'
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /rbar/addresstables
Adds a new Address Table to the RBAR configuration. The new Address Table must have a name that is unique to the SOAM's configuration.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/addresstable/addresstable.json",
"properties": {
"name": {
"description": "Unique name of the Address Table. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"comment": {
"description": "Purpose of the Address Table. Valid comments are strings between one and 64 characters, inclusive.",
"maxLength": 64,
"type": "string"
},
"comment": {
"description": "Purpose of the Address Table. Valid comments are strings between one and 64 characters, inclusive.",
"maxLength": 64,
"type": "string"
},
"routingEntity": {
"description": "Type of Routing Entity. A Routing Entity can be a User Identity (Imsi, Msisdn, Impi, Impu or External Identifier) or an IP Address associated with the User Equipment (Ipv4, Ipv6PfxAddr or Unsigned16).",
"enum": [
"Imsi",
"Msisdn",
"Impi",
"Impu",
"Ipv4",
"Ipv6PfxAddr",
"Unsigned16",
"ExternalId"
],
"type": "string"
},
"routingEntityComp": {
"description": "Routing Entity Component of the Address which is required only if Routing Entity Type is External Identifier.",
"enum": [
"LocalIdentifier",
"DomainIdentifier"
],
"type": "string"
}
},
"required": [
"name",
"routingEntity"
],
"type": "object"
}
Example
{
"name": "AutImsi1",
"comment": "Comment1",
"routingEntity": 'Imsi'
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/rbar/addresstables/{name}
get /rbar/addresstables/{name}
Returns the configuration details for the specified Address Table. If the specified Address Table does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/items/addresstableItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/addresstable/addresstable.json",
"properties": {
"name": {
"description": "Unique name of the Address Table. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"comment": {
"description": "Purpose of the Address Table. Valid comments are strings between one and 64 characters, inclusive.",
"maxLength": 64,
"type": "string"
},
"comment": {
"description": "Purpose of the Address Table. Valid comments are strings between one and 64 characters, inclusive.",
"maxLength": 64,
"type": "string"
},
"routingEntity": {
"description": "Type of Routing Entity. A Routing Entity can be a User Identity (Imsi, Msisdn, Impi, Impu or External Identifier) or an IP Address associated with the User Equipment (Ipv4, Ipv6PfxAddr or Unsigned16).",
"enum": [
"Imsi",
"Msisdn",
"Impi",
"Impu",
"Ipv4",
"Ipv6PfxAddr",
"Unsigned16",
"ExternalId"
],
"type": "string"
},
"routingEntityComp": {
"description": "Routing Entity Component of the Address which is required only if Routing Entity Type is External Identifier.",
"enum": [
"LocalIdentifier",
"DomainIdentifier"
],
"type": "string"
}
},
"required": [
"name",
"routingEntity"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"name": "AutImsi1",
"comment": "Comment1",
"routingEntity": 'Imsi'
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
delete /rbar/addresstables/{name}
Deletes the specified Address Table from the SOAM configuration. Address Table will only be deleted if all delete validation checks pass. If the Address Table is part of the configuration of some other Managed Object, the Address Table cannot be deleted. An attempt to delete an Address Table that cannot be deleted will result in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Rbar: Destinations
Destinations contains the attributes associated with a destination to which RBAR routes a message. RBAR uses these attributes to modify the contents of a received message before forwarding the message. Each destination can be configured with any combination of a Realm and FQDN such as Realm-only, FQDN-only, or Realm and FQDN
/rbar/destinations
get /rbar/destinations
Returns all Destinations configured at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those Destinations meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section)
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/collections/destinationCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/destination/destination.json",
"properties": {
"avpInsertion": {
"description": "If set to true, subsequent invocation of RBAR on a different node in the network is allowed. If the System Options Allow Subsequent RBAR Invocation (/rbar/options) is true, then this per-Destination attribute will be ignored.",
"type": "boolean"
},
"fqdn": {
"description": "Fully Qualified Domain Name of this Peer Node. fqdn is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and an FQDN must be at most 255 characters long. At least Realm or Fully Qualified Domain Name is required to configure a Destination.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
},
"name": {
"description": "Unique name of the Destination. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"realm": {
"description": "Realm of this Local Node. Realm is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and a Realm must be at most 255 characters long. At least Realm or Fully Qualified Domain Name is required to configure a Destination.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"name":"AutomDestination1",
"realm":"oracle.com",
"fqdn":"fqdn1.oracle.com",
"avpInsertion":true
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /rbar/destinations
Adds a new Destination to the RBAR configuration. The new Destination must have a name that is unique to the SOAM's configuration.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/destination/destination.json",
"properties": {
"avpInsertion": {
"description": "If set to true, subsequent invocation of RBAR on a different node in the network is allowed. If the System Options Allow Subsequent RBAR Invocation (/rbar/options) is true, then this per-Destination attribute will be ignored.",
"type": "boolean"
},
"fqdn": {
"description": "Fully Qualified Domain Name of this Peer Node. fqdn is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and an FQDN must be at most 255 characters long. At least Realm or Fully Qualified Domain Name is required to configure a Destination.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
},
"name": {
"description": "Unique name of the Destination. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"realm": {
"description": "Realm of this Local Node. Realm is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and a Realm must be at most 255 characters long. At least Realm or Fully Qualified Domain Name is required to configure a Destination.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
Example
{
"name":"AutomDestination1",
"realm":"oracle.com",
"fqdn":"fqdn1.oracle.com",
"avpInsertion":true
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/rbar/destinations/{name}
get /rbar/destinations/{name}
Returns the configuration details for the specified Destination. If the specified Destination does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/items/destinationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/destination/destination.json",
"properties": {
"avpInsertion": {
"description": "If set to true, subsequent invocation of RBAR on a different node in the network is allowed. If the System Options Allow Subsequent RBAR Invocation (/rbar/options) is true, then this per-Destination attribute will be ignored.",
"type": "boolean"
},
"fqdn": {
"description": "Fully Qualified Domain Name of this Peer Node. fqdn is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and an FQDN must be at most 255 characters long. At least Realm or Fully Qualified Domain Name is required to configure a Destination.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
},
"name": {
"description": "Unique name of the Destination. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"realm": {
"description": "Realm of this Local Node. Realm is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and a Realm must be at most 255 characters long. At least Realm or Fully Qualified Domain Name is required to configure a Destination.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"name":"AutomDestination1",
"realm":"oracle.com",
"fqdn":"fqdn1.oracle.com",
"avpInsertion":true
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /rbar/destinations/{name}
Updates the configuration for the specified Destination. If the provided Destination data is invalid in any way, the update will fail, resulting in an error message returned within the HTTP response
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/destination/destination.json",
"properties": {
"avpInsertion": {
"description": "If set to true, subsequent invocation of RBAR on a different node in the network is allowed. If the System Options Allow Subsequent RBAR Invocation (/rbar/options) is true, then this per-Destination attribute will be ignored.",
"type": "boolean"
},
"fqdn": {
"description": "Fully Qualified Domain Name of this Peer Node. fqdn is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and an FQDN must be at most 255 characters long. At least Realm or Fully Qualified Domain Name is required to configure a Destination.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
},
"name": {
"description": "Unique name of the Destination. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"realm": {
"description": "Realm of this Local Node. Realm is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and a Realm must be at most 255 characters long. At least Realm or Fully Qualified Domain Name is required to configure a Destination.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
Example
{
"name":"AutomDestination1",
"realm":"oracle.com",
"fqdn":"fqdn1.oracle.com",
"avpInsertion":true
}
delete /rbar/destinations/{name}
Deletes the specified Destination from the SOAM configuration. A Destination will only be deleted if all delete validation checks pass. If the Destination is part of the configuration of some other Managed Object, the Destination cannot be deleted. For example, if the Destination is associated with an Exception (/rbar/exception), that association must first be removed and then the Destination can be deleted from the configuration. An attempt to delete Destination that cannot be deleted will result in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Rbar: Domain Addresses
Domain Address provides a mapping between a domain address and the destination for routing.
/rbar/domainaddresses
get /rbar/domainaddresses
Returns all Domain Addresses configured at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those Domain Addresses meeting the request parameters as returned in the response.
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/collections/domainaddressCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/domainaddress/domainaddress.json",
"properties": {
"routingEntity": {
"description": "TBD",
"enum": [
"Imsi",
"Msisdn",
"Impi",
"Impu",
"Ipv4",
"Ipv6PfxAddr",
"Unsigned16",
"ExternalId"
],
"type": "string"
},
"routingEntityComp": {
"description": "Routing Entity Component of the Address which is required only if Routing Entity Type is External Identifier.",
"enum": [
"LocalIdentifier",
"DomainIdentifier"
],
"type": "string"
},
"address": {
"description": "TBD",
"type": "string",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^([0-9]){1,15}$"
},
"destination": {
"description": "Destination name of the address (/rbar/destinations)",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"id": {
"description": "The natural identifier for the Individual Address instance (which has no name).",
"readOnly": true,
"type": "string"
},
"ipv6PfxLength": {
"description": "Prefix length of IPv6-prefix address. This is applicable when routing entity is Ipv6PfxAddr.",
"maximum": 128,
"minimum": 1,
"type": "integer"
},
"tableName": {
"description": "Table name of the address table (/rbar/addresstables)",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"nestedTableName": {
"description": "Address Table for next level search using the local Identifier of External Identifier AVP.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"routingEntity",
"address",
"destination",
"tableName"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"routingEntity": "ExternalId",
"address": "111111111111111",
"destination": "AutDestination1",
"tableName": "AutExtIdDomainOne",
"nestedTableName": "AutExtIdLocalOne",
"routingEntityComp": "DomainIdentifier"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /rbar/domainaddresses
Adds a new Domain Address to the RBAR configuration. The new Domain Address must have Address and Table Name that is unique to the SOAM's configuration.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/domainaddress/domainaddress.json",
"properties": {
"routingEntity": {
"description": "TBD",
"enum": [
"Imsi",
"Msisdn",
"Impi",
"Impu",
"Ipv4",
"Ipv6PfxAddr",
"Unsigned16",
"ExternalId"
],
"type": "string"
},
"routingEntityComp": {
"description": "Routing Entity Component of the Address which is required only if Routing Entity Type is External Identifier.",
"enum": [
"LocalIdentifier",
"DomainIdentifier"
],
"type": "string"
},
"address": {
"description": "TBD",
"type": "string",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^([0-9]){1,15}$"
},
"destination": {
"description": "Destination name of the address (/rbar/destinations)",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"id": {
"description": "The natural identifier for the Individual Address instance (which has no name).",
"readOnly": true,
"type": "string"
},
"ipv6PfxLength": {
"description": "Prefix length of IPv6-prefix address. This is applicable when routing entity is Ipv6PfxAddr.",
"maximum": 128,
"minimum": 1,
"type": "integer"
},
"tableName": {
"description": "Table name of the address table (/rbar/addresstables)",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"nestedTableName": {
"description": "Address Table for next level search using the local Identifier of External Identifier AVP.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"routingEntity",
"address",
"destination",
"tableName"
],
"type": "object"
}
Example
{
"routingEntity": "ExternalId",
"address": "111111111111111",
"destination": "AutDestination1",
"tableName": "AutExtIdDomainOne",
"nestedTableName": "AutExtIdLocalOne",
"routingEntityComp": "DomainIdentifier"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/rbar/domainaddresses/{TableName}
get /rbar/domainaddresses/{TableName}
Returns the configuration details for the specified Domain Address. If the specified Domain Address does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- TableName: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/items/domainaddressItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/domainaddress/domainaddress.json",
"properties": {
"routingEntity": {
"description": "TBD",
"enum": [
"Imsi",
"Msisdn",
"Impi",
"Impu",
"Ipv4",
"Ipv6PfxAddr",
"Unsigned16",
"ExternalId"
],
"type": "string"
},
"routingEntityComp": {
"description": "Routing Entity Component of the Address which is required only if Routing Entity Type is External Identifier.",
"enum": [
"LocalIdentifier",
"DomainIdentifier"
],
"type": "string"
},
"address": {
"description": "TBD",
"type": "string",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^([0-9]){1,15}$"
},
"destination": {
"description": "Destination name of the address (/rbar/destinations)",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"id": {
"description": "The natural identifier for the Individual Address instance (which has no name).",
"readOnly": true,
"type": "string"
},
"ipv6PfxLength": {
"description": "Prefix length of IPv6-prefix address. This is applicable when routing entity is Ipv6PfxAddr.",
"maximum": 128,
"minimum": 1,
"type": "integer"
},
"tableName": {
"description": "Table name of the address table (/rbar/addresstables)",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"nestedTableName": {
"description": "Address Table for next level search using the local Identifier of External Identifier AVP.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"routingEntity",
"address",
"destination",
"tableName"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"routingEntity": "ExternalId",
"address": "111111111111111",
"destination": "AutDestination1",
"tableName": "AutExtIdDomainOne",
"nestedTableName": "AutExtIdLocalOne",
"routingEntityComp": "DomainIdentifier"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /rbar/domainaddresses/{TableName}
Updates the configuration for the specified Domain Address. If the provided Domain Address data is invalid in any way, the update will fail, resulting in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- TableName: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/domainaddress/domainaddress.json",
"properties": {
"routingEntity": {
"description": "TBD",
"enum": [
"Imsi",
"Msisdn",
"Impi",
"Impu",
"Ipv4",
"Ipv6PfxAddr",
"Unsigned16",
"ExternalId"
],
"type": "string"
},
"routingEntityComp": {
"description": "Routing Entity Component of the Address which is required only if Routing Entity Type is External Identifier.",
"enum": [
"LocalIdentifier",
"DomainIdentifier"
],
"type": "string"
},
"address": {
"description": "TBD",
"type": "string",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^([0-9]){1,15}$"
},
"destination": {
"description": "Destination name of the address (/rbar/destinations)",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"id": {
"description": "The natural identifier for the Individual Address instance (which has no name).",
"readOnly": true,
"type": "string"
},
"ipv6PfxLength": {
"description": "Prefix length of IPv6-prefix address. This is applicable when routing entity is Ipv6PfxAddr.",
"maximum": 128,
"minimum": 1,
"type": "integer"
},
"tableName": {
"description": "Table name of the address table (/rbar/addresstables)",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"nestedTableName": {
"description": "Address Table for next level search using the local Identifier of External Identifier AVP.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"routingEntity",
"address",
"destination",
"tableName"
],
"type": "object"
}
Example
{
"routingEntity": "ExternalId",
"address": "111111111111111",
"destination": "AutDestination1",
"tableName": "AutExtIdDomainOne",
"nestedTableName": "AutExtIdLocalOne",
"routingEntityComp": "DomainIdentifier"
}
delete /rbar/domainaddresses/{TableName}
Deletes the specified Domain Address from the SOAM configuration. A Domain Address will only be deleted if all delete validation checks pass.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- TableName: required (string)
Rbar: Individual Addresses
Individual Address provides the mapping between an individual address and a Destination for routing.
/rbar/individualaddresses
get /rbar/individualaddresses
Returns all Individual Addresses configured at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those Individual Addresses meeting the request parameters are returned in the response.
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/collections/individualaddressCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/individualaddress/individualaddress.json",
"properties": {
"routingEntity": {
"description": "TBD",
"enum": [
"Imsi",
"Msisdn",
"Impi",
"Impu",
"Ipv4",
"Ipv6PfxAddr",
"Unsigned16",
"ExternalId"
],
"type": "string"
},
"routingEntityComp": {
"description": "Routing Entity Component of the Address which is required only if Routing Entity Type is External Identifier.",
"enum": [
"LocalIdentifier",
"DomainIdentifier"
],
"type": "string"
},
"address": {
"description": "TBD",
"type": "string",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^([0-9]){1,15}$"
},
"destination": {
"description": "Destination name of the address (/rbar/destinations)",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"id": {
"description": "The natural identifier for the Individual Address instance (which has no name).",
"readOnly": true,
"type": "string"
},
"ipv6PfxLength": {
"description": "Prefix length of IPv6-prefix address. This is applicable when routing entity is Ipv6PfxAddr.",
"maximum": 128,
"minimum": 1,
"type": "integer"
},
"tableName": {
"description": "Table name of the address table (/rbar/addresstables)",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"nestedTableName": {
"description": "Address Table for next level search using the local Identifier of External Identifier AVP.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"routingEntity",
"address",
"destination",
"tableName"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"routingEntity": "Imsi",
"address": "111111111111111",
"destination": "AutDestination1",
"tableName": "AutImsi"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /rbar/individualaddresses
Adds a new Individual Address to the RBAR configuration. The new Individual Address must have Address and Table Name that is unique to the SOAM's configuration.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/individualaddress/individualaddress.json",
"properties": {
"routingEntity": {
"description": "TBD",
"enum": [
"Imsi",
"Msisdn",
"Impi",
"Impu",
"Ipv4",
"Ipv6PfxAddr",
"Unsigned16",
"ExternalId"
],
"type": "string"
},
"routingEntityComp": {
"description": "Routing Entity Component of the Address which is required only if Routing Entity Type is External Identifier.",
"enum": [
"LocalIdentifier",
"DomainIdentifier"
],
"type": "string"
},
"address": {
"description": "TBD",
"type": "string",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^([0-9]){1,15}$"
},
"destination": {
"description": "Destination name of the address (/rbar/destinations)",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"id": {
"description": "The natural identifier for the Individual Address instance (which has no name).",
"readOnly": true,
"type": "string"
},
"ipv6PfxLength": {
"description": "Prefix length of IPv6-prefix address. This is applicable when routing entity is Ipv6PfxAddr.",
"maximum": 128,
"minimum": 1,
"type": "integer"
},
"tableName": {
"description": "Table name of the address table (/rbar/addresstables)",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"nestedTableName": {
"description": "Address Table for next level search using the local Identifier of External Identifier AVP.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"routingEntity",
"address",
"destination",
"tableName"
],
"type": "object"
}
Example
{
"routingEntity": "Imsi",
"address": "111111111111111",
"destination": "AutDestination1",
"tableName": "AutImsi"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/rbar/individualaddresses/{TableName}
get /rbar/individualaddresses/{TableName}
Returns the configuration details for the specified Individual Address. If the specified Individual Address does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- TableName: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/items/individualaddressItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/individualaddress/individualaddress.json",
"properties": {
"routingEntity": {
"description": "TBD",
"enum": [
"Imsi",
"Msisdn",
"Impi",
"Impu",
"Ipv4",
"Ipv6PfxAddr",
"Unsigned16",
"ExternalId"
],
"type": "string"
},
"routingEntityComp": {
"description": "Routing Entity Component of the Address which is required only if Routing Entity Type is External Identifier.",
"enum": [
"LocalIdentifier",
"DomainIdentifier"
],
"type": "string"
},
"address": {
"description": "TBD",
"type": "string",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^([0-9]){1,15}$"
},
"destination": {
"description": "Destination name of the address (/rbar/destinations)",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"id": {
"description": "The natural identifier for the Individual Address instance (which has no name).",
"readOnly": true,
"type": "string"
},
"ipv6PfxLength": {
"description": "Prefix length of IPv6-prefix address. This is applicable when routing entity is Ipv6PfxAddr.",
"maximum": 128,
"minimum": 1,
"type": "integer"
},
"tableName": {
"description": "Table name of the address table (/rbar/addresstables)",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"nestedTableName": {
"description": "Address Table for next level search using the local Identifier of External Identifier AVP.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"routingEntity",
"address",
"destination",
"tableName"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"routingEntity": "Imsi",
"address": "111111111111111",
"destination": "AutDestination1",
"tableName": "AutImsi"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /rbar/individualaddresses/{TableName}
Updates the configuration for the specified Individual Address. If the provided Individual Address data is invalid in any way, the update will fail, resulting in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- TableName: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/individualaddress/individualaddress.json",
"properties": {
"routingEntity": {
"description": "TBD",
"enum": [
"Imsi",
"Msisdn",
"Impi",
"Impu",
"Ipv4",
"Ipv6PfxAddr",
"Unsigned16",
"ExternalId"
],
"type": "string"
},
"routingEntityComp": {
"description": "Routing Entity Component of the Address which is required only if Routing Entity Type is External Identifier.",
"enum": [
"LocalIdentifier",
"DomainIdentifier"
],
"type": "string"
},
"address": {
"description": "TBD",
"type": "string",
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^([0-9]){1,15}$"
},
"destination": {
"description": "Destination name of the address (/rbar/destinations)",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"id": {
"description": "The natural identifier for the Individual Address instance (which has no name).",
"readOnly": true,
"type": "string"
},
"ipv6PfxLength": {
"description": "Prefix length of IPv6-prefix address. This is applicable when routing entity is Ipv6PfxAddr.",
"maximum": 128,
"minimum": 1,
"type": "integer"
},
"tableName": {
"description": "Table name of the address table (/rbar/addresstables)",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"nestedTableName": {
"description": "Address Table for next level search using the local Identifier of External Identifier AVP.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"routingEntity",
"address",
"destination",
"tableName"
],
"type": "object"
}
Example
{
"routingEntity": "Imsi",
"address": "111111111111111",
"destination": "AutDestination1",
"tableName": "AutImsi"
}
delete /rbar/individualaddresses/{TableName}
Deletes the specified Individual Address from the SOAM configuration. An Individual Address will only be deleted if all delete validation checks pass.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- TableName: required (string)
Rbar: Options
Options (sometimes referred to as System Options) is a collection of parameters that govern various aspects of RBAR global parameters.
There is a single instance of this resource, which contains all of the individual options that can be retrieved and set. Because there is no collection of instances, there is no collection GET action. No new Options resource can be created, so there is no POST action, and the single instance cannot be removed, so there is no DELETE action. The single instance GET is used to retrieve the options, and PUT is used to update one or more values within the set of options. A name for this single, non-deletable instance is neither required nor expected.
/rbar/options
get /rbar/options
Returns the set of current values for the Options.
Target Server: SOAM
Response
HTTP status code 200
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/items/optionItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/option/option.json",
"properties": {
"allowSubsequentDSRAppInvoc": {
"description": "If set to true, subsequent invocation of RBAR on a different node in the network is allowed.",
"type": "boolean"
},
"asciiExcludedList": {
"items": {
"description": "A list of ASCII characters to ignore while parsing digits from a raw AVP data field of AVP Type UTF8String.",
"type": "string",
"pattern": "^[0-9a-zA-Z\\(\\'\\)\\+\\-\\[\\]\\{\\}\\=\\!\\@\\#\\$\\^\\&\\*\\:\\;\\,\\<\\>\\?.\\/\\~\\`\"\\|]+$"
},
"type": "array"
},
"excludeSpace": {
"description": "If set to true, ASCII character space is ignored while parsing digits from a raw AVP data field of AVP Type UTF8String.",
"type": "boolean"
},
"fqdn": {
"description": "Fully Qualified Domain Name of this Peer Node. fqdn is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and an FQDN must be at most 255 characters long. At least Realm or Fully Qualified Domain Name is required to configure a Destination.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
},
"realm": {
"description": "Realm of this Local Node. Realm is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and a Realm must be at most 255 characters long. At least Realm or Fully Qualified Domain Name is required to configure a Destination.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
},
"removeDestHost": {
"description": "If set to true, RBAR deletes any instance of 'Destination-Host' AVPs in the message when performing 'Realm only' resolution.",
"type": "boolean"
},
"resExhaustionErrCode": {
"description": "The Result-Code or Experimental-Result-Code value to be returned in an Answer message when a message is not successfully routed because of internal resource being exhausted. If Vendor-Id is configured, this value is encoded as Experimental-Result-Code AVP else Result-Code AVP.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"resExhaustionErrMsg": {
"description": "The Error-Message AVP value to be returned in an Answer message when a message is not successfully routed because of internal resource being exhausted.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"resExhaustionVendorId": {
"description": "The Vendor-Id AVP value to be returned in an Answer message when a message is not successfully routed because of internal resource being exhausted.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
},
"tbcdExcludedList": {
"items": {
"description": "Character is ignored while parsing digits from a raw AVP data field of AVP Type OctetString encoded as a TBCD-string.",
"enum": ["*","#","a","b","c"],
"type": "string"
},
"maxItems": 5,
"minItems": 0,
"type": "array"
},
"unavailableAppAction": {
"description": "Action to be taken when RBAR application is unavailable to process messages.",
"enum": [
"ContinueRouting",
"DefaultRoute",
"SendAnswer",
"SendAnsExp"
],
"type": "string"
},
"unavailableAppErrMsg": {
"description": "The Error-Message AVP value to be returned in an Answer message when a message is not successfully routed because of RBAR application being unavailable.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"unavailableAppResultCode": {
"description": "The Result-Code or Experimental-Result-Code value to be returned in an Answer message when a message is not successfully routed because of RBAR application being unavailable. If Vendor-Id is configured, this value is encoded as Experimental-Result-Code AVP else Result-Code AVP.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"unavailableAppRouteList": {
"description": "If the Unavailability Action is 'Default Route' and RBAR application is not available, the requests will be routed using this Route List and Peer Routing Rules will be bypassed.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"unavailableAppVendorId": {
"description": "The Vendor-Id AVP value to be returned in an Answer message when a message is not successfully routed because of RBAR application being unavailable.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
},
"uriSupported": {
"description": "If set to true, both Local and Global Numbers are valid addresses for IMPU and MSISDN decoded from Diameter Requests. If set to false, only Global Numbers are valid addresses. URI Local Numbers Supported defines whether Local Numbers are considered valid addresses within a SIP or TEL URI. This only applies to the Routing Entity Type 'IMPU' and 'MSISDN'. An address of this form is consider a 'Local Number' if it does not start with the Global Number prefix character '+'.",
"type": "boolean"
}
},
"required": [],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"UriLocalNumSupported": 'Yes',
"asciiExcludedList": "Default",
"excludeSpace": 'No',
"tbcdExcludedList": 'a',
"allowSubsequentDSRAppInvoc": 'No',
"RemoveDestHost": 'Yes',
"realm": "oracle.com",
"fqdn": "fqdn1.oracle.com",
"resExhaustionErrCode": 3004,
"resExhaustionErrMsg": 'RBAR Resource Exhausted',
"resExhaustionVendorId": 23,
"unavailableAppAction": 'SendAnsExp',
"unavailableAppRouteList": "Default",
"unavailableAppResultCode": 3002,
"unavailableAppErrMsg": "RBAR Unavailable",
"unavailableAppVendorId": 23
},
"messages":
[
],
"links":
{
},
"status":
true
}
put /rbar/options
Updates the Options with the values supplied. To update just one of the individual options, GET the set, modify the value for the option that needs to be changed, and then PUT the Options.
Target Server: SOAM
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/option/option.json",
"properties": {
"allowSubsequentDSRAppInvoc": {
"description": "If set to true, subsequent invocation of RBAR on a different node in the network is allowed.",
"type": "boolean"
},
"asciiExcludedList": {
"items": {
"description": "A list of ASCII characters to ignore while parsing digits from a raw AVP data field of AVP Type UTF8String.",
"type": "string",
"pattern": "^[0-9a-zA-Z\\(\\'\\)\\+\\-\\[\\]\\{\\}\\=\\!\\@\\#\\$\\^\\&\\*\\:\\;\\,\\<\\>\\?.\\/\\~\\`\"\\|]+$"
},
"type": "array"
},
"excludeSpace": {
"description": "If set to true, ASCII character space is ignored while parsing digits from a raw AVP data field of AVP Type UTF8String.",
"type": "boolean"
},
"fqdn": {
"description": "Fully Qualified Domain Name of this Peer Node. fqdn is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and an FQDN must be at most 255 characters long. At least Realm or Fully Qualified Domain Name is required to configure a Destination.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
},
"realm": {
"description": "Realm of this Local Node. Realm is a case-insensitive string consisting of a list of labels separated by dots, where a label may contain letters, digits, dashes ('-') and underscore ('_'). A label must start with a letter, digit or underscore and must end with a letter or digit. Underscores may be used only as the first character. A label must be at most 63 characters long and a Realm must be at most 255 characters long. At least Realm or Fully Qualified Domain Name is required to configure a Destination.",
"maxLength": 255,
"pattern": "^(?!\\-)(?:[a-zA-Z0-9\\-\\_]{0,63}[a-zA-Z0-9]\\.){1,64}(?!0-9+)[a-zA-Z0-9]{1,64}$",
"type": "string"
},
"removeDestHost": {
"description": "If set to true, RBAR deletes any instance of 'Destination-Host' AVPs in the message when performing 'Realm only' resolution.",
"type": "boolean"
},
"resExhaustionErrCode": {
"description": "The Result-Code or Experimental-Result-Code value to be returned in an Answer message when a message is not successfully routed because of internal resource being exhausted. If Vendor-Id is configured, this value is encoded as Experimental-Result-Code AVP else Result-Code AVP.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"resExhaustionErrMsg": {
"description": "The Error-Message AVP value to be returned in an Answer message when a message is not successfully routed because of internal resource being exhausted.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"resExhaustionVendorId": {
"description": "The Vendor-Id AVP value to be returned in an Answer message when a message is not successfully routed because of internal resource being exhausted.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
},
"tbcdExcludedList": {
"items": {
"description": "Character is ignored while parsing digits from a raw AVP data field of AVP Type OctetString encoded as a TBCD-string.",
"enum": ["*","#","a","b","c"],
"type": "string"
},
"maxItems": 5,
"minItems": 0,
"type": "array"
},
"unavailableAppAction": {
"description": "Action to be taken when RBAR application is unavailable to process messages.",
"enum": [
"ContinueRouting",
"DefaultRoute",
"SendAnswer",
"SendAnsExp"
],
"type": "string"
},
"unavailableAppErrMsg": {
"description": "The Error-Message AVP value to be returned in an Answer message when a message is not successfully routed because of RBAR application being unavailable.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"unavailableAppResultCode": {
"description": "The Result-Code or Experimental-Result-Code value to be returned in an Answer message when a message is not successfully routed because of RBAR application being unavailable. If Vendor-Id is configured, this value is encoded as Experimental-Result-Code AVP else Result-Code AVP.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"unavailableAppRouteList": {
"description": "If the Unavailability Action is 'Default Route' and RBAR application is not available, the requests will be routed using this Route List and Peer Routing Rules will be bypassed.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"unavailableAppVendorId": {
"description": "The Vendor-Id AVP value to be returned in an Answer message when a message is not successfully routed because of RBAR application being unavailable.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
},
"uriSupported": {
"description": "If set to true, both Local and Global Numbers are valid addresses for IMPU and MSISDN decoded from Diameter Requests. If set to false, only Global Numbers are valid addresses. URI Local Numbers Supported defines whether Local Numbers are considered valid addresses within a SIP or TEL URI. This only applies to the Routing Entity Type 'IMPU' and 'MSISDN'. An address of this form is consider a 'Local Number' if it does not start with the Global Number prefix character '+'.",
"type": "boolean"
}
},
"required": [],
"type": "object"
}
Example
{
"UriLocalNumSupported": 'Yes',
"asciiExcludedList": "Default",
"excludeSpace": 'No',
"tbcdExcludedList": 'a',
"allowSubsequentDSRAppInvoc": 'No',
"RemoveDestHost": 'Yes',
"realm": "oracle.com",
"fqdn": "fqdn1.oracle.com",
"resExhaustionErrCode": 3004,
"resExhaustionErrMsg": 'RBAR Resource Exhausted',
"resExhaustionVendorId": 23,
"unavailableAppAction": 'SendAnsExp',
"unavailableAppRouteList": "Default",
"unavailableAppResultCode": 3002,
"unavailableAppErrMsg": "RBAR Unavailable",
"unavailableAppVendorId": 23
}
Response
HTTP status code 200
Rbar: Routing Exceptions
Exception (sometimes referred to as Routing Exception) allows you to specify the routing exception action to take when RBAR is unable to resolve an address to a Destination for each supported Diameter Application and Routing Exception Type. There are three (3) Routing Exception entries (No Address Match, No valid Routing Entity Address, and Unknown Command Code) automatically inserted with the Routing Exception Action set to Forward Unchanged as the default action for a supported Diameter application entry when that application entry is added. Similarly, these Routing Exceptions that are associated with an application entry are automatically deleted when that application entry is deleted
/rbar/routingexceptions
get /rbar/routingexceptions
Returns all Routing Exception configured at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those Routing Exception meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section).
Target Server: SOAM
Request
Query Parameters
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/collections/routingexceptionCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/routingexception/routingexception.json",
"properties": {
"action": {
"description": "Action to be taken on exception.",
"enum": [
"AbandonRequest",
"FwdUnchanged",
"FwdToDest",
"SendAnswer",
"SendAnsExp"
],
"type": "string"
},
"ansResultCode": {
"description": "The Result-Code or Experimental-Result-Code value to be returned in an Answer message on exception. If Vendor-Id is configured, this value is encoded as Experimental-Result-Code AVP else Result-Code AVP.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"applId": {
"description": "The Application Id is the numeric value used to identify a Diameter Application.",
"readOnly": true,
"type": "integer"
},
"destName": {
"description": "Destination to which message will be forwarded on exception",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"errMsg": {
"description": "The Error-Message AVP value to be returned in an Answer message on exception.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"exceptionType": {
"description": "Type of Routing Exception.",
"enum": [
"UnknownCmdCode",
"NoRoutingEntityAddress",
"NoDrtEntry"
],
"readOnly": true,
"type": "string"
},
"id": {
"description": "The natural identifier for the Routing Exception instance (which has no name).",
"readOnly": true,
"type": "string"
},
"vendorId": {
"description": "The Vendor-Id AVP value to be returned in an Answer message on exception.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
}
},
"required": [
"applId"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"applId": 16777251,
"exceptionType": "NoRoutingEntityAddress",
"action": "FwdUnchanged"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
/rbar/routingexceptions/{id}
get /rbar/routingexceptions/{id}
Returns the configuration details for the specified Routing Exception. If the specified Routing Exception does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- id: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/items/routingexceptionItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/routingexception/routingexception.json",
"properties": {
"action": {
"description": "Action to be taken on exception.",
"enum": [
"AbandonRequest",
"FwdUnchanged",
"FwdToDest",
"SendAnswer",
"SendAnsExp"
],
"type": "string"
},
"ansResultCode": {
"description": "The Result-Code or Experimental-Result-Code value to be returned in an Answer message on exception. If Vendor-Id is configured, this value is encoded as Experimental-Result-Code AVP else Result-Code AVP.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"applId": {
"description": "The Application Id is the numeric value used to identify a Diameter Application.",
"readOnly": true,
"type": "integer"
},
"destName": {
"description": "Destination to which message will be forwarded on exception",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"errMsg": {
"description": "The Error-Message AVP value to be returned in an Answer message on exception.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"exceptionType": {
"description": "Type of Routing Exception.",
"enum": [
"UnknownCmdCode",
"NoRoutingEntityAddress",
"NoDrtEntry"
],
"readOnly": true,
"type": "string"
},
"id": {
"description": "The natural identifier for the Routing Exception instance (which has no name).",
"readOnly": true,
"type": "string"
},
"vendorId": {
"description": "The Vendor-Id AVP value to be returned in an Answer message on exception.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
}
},
"required": [
"applId"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"applId": 16777251,
"exceptionType": "NoRoutingEntityAddress",
"action": "FwdUnchanged"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /rbar/routingexceptions/{id}
Updates the Routing Exception with the values supplied. To update just one of the individual options, GET the set, modify the value for the option that needs to be changed, and then PUT the Options.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- id: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/routingexception/routingexception.json",
"properties": {
"action": {
"description": "Action to be taken on exception.",
"enum": [
"AbandonRequest",
"FwdUnchanged",
"FwdToDest",
"SendAnswer",
"SendAnsExp"
],
"type": "string"
},
"ansResultCode": {
"description": "The Result-Code or Experimental-Result-Code value to be returned in an Answer message on exception. If Vendor-Id is configured, this value is encoded as Experimental-Result-Code AVP else Result-Code AVP.",
"maximum": 5999,
"minimum": 1000,
"type": "integer"
},
"applId": {
"description": "The Application Id is the numeric value used to identify a Diameter Application.",
"readOnly": true,
"type": "integer"
},
"destName": {
"description": "Destination to which message will be forwarded on exception",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"errMsg": {
"description": "The Error-Message AVP value to be returned in an Answer message on exception.",
"maxLength": 64,
"minLength": 0,
"type": "string"
},
"exceptionType": {
"description": "Type of Routing Exception.",
"enum": [
"UnknownCmdCode",
"NoRoutingEntityAddress",
"NoDrtEntry"
],
"readOnly": true,
"type": "string"
},
"id": {
"description": "The natural identifier for the Routing Exception instance (which has no name).",
"readOnly": true,
"type": "string"
},
"vendorId": {
"description": "The Vendor-Id AVP value to be returned in an Answer message on exception.",
"maximum": 4294967295,
"minimum": 1,
"type": "integer"
}
},
"required": [
"applId"
],
"type": "object"
}
Example
{
"applId": 16777251,
"exceptionType": "NoRoutingEntityAddress",
"action": "FwdUnchanged"
}
Rbar: Supported Applications
Applications(sometimes referred to as Supported Applications) allows user to access a list of Diameter Applications supported by RBAR
/rbar/supportedapplications
get /rbar/supportedapplications
Returns all Applications configured at the SOAM that meet the criteria specified in a valid GET request. If valid paging parameters are provided in the request, only those Supported Applications meeting the request parameters are returned in the response. If paging parameters are not provided in the request, the DSR applies default paging (as described in the General Behaviors section).
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/collections/supportedapplicationCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/supportedapplication/supportedapplication.json",
"properties": {
"applId": {
"description": "The Application Id is the numeric value used to identify a Diameter Application.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"routingMode": {
"description": "Routing Mode.",
"type": "string"
}
},
"required": [
"applId"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"applId": 16777251,
"routingMode": "Proxy"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /rbar/supportedapplications
Adds a new Application to the RBAR configuration. The new Application must be unique to the SOAM's configuration
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/supportedapplication/supportedapplication.json",
"properties": {
"applId": {
"description": "The Application Id is the numeric value used to identify a Diameter Application.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"routingMode": {
"description": "Routing Mode.",
"type": "string"
}
},
"required": [
"applId"
],
"type": "object"
}
Example
{
"applId": 16777251,
"routingMode": "Proxy"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/rbar/supportedapplications/{id}
get /rbar/supportedapplications/{id}
Returns the configuration details for the specified Application. If the specified Application does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- id: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/items/supportedapplicationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/rbar/supportedapplication/supportedapplication.json",
"properties": {
"applId": {
"description": "The Application Id is the numeric value used to identify a Diameter Application.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"routingMode": {
"description": "Routing Mode.",
"type": "string"
}
},
"required": [
"applId"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"applId": 16777251,
"routingMode": "Proxy"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /rbar/supportedapplications/{id}
delete /rbar/supportedapplications/{id}
Deletes the specified Application from the SOAM configuration. An Application will only be deleted if all delete validation checks pass.
Target Server: SOAM
Secured by x-other
Topo: DSCP Interface Rules
Differentiated Service Code Points (DSCP) rules can be associated with either ports or interfaces and allow packets to be classified for quality of service purposes.
Items in the DSCP Interface Rule collection don't have a simple natural identifier. Each time a new Interface Rule is created, it is assigned an identifier which is available as the UUID field.
Configuration of DSCP Interface Rules is only available at the NOAM.
/topo/dscpinterfacerules
get /topo/dscpinterfacerules
Returns the details for all configured DSCP Interface Rules that meet the request parameters.
Target server: NOAM
Secured by x-other
Request
Query Parameters
- scope_type: (one of Server, ServerGroup, NetworkElement)
Identifies the type of Server collection the results are limited to.
Example:
?scope_type=Server&scope_name=mynoa
- scope_name: (string)
Names the specific Server collection the results are limited to.
Example:
?scope_type=ServerGroup&scope_name=NO_SG
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/collections/dscpinterfaceruleCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/dscpinterfacerule/dscpinterfacerule.json",
"type": "object",
"required": ["interface","dscp","protocol","scope","scopeType"],
"notInsertable": ["UUID"],
"properties": {
"UUID": {
"type": "string",
"description": "DSCP Rule Identifier (generated)",
"example": "3907f4f5-130b-4f99-9c8f-8b5d32d6112",
"pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
"interface": {
"type": "string",
"example": "eth01",
"description": "Server Interface"
},
"dscp": {
"type": "integer",
"minimum": 0,
"maximum": 63,
"example": 42,
"description": "DSCP Value"
},
"protocol": {
"type": "string",
"example": "Tcp",
"enum": [
"Sctp",
"Tcp"
],
"description": "Protocol"
},
"scope": {
"type": "string",
"example": "NO_SG",
"description": "Scope"
},
"scopeType": {
"type": "string",
"example": "ServerGroup",
"enum": [
"Server",
"ServerGroup"
],
"description": "Scope Type"
}
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"UUID": "3529ac5f-1b2d-4154-bbe6-df8fa20bd3f9",
"interface": "eth0.1234",
"dscp": 23,
"protocol": "Tcp",
"scope": "snowman-noa",
"scopeType": "Server"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /topo/dscpinterfacerules
Adds a new DSCP Interface Rule, which allows the DSCP field to be specified for all traffic exiting a server or server group via a specific interface.
A uuid is returned and is used to identify the Rule instance.
Target server: NOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/dscpinterfacerule/dscpinterfacerule.json",
"type": "object",
"required": ["interface","dscp","protocol","scope","scopeType"],
"notInsertable": ["UUID"],
"properties": {
"UUID": {
"type": "string",
"description": "DSCP Rule Identifier (generated)",
"example": "3907f4f5-130b-4f99-9c8f-8b5d32d6112",
"pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
"interface": {
"type": "string",
"example": "eth01",
"description": "Server Interface"
},
"dscp": {
"type": "integer",
"minimum": 0,
"maximum": 63,
"example": 42,
"description": "DSCP Value"
},
"protocol": {
"type": "string",
"example": "Tcp",
"enum": [
"Sctp",
"Tcp"
],
"description": "Protocol"
},
"scope": {
"type": "string",
"example": "NO_SG",
"description": "Scope"
},
"scopeType": {
"type": "string",
"example": "ServerGroup",
"enum": [
"Server",
"ServerGroup"
],
"description": "Scope Type"
}
}
}
Example
{
"UUID": "3529ac5f-1b2d-4154-bbe6-df8fa20bd3f9",
"interface": "eth0.1234",
"dscp": 23,
"protocol": "Tcp",
"scope": "snowman-noa",
"scopeType": "Server"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/topo/dscpinterfacerules/{uuid}
get /topo/dscpinterfacerules/{uuid}
Returns the configuration details and a set of links for the specified DSCP Interface Rule. The links can be used to perform delete or edit operations on the Rule.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- uuid: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/items/dscpinterfaceruleItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/dscpinterfacerule/dscpinterfacerule.json",
"type": "object",
"required": ["interface","dscp","protocol","scope","scopeType"],
"notInsertable": ["UUID"],
"properties": {
"UUID": {
"type": "string",
"description": "DSCP Rule Identifier (generated)",
"example": "3907f4f5-130b-4f99-9c8f-8b5d32d6112",
"pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
"interface": {
"type": "string",
"example": "eth01",
"description": "Server Interface"
},
"dscp": {
"type": "integer",
"minimum": 0,
"maximum": 63,
"example": 42,
"description": "DSCP Value"
},
"protocol": {
"type": "string",
"example": "Tcp",
"enum": [
"Sctp",
"Tcp"
],
"description": "Protocol"
},
"scope": {
"type": "string",
"example": "NO_SG",
"description": "Scope"
},
"scopeType": {
"type": "string",
"example": "ServerGroup",
"enum": [
"Server",
"ServerGroup"
],
"description": "Scope Type"
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"UUID": "3529ac5f-1b2d-4154-bbe6-df8fa20bd3f9",
"interface": "eth0.1234",
"dscp": 23,
"protocol": "Tcp",
"scope": "snowman-noa",
"scopeType": "Server"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
delete /topo/dscpinterfacerules/{uuid}
Deletes a DSCP Interface Rule, using a link returned by a previous GET operation.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- uuid: required (string)
Topo: DSCP Port Rules
Differentiated Service Code Points (DSCP) rules can be associated with either ports or interfaces and allow packets to be classified for quality of service purposes.
Items in the DSCP Port Rule collection don't have a simple natural identifier. Each time a new Port Rule is created, it is assigned an identifier which is available as the UUID field.
Configuration of DSCP Port Rules is only available at the NOAM.
/topo/dscpportrules
get /topo/dscpportrules
Returns the details for all configured DSCP Port Rules that meet the request parameters.
Target server: NOAM
Secured by x-other
Request
Query Parameters
- scope_type: (one of Server, ServerGroup, NetworkElement)
Identifies the type of Server collection the results are limited to.
Example:
?scope_type=Server&scope_name=mynoa
- scope_name: (string)
Names the specific Server collection the results are limited to.
Example:
?scope_type=ServerGroup&scope_name=NO_SG
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/collections/dscpportruleCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/dscpportrule/dscpportrule.json",
"type": "object",
"required": ["port","dscp","protocol","scope","scopeType"],
"notInsertable": ["UUID"],
"properties": {
"UUID": {
"type": "string",
"description": "DSCP Rule Identifier (*generated*)",
"example": "3907f4f5-130b-4f99-9c8f-8b5d32d6112",
"pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
"port": {
"type": "integer",
"minimum": 1,
"maximum": 65535,
"example": 1556,
"description": "Port"
},
"dscp": {
"type": "integer",
"example": 63,
"minimum": 0,
"maximum": 63,
"description": "The DSCP Value"
},
"protocol": {
"type": "string",
"example": "Tcp",
"enum": [
"Sctp",
"Tcp"
],
"description": "Protocol"
},
"scope": {
"type": "string",
"example": "snowman-noa",
"description": "Scope"
},
"scopeType": {
"type": "string",
"example": "Server",
"enum": [
"Server",
"ServerGroup"
],
"description": "Scope Type"
}
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"UUID": "4f88a7d5-0894-42a0-be90-86e9f5892414",
"port": 535,
"dscp": 15,
"protocol": "Sctp",
"scope": "snowman-noa",
"scopeType": "Server"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /topo/dscpportrules
Adds a new DSCP Port Rule, which allows the DSCP field to be specified for all traffic exiting a server or server group via a specific port.
The uuid is returned and is used to identify the Port Rule instance.
Target server: NOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/dscpportrule/dscpportrule.json",
"type": "object",
"required": ["port","dscp","protocol","scope","scopeType"],
"notInsertable": ["UUID"],
"properties": {
"UUID": {
"type": "string",
"description": "DSCP Rule Identifier (*generated*)",
"example": "3907f4f5-130b-4f99-9c8f-8b5d32d6112",
"pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
"port": {
"type": "integer",
"minimum": 1,
"maximum": 65535,
"example": 1556,
"description": "Port"
},
"dscp": {
"type": "integer",
"example": 63,
"minimum": 0,
"maximum": 63,
"description": "The DSCP Value"
},
"protocol": {
"type": "string",
"example": "Tcp",
"enum": [
"Sctp",
"Tcp"
],
"description": "Protocol"
},
"scope": {
"type": "string",
"example": "snowman-noa",
"description": "Scope"
},
"scopeType": {
"type": "string",
"example": "Server",
"enum": [
"Server",
"ServerGroup"
],
"description": "Scope Type"
}
}
}
Example
{
"UUID": "4f88a7d5-0894-42a0-be90-86e9f5892414",
"port": 535,
"dscp": 15,
"protocol": "Sctp",
"scope": "snowman-noa",
"scopeType": "Server"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/topo/dscpportrules/{uuid}
get /topo/dscpportrules/{uuid}
Returns the configuration details and a set of links for the specified DSCP Port Rule. The links can be used to perform delete or edit operations on the Rule.
Secured by x-other
Request
URI Parameters
- uuid: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/items/dscpportruleItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/dscpportrule/dscpportrule.json",
"type": "object",
"required": ["port","dscp","protocol","scope","scopeType"],
"notInsertable": ["UUID"],
"properties": {
"UUID": {
"type": "string",
"description": "DSCP Rule Identifier (*generated*)",
"example": "3907f4f5-130b-4f99-9c8f-8b5d32d6112",
"pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
"port": {
"type": "integer",
"minimum": 1,
"maximum": 65535,
"example": 1556,
"description": "Port"
},
"dscp": {
"type": "integer",
"example": 63,
"minimum": 0,
"maximum": 63,
"description": "The DSCP Value"
},
"protocol": {
"type": "string",
"example": "Tcp",
"enum": [
"Sctp",
"Tcp"
],
"description": "Protocol"
},
"scope": {
"type": "string",
"example": "snowman-noa",
"description": "Scope"
},
"scopeType": {
"type": "string",
"example": "Server",
"enum": [
"Server",
"ServerGroup"
],
"description": "Scope Type"
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"UUID": "4f88a7d5-0894-42a0-be90-86e9f5892414",
"port": 535,
"dscp": 15,
"protocol": "Sctp",
"scope": "snowman-noa",
"scopeType": "Server"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
delete /topo/dscpportrules/{uuid}
Deletes a DSCP Port Rule, using a link returned by a previous GET operation.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- uuid: required (string)
Topo: Network Devices
Network Devices provide servers access to networks. Network Devices are identified using a port name; they have a type (e.g., Ethernet or VLAN); and they provide access to the server-specific network details such as IP addresses.
Items in the Network Device collection don't have an inherent natural identifier. Each time a new Network Device is created, it is assigned an identifier which is available as the uuid field.
Configuration of Network Devices is only available at the NOAM.
/topo/networkdevices
get /topo/networkdevices
Returns the details for all configured Network Devices that meet the criteria specified in a valid GET request. For DSR networks with a large number of Network Devices(several hundred or more), the time required by the DSR to prepare and send the response to the client can take multiple minutes. It is recommended that clients limit the requested data using the scope_type and scope_name query parameters, to avoid potential client-side request timeouts due to a potentially slow DSR response.
Target server: NOAM
Secured by x-other
Request
Query Parameters
- scope_type: (one of Server, ServerGroup, NetworkElement)
Identifies the type of Server collection the results are limited to.
Example:
?scope_type=Server&scope_name=mynoa
- scope_name: (string)
Names the specific Server collection the results are limited to.
Example:
?scope_type=ServerGroup&scope_name=NO_SG
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/collections/networkdeviceCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/networkdevice/networkdevice.json",
"type" :"object",
"required": ["hostname","type","interfaces"],
"notInsertable": ["status","UUID"],
"properties": {
"port": {
"type": "string",
"example": "eth01",
"description": "Device Port"
},
"type": {
"type": "string",
"enum": ["Bonding","Vlan","Alias","Ethernet"],
"example": "Vlan",
"description": "Device Type"
},
"status": {
"type": "string",
"description": "Device configuration status (computed)",
"enum": [
"Configured",
"DeletePending",
"Deployed",
"Discovered",
"EditPending"
]
},
"UUID": {
"type": "string",
"description": "Device Identifier (generated)",
"example": "3907f4f5-130b-4f99-9c8f-8b5d32d6112",
"pattern": "[a-f0-9]{8}-[a-f0-9]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^([A-Za-z0-9=]+)$"
},
"hostname": {
"type": "string",
"example": "sans-noa",
"description": "Hostname"
},
"interfaces": {
"type": "array",
"description": "Device Interfaces",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/deviceInterface/deviceInterface.json",
"type" :"object",
"required": ["networkName","ipAddress"],
"properties": {
"networkName": {
"type": "string",
"example": "LAN",
"description": "Network Name"
},
"ipAddress":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6/IPv4orIPv6.json",
"type": "string",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^(default)$",
"example": "192.168.1.1"
}
}
},
"minItems": 0
},
"options": {
"type": "object",
"properties": {
"onboot": {
"type": "boolean"
},
"bootProto": {
"type": "string",
"example": "Dhcp",
"enum": [
"Dhcp",
"None"
]
},
"mtu": {
"type": "integer",
"minimum": 1280,
"maximum": 65570
},
"baseDevice": {
"type": "array",
"example": ["eth0"],
"items":
{ "type": "string" },
"minItems": 1
},
"monitorType": {
"type": "string",
"example": "Mii",
"enum": ["Mii","Arp"]
},
"primary": {
"type": "string"
},
"miimon": {
"type": "integer",
"minimum": 1
},
"updelay": {
"type": "integer",
"minimum": 1
},
"downdelay": {
"type": "integer",
"minimum": 1
},
"arpInterval": {
"type": "integer",
"minimum": 1
},
"arpValidate": {
"type": "string",
"example": "Active",
"enum": ["None","Active","Backup","All"]
},
"arpIpTarget": {
"type": "string"
},
"persistentDhclient": {
"type": "boolean",
"readOnly": true
},
"hwAddr": {
"type": "string",
"example": "02:5C:3A:73:05:35",
"readOnly": true,
"pattern": "^[A-F0-9]{2}:[A-F0-9]{2}:[A-F0-9]{2}:[A-F0-9]{2}:[A-F0-9]{2}:[A-F0-9]{2}$"
},
"ethtoolOpts": {
"type": "string",
"readOnly": true
},
"ethtoolAccelOpts": {
"type": "string",
"readOnly": true
}
}
}
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"port": "eth0.42",
"type": "Vlan",
"status": "Deployed",
"UUID": "035506de-ef75-49be-ada9-a25b820fc738",
"hostname": "papyrus-noa",
"interfaces": [
{
"ipAddress": "23.16.0.4",
"networkName": "WAN"
}
],
"options": {
"baseDevice": [
"eth0"
],
"mtu": 1500,
"bootProto": "None",
"onboot": true
}
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /topo/networkdevices
Adds a new Network Device. Using existing networking devices, create a new Network Device. The following Network Device types may be created using this interface:
- Bonding - combine two devices into a single aggregated network interface.
- Vlan - Add a Vlan network interface to a device.
Alias - Add an aliased network interface to a device (add a second IPV4 address).
Ethernet devices cannot be added or deleted - these must preconfigured by the OS.
The POST operation will return the generated uuid for the newly created device.
Target server: NOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/networkdevice/networkdevice.json",
"type" :"object",
"required": ["hostname","type","interfaces"],
"notInsertable": ["status","UUID"],
"properties": {
"port": {
"type": "string",
"example": "eth01",
"description": "Device Port"
},
"type": {
"type": "string",
"enum": ["Bonding","Vlan","Alias","Ethernet"],
"example": "Vlan",
"description": "Device Type"
},
"status": {
"type": "string",
"description": "Device configuration status (computed)",
"enum": [
"Configured",
"DeletePending",
"Deployed",
"Discovered",
"EditPending"
]
},
"UUID": {
"type": "string",
"description": "Device Identifier (generated)",
"example": "3907f4f5-130b-4f99-9c8f-8b5d32d6112",
"pattern": "[a-f0-9]{8}-[a-f0-9]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^([A-Za-z0-9=]+)$"
},
"hostname": {
"type": "string",
"example": "sans-noa",
"description": "Hostname"
},
"interfaces": {
"type": "array",
"description": "Device Interfaces",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/deviceInterface/deviceInterface.json",
"type" :"object",
"required": ["networkName","ipAddress"],
"properties": {
"networkName": {
"type": "string",
"example": "LAN",
"description": "Network Name"
},
"ipAddress":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6/IPv4orIPv6.json",
"type": "string",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^(default)$",
"example": "192.168.1.1"
}
}
},
"minItems": 0
},
"options": {
"type": "object",
"properties": {
"onboot": {
"type": "boolean"
},
"bootProto": {
"type": "string",
"example": "Dhcp",
"enum": [
"Dhcp",
"None"
]
},
"mtu": {
"type": "integer",
"minimum": 1280,
"maximum": 65570
},
"baseDevice": {
"type": "array",
"example": ["eth0"],
"items":
{ "type": "string" },
"minItems": 1
},
"monitorType": {
"type": "string",
"example": "Mii",
"enum": ["Mii","Arp"]
},
"primary": {
"type": "string"
},
"miimon": {
"type": "integer",
"minimum": 1
},
"updelay": {
"type": "integer",
"minimum": 1
},
"downdelay": {
"type": "integer",
"minimum": 1
},
"arpInterval": {
"type": "integer",
"minimum": 1
},
"arpValidate": {
"type": "string",
"example": "Active",
"enum": ["None","Active","Backup","All"]
},
"arpIpTarget": {
"type": "string"
},
"persistentDhclient": {
"type": "boolean",
"readOnly": true
},
"hwAddr": {
"type": "string",
"example": "02:5C:3A:73:05:35",
"readOnly": true,
"pattern": "^[A-F0-9]{2}:[A-F0-9]{2}:[A-F0-9]{2}:[A-F0-9]{2}:[A-F0-9]{2}:[A-F0-9]{2}$"
},
"ethtoolOpts": {
"type": "string",
"readOnly": true
},
"ethtoolAccelOpts": {
"type": "string",
"readOnly": true
}
}
}
}
}
Example
{
"port": "eth0.42",
"type": "Vlan",
"status": "Deployed",
"UUID": "035506de-ef75-49be-ada9-a25b820fc738",
"hostname": "papyrus-noa",
"interfaces": [
{
"ipAddress": "23.16.0.4",
"networkName": "WAN"
}
],
"options": {
"baseDevice": [
"eth0"
],
"mtu": 1500,
"bootProto": "None",
"onboot": true
}
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/topo/networkdevices/{uuid}
get /topo/networkdevices/{uuid}
Returns the configuration details and a set of links for the specified Network Device. The links can be used to perform delete or edit operations on the Network Device.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- uuid: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/items/networkdeviceItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/networkdevice/networkdevice.json",
"type" :"object",
"required": ["hostname","type","interfaces"],
"notInsertable": ["status","UUID"],
"properties": {
"port": {
"type": "string",
"example": "eth01",
"description": "Device Port"
},
"type": {
"type": "string",
"enum": ["Bonding","Vlan","Alias","Ethernet"],
"example": "Vlan",
"description": "Device Type"
},
"status": {
"type": "string",
"description": "Device configuration status (computed)",
"enum": [
"Configured",
"DeletePending",
"Deployed",
"Discovered",
"EditPending"
]
},
"UUID": {
"type": "string",
"description": "Device Identifier (generated)",
"example": "3907f4f5-130b-4f99-9c8f-8b5d32d6112",
"pattern": "[a-f0-9]{8}-[a-f0-9]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^([A-Za-z0-9=]+)$"
},
"hostname": {
"type": "string",
"example": "sans-noa",
"description": "Hostname"
},
"interfaces": {
"type": "array",
"description": "Device Interfaces",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/deviceInterface/deviceInterface.json",
"type" :"object",
"required": ["networkName","ipAddress"],
"properties": {
"networkName": {
"type": "string",
"example": "LAN",
"description": "Network Name"
},
"ipAddress":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6/IPv4orIPv6.json",
"type": "string",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^(default)$",
"example": "192.168.1.1"
}
}
},
"minItems": 0
},
"options": {
"type": "object",
"properties": {
"onboot": {
"type": "boolean"
},
"bootProto": {
"type": "string",
"example": "Dhcp",
"enum": [
"Dhcp",
"None"
]
},
"mtu": {
"type": "integer",
"minimum": 1280,
"maximum": 65570
},
"baseDevice": {
"type": "array",
"example": ["eth0"],
"items":
{ "type": "string" },
"minItems": 1
},
"monitorType": {
"type": "string",
"example": "Mii",
"enum": ["Mii","Arp"]
},
"primary": {
"type": "string"
},
"miimon": {
"type": "integer",
"minimum": 1
},
"updelay": {
"type": "integer",
"minimum": 1
},
"downdelay": {
"type": "integer",
"minimum": 1
},
"arpInterval": {
"type": "integer",
"minimum": 1
},
"arpValidate": {
"type": "string",
"example": "Active",
"enum": ["None","Active","Backup","All"]
},
"arpIpTarget": {
"type": "string"
},
"persistentDhclient": {
"type": "boolean",
"readOnly": true
},
"hwAddr": {
"type": "string",
"example": "02:5C:3A:73:05:35",
"readOnly": true,
"pattern": "^[A-F0-9]{2}:[A-F0-9]{2}:[A-F0-9]{2}:[A-F0-9]{2}:[A-F0-9]{2}:[A-F0-9]{2}$"
},
"ethtoolOpts": {
"type": "string",
"readOnly": true
},
"ethtoolAccelOpts": {
"type": "string",
"readOnly": true
}
}
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"port": "eth0.42",
"type": "Vlan",
"status": "Deployed",
"UUID": "035506de-ef75-49be-ada9-a25b820fc738",
"hostname": "papyrus-noa",
"interfaces": [
{
"ipAddress": "23.16.0.4",
"networkName": "WAN"
}
],
"options": {
"baseDevice": [
"eth0"
],
"mtu": 1500,
"bootProto": "None",
"onboot": true
}
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /topo/networkdevices/{uuid}
Updates the Network Device details.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- uuid: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/networkdevice/networkdevice.json",
"type" :"object",
"required": ["hostname","type","interfaces"],
"notInsertable": ["status","UUID"],
"properties": {
"port": {
"type": "string",
"example": "eth01",
"description": "Device Port"
},
"type": {
"type": "string",
"enum": ["Bonding","Vlan","Alias","Ethernet"],
"example": "Vlan",
"description": "Device Type"
},
"status": {
"type": "string",
"description": "Device configuration status (computed)",
"enum": [
"Configured",
"DeletePending",
"Deployed",
"Discovered",
"EditPending"
]
},
"UUID": {
"type": "string",
"description": "Device Identifier (generated)",
"example": "3907f4f5-130b-4f99-9c8f-8b5d32d6112",
"pattern": "[a-f0-9]{8}-[a-f0-9]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^([A-Za-z0-9=]+)$"
},
"hostname": {
"type": "string",
"example": "sans-noa",
"description": "Hostname"
},
"interfaces": {
"type": "array",
"description": "Device Interfaces",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/deviceInterface/deviceInterface.json",
"type" :"object",
"required": ["networkName","ipAddress"],
"properties": {
"networkName": {
"type": "string",
"example": "LAN",
"description": "Network Name"
},
"ipAddress":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6/IPv4orIPv6.json",
"type": "string",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^(default)$",
"example": "192.168.1.1"
}
}
},
"minItems": 0
},
"options": {
"type": "object",
"properties": {
"onboot": {
"type": "boolean"
},
"bootProto": {
"type": "string",
"example": "Dhcp",
"enum": [
"Dhcp",
"None"
]
},
"mtu": {
"type": "integer",
"minimum": 1280,
"maximum": 65570
},
"baseDevice": {
"type": "array",
"example": ["eth0"],
"items":
{ "type": "string" },
"minItems": 1
},
"monitorType": {
"type": "string",
"example": "Mii",
"enum": ["Mii","Arp"]
},
"primary": {
"type": "string"
},
"miimon": {
"type": "integer",
"minimum": 1
},
"updelay": {
"type": "integer",
"minimum": 1
},
"downdelay": {
"type": "integer",
"minimum": 1
},
"arpInterval": {
"type": "integer",
"minimum": 1
},
"arpValidate": {
"type": "string",
"example": "Active",
"enum": ["None","Active","Backup","All"]
},
"arpIpTarget": {
"type": "string"
},
"persistentDhclient": {
"type": "boolean",
"readOnly": true
},
"hwAddr": {
"type": "string",
"example": "02:5C:3A:73:05:35",
"readOnly": true,
"pattern": "^[A-F0-9]{2}:[A-F0-9]{2}:[A-F0-9]{2}:[A-F0-9]{2}:[A-F0-9]{2}:[A-F0-9]{2}$"
},
"ethtoolOpts": {
"type": "string",
"readOnly": true
},
"ethtoolAccelOpts": {
"type": "string",
"readOnly": true
}
}
}
}
}
Example
{
"port": "eth0.42",
"type": "Vlan",
"status": "Deployed",
"UUID": "035506de-ef75-49be-ada9-a25b820fc738",
"hostname": "papyrus-noa",
"interfaces": [
{
"ipAddress": "23.16.0.4",
"networkName": "WAN"
}
],
"options": {
"baseDevice": [
"eth0"
],
"mtu": 1500,
"bootProto": "None",
"onboot": true
}
}
delete /topo/networkdevices/{uuid}
Deletes the Network Device, using a link returned by a previous GET operation.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- uuid: required (string)
/topo/networkdevices/discovered
get /topo/networkdevices/discovered
Returns the details for discovered Network Devices that meet the request parameters.
Target server: NOAM
Secured by x-other
Request
Query Parameters
- scope_type: (one of Server, ServerGroup, NetworkElement)
Identifies the type of Server collection the results are limited to.
Example:
?scope_type=Server&scope_name=mynoa
- scope_name: (string)
Names the specific Server collection the results are limited to.
Example:
?scope_type=ServerGroup&scope_name=NO_SG
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/collections/networkdeviceCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/networkdevice/networkdevice.json",
"type" :"object",
"required": ["hostname","type","interfaces"],
"notInsertable": ["status","UUID"],
"properties": {
"port": {
"type": "string",
"example": "eth01",
"description": "Device Port"
},
"type": {
"type": "string",
"enum": ["Bonding","Vlan","Alias","Ethernet"],
"example": "Vlan",
"description": "Device Type"
},
"status": {
"type": "string",
"description": "Device configuration status (computed)",
"enum": [
"Configured",
"DeletePending",
"Deployed",
"Discovered",
"EditPending"
]
},
"UUID": {
"type": "string",
"description": "Device Identifier (generated)",
"example": "3907f4f5-130b-4f99-9c8f-8b5d32d6112",
"pattern": "[a-f0-9]{8}-[a-f0-9]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^([A-Za-z0-9=]+)$"
},
"hostname": {
"type": "string",
"example": "sans-noa",
"description": "Hostname"
},
"interfaces": {
"type": "array",
"description": "Device Interfaces",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/deviceInterface/deviceInterface.json",
"type" :"object",
"required": ["networkName","ipAddress"],
"properties": {
"networkName": {
"type": "string",
"example": "LAN",
"description": "Network Name"
},
"ipAddress":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6/IPv4orIPv6.json",
"type": "string",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^(default)$",
"example": "192.168.1.1"
}
}
},
"minItems": 0
},
"options": {
"type": "object",
"properties": {
"onboot": {
"type": "boolean"
},
"bootProto": {
"type": "string",
"example": "Dhcp",
"enum": [
"Dhcp",
"None"
]
},
"mtu": {
"type": "integer",
"minimum": 1280,
"maximum": 65570
},
"baseDevice": {
"type": "array",
"example": ["eth0"],
"items":
{ "type": "string" },
"minItems": 1
},
"monitorType": {
"type": "string",
"example": "Mii",
"enum": ["Mii","Arp"]
},
"primary": {
"type": "string"
},
"miimon": {
"type": "integer",
"minimum": 1
},
"updelay": {
"type": "integer",
"minimum": 1
},
"downdelay": {
"type": "integer",
"minimum": 1
},
"arpInterval": {
"type": "integer",
"minimum": 1
},
"arpValidate": {
"type": "string",
"example": "Active",
"enum": ["None","Active","Backup","All"]
},
"arpIpTarget": {
"type": "string"
},
"persistentDhclient": {
"type": "boolean",
"readOnly": true
},
"hwAddr": {
"type": "string",
"example": "02:5C:3A:73:05:35",
"readOnly": true,
"pattern": "^[A-F0-9]{2}:[A-F0-9]{2}:[A-F0-9]{2}:[A-F0-9]{2}:[A-F0-9]{2}:[A-F0-9]{2}$"
},
"ethtoolOpts": {
"type": "string",
"readOnly": true
},
"ethtoolAccelOpts": {
"type": "string",
"readOnly": true
}
}
}
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"port": "eth0.42",
"type": "Vlan",
"status": "Deployed",
"UUID": "035506de-ef75-49be-ada9-a25b820fc738",
"hostname": "papyrus-noa",
"interfaces": [
{
"ipAddress": "23.16.0.4",
"networkName": "WAN"
}
],
"options": {
"baseDevice": [
"eth0"
],
"mtu": 1500,
"bootProto": "None",
"onboot": true
}
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
/topo/networkdevices/discovered/{uuid}
get /topo/networkdevices/discovered/{uuid}
Returns the details and a set of link for discovered Network devices. The link can be used to perform an edit operation on the Network Device.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- uuid: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/items/networkdeviceItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/networkdevice/networkdevice.json",
"type" :"object",
"required": ["hostname","type","interfaces"],
"notInsertable": ["status","UUID"],
"properties": {
"port": {
"type": "string",
"example": "eth01",
"description": "Device Port"
},
"type": {
"type": "string",
"enum": ["Bonding","Vlan","Alias","Ethernet"],
"example": "Vlan",
"description": "Device Type"
},
"status": {
"type": "string",
"description": "Device configuration status (computed)",
"enum": [
"Configured",
"DeletePending",
"Deployed",
"Discovered",
"EditPending"
]
},
"UUID": {
"type": "string",
"description": "Device Identifier (generated)",
"example": "3907f4f5-130b-4f99-9c8f-8b5d32d6112",
"pattern": "[a-f0-9]{8}-[a-f0-9]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^([A-Za-z0-9=]+)$"
},
"hostname": {
"type": "string",
"example": "sans-noa",
"description": "Hostname"
},
"interfaces": {
"type": "array",
"description": "Device Interfaces",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/deviceInterface/deviceInterface.json",
"type" :"object",
"required": ["networkName","ipAddress"],
"properties": {
"networkName": {
"type": "string",
"example": "LAN",
"description": "Network Name"
},
"ipAddress":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6/IPv4orIPv6.json",
"type": "string",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^(default)$",
"example": "192.168.1.1"
}
}
},
"minItems": 0
},
"options": {
"type": "object",
"properties": {
"onboot": {
"type": "boolean"
},
"bootProto": {
"type": "string",
"example": "Dhcp",
"enum": [
"Dhcp",
"None"
]
},
"mtu": {
"type": "integer",
"minimum": 1280,
"maximum": 65570
},
"baseDevice": {
"type": "array",
"example": ["eth0"],
"items":
{ "type": "string" },
"minItems": 1
},
"monitorType": {
"type": "string",
"example": "Mii",
"enum": ["Mii","Arp"]
},
"primary": {
"type": "string"
},
"miimon": {
"type": "integer",
"minimum": 1
},
"updelay": {
"type": "integer",
"minimum": 1
},
"downdelay": {
"type": "integer",
"minimum": 1
},
"arpInterval": {
"type": "integer",
"minimum": 1
},
"arpValidate": {
"type": "string",
"example": "Active",
"enum": ["None","Active","Backup","All"]
},
"arpIpTarget": {
"type": "string"
},
"persistentDhclient": {
"type": "boolean",
"readOnly": true
},
"hwAddr": {
"type": "string",
"example": "02:5C:3A:73:05:35",
"readOnly": true,
"pattern": "^[A-F0-9]{2}:[A-F0-9]{2}:[A-F0-9]{2}:[A-F0-9]{2}:[A-F0-9]{2}:[A-F0-9]{2}$"
},
"ethtoolOpts": {
"type": "string",
"readOnly": true
},
"ethtoolAccelOpts": {
"type": "string",
"readOnly": true
}
}
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"port": "eth0.42",
"type": "Vlan",
"status": "Deployed",
"UUID": "035506de-ef75-49be-ada9-a25b820fc738",
"hostname": "papyrus-noa",
"interfaces": [
{
"ipAddress": "23.16.0.4",
"networkName": "WAN"
}
],
"options": {
"baseDevice": [
"eth0"
],
"mtu": 1500,
"bootProto": "None",
"onboot": true
}
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /topo/networkdevices/discovered/{uuid}
The PUT operation allows a client to take ownership of a discovered Network Device. Using the details returned by a previous GET operation, the PUT operation allows a discovered device to be recharacterized as a configured device. The client can use the Network Devices URI (/topo/networkdevices) to retrieve the configured Network Device.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- uuid: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/update/update.json",
"type" :"object",
"required": [
],
"properties": {
}
}
Example
{
}
Topo: Network Elements
A Network Element is a common set of networking configurations that several servers may share. Typically, all the the servers sharing the Network Element configuration are located at the same site. The name field is the natural identifier for this collection.
Configuration of Network Elements is only available at the NOAM.
/topo/networkelements
get /topo/networkelements
Retrieves configuration data for all Network Elements that meet the request parameters.
Target server: NOAM
Secured by x-other
Request
Query Parameters
- scope_type: (one of Server, ServerGroup, NetworkElement)
Identifies the type of Server collection the results are limited to.
Example:
?scope_type=Server&scope_name=mynoa
- scope_name: (string)
Names the specific Server collection the results are limited to.
Example:
?scope_type=ServerGroup&scope_name=NO_SG
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/collections/networkelementCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/networkelement/networkelement.json",
"type": "object",
"required": ["name"],
"properties": {
"name": {
"type": "string",
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"maxLength": 32,
"example": "NO_NE",
"description": "Network Element Name"
}
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"name": "NO_NE"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /topo/networkelements
Adds a new Network Element. The name field is the identifier and is returned by the POST operation.
Target server: NOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/networkelement/networkelement.json",
"type": "object",
"required": ["name"],
"properties": {
"name": {
"type": "string",
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"maxLength": 32,
"example": "NO_NE",
"description": "Network Element Name"
}
}
}
Example
{
"name": "NO_NE"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/topo/networkelements/{name}
get /topo/networkelements/{name}
Returns the configuration details for the specified Network Element.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/items/networkelementItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/networkelement/networkelement.json",
"type": "object",
"required": ["name"],
"properties": {
"name": {
"type": "string",
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"maxLength": 32,
"example": "NO_NE",
"description": "Network Element Name"
}
}
}
,
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"name": "NO_NE"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
delete /topo/networkelements/{name}
Deletes the specified Network Element. Note that a Network Element can only be deleted if it has no children.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
/topo/networkelements/{name}/monitor
get /topo/networkelements/{name}/monitor
Retrieves the router monitoring status for the named Network Element.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/networkelement/nemonitor.json",
"type": "object",
"required": ["ping"],
"properties": {
"ping": {
"description": "Router Monitor Ping",
"enum": [ "Enabled", "Disabled" ],
"example": "Enabled"
}
}
}
Example
{
"ping": "Enabled"
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /topo/networkelements/{name}/monitor
Manages the router monitoring for a Network Element.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/networkelement/nemonitor.json",
"type": "object",
"required": ["ping"],
"properties": {
"ping": {
"description": "Router Monitor Ping",
"enum": [ "Enabled", "Disabled" ],
"example": "Enabled"
}
}
}
Example
{
"ping": "Enabled"
}
Topo: Network Routes
Network Routes are used to direct network traffic between servers. Routes may be added for both IPV6 and IPV4 networks. Items in the Network Route collection don't have a natural identifier. Each time a new Route is created, it is assigned an identifier which is available as the uuid field.
Configuration of network routes is only available at the NOAM.
/topo/networkroutes
get /topo/networkroutes
Returns the configuration data for all Network Routes that meet the request parameters.
Target server: NOAM
Secured by x-other
Request
Query Parameters
- scope_type: (one of Server, ServerGroup, NetworkElement)
Identifies the type of Server collection the results are limited to.
Example:
?scope_type=Server&scope_name=mynoa
- scope_name: (string)
Names the specific Server collection the results are limited to.
Example:
?scope_type=ServerGroup&scope_name=NO_SG
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/collections/networkrouteCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/networkroute/networkroute.json",
"type": "object",
"required": ["type","port","scope","scopeType"],
"notInsertable": ["UUID"],
"properties": {
"hostname": {
"type": "string",
"description": "Hostname"
},
"UUID": {
"type": "string",
"description": "Route Identifier",
"example": "3907f4f5-130b-4f99-9c8f-8b5d32d6112",
"pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^([A-Za-z0-9=]+)$"
},
"type": {
"type": "string",
"enum": [
"Default",
"Host",
"Net"
]
},
"port": {
"type": "string",
"description": "Device name"
},
"networkAddress":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6/IPv4orIPv6.json",
"type": "string",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^(default)$",
"example": "192.168.1.1"
},
"subnetMask":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6NetMask/IPv4orIPv6NetMask.json",
"type": "string",
"pattern": "^(((1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}(1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^/[0-9]{1,3}$",
"example": "/24"
},
"gatewayAddress":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6/IPv4orIPv6.json",
"type": "string",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^(default)$",
"example": "192.168.1.1"
},
"scope": {
"type": "string",
"description": "Route Scope"
},
"scopeType": {
"type": "string",
"enum": [
"Server",
"ServerGroup"
]
},
"status": {
"type": "string",
"description": "Configuration status (computed)",
"enum": ["Deployed","Discovered","Configured"]
},
"statusDetails": {
"type": "string",
"description": "Additional status details (computed)",
"example": "Route deployed to 12 of 34 servers"
}
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"hostname": "mettaton-noa",
"UUID": "2c7abb61-0fb2-4d10-848f-17778b1b005b",
"type": "Net",
"port": "eth0.3000",
"networkAddress": "42.42.43.0",
"subnetMask": "255.255.255.0",
"gatewayAddress": "4.3.2.1",
"scope": "mettaton-noa",
"scopeType": "Server",
"status": "Deployed"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /topo/networkroutes
Adds a new Network Route, allowing a Route to be associated with either a Server or a Server Group. The generated uuid is returned.
Target server: NOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/networkroute/networkroute.json",
"type": "object",
"required": ["type","port","scope","scopeType"],
"notInsertable": ["UUID"],
"properties": {
"hostname": {
"type": "string",
"description": "Hostname"
},
"UUID": {
"type": "string",
"description": "Route Identifier",
"example": "3907f4f5-130b-4f99-9c8f-8b5d32d6112",
"pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^([A-Za-z0-9=]+)$"
},
"type": {
"type": "string",
"enum": [
"Default",
"Host",
"Net"
]
},
"port": {
"type": "string",
"description": "Device name"
},
"networkAddress":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6/IPv4orIPv6.json",
"type": "string",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^(default)$",
"example": "192.168.1.1"
},
"subnetMask":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6NetMask/IPv4orIPv6NetMask.json",
"type": "string",
"pattern": "^(((1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}(1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^/[0-9]{1,3}$",
"example": "/24"
},
"gatewayAddress":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6/IPv4orIPv6.json",
"type": "string",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^(default)$",
"example": "192.168.1.1"
},
"scope": {
"type": "string",
"description": "Route Scope"
},
"scopeType": {
"type": "string",
"enum": [
"Server",
"ServerGroup"
]
},
"status": {
"type": "string",
"description": "Configuration status (computed)",
"enum": ["Deployed","Discovered","Configured"]
},
"statusDetails": {
"type": "string",
"description": "Additional status details (computed)",
"example": "Route deployed to 12 of 34 servers"
}
}
}
Example
{
"hostname": "mettaton-noa",
"UUID": "2c7abb61-0fb2-4d10-848f-17778b1b005b",
"type": "Net",
"port": "eth0.3000",
"networkAddress": "42.42.43.0",
"subnetMask": "255.255.255.0",
"gatewayAddress": "4.3.2.1",
"scope": "mettaton-noa",
"scopeType": "Server",
"status": "Deployed"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/topo/networkroutes/{uuid}
get /topo/networkroutes/{uuid}
Returns the configuration details for the specified Network Route.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- uuid: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/items/networkrouteItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/networkroute/networkroute.json",
"type": "object",
"required": ["type","port","scope","scopeType"],
"notInsertable": ["UUID"],
"properties": {
"hostname": {
"type": "string",
"description": "Hostname"
},
"UUID": {
"type": "string",
"description": "Route Identifier",
"example": "3907f4f5-130b-4f99-9c8f-8b5d32d6112",
"pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^([A-Za-z0-9=]+)$"
},
"type": {
"type": "string",
"enum": [
"Default",
"Host",
"Net"
]
},
"port": {
"type": "string",
"description": "Device name"
},
"networkAddress":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6/IPv4orIPv6.json",
"type": "string",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^(default)$",
"example": "192.168.1.1"
},
"subnetMask":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6NetMask/IPv4orIPv6NetMask.json",
"type": "string",
"pattern": "^(((1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}(1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^/[0-9]{1,3}$",
"example": "/24"
},
"gatewayAddress":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6/IPv4orIPv6.json",
"type": "string",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^(default)$",
"example": "192.168.1.1"
},
"scope": {
"type": "string",
"description": "Route Scope"
},
"scopeType": {
"type": "string",
"enum": [
"Server",
"ServerGroup"
]
},
"status": {
"type": "string",
"description": "Configuration status (computed)",
"enum": ["Deployed","Discovered","Configured"]
},
"statusDetails": {
"type": "string",
"description": "Additional status details (computed)",
"example": "Route deployed to 12 of 34 servers"
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"hostname": "mettaton-noa",
"UUID": "2c7abb61-0fb2-4d10-848f-17778b1b005b",
"type": "Net",
"port": "eth0.3000",
"networkAddress": "42.42.43.0",
"subnetMask": "255.255.255.0",
"gatewayAddress": "4.3.2.1",
"scope": "mettaton-noa",
"scopeType": "Server",
"status": "Deployed"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /topo/networkroutes/{uuid}
Updates the Network Route details.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- uuid: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/networkroute/networkroute.json",
"type": "object",
"required": ["type","port","scope","scopeType"],
"notInsertable": ["UUID"],
"properties": {
"hostname": {
"type": "string",
"description": "Hostname"
},
"UUID": {
"type": "string",
"description": "Route Identifier",
"example": "3907f4f5-130b-4f99-9c8f-8b5d32d6112",
"pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^([A-Za-z0-9=]+)$"
},
"type": {
"type": "string",
"enum": [
"Default",
"Host",
"Net"
]
},
"port": {
"type": "string",
"description": "Device name"
},
"networkAddress":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6/IPv4orIPv6.json",
"type": "string",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^(default)$",
"example": "192.168.1.1"
},
"subnetMask":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6NetMask/IPv4orIPv6NetMask.json",
"type": "string",
"pattern": "^(((1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}(1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^/[0-9]{1,3}$",
"example": "/24"
},
"gatewayAddress":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6/IPv4orIPv6.json",
"type": "string",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^(default)$",
"example": "192.168.1.1"
},
"scope": {
"type": "string",
"description": "Route Scope"
},
"scopeType": {
"type": "string",
"enum": [
"Server",
"ServerGroup"
]
},
"status": {
"type": "string",
"description": "Configuration status (computed)",
"enum": ["Deployed","Discovered","Configured"]
},
"statusDetails": {
"type": "string",
"description": "Additional status details (computed)",
"example": "Route deployed to 12 of 34 servers"
}
}
}
Example
{
"hostname": "mettaton-noa",
"UUID": "2c7abb61-0fb2-4d10-848f-17778b1b005b",
"type": "Net",
"port": "eth0.3000",
"networkAddress": "42.42.43.0",
"subnetMask": "255.255.255.0",
"gatewayAddress": "4.3.2.1",
"scope": "mettaton-noa",
"scopeType": "Server",
"status": "Deployed"
}
delete /topo/networkroutes/{uuid}
Deletes a Network Route.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- uuid: required (string)
/topo/networkroutes/discovered
get /topo/networkroutes/discovered
Returns all discovered Network Routes that meet the request parameters.
Target server: NOAM
Secured by x-other
Request
Query Parameters
- scope_type: (one of Server, ServerGroup, NetworkElement)
Identifies the type of Server collection the results are limited to.
Example:
?scope_type=Server&scope_name=mynoa
- scope_name: (string)
Names the specific Server collection the results are limited to.
Example:
?scope_type=ServerGroup&scope_name=NO_SG
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/collections/networkrouteCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/networkroute/networkroute.json",
"type": "object",
"required": ["type","port","scope","scopeType"],
"notInsertable": ["UUID"],
"properties": {
"hostname": {
"type": "string",
"description": "Hostname"
},
"UUID": {
"type": "string",
"description": "Route Identifier",
"example": "3907f4f5-130b-4f99-9c8f-8b5d32d6112",
"pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^([A-Za-z0-9=]+)$"
},
"type": {
"type": "string",
"enum": [
"Default",
"Host",
"Net"
]
},
"port": {
"type": "string",
"description": "Device name"
},
"networkAddress":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6/IPv4orIPv6.json",
"type": "string",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^(default)$",
"example": "192.168.1.1"
},
"subnetMask":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6NetMask/IPv4orIPv6NetMask.json",
"type": "string",
"pattern": "^(((1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}(1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^/[0-9]{1,3}$",
"example": "/24"
},
"gatewayAddress":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6/IPv4orIPv6.json",
"type": "string",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^(default)$",
"example": "192.168.1.1"
},
"scope": {
"type": "string",
"description": "Route Scope"
},
"scopeType": {
"type": "string",
"enum": [
"Server",
"ServerGroup"
]
},
"status": {
"type": "string",
"description": "Configuration status (computed)",
"enum": ["Deployed","Discovered","Configured"]
},
"statusDetails": {
"type": "string",
"description": "Additional status details (computed)",
"example": "Route deployed to 12 of 34 servers"
}
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"hostname": "mettaton-noa",
"UUID": "2c7abb61-0fb2-4d10-848f-17778b1b005b",
"type": "Net",
"port": "eth0.3000",
"networkAddress": "42.42.43.0",
"subnetMask": "255.255.255.0",
"gatewayAddress": "4.3.2.1",
"scope": "mettaton-noa",
"scopeType": "Server",
"status": "Deployed"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
/topo/networkroutes/discovered/{uuid}
get /topo/networkroutes/discovered/{uuid}
Returns the details for the specified discovered Network Route.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- uuid: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/items/networkrouteItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/networkroute/networkroute.json",
"type": "object",
"required": ["type","port","scope","scopeType"],
"notInsertable": ["UUID"],
"properties": {
"hostname": {
"type": "string",
"description": "Hostname"
},
"UUID": {
"type": "string",
"description": "Route Identifier",
"example": "3907f4f5-130b-4f99-9c8f-8b5d32d6112",
"pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^([A-Za-z0-9=]+)$"
},
"type": {
"type": "string",
"enum": [
"Default",
"Host",
"Net"
]
},
"port": {
"type": "string",
"description": "Device name"
},
"networkAddress":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6/IPv4orIPv6.json",
"type": "string",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^(default)$",
"example": "192.168.1.1"
},
"subnetMask":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6NetMask/IPv4orIPv6NetMask.json",
"type": "string",
"pattern": "^(((1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}(1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^/[0-9]{1,3}$",
"example": "/24"
},
"gatewayAddress":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6/IPv4orIPv6.json",
"type": "string",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^(default)$",
"example": "192.168.1.1"
},
"scope": {
"type": "string",
"description": "Route Scope"
},
"scopeType": {
"type": "string",
"enum": [
"Server",
"ServerGroup"
]
},
"status": {
"type": "string",
"description": "Configuration status (computed)",
"enum": ["Deployed","Discovered","Configured"]
},
"statusDetails": {
"type": "string",
"description": "Additional status details (computed)",
"example": "Route deployed to 12 of 34 servers"
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"hostname": "mettaton-noa",
"UUID": "2c7abb61-0fb2-4d10-848f-17778b1b005b",
"type": "Net",
"port": "eth0.3000",
"networkAddress": "42.42.43.0",
"subnetMask": "255.255.255.0",
"gatewayAddress": "4.3.2.1",
"scope": "mettaton-noa",
"scopeType": "Server",
"status": "Deployed"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /topo/networkroutes/discovered/{uuid}
Using the details returned by a previous GET operation, the PUT operation allows a discovered Network Route to be recharacterized as a configured Network Route. The client can use the Network Routes URI (/topo/networkroutes) to retrieve the configured Network Route.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- uuid: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/update/update.json",
"type" :"object",
"required": [
],
"properties": {
}
}
Example
{
}
Topo: Networks
A Network is used to name a collection of network related data. Networks sharing the same name are typical and expected as the network names are used when defining service paths. Items in the Network collection don't have a natural identifier. Each time a new Network is created, it is assigned an identifier which is available as the uuid field.
Configuration of networks is only available at the NOAM.
/topo/networks
get /topo/networks
Returns the configuration details for all configured Networks.
Target server: NOAM
Secured by x-other
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/collections/networkCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/network/network.json",
"type" :"object",
"required": ["name", "vlanId", "ipAddress", "subnetMask"],
"notInsertable": ["UUID"],
"properties": {
"name": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9]*$",
"maxLength": 31,
"example": "LAN",
"description": "Network Name"
},
"UUID": {
"type": "string",
"description": "Network Identifier (*computed*)",
"example": "3907f4f5-130b-4f99-9c8f-8b5d32d6112",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
"neName": {
"type": "string",
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"maxLength": 32,
"example": "NO_NE",
"description": "Network Element Name"
},
"type": {
"enum": [
"Application",
"Oam"
],
"example": "Oam",
"description": "Network Type"
},
"vlanId": {
"type": "integer",
"minimum": 1,
"maximum": 4094,
"example": 123,
"description": "VLAN ID for this Network"
},
"ipAddress":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6/IPv4orIPv6.json",
"type": "string",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^(default)$",
"example": "192.168.1.1"
},
"subnetMask":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6NetMask/IPv4orIPv6NetMask.json",
"type": "string",
"pattern": "^(((1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}(1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^/[0-9]{1,3}$",
"example": "/24"
},
"gatewayAddress":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6/IPv4orIPv6.json",
"type": "string",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^(default)$",
"example": "192.168.1.1"
},
"isDefault": {
"type": "boolean",
"example": true,
"description": "Is Default Gateway"
},
"isRoutable": {
"type": "boolean",
"example": true,
"description": "Is Routable"
},
"locked": {
"type": "boolean",
"example": false,
"description": "Locked"
}
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"name": "WAN",
"UUID": "445b8667-bd22-45fd-adfd-c6fa5032819f",
"neName": "NO_NE",
"type": "Oam",
"vlanId": 38,
"ipAddress": "23.55.0.0",
"subnetMask": "255.255.255.0",
"gatewayAddress": "23.55.0.1",
"isDefault": true,
"isRoutable": true,
"locked": true
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /topo/networks
Adds a new Network to the configuration. The generated uuid field is returned.
Target server: NOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/network/network.json",
"type" :"object",
"required": ["name", "vlanId", "ipAddress", "subnetMask"],
"notInsertable": ["UUID"],
"properties": {
"name": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9]*$",
"maxLength": 31,
"example": "LAN",
"description": "Network Name"
},
"UUID": {
"type": "string",
"description": "Network Identifier (*computed*)",
"example": "3907f4f5-130b-4f99-9c8f-8b5d32d6112",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
"neName": {
"type": "string",
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"maxLength": 32,
"example": "NO_NE",
"description": "Network Element Name"
},
"type": {
"enum": [
"Application",
"Oam"
],
"example": "Oam",
"description": "Network Type"
},
"vlanId": {
"type": "integer",
"minimum": 1,
"maximum": 4094,
"example": 123,
"description": "VLAN ID for this Network"
},
"ipAddress":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6/IPv4orIPv6.json",
"type": "string",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^(default)$",
"example": "192.168.1.1"
},
"subnetMask":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6NetMask/IPv4orIPv6NetMask.json",
"type": "string",
"pattern": "^(((1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}(1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^/[0-9]{1,3}$",
"example": "/24"
},
"gatewayAddress":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6/IPv4orIPv6.json",
"type": "string",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^(default)$",
"example": "192.168.1.1"
},
"isDefault": {
"type": "boolean",
"example": true,
"description": "Is Default Gateway"
},
"isRoutable": {
"type": "boolean",
"example": true,
"description": "Is Routable"
},
"locked": {
"type": "boolean",
"example": false,
"description": "Locked"
}
}
}
Example
{
"name": "WAN",
"UUID": "445b8667-bd22-45fd-adfd-c6fa5032819f",
"neName": "NO_NE",
"type": "Oam",
"vlanId": 38,
"ipAddress": "23.55.0.0",
"subnetMask": "255.255.255.0",
"gatewayAddress": "23.55.0.1",
"isDefault": true,
"isRoutable": true,
"locked": true
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/topo/networks/{uuid}
get /topo/networks/{uuid}
Returns the configuration details for the specified Network.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- uuid: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/items/networkItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/network/network.json",
"type" :"object",
"required": ["name", "vlanId", "ipAddress", "subnetMask"],
"notInsertable": ["UUID"],
"properties": {
"name": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9]*$",
"maxLength": 31,
"example": "LAN",
"description": "Network Name"
},
"UUID": {
"type": "string",
"description": "Network Identifier (*computed*)",
"example": "3907f4f5-130b-4f99-9c8f-8b5d32d6112",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
"neName": {
"type": "string",
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"maxLength": 32,
"example": "NO_NE",
"description": "Network Element Name"
},
"type": {
"enum": [
"Application",
"Oam"
],
"example": "Oam",
"description": "Network Type"
},
"vlanId": {
"type": "integer",
"minimum": 1,
"maximum": 4094,
"example": 123,
"description": "VLAN ID for this Network"
},
"ipAddress":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6/IPv4orIPv6.json",
"type": "string",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^(default)$",
"example": "192.168.1.1"
},
"subnetMask":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6NetMask/IPv4orIPv6NetMask.json",
"type": "string",
"pattern": "^(((1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}(1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^/[0-9]{1,3}$",
"example": "/24"
},
"gatewayAddress":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6/IPv4orIPv6.json",
"type": "string",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^(default)$",
"example": "192.168.1.1"
},
"isDefault": {
"type": "boolean",
"example": true,
"description": "Is Default Gateway"
},
"isRoutable": {
"type": "boolean",
"example": true,
"description": "Is Routable"
},
"locked": {
"type": "boolean",
"example": false,
"description": "Locked"
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"name": "WAN",
"UUID": "445b8667-bd22-45fd-adfd-c6fa5032819f",
"neName": "NO_NE",
"type": "Oam",
"vlanId": 38,
"ipAddress": "23.55.0.0",
"subnetMask": "255.255.255.0",
"gatewayAddress": "23.55.0.1",
"isDefault": true,
"isRoutable": true,
"locked": true
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /topo/networks/{uuid}
Updates the specified Network.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- uuid: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/network/network.json",
"type" :"object",
"required": ["name", "vlanId", "ipAddress", "subnetMask"],
"notInsertable": ["UUID"],
"properties": {
"name": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9]*$",
"maxLength": 31,
"example": "LAN",
"description": "Network Name"
},
"UUID": {
"type": "string",
"description": "Network Identifier (*computed*)",
"example": "3907f4f5-130b-4f99-9c8f-8b5d32d6112",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
"neName": {
"type": "string",
"pattern": "^$|^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"maxLength": 32,
"example": "NO_NE",
"description": "Network Element Name"
},
"type": {
"enum": [
"Application",
"Oam"
],
"example": "Oam",
"description": "Network Type"
},
"vlanId": {
"type": "integer",
"minimum": 1,
"maximum": 4094,
"example": 123,
"description": "VLAN ID for this Network"
},
"ipAddress":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6/IPv4orIPv6.json",
"type": "string",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^(default)$",
"example": "192.168.1.1"
},
"subnetMask":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6NetMask/IPv4orIPv6NetMask.json",
"type": "string",
"pattern": "^(((1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}(1?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^/[0-9]{1,3}$",
"example": "/24"
},
"gatewayAddress":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6/IPv4orIPv6.json",
"type": "string",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^(default)$",
"example": "192.168.1.1"
},
"isDefault": {
"type": "boolean",
"example": true,
"description": "Is Default Gateway"
},
"isRoutable": {
"type": "boolean",
"example": true,
"description": "Is Routable"
},
"locked": {
"type": "boolean",
"example": false,
"description": "Locked"
}
}
}
Example
{
"name": "WAN",
"UUID": "445b8667-bd22-45fd-adfd-c6fa5032819f",
"neName": "NO_NE",
"type": "Oam",
"vlanId": 38,
"ipAddress": "23.55.0.0",
"subnetMask": "255.255.255.0",
"gatewayAddress": "23.55.0.1",
"isDefault": true,
"isRoutable": true,
"locked": true
}
delete /topo/networks/{uuid}
Deletes the specified Network.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- uuid: required (string)
Topo: Network Service Paths
Service Paths are used to segregate traffic of a defined category on to a specified set of networks. Each distinct Service Path is identified using a preconfigured collection name.
Configuration of Service Paths is only available at the NOAM.
/topo/servicepaths
get /topo/servicepaths
Returns all the the configured Service Paths that meet the request parameters, for each predefined category.
Target server: NOAM
Secured by x-other
Request
Query Parameters
- scope_type: (one of Server, ServerGroup, NetworkElement)
Identifies the type of Server collection the results are limited to.
Example:
?scope_type=Server&scope_name=mynoa
- scope_name: (string)
Names the specific Server collection the results are limited to.
Example:
?scope_type=ServerGroup&scope_name=NO_SG
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/collections/servicepathCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/servicepath/servicepath.json",
"type": "object",
"required": ["name","intraSitePath","interSitePath"],
"properties": {
"name": {
"type": "string",
"description": "Name of Service"
},
"intraSitePath": {
"type": "string",
"description": "Intra-NE Network"
},
"interSitePath": {
"type": "string",
"description": "Inter-NE Network"
}
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"name": "OAM",
"intraSitePath": "LAN",
"interSitePath": "WAN"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
/topo/servicepaths/{name}
get /topo/servicepaths/{name}
Returns the configuration details for the specified Service Path.
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/items/servicepathItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/servicepath/servicepath.json",
"type": "object",
"required": ["name","intraSitePath","interSitePath"],
"properties": {
"name": {
"type": "string",
"description": "Name of Service"
},
"intraSitePath": {
"type": "string",
"description": "Intra-NE Network"
},
"interSitePath": {
"type": "string",
"description": "Inter-NE Network"
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"name": "OAM",
"intraSitePath": "LAN",
"interSitePath": "WAN"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /topo/servicepaths/{name}
Updates the specified Service Path. The list of suitable intraSitePath and interSitePath settings can be found by making a call to GET /topo/networks GET and finding the name fields.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/servicepath/servicepath.json",
"type": "object",
"required": ["name","intraSitePath","interSitePath"],
"properties": {
"name": {
"type": "string",
"description": "Name of Service"
},
"intraSitePath": {
"type": "string",
"description": "Intra-NE Network"
},
"interSitePath": {
"type": "string",
"description": "Inter-NE Network"
}
}
}
Example
{
"name": "OAM",
"intraSitePath": "LAN",
"interSitePath": "WAN"
}
Topo: Places
Places are used to define server location details. Places can be defined to act as parents for other Places, thus allowing hierarchical relationships to be defined (e.g., Earth -> North America -> United States -> Illinois -> Chicago). The Place name is the natural identifier for this collection.
Configuration of Places is only available at the NOAM.
/topo/places
get /topo/places
Returns the details for all configured Places.
Target server: NOAM
Secured by x-other
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/collections/placeCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/place/place.json",
"type": "object",
"required": ["name","typeName","serverList"],
"properties": {
"name": {
"type": "string",
"description": "Place Name",
"pattern": "^[A-Za-z0-9_ -]+$",
"maxLength": 32
},
"parentPlaceName": {
"type": "string",
"description": "Parent (not updatable)"
},
"typeName": {
"type": "string",
"description": "Type of Place (not updatable)"
},
"serverList": {
"type": "array",
"description": "Servers in Place",
"items": {
"type": "string"
},
"minItems": 0
}
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"name": "Winters",
"parentPlaceName": "Foggyland",
"typeName": "Site",
"serverList": [
"snowman-noa",
"snowman-soa1",
"snowman-so1mp1"
]
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /topo/places
Adds a new Place. The name field is returned as the instance identifier.
Target server: NOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/place/place.json",
"type": "object",
"required": ["name","typeName","serverList"],
"properties": {
"name": {
"type": "string",
"description": "Place Name",
"pattern": "^[A-Za-z0-9_ -]+$",
"maxLength": 32
},
"parentPlaceName": {
"type": "string",
"description": "Parent (not updatable)"
},
"typeName": {
"type": "string",
"description": "Type of Place (not updatable)"
},
"serverList": {
"type": "array",
"description": "Servers in Place",
"items": {
"type": "string"
},
"minItems": 0
}
}
}
Example
{
"name": "Winters",
"parentPlaceName": "Foggyland",
"typeName": "Site",
"serverList": [
"snowman-noa",
"snowman-soa1",
"snowman-so1mp1"
]
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/topo/places/types
get /topo/places/types
Returns all available Place Types.
Target server: NOAM
Secured by x-other
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/collections/optionCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/option/option.json",
"type" :"string"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
"Profile 1"
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
/topo/places/{name}
get /topo/places/{name}
Returns the configuration details for the specified Place.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/items/placeItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/place/place.json",
"type": "object",
"required": ["name","typeName","serverList"],
"properties": {
"name": {
"type": "string",
"description": "Place Name",
"pattern": "^[A-Za-z0-9_ -]+$",
"maxLength": 32
},
"parentPlaceName": {
"type": "string",
"description": "Parent (not updatable)"
},
"typeName": {
"type": "string",
"description": "Type of Place (not updatable)"
},
"serverList": {
"type": "array",
"description": "Servers in Place",
"items": {
"type": "string"
},
"minItems": 0
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"name": "Winters",
"parentPlaceName": "Foggyland",
"typeName": "Site",
"serverList": [
"snowman-noa",
"snowman-soa1",
"snowman-so1mp1"
]
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /topo/places/{name}
Updates a Place.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/place/place.json",
"type": "object",
"required": ["name","typeName","serverList"],
"properties": {
"name": {
"type": "string",
"description": "Place Name",
"pattern": "^[A-Za-z0-9_ -]+$",
"maxLength": 32
},
"parentPlaceName": {
"type": "string",
"description": "Parent (not updatable)"
},
"typeName": {
"type": "string",
"description": "Type of Place (not updatable)"
},
"serverList": {
"type": "array",
"description": "Servers in Place",
"items": {
"type": "string"
},
"minItems": 0
}
}
}
Example
{
"name": "Winters",
"parentPlaceName": "Foggyland",
"typeName": "Site",
"serverList": [
"snowman-noa",
"snowman-soa1",
"snowman-so1mp1"
]
}
delete /topo/places/{name}
Deletes the specified Place. Note that a Place can only be deleted if it has no children.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Topo: Place Associations
The configuration data for all Place Associations. Place Associations classify and name a relationship between two Places. The Place Association name is the natural identifier for this collection.
Configuration of Place Associations is only available at the NOAM.
/topo/placeassociations
get /topo/placeassociations
Returns the details for all configured Place Associations.
Target server: NOAM
Secured by x-other
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/collections/placeassociationCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/placeassociation/placeassociation.json",
"type" :"object",
"required": ["name","typeName","placeList"],
"properties": {
"name": {
"type": "string",
"description": "Place Association Name",
"pattern": "^[A-Za-z0-9_ -]+$",
"maxLength": 32
},
"typeName": {
"type": "string",
"description": "Type of Place Association"
},
"placeList": {
"type": "array",
"description": "Place in Association",
"items": {
"type": "string"
},
"minItems": 0
}
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"name": "austria",
"typeName": "ALEXA Related Region",
"placeList": [
"vienna"
]
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /topo/placeassociations
Adds a new Place Association to the configuration. The name field is returned as the instance identifier.
Target Server: NOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/placeassociation/placeassociation.json",
"type" :"object",
"required": ["name","typeName","placeList"],
"properties": {
"name": {
"type": "string",
"description": "Place Association Name",
"pattern": "^[A-Za-z0-9_ -]+$",
"maxLength": 32
},
"typeName": {
"type": "string",
"description": "Type of Place Association"
},
"placeList": {
"type": "array",
"description": "Place in Association",
"items": {
"type": "string"
},
"minItems": 0
}
}
}
Example
{
"name": "austria",
"typeName": "ALEXA Related Region",
"placeList": [
"vienna"
]
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/topo/placeassociations/types
get /topo/placeassociations/types
Returns all of the available Place Association Types.
Target Server: NOAM
Secured by x-other
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/collections/optionCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/option/option.json",
"type" :"string"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
"Profile 1"
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
/topo/placeassociations/{name}
get /topo/placeassociations/{name}
Returns the configuration details for the specified Place Association.
Target Server: NOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/items/placeassociationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/placeassociation/placeassociation.json",
"type" :"object",
"required": ["name","typeName","placeList"],
"properties": {
"name": {
"type": "string",
"description": "Place Association Name",
"pattern": "^[A-Za-z0-9_ -]+$",
"maxLength": 32
},
"typeName": {
"type": "string",
"description": "Type of Place Association"
},
"placeList": {
"type": "array",
"description": "Place in Association",
"items": {
"type": "string"
},
"minItems": 0
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"name": "austria",
"typeName": "ALEXA Related Region",
"placeList": [
"vienna"
]
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /topo/placeassociations/{name}
Updates a Place Association.
Target Server: NOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/placeassociation/placeassociation.json",
"type" :"object",
"required": ["name","typeName","placeList"],
"properties": {
"name": {
"type": "string",
"description": "Place Association Name",
"pattern": "^[A-Za-z0-9_ -]+$",
"maxLength": 32
},
"typeName": {
"type": "string",
"description": "Type of Place Association"
},
"placeList": {
"type": "array",
"description": "Place in Association",
"items": {
"type": "string"
},
"minItems": 0
}
}
}
Example
{
"name": "austria",
"typeName": "ALEXA Related Region",
"placeList": [
"vienna"
]
}
delete /topo/placeassociations/{name}
Deletes the specified Place Association.
Target Server: NOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Topo: Resource Domains
Resource Domains define a named collection of Server Groups implementing predefined availability profiles. Each Resource Domain is uniquely identified using its name field.
Configuration of Resource Ddomains is only available at the NOAM.
/topo/resourcedomains
get /topo/resourcedomains
Returns the details for all configured Resource Domains, listing defined Server Groups and predefined availability profiles.
Target server: NOAM
Secured by x-other
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/collections/resourcedomainCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/resourcedomain/resourcedomain.json",
"type": "object",
"required": ["name","sgNames"],
"properties": {
"name": {
"type": "string",
"description": "Resource Domain Name",
"pattern": "^[A-Za-z0-9_]+$",
"maxLength": 32
},
"profileName": {
"type": "string",
"description": "Profile"
},
"sgNames": {
"type": "array",
"description": "Server Groups in Domain",
"items": {
"type": "string"
},
"minItems": 0
}
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"name": "the_lab",
"profileName": "NONE",
"sgNames": [
"NO_SG",
"SO_SG1",
"SO1MP_SG1"
]
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /topo/resourcedomains
Adds a new Resource Domain, associating it with a set of Server Groups and a named availability profile. The name field is the instance identifier and is returned in the POST response.
Target server: NOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/resourcedomain/resourcedomain.json",
"type": "object",
"required": ["name","sgNames"],
"properties": {
"name": {
"type": "string",
"description": "Resource Domain Name",
"pattern": "^[A-Za-z0-9_]+$",
"maxLength": 32
},
"profileName": {
"type": "string",
"description": "Profile"
},
"sgNames": {
"type": "array",
"description": "Server Groups in Domain",
"items": {
"type": "string"
},
"minItems": 0
}
}
}
Example
{
"name": "the_lab",
"profileName": "NONE",
"sgNames": [
"NO_SG",
"SO_SG1",
"SO1MP_SG1"
]
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/topo/resourcedomains/profiles
get /topo/resourcedomains/profiles
Returns the available Resource Domain Profiles.
Target server: NOAM
Secured by x-other
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/collections/optionCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/option/option.json",
"type" :"string"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
"Profile 1"
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
/topo/resourcedomains/{name}
get /topo/resourcedomains/{name}
Returns the configuration details for the specified Resource Domain.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/items/resourcedomainItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/resourcedomain/resourcedomain.json",
"type": "object",
"required": ["name","sgNames"],
"properties": {
"name": {
"type": "string",
"description": "Resource Domain Name",
"pattern": "^[A-Za-z0-9_]+$",
"maxLength": 32
},
"profileName": {
"type": "string",
"description": "Profile"
},
"sgNames": {
"type": "array",
"description": "Server Groups in Domain",
"items": {
"type": "string"
},
"minItems": 0
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"name": "the_lab",
"profileName": "NONE",
"sgNames": [
"NO_SG",
"SO_SG1",
"SO1MP_SG1"
]
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /topo/resourcedomains/{name}
Updates the specified Resource Domain.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/resourcedomain/resourcedomain.json",
"type": "object",
"required": ["name","sgNames"],
"properties": {
"name": {
"type": "string",
"description": "Resource Domain Name",
"pattern": "^[A-Za-z0-9_]+$",
"maxLength": 32
},
"profileName": {
"type": "string",
"description": "Profile"
},
"sgNames": {
"type": "array",
"description": "Server Groups in Domain",
"items": {
"type": "string"
},
"minItems": 0
}
}
}
Example
{
"name": "the_lab",
"profileName": "NONE",
"sgNames": [
"NO_SG",
"SO_SG1",
"SO1MP_SG1"
]
}
delete /topo/resourcedomains/{name}
Deletes the specified Resource Domain.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Topo: Servers
A part of the topology API, the Servers resource provides access to Server configuration and management of the following server aspects:
- appl - Application - enable/disable the application
- ha - High Availability - control and manage high availability settings
- db - Database - control and manage databases
- repl - Replication - control and manage database replication
Performing status requests at the NOAM level will provide status of all servers in the topology. Performing status requests at the SOAM level will only provide status of Servers at that site.
Servers are uniquely identified using the hostname field.
Configuration of Servers is only available at the NOAM.
/topo/servers
get /topo/servers
Retrieves the configuration data for all Servers that meet the request parameters.
Target server: NOAM
Secured by x-other
Request
Query Parameters
- scope_type: (one of Server, ServerGroup, NetworkElement)
Identifies the type of Server collection the results are limited to.
Example:
?scope_type=Server&scope_name=mynoa
- scope_name: (string)
Names the specific Server collection the results are limited to.
Example:
?scope_type=ServerGroup&scope_name=NO_SG
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/collections/serverCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/server/server.json",
"type" : "object",
"required": ["hostname","networkElementName","profileName","location","role","ntpServers"],
"properties" : {
"hostname": {
"type": "string",
"pattern": "^(([A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])|([A-Za-z0-9]+))$",
"maxLength": 20,
"description": "Server host name (not updatable)"
},
"networkElementName": {
"type": "string",
"description": "Network Element Name (not updatable)"
},
"serverGroupName": {
"type": "string",
"description": "The name of the Server Group (/topo/servergroups) to which this Server belongs. If there is no value returned by the DSR, this Server has not been associated with any Server Group. A Server can be associated with/removed from a Server Group using the /topo/servergroups/{name}/members URI.",
"readOnly": true
},
"profileName": {
"type": "string",
"description": "Hardware Profile (not updatable)"
},
"location": {
"type": "string",
"maxLength": 15,
"description": "Server Location"
},
"role": {
"type": "string",
"description": "Server Role (not updatable)",
"enum": [
"Mp",
"Noam",
"QueryServer",
"Soam"
]
},
"systemId": {
"type": "string",
"maxLength": 64,
"description": "System Identifier"
},
"ntpServers": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/ntppref/ntppref.json",
"type": "object",
"required": ["ipAddress"],
"properties": {
"ipAddress":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6/IPv4orIPv6.json",
"type": "string",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^(default)$",
"example": "192.168.1.1"
},
"prefer": { "type": "boolean" }
}
},
"minItems": 0
}
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"hostname": "onett-noa",
"networkElementName": "NO_NE",
"serverGroupName": "NO_SG",
"profileName": "TVOE Guest",
"location": "Eagleland",
"role": "Noam",
"systemId": "CRABSYS",
"ntpServers": [
{
"ipAddress": "172.23.0.1",
"prefer": true
}
]
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /topo/servers
Adds a new Server to the topology. Once a server is added to the configuration, it must be bootstrapped (/servers/{id}/bootstrap PUT) to complete the configuration process. The hostname field is the Server identifier and is returned in the POST response.
Target server: NOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/server/server.json",
"type" : "object",
"required": ["hostname","networkElementName","profileName","location","role","ntpServers"],
"properties" : {
"hostname": {
"type": "string",
"pattern": "^(([A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])|([A-Za-z0-9]+))$",
"maxLength": 20,
"description": "Server host name (not updatable)"
},
"networkElementName": {
"type": "string",
"description": "Network Element Name (not updatable)"
},
"serverGroupName": {
"type": "string",
"description": "The name of the Server Group (/topo/servergroups) to which this Server belongs. If there is no value returned by the DSR, this Server has not been associated with any Server Group. A Server can be associated with/removed from a Server Group using the /topo/servergroups/{name}/members URI.",
"readOnly": true
},
"profileName": {
"type": "string",
"description": "Hardware Profile (not updatable)"
},
"location": {
"type": "string",
"maxLength": 15,
"description": "Server Location"
},
"role": {
"type": "string",
"description": "Server Role (not updatable)",
"enum": [
"Mp",
"Noam",
"QueryServer",
"Soam"
]
},
"systemId": {
"type": "string",
"maxLength": 64,
"description": "System Identifier"
},
"ntpServers": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/ntppref/ntppref.json",
"type": "object",
"required": ["ipAddress"],
"properties": {
"ipAddress":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6/IPv4orIPv6.json",
"type": "string",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^(default)$",
"example": "192.168.1.1"
},
"prefer": { "type": "boolean" }
}
},
"minItems": 0
}
}
}
Example
{
"hostname": "onett-noa",
"networkElementName": "NO_NE",
"serverGroupName": "NO_SG",
"profileName": "TVOE Guest",
"location": "Eagleland",
"role": "Noam",
"systemId": "CRABSYS",
"ntpServers": [
{
"ipAddress": "172.23.0.1",
"prefer": true
}
]
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/topo/servers/profiles
get /topo/servers/profiles
Returns the available Server Hardware Profiles.
Target server: NOAM
Secured by x-other
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/collections/optionCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/option/option.json",
"type" :"string"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
"Profile 1"
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
/topo/servers/status
get /topo/servers/status
Retrieves Server status data for all Servers that match the request parameters.
Target server: NOAM
Secured by x-other
Request
Query Parameters
- scope_type: (one of Server, ServerGroup, NetworkElement)
Identifies the type of Server collection the results are limited to.
Example:
?scope_type=Server&scope_name=mynoa
- scope_name: (string)
Names the specific Server collection the results are limited to.
Example:
?scope_type=ServerGroup&scope_name=NO_SG
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/collections/serverstatusCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/server/serverstatus.json",
"type" : "object",
"required": ["hostname","networkElementName","applicationState","minor","major","critical","dbStatus","maxAllowedHaRole","haRole"],
"properties" : {
"hostname": {
"type": "string",
"description": "Server host name" ,
"example": "ruby-noa"
},
"networkElementName": {
"type": "string",
"description": "The Network Element (/topo/networkelements) of which this Server is a part.",
"example": "NO_NE"
},
"applicationState": {
"type": "string",
"enum": [
"Disabled",
"Enabled"
],
"description": "The administrative state of whatever application is running on the Server.",
"example": "Enabled"
},
"alarmStatus": {
"type": "string",
"enum": [
"Critical",
"Major",
"Minor",
"None",
"Clear"
],
"description": "Indicates the highest severity alarm currently sourced by the Server. When set to None, the Server is not currently sourcing any alarms.",
"example": "Minor"
},
"critical": {
"type": "integer",
"description": "Number of critical alarms on server",
"example": 0
},
"major": {
"type": "integer",
"description": "Number of major alarms on server",
"example": 1
},
"minor": {
"type": "integer",
"description": "Number of minor alarms on server",
"example": 5
},
"dbStatus": {
"type": "string",
"enum": [
"Normal",
"Clear",
"Minor",
"Major",
"Critical",
"BackupInProgress",
"RestoreInProgress",
"CompareInProgress",
"Unknown"
],
"description": "Indicates the overall status of the Server's database. When set to Normal, the database is not undergoing any maintenance actions and is free of any database-specific alarms. When set to Clear, the database-specific alarms are in the cleared state and the database is transitioning to the Normal state. The states of Minor, Major or Critical indicate that the database has one or more active database-specific alarms and the highest severity alarm is being reported. When set to Critical, the database version is incompatible with the installed software database version. When set to Major, one or more of the following is true: one or more process interfaces to the database are impaired by a software fault; a disk or shared memory configured database threshold has been exceeded; or the database durability has dropped below configured durability level. When set to Minor, one or more of the following is true: provisioning or replication has been disabled; a failure has occurred writing the database to the disk; the database update log has been overrun (which increases the chance for data loss); Database Replication process cannot apply updates to the database; or a database change cannot be stored in the update log. When set to BackupInProgress, a maintenance action of a database backup is in progress. When set to RestoreInProgress, a maintenance action of a database restore is in progress. When set to CompareInProgress, a maintenance action of a database compare is in progress. When set to Unknown, the database status of the server cannot be determined.",
"example": "Normal"
},
"maxAllowedHaRole": {
"type": "string",
"enum": [
"Active",
"Observer",
"Oos",
"Spare",
"Standby",
"NotApplicable",
"Unknown"
],
"description": "The maximum allowed High Availability (HA) role for the Server. The Server cannot attain an HA role higher than this value.",
"example": "Active"
},
"haRole": {
"type": "string",
"enum": [
"Active",
"Observer",
"Oos",
"Spare",
"Standby",
"Unknown"
],
"description": "The current HA role for the Server.",
"example": "Active"
},
"processStatus": {
"type": "string",
"enum": [
"Up",
"Kill",
"Pending",
"ApplicationSoftwareDisabled",
"Unknown"
],
"description": "Process Status Summary",
"example": "Indicates the overall status of all the processes on the server. When set to Up, all processes are up and running. When set to Kill, one or more processes have been stopped. Check the active alarms (/mon/alarms) to determine which process(es) are down. When set to Pending, one or more processes are in the pending state, which means they are in the process of coming up. When set to ApplicationSoftwareDisabled, the application software has been completely disabled. When set to Unknown, the process status of the server cannot be determined. If there are processes in multiple states, the value of processStatus will be is determined by the following order of precedence: Unknown, ApplicationSoftwareDisabled, Pending, Kill, Up."
}
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"hostname":"ruby-noa",
"networkElementName":"SO_NE1",
"applicationState":"Enabled",
"alarmStatus":"None",
"minor":0,
"major":0,
"critical":0,
"dbStatus":"Normal",
"maxAllowedHaRole":"Active",
"haRole":"Standby",
"processStatus":"Up"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
/topo/servers/{hostname}
get /topo/servers/{hostname}
Returns the configuration details for the specified Server.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- hostname: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/items/serverItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/server/server.json",
"type" : "object",
"required": ["hostname","networkElementName","profileName","location","role","ntpServers"],
"properties" : {
"hostname": {
"type": "string",
"pattern": "^(([A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])|([A-Za-z0-9]+))$",
"maxLength": 20,
"description": "Server host name (not updatable)"
},
"networkElementName": {
"type": "string",
"description": "Network Element Name (not updatable)"
},
"serverGroupName": {
"type": "string",
"description": "The name of the Server Group (/topo/servergroups) to which this Server belongs. If there is no value returned by the DSR, this Server has not been associated with any Server Group. A Server can be associated with/removed from a Server Group using the /topo/servergroups/{name}/members URI.",
"readOnly": true
},
"profileName": {
"type": "string",
"description": "Hardware Profile (not updatable)"
},
"location": {
"type": "string",
"maxLength": 15,
"description": "Server Location"
},
"role": {
"type": "string",
"description": "Server Role (not updatable)",
"enum": [
"Mp",
"Noam",
"QueryServer",
"Soam"
]
},
"systemId": {
"type": "string",
"maxLength": 64,
"description": "System Identifier"
},
"ntpServers": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/ntppref/ntppref.json",
"type": "object",
"required": ["ipAddress"],
"properties": {
"ipAddress":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6/IPv4orIPv6.json",
"type": "string",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^(default)$",
"example": "192.168.1.1"
},
"prefer": { "type": "boolean" }
}
},
"minItems": 0
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"hostname": "onett-noa",
"networkElementName": "NO_NE",
"serverGroupName": "NO_SG",
"profileName": "TVOE Guest",
"location": "Eagleland",
"role": "Noam",
"systemId": "CRABSYS",
"ntpServers": [
{
"ipAddress": "172.23.0.1",
"prefer": true
}
]
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /topo/servers/{hostname}
Updates the configuration data for the specified Server.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- hostname: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/server/server.json",
"type" : "object",
"required": ["hostname","networkElementName","profileName","location","role","ntpServers"],
"properties" : {
"hostname": {
"type": "string",
"pattern": "^(([A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])|([A-Za-z0-9]+))$",
"maxLength": 20,
"description": "Server host name (not updatable)"
},
"networkElementName": {
"type": "string",
"description": "Network Element Name (not updatable)"
},
"serverGroupName": {
"type": "string",
"description": "The name of the Server Group (/topo/servergroups) to which this Server belongs. If there is no value returned by the DSR, this Server has not been associated with any Server Group. A Server can be associated with/removed from a Server Group using the /topo/servergroups/{name}/members URI.",
"readOnly": true
},
"profileName": {
"type": "string",
"description": "Hardware Profile (not updatable)"
},
"location": {
"type": "string",
"maxLength": 15,
"description": "Server Location"
},
"role": {
"type": "string",
"description": "Server Role (not updatable)",
"enum": [
"Mp",
"Noam",
"QueryServer",
"Soam"
]
},
"systemId": {
"type": "string",
"maxLength": 64,
"description": "System Identifier"
},
"ntpServers": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/ntppref/ntppref.json",
"type": "object",
"required": ["ipAddress"],
"properties": {
"ipAddress":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6/IPv4orIPv6.json",
"type": "string",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^(default)$",
"example": "192.168.1.1"
},
"prefer": { "type": "boolean" }
}
},
"minItems": 0
}
}
}
Example
{
"hostname": "onett-noa",
"networkElementName": "NO_NE",
"serverGroupName": "NO_SG",
"profileName": "TVOE Guest",
"location": "Eagleland",
"role": "Noam",
"systemId": "CRABSYS",
"ntpServers": [
{
"ipAddress": "172.23.0.1",
"prefer": true
}
]
}
delete /topo/servers/{hostname}
Delete the server
Secured by x-other
Request
URI Parameters
- hostname: required (string)
/topo/servers/{hostname}/status
get /topo/servers/{hostname}/status
Retrieve the general status overview for a specific Server.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- hostname: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/items/serverstatusItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/server/serverstatus.json",
"type" : "object",
"required": ["hostname","networkElementName","applicationState","minor","major","critical","dbStatus","maxAllowedHaRole","haRole"],
"properties" : {
"hostname": {
"type": "string",
"description": "Server host name" ,
"example": "ruby-noa"
},
"networkElementName": {
"type": "string",
"description": "The Network Element (/topo/networkelements) of which this Server is a part.",
"example": "NO_NE"
},
"applicationState": {
"type": "string",
"enum": [
"Disabled",
"Enabled"
],
"description": "The administrative state of whatever application is running on the Server.",
"example": "Enabled"
},
"alarmStatus": {
"type": "string",
"enum": [
"Critical",
"Major",
"Minor",
"None",
"Clear"
],
"description": "Indicates the highest severity alarm currently sourced by the Server. When set to None, the Server is not currently sourcing any alarms.",
"example": "Minor"
},
"critical": {
"type": "integer",
"description": "Number of critical alarms on server",
"example": 0
},
"major": {
"type": "integer",
"description": "Number of major alarms on server",
"example": 1
},
"minor": {
"type": "integer",
"description": "Number of minor alarms on server",
"example": 5
},
"dbStatus": {
"type": "string",
"enum": [
"Normal",
"Clear",
"Minor",
"Major",
"Critical",
"BackupInProgress",
"RestoreInProgress",
"CompareInProgress",
"Unknown"
],
"description": "Indicates the overall status of the Server's database. When set to Normal, the database is not undergoing any maintenance actions and is free of any database-specific alarms. When set to Clear, the database-specific alarms are in the cleared state and the database is transitioning to the Normal state. The states of Minor, Major or Critical indicate that the database has one or more active database-specific alarms and the highest severity alarm is being reported. When set to Critical, the database version is incompatible with the installed software database version. When set to Major, one or more of the following is true: one or more process interfaces to the database are impaired by a software fault; a disk or shared memory configured database threshold has been exceeded; or the database durability has dropped below configured durability level. When set to Minor, one or more of the following is true: provisioning or replication has been disabled; a failure has occurred writing the database to the disk; the database update log has been overrun (which increases the chance for data loss); Database Replication process cannot apply updates to the database; or a database change cannot be stored in the update log. When set to BackupInProgress, a maintenance action of a database backup is in progress. When set to RestoreInProgress, a maintenance action of a database restore is in progress. When set to CompareInProgress, a maintenance action of a database compare is in progress. When set to Unknown, the database status of the server cannot be determined.",
"example": "Normal"
},
"maxAllowedHaRole": {
"type": "string",
"enum": [
"Active",
"Observer",
"Oos",
"Spare",
"Standby",
"NotApplicable",
"Unknown"
],
"description": "The maximum allowed High Availability (HA) role for the Server. The Server cannot attain an HA role higher than this value.",
"example": "Active"
},
"haRole": {
"type": "string",
"enum": [
"Active",
"Observer",
"Oos",
"Spare",
"Standby",
"Unknown"
],
"description": "The current HA role for the Server.",
"example": "Active"
},
"processStatus": {
"type": "string",
"enum": [
"Up",
"Kill",
"Pending",
"ApplicationSoftwareDisabled",
"Unknown"
],
"description": "Process Status Summary",
"example": "Indicates the overall status of all the processes on the server. When set to Up, all processes are up and running. When set to Kill, one or more processes have been stopped. Check the active alarms (/mon/alarms) to determine which process(es) are down. When set to Pending, one or more processes are in the pending state, which means they are in the process of coming up. When set to ApplicationSoftwareDisabled, the application software has been completely disabled. When set to Unknown, the process status of the server cannot be determined. If there are processes in multiple states, the value of processStatus will be is determined by the following order of precedence: Unknown, ApplicationSoftwareDisabled, Pending, Kill, Up."
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"hostname":"ruby-noa",
"networkElementName":"SO_NE1",
"applicationState":"Enabled",
"alarmStatus":"None",
"minor":0,
"major":0,
"critical":0,
"dbStatus":"Normal",
"maxAllowedHaRole":"Active",
"haRole":"Standby",
"processStatus":"Up"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
/topo/servers/{hostname}/appl
get /topo/servers/{hostname}/appl
Retrieves the application status for the specifeid Server.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- hostname: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/items/serverapplItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/server/serverappl.json",
"type": "object",
"required": ["applState"],
"properties": {
"applState": {
"type": "string",
"description": "Application State",
"enum": [ "Enabled", "Disabled" ],
"example": "Enabled"
}
}
}
,
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"applState": "Enabled"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /topo/servers/{hostname}/appl
Used to stop or (re)start the application services on a Server.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- hostname: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/server/serverappl.json",
"type": "object",
"required": ["applState"],
"properties": {
"applState": {
"type": "string",
"description": "Application State",
"enum": [ "Enabled", "Disabled" ],
"example": "Enabled"
}
}
}
Example
{
"applState": "Enabled"
}
/topo/servers/{hostname}/ha
get /topo/servers/{hostname}/ha
Retrieves the High Availability status and role for a Server.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- hostname: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/server/serverha.json",
"type" : "object",
"required": ["hostname","networkElementName","maxHaRole","oamMaxHaRole","appMaxHaRole","serverRole","maxHaCapability","mates"],
"properties" : {
"hostname": {
"type": "string",
"description": "Server host name (non updatable)" ,
"example": "monotoli-noa"
},
"networkElementName": {
"type": "string",
"description": "Network Element Name (non updatable)",
"example": "NO_NE"
},
"maxHaRole": {
"type": "string",
"enum": [
"Active",
"Observer",
"Oos",
"Spare",
"Standby"
],
"description": "Max HA Role (non updatable)",
"example": "Active"
},
"oamMaxHaRole": {
"type": "string",
"enum": [
"Active",
"Observer",
"Oos",
"Spare",
"Standby"
],
"description": "Max OAM HA Role (non updatable)",
"example": "Active"
},
"appMaxHaRole": {
"type": "string",
"enum": [
"Active",
"Observer",
"Oos",
"Spare",
"Standby"
],
"description": "Max Application HA Role (non updatable)",
"example": "Active"
},
"serverRole": {
"type": "string",
"enum": [
"Mp",
"Noam",
"QueryServer",
"Soam"
],
"description": "Server Role (non updatable)",
"example": "Noam"
},
"maxHaCapability": {
"type": "string",
"enum": [
"Active",
"Observer",
"Oos",
"Spare",
"Standby"
],
"description": "Max Allowed HA Role",
"example": "Active"
},
"mates": {
"type": "array",
"description": "List of mate hostnames (non updatable)",
"items": {
"description": "Mate hostname",
"type": "string"
},
"minItems": 0,
"example" : [ "monotoli-nob" ]
}
}
}
Example
{
"hostname": "monotoli-noa",
"networkElementName": "NO_NE",
"maxHaRole": "Active",
"oamMaxHaRole": "Active",
"appMaxHaRole": "Oos",
"serverRole": "Noam",
"maxHaCapability": "Active",
"mates": [
"monotoli-nob"
]
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /topo/servers/{hostname}/ha
Updates the maximum High Availability role for a Server.
Updating the role of a Server may cause a resource to failover to another server in the cluster. Here are some possible settings:
- Active (default) - the Server is allowed to become active.
- Standby - the Server is allowed to become (at most) standby.
- Spare - the Server is allowed to become (at most) spare.
- Observer - the Server will be an observer (providing read only access).
- Oos - the Server is taken out of service.
Setting an active Server to have a max role of standby will force a failover. This is a required step in the software upgrade process.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- hostname: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/server/servermaxha.json",
"type" : "object",
"required": ["maxHaCapability"],
"properties" : {
"maxHaCapability": {
"type": "string",
"enum": [
"Active",
"Observer",
"Oos",
"Spare",
"Standby"
],
"description": "Max Allowed HA Role",
"example": "Active"
}
}
}
Example
{
"maxHaCapability": "Active"
}
/topo/servers/{hostname}/repl
get /topo/servers/{hostname}/repl
Retrieves the database replication status for a Server.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- hostname: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/server/serverrepl.json",
"type": "object",
"required": ["replState"],
"properties": {
"replState": {
"type": "string",
"description": "Replication State",
"enum": [ "Allowed", "Inhibited" ],
"example": "Allowed"
}
}
}
Example
{
"relStatus": "Allowed"
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /topo/servers/{hostname}/repl
Manage database replication for a Server.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- hostname: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/server/serverrepl.json",
"type": "object",
"required": ["replState"],
"properties": {
"replState": {
"type": "string",
"description": "Replication State",
"enum": [ "Allowed", "Inhibited" ],
"example": "Allowed"
}
}
}
Example
{
"relStatus": "Allowed"
}
/topo/servers/{hostname}/db
get /topo/servers/{hostname}/db
Retrieves the active database status for the specified Server.
Returns various status items for the database on a specific server, including:
- durability status
- DB versions and creation data (birthday)
- DB capacities and utilization
Target server: NOAM
Secured by x-other
Request
URI Parameters
- hostname: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/items/serverdbItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/server/serverdb.json",
"type": "object",
"properties": {
"dbBirthday": {
"description": "Database birthday",
"type": "string",
"pattern": "^[0-9]{4}[-][0-1]{1}[0-9]{1}[-][0-3]{1}[0-9]{1}T[0-2]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}([.][0-9]{1,7})?[+-](?:2[0-3]|[0-1][0-9])[:][0-5][0-9]?$",
"example": "2015-07-30T12:37:48-04:00"
},
"dbVersionAW": {
"description": "AppWorks database version",
"type": "string",
"example": "6.0"
},
"dbVersionAPP": {
"description": "Application database version",
"type": "string",
"example": "6.0.1_60.32.6"
},
"dbLevel": {
"description": "Database level",
"type": "integer",
"example": 0
},
"dbMemUse": {
"description": "Database memory usage",
"type": "object",
"properties": {
"used": {
"type": "string",
"example": "794M"
},
"total": {
"type": "string",
"example": "3076M"
},
"avail": {
"type": "string",
"example": "2282M"
}
}
},
"dbDiskUse": {
"description": "Database disk usage",
"type": "object",
"properties": {
"used": {
"type": "string",
"example": "213M"
},
"total": {
"type": "string",
"example": "4.8G"
},
"avail": {
"type": "string",
"example": "4.4G"
}
}
},
"dbDurability": {
"description": "Database durability",
"type": "object",
"properties": {
"statusTime": {
"type": "string",
"pattern": "^[0-9]{4}[-][0-1]{1}[0-9]{1}[-][0-3]{1}[0-9]{1}T[0-2]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}([.][0-9]{1,7})?[+-](?:2[0-3]|[0-1][0-9])[:][0-5][0-9]?$",
"example": "2015-08-06T16:56:28-04:00"
},
"stateTime": {
"type": "string",
"pattern": "^[0-9]{4}[-][0-1]{1}[0-9]{1}[-][0-3]{1}[0-9]{1}T[0-2]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}([.][0-9]{1,7})?[+-](?:2[0-3]|[0-1][0-9])[:][0-5][0-9]?$",
"example": "2015-07-30T12:43:40-04:00"
},
"runState": {
"type": "string",
"example": "Normal"
},
"adminState": {
"type": "string",
"example": "DiskOnly"
},
"operState": {
"type": "string",
"example": "DiskMate"
},
"memDbLevel": {
"type": "integer",
"example": 0
},
"diskDbLevel": {
"type": "integer",
"example": 0
},
"mateDbLevel": {
"type": "integer",
"example": 0
},
"secondaryDbLevel": {
"type": "integer",
"example": 0
},
"durableLevel": {
"type": "integer",
"example": 0
}
}
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"dbBirthday": "2015-07-30T12:37:48-04:00",
"dbVersionAW": "6.0",
"dbVersionAPP": "6.0.1_60.32.6",
"dbLevel": 0,
"dbMemUse": {
"used": "794M",
"total": "3076M",
"avail": "2282M"
},
"dbDiskUse": {
"used": "213M",
"total": "4.8G",
"avail": "4.4G"
},
"dbDurability": {
"statusTime": "2015-08-06T16:56:28-04:00",
"stateTime": "2015-07-30T12:43:40-04:00",
"runState": "Normal",
"adminState": "DiskOnly",
"operState": "DiskMate",
"memDbLevel": 0,
"diskDbLevel": 0,
"mateDbLevel": 0,
"secondaryDbLevel": 0,
"durableLevel": 0
}
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
/topo/servers/{hostname}/db/backup
get /topo/servers/{hostname}/db/backup
Returns a list of all database backups for the specified Server.
Target server: NOAM or SOAM
Secured by x-other
Request
URI Parameters
- hostname: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/collections/serverdbbackupCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/server/serverdbbackup.json",
"type": "object",
"required": ["type", "filename", "comment"],
"nonInsertable": ["UUID", "status"],
"properties": {
"UUID": {
"type": "string",
"description": "The backup instance identifier (*generated*)",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"example": "0a3c24c2-873b-4412-b595-c2afe16f1ccc"
},
"compression": {
"type": "string",
"description": "Compression type",
"enum": [
"Bzip2",
"Gzip",
"None"
]
},
"type": {
"type": "string",
"description": "The backup type",
"enum": [ "Configuration", "Provisioning", "Both" ]
},
"filename": {
"type": "string",
"description": "The backup instance filename. On POST without the compression suffix.",
"example": "Backup.alexa.ruby-noa.Configuration.NETWORK_OAMP.20150801_021502.AUTO.tar",
"maxLength": 249
},
"comment": {
"type": "string",
"description": "A comment to associate with the backup instance"
},
"status": {
"type": "string",
"description": "The backup status",
"enum": [
"Complete",
"InProgress"
]
}
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"compression": "Bzip2",
"type": "Provisioning",
"filename": "Backup.alexa.ruby-noa.Provisioning.NETWORK_OAMP.20150801_021502.AUTO.tar",
"comment": "A sample comment"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /topo/servers/{hostname}/db/backup
Initiates a database backup for a Server. Once initiated, the backup status can be tracked using the returned link to the GET /servers/{hostname}/db/backup/{UUID} resource. The generated UUID will be included in the response body.
Target server: NOAM or SOAM
Secured by x-other
Request
URI Parameters
- hostname: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/server/serverdbbackup.json",
"type": "object",
"required": ["type", "filename", "comment"],
"nonInsertable": ["UUID", "status"],
"properties": {
"UUID": {
"type": "string",
"description": "The backup instance identifier (*generated*)",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"example": "0a3c24c2-873b-4412-b595-c2afe16f1ccc"
},
"compression": {
"type": "string",
"description": "Compression type",
"enum": [
"Bzip2",
"Gzip",
"None"
]
},
"type": {
"type": "string",
"description": "The backup type",
"enum": [ "Configuration", "Provisioning", "Both" ]
},
"filename": {
"type": "string",
"description": "The backup instance filename. On POST without the compression suffix.",
"example": "Backup.alexa.ruby-noa.Configuration.NETWORK_OAMP.20150801_021502.AUTO.tar",
"maxLength": 249
},
"comment": {
"type": "string",
"description": "A comment to associate with the backup instance"
},
"status": {
"type": "string",
"description": "The backup status",
"enum": [
"Complete",
"InProgress"
]
}
}
}
Example
{
"compression": "Bzip2",
"type": "Provisioning",
"filename": "Backup.alexa.ruby-noa.Provisioning.NETWORK_OAMP.20150801_021502.AUTO.tar",
"comment": "A sample comment"
}
/topo/servers/{hostname}/db/backup/{UUID}
get /topo/servers/{hostname}/db/backup/{UUID}
Returns a specific backup for a specific Server.
Target server: NOAM or SOAM
Secured by x-other
Request
URI Parameters
- hostname: required (string)
- UUID: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/items/serverdbbackupItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/server/serverdbbackup.json",
"type": "object",
"required": ["type", "filename", "comment"],
"nonInsertable": ["UUID", "status"],
"properties": {
"UUID": {
"type": "string",
"description": "The backup instance identifier (*generated*)",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"example": "0a3c24c2-873b-4412-b595-c2afe16f1ccc"
},
"compression": {
"type": "string",
"description": "Compression type",
"enum": [
"Bzip2",
"Gzip",
"None"
]
},
"type": {
"type": "string",
"description": "The backup type",
"enum": [ "Configuration", "Provisioning", "Both" ]
},
"filename": {
"type": "string",
"description": "The backup instance filename. On POST without the compression suffix.",
"example": "Backup.alexa.ruby-noa.Configuration.NETWORK_OAMP.20150801_021502.AUTO.tar",
"maxLength": 249
},
"comment": {
"type": "string",
"description": "A comment to associate with the backup instance"
},
"status": {
"type": "string",
"description": "The backup status",
"enum": [
"Complete",
"InProgress"
]
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"compression": "Bzip2",
"type": "Provisioning",
"filename": "Backup.alexa.ruby-noa.Provisioning.NETWORK_OAMP.20150801_021502.AUTO.tar",
"comment": "A sample comment"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
/topo/servers/{hostname}/db/backup/{UUID}/compare
get /topo/servers/{hostname}/db/backup/{UUID}/compare
Returns a comparison report for a database on a specific Server. The report must have been previously generated using the /topo/servers/{hostname}/db/backup/{UUID}/compare POST operation.
Target server: NOAM or SOAM
Secured by x-other
Request
URI Parameters
- hostname: required (string)
- UUID: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/items/serverdbcompareItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/server/serverdbcompare.json",
"type": "object",
"required": ["report"],
"properties": {
"report": {
"type": "string",
"description": "Database backup archive comparison report."
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"report": "Alexa Compatibility\nCompatible\n\nThe selected database came from stock72-noa on 06/25/2016 at 02:15:15 EDT and contains the following comment: Nightly Automatic Backup of Configuration Data\n\n\nArchive Contents\nConfiguration data\n\nDatabase Compatibility\nThe databases are compatible.\n\nNode Type Compatibility\nThe node types are compatible.\n\nTopology Compatibility\nThe topology is compatible.\n\nUser Compatibility\nThe user and authentication data are compatible.\n\nContents\nConfiguration\n\nTable Instance Counts\nCurrent ADICCmd count: 2 Selected: 2\nCurrent APIKeys count: 2 Selected: 2\nCurrent APITokens count: 2 Selected: 2\nCurrent AWCerts count: 2 Selected: 2\nCurrent AppworksCapacityConstraints count: 2 Selected: 2\nCurrent AuthKeys count: 18 Selected: 18\nCurrent AuthorizedIp count: 2 Selected: 2\nCurrent AwpSampleDemo count: 3 Selected: 3\nCurrent ClusterGroupInfo count: 3 Selected: 3\nCurrent ClusterInfo count: 3 Selected: 3\nCurrent Crontab count: 2 Selected: 2\nCurrent DbReInitList count: 2 Selected: 2\nCurrent DefaultNtpReference count: 2 Selected: 2\nCurrent DnsConfiguration count: 2 Selected: 2\nCurrent DoubleParam count: 2 Selected: 2\nCurrent DscpByIntf count: 2 Selected: 2\nCurrent DscpByPort count: 2 Selected: 2\nCurrent FailedAccessLog count: 2 Selected: 2\nCurrent Function count: 2 Selected: 2\nCurrent FunctionAbilities count: 2 Selected: 2\nCurrent HaCfg count: 3 Selected: 3\nCurrent HaClusterPolicyCfg count: 2 Selected: 2\nCurrent HaClusterResourceCfg count: 2 Selected: 2\nCurrent HaDefParms count: 2 Selected: 2\nCurrent HaNodeCfg count: 2 Selected: 2\nCurrent HaNodeLocPref count: 6 Selected: 6\nCurrent HaNodePolicyCfg count: 2 Selected: 2\nCurrent HaNodeResourceCfg count: 2 Selected: 2\nCurrent HaParms count: 2 Selected: 2\nCurrent HaPolicyCfg count: 2 Selected: 2\nCurrent HaResourceCfg count: 3 Selected: 3\nCurrent HaSiteCfg count: 2 Selected: 2\nCurrent HaSiteLocPref count: 2 Selected: 2\nCurrent HaVipDef count: 2 Selected: 2\nCurrent KPIDef count: 110 Selected: 110\nCurrent KPIUserPref count: 7 Selected: 7\nCurrent L3Interface count: 12 Selected: 12\nCurrent LDAPServer count: 2 Selected: 2\nCurrent LogicalPath count: 12 Selected: 12\nCurrent LongParam count: 41 Selected: 41\nCurrent MasterLoginAttempts count: 2 Selected: 2\nCurrent NameServiceChangeList count: 2 Selected: 2\nCurrent Network count: 4 Selected: 4\nCurrent NetworkDevice count: 12 Selected: 12\nCurrent NetworkDeviceOption count: 48 Selected: 48\nCurrent NetworkElement count: 2 Selected: 2\nCurrent NetworkRoute count: 2 Selected: 2\nCurrent NetworkType count: 13 Selected: 13\nCurrent NodeInfo count: 6 Selected: 6\nCurrent NtpChangeList count: 2 Selected: 2\nCurrent NtpServer count: 6 Selected: 6\nCurrent NtpServer2SG count: 2 Selected: 2\nCurrent OGTApplStatus count: 2 Selected: 2\nCurrent PeriodicTask count: 2 Selected: 2\nCurrent Place count: 2 Selected: 2\nCurrent Place2Assoc count: 2 Selected: 2\nCurrent PlaceAssoc count: 2 Selected: 2\nCurrent PlaceAssocType count: 2 Selected: 2\nCurrent PlaceType count: 2 Selected: 2\nCurrent ProductEvID count: 4 Selected: 4\nCurrent RemoteServer count: 2 Selected: 2\nCurrent ResourceDomain count: 2 Selected: 2\nCurrent ResourceDomainProfile count: 3 Selected: 3\nCurrent SG2SuperGroup count: 3 Selected: 3\nCurrent SGNEAssociation count: 2 Selected: 2\nCurrent SNMPTrapIndex count: 2 Selected: 2\nCurrent SNMPacknowledgement count: 2 Selected: 2\nCurrent Server count: 6 Selected: 6\nCurrent Server2SG count: 6 Selected: 6\nCurrent ServerGroup count: 3 Selected: 3\nCurrent ServerGroup2RD count: 2 Selected: 2\nCurrent ServerProfile count: 6 Selected: 6\nCurrent ServiceCategory count: 7 Selected: 7\nCurrent ServiceMap count: 15 Selected: 15\nCurrent SftpUsers count: 2 Selected: 2\nCurrent Site count: 2 Selected: 2\nCurrent SiteInfo count: 3 Selected: 3\nCurrent SnmpCfg count: 2 Selected: 2\nCurrent SoapSecurityConfig count: 2 Selected: 2\nCurrent StringParam count: 13 Selected: 13\nCurrent SuperGroup count: 3 Selected: 3\nCurrent SwitchGroup count: 2 Selected: 2\nCurrent TaskMetaDefinition count: 18 Selected: 18\nCurrent TopologyMapping count: 6 Selected: 6\nCurrent UpgradeStatus count: 2 Selected: 2\nCurrent VirtualIp count: 2 Selected: 2\nCurrent VirtualL3Interface count: 2 Selected: 2\nCurrent VlobParam count: 2 Selected: 2\nCurrent alarmconfig count: 3 Selected: 3\nCurrent app_config_perms count: 2 Selected: 2\nCurrent custom_perms count: 2 Selected: 2\nCurrent groups count: 2 Selected: 2\nCurrent permissions count: 48 Selected: 48\nCurrent sampleCfg count: 3 Selected: 3\nCurrent timezones count: 2 Selected: 2\nCurrent user count: 2 Selected: 2\n"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /topo/servers/{hostname}/db/backup/{UUID}/compare
Initiates a comparison of the active database versus the backup archive specified as a URL parameter on the server specified by a URL parameter.
Once initiated, the compare report can be obtained using the returned link to the /servers/{hostname}/db/backup/{UUID}/compare GET resource. The backup file's UUID will be returned.
Target server: NOAM or SOAM
Secured by x-other
/topo/servers/{hostname}/db/backup/{UUID}/restore
get /topo/servers/{hostname}/db/backup/{UUID}/restore
Retrieves the status of a restore operation for a particular Server.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- hostname: required (string)
- UUID: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/items/serverdbrestoreItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/server/serverdbrestore.json",
"type": "object",
"required": ["expected_end_time", "maint_status", "cmd_status", "cmd_output"],
"properties": {
"expected_end_time": {
"description": "Expected end time for restore operation",
"type": "string",
"pattern": "^[0-9]{4}[-][0-1]{1}[0-9]{1}[-][0-3]{1}[0-9]{1}T[0-2]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}([.][0-9]{1,7})?[+-](?:2[0-3]|[0-1][0-9])[:][0-5][0-9]?$",
"example": "2016-01-04T12:37:48-05:00"
},
"maint_status": {
"description": "Maintenance status",
"type": "string",
"example": "MAINT_CMD_SUCCESS"
},
"cmd_status": {
"description": "Command status",
"type": "integer",
"example": 0
},
"cmd_output": {
"description": "Command output",
"type": "string",
"example": "Success"
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"expected_end_time": "2016-01-04T12:37:48-05:00",
"maint_status": "MAINT_CMD_FAILED",
"cmd_status": 1,
"cmd_output": "Failed to restore database archive"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /topo/servers/{hostname}/db/backup/{UUID}/restore
Initiates a database restore for a specific Server.
Once initiated, the restore status can be tracked using the returned link to the /servers/{hostname}/db/backup/{UUID}/restore GET resource.
Note: access to the server may be temporarily impaired while a restore is in progress.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- hostname: required (string)
- UUID: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/server/serverdbrestorereq.json",
"type": "object",
"required": ["force"],
"properties": {
"force": {
"description": "Whether to ignore compare errors when restoring a backup archive",
"type": "boolean"
}
}
}
Example
{
"force": false
}
/topo/servers/{hostname}/reboot
put /topo/servers/{hostname}/reboot
Reboots the specified Server.
Warning - this is service affecting!
Target server: NOAM
Secured by x-other
/topo/servers/{hostname}/ntpsync
put /topo/servers/{hostname}/ntpsync
Synchronizes NTP on the specified Server.
Target server: NOAM
Secured by x-other
/topo/servers/{hostname}/bootstrap
put /topo/servers/{hostname}/bootstrap
Bootstraps a Server. Bootstrap options are processed in order, and each option represents a switch that can be enabled/disabled.
These special options may be used turn everything on or off:
- none - Turn off all options
- all - Turn on all options
The following bootstrap options must be proceeded with "+" (enable) or "-" (disable):
- hostname - Configure using the provided hostname
- ntp - Configure the NTP protocol
- tz - Configure using the provided Time Zone
- network - Configure networking devices
- dns - Configure DNS
The following two option sets are equivalent:
- { "all":"", "-hostname":"", "-ntp":"", "-tz":"" }
- { "none":"", "+network":"", "+dns":"" }
There are two bootstrap option paths, then: either start with nothing and grow, or start with everything and shrink the bootstrap option set.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- hostname: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/server/serverbootstrap.json",
"type": "object",
"required": ["host","options"],
"properties": {
"host": {
"description": "IP address of the configuration server",
"type": "string",
"example":"192.168.1.100"
},
"options": {
"type": "object",
"additionalProperties": {
"type": "string",
"description": "bootstrap option values"
}
}
}
}
Example
{
"host": "192.168.1.100",
"options": {
"none": "",
"+hostname": "",
"+tz": "Americas/New_York",
"+ntp": "",
"+network": "",
"+dns": ""
}
}
Topo: Server Groups
Server Groups are used to place Servers into a fault tolerant association. Each item in the Server Group collection is identified using its name.
Configuration of Server Groups is only available at the NOAM.
/topo/servergroups
get /topo/servergroups
Returns the details for all configured Server Groups.
Target server: NOAM
Secured by x-other
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/collections/servergroupCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/servergroup/servergroup.json",
"type": "object",
"required": ["name", "level", "parentSgName", "functionName"],
"properties": {
"name": {
"type": "string",
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"maxLength": 32,
"description": "Server Group Name"
},
"level": {
"type": "string",
"enum": ["A", "B", "C"],
"description": "Level (not updatable)"
},
"parentSgName": {
"type": "string",
"description": "Parent (not updatable unless C-level node)"
},
"functionName": {
"type": "string",
"description": "Function (not updatable)"
},
"numWanRepConn": {
"type": "integer",
"minimum": 1,
"maximum": 8,
"description": "Connection Count"
}
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"name": "NO_SG",
"level": "A",
"parentSgName": "NONE",
"functionName": "NONE",
"numWanRepConn": 1
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /topo/servergroups
Creates a Server Group with the specified attributes and associates it with a collection of Servers. The name field is the identifier and is returned.
Target server: NOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/servergroup/servergroup.json",
"type": "object",
"required": ["name", "level", "parentSgName", "functionName"],
"properties": {
"name": {
"type": "string",
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"maxLength": 32,
"description": "Server Group Name"
},
"level": {
"type": "string",
"enum": ["A", "B", "C"],
"description": "Level (not updatable)"
},
"parentSgName": {
"type": "string",
"description": "Parent (not updatable unless C-level node)"
},
"functionName": {
"type": "string",
"description": "Function (not updatable)"
},
"numWanRepConn": {
"type": "integer",
"minimum": 1,
"maximum": 8,
"description": "Connection Count"
}
}
}
Example
{
"name": "NO_SG",
"level": "A",
"parentSgName": "NONE",
"functionName": "NONE",
"numWanRepConn": 1
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/topo/servergroups/functions
get /topo/servergroups/functions
Returns the available Server Group functions.
Target server: NOAM
Secured by x-other
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/collections/optionCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/option/option.json",
"type" :"string"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
"Profile 1"
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
/topo/servergroups/{name}
get /topo/servergroups/{name}
Returns the details for the named Server Group.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/items/servergroupItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/servergroup/servergroup.json",
"type": "object",
"required": ["name", "level", "parentSgName", "functionName"],
"properties": {
"name": {
"type": "string",
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"maxLength": 32,
"description": "Server Group Name"
},
"level": {
"type": "string",
"enum": ["A", "B", "C"],
"description": "Level (not updatable)"
},
"parentSgName": {
"type": "string",
"description": "Parent (not updatable unless C-level node)"
},
"functionName": {
"type": "string",
"description": "Function (not updatable)"
},
"numWanRepConn": {
"type": "integer",
"minimum": 1,
"maximum": 8,
"description": "Connection Count"
}
}
}
,
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"name": "NO_SG",
"level": "A",
"parentSgName": "NONE",
"functionName": "NONE",
"numWanRepConn": 1
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /topo/servergroups/{name}
Updates the named Server Group.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/servergroup/servergroup.json",
"type": "object",
"required": ["name", "level", "parentSgName", "functionName"],
"properties": {
"name": {
"type": "string",
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"maxLength": 32,
"description": "Server Group Name"
},
"level": {
"type": "string",
"enum": ["A", "B", "C"],
"description": "Level (not updatable)"
},
"parentSgName": {
"type": "string",
"description": "Parent (not updatable unless C-level node)"
},
"functionName": {
"type": "string",
"description": "Function (not updatable)"
},
"numWanRepConn": {
"type": "integer",
"minimum": 1,
"maximum": 8,
"description": "Connection Count"
}
}
}
Example
{
"name": "NO_SG",
"level": "A",
"parentSgName": "NONE",
"functionName": "NONE",
"numWanRepConn": 1
}
delete /topo/servergroups/{name}
Deletes the named Server Group. A Server Group can only be deleted if it has no associated Servers.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
/topo/servergroups/{name}/prov
get /topo/servergroups/{name}/prov
Retrieves the database provisioning status for a Network / Site.
Target server: NOAM or SOAM
Secured by x-other
put /topo/servergroups/{name}/prov
Manage the database provisioning for a Network / Site.
Target server: NOAM
Secured by x-other
/topo/servergroups/{name}/members
get /topo/servergroups/{name}/members
Returns the list of Servers (members) that comprise the specified Server Group.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/collections/memberCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/servergroup/member.json",
"properties": {
"haRolePreference": {
"description": "Indicates the client's preferred High-Availability role for this Server (/topo/servers). When set to Active, the Server keeps the Active role as long as the Server remains available. When set to Standby, the Server only becomes Active if there is no other Server in the Server Group having a preferred haRolePreference of Active. In other words, if a Server's haRolePreference value is Standby, and if that Server is promoted to Active (because no other preferred-Active Server in the Server Group is available), and then another preferred-Active Server becomes available, the preferred-Standby Server will revert to the Standby role. When set to Spare, the Server is only promoted to Active or Standby if no other Servers in the Server Group are available to play the Active and Standby Roles. As soon as another Server becomes available to be Active or Standby, the preferred-Spare Server will revert to the Spare role. When set to Default, or if the client does not specify a value for haRolePreference, the DSR effectively treats the Server as having value Default.",
"enum": [ "Default", "Active", "Spare", "Standby" ],
"type": "string"
},
"hostname": {
"description": "The name of the Server (/topo/servers).",
"type": "string"
},
"serverGroupName": {
"description": "The name of the Server Group in which hostname is a member.",
"type": "string"
}
},
"required": [ "serverGroupName", "hostname"],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"haRolePreference":"Spare",
"hostname":"NO1",
"serverGroupName": "NO_SG"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /topo/servergroups/{name}/members
Adds a Server to the Server Group.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/servergroup/member.json",
"properties": {
"haRolePreference": {
"description": "Indicates the client's preferred High-Availability role for this Server (/topo/servers). When set to Active, the Server keeps the Active role as long as the Server remains available. When set to Standby, the Server only becomes Active if there is no other Server in the Server Group having a preferred haRolePreference of Active. In other words, if a Server's haRolePreference value is Standby, and if that Server is promoted to Active (because no other preferred-Active Server in the Server Group is available), and then another preferred-Active Server becomes available, the preferred-Standby Server will revert to the Standby role. When set to Spare, the Server is only promoted to Active or Standby if no other Servers in the Server Group are available to play the Active and Standby Roles. As soon as another Server becomes available to be Active or Standby, the preferred-Spare Server will revert to the Spare role. When set to Default, or if the client does not specify a value for haRolePreference, the DSR effectively treats the Server as having value Default.",
"enum": [ "Default", "Active", "Spare", "Standby" ],
"type": "string"
},
"hostname": {
"description": "The name of the Server (/topo/servers).",
"type": "string"
},
"serverGroupName": {
"description": "The name of the Server Group in which hostname is a member.",
"type": "string"
}
},
"required": [ "serverGroupName", "hostname"],
"type": "object"
}
Example
{
"haRolePreference":"Spare",
"hostname":"NO1",
"serverGroupName": "NO_SG"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/topo/servergroups/{name}/members/{hostname}
put /topo/servergroups/{name}/members/{hostname}
PUT is used to change a Server's {hostname} preferred High-Availability role within the Server Group {name}.
Target Server: NOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
- hostname: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/servergroup/member.json",
"properties": {
"haRolePreference": {
"description": "Indicates the client's preferred High-Availability role for this Server (/topo/servers). When set to Active, the Server keeps the Active role as long as the Server remains available. When set to Standby, the Server only becomes Active if there is no other Server in the Server Group having a preferred haRolePreference of Active. In other words, if a Server's haRolePreference value is Standby, and if that Server is promoted to Active (because no other preferred-Active Server in the Server Group is available), and then another preferred-Active Server becomes available, the preferred-Standby Server will revert to the Standby role. When set to Spare, the Server is only promoted to Active or Standby if no other Servers in the Server Group are available to play the Active and Standby Roles. As soon as another Server becomes available to be Active or Standby, the preferred-Spare Server will revert to the Spare role. When set to Default, or if the client does not specify a value for haRolePreference, the DSR effectively treats the Server as having value Default.",
"enum": [ "Default", "Active", "Spare", "Standby" ],
"type": "string"
},
"hostname": {
"description": "The name of the Server (/topo/servers).",
"type": "string"
},
"serverGroupName": {
"description": "The name of the Server Group in which hostname is a member.",
"type": "string"
}
},
"required": [ "serverGroupName", "hostname"],
"type": "object"
}
Example
{
"haRolePreference":"Spare",
"hostname":"NO1",
"serverGroupName": "NO_SG"
}
delete /topo/servergroups/{name}/members/{hostname}
Removes the specified Server {hostname} from the Server Group {name}.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
- hostname: required (string)
/topo/servergroups/{name}/vips
get /topo/servergroups/{name}/vips
Returns the details of the specified Server Group's VIPs.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/collections/vipCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/servergroup/vip.json",
"type": "object",
"required": ["serverGroupName","ipAddress"],
"properties": {
"UUID": {
"type": "string",
"description": "VIP Identifier (*computed*)",
"example": "3907f4f5-130b-4f99-9c8f-8b5d32d6112",
"pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
"serverGroupName": {
"type": "string",
"description": "The name of the Server Group associated with this VIP"
},
"ipAddress":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6/IPv4orIPv6.json",
"type": "string",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^(default)$",
"example": "192.168.1.1"
}
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"UUID": "2760ea35-a33e-4dde-a28e-0c6aee4cd1cc",
"serverGroupName": "NO_SG",
"ipAddress": "23.55.0.6"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /topo/servergroups/{name}/vips
Adds a VIP to the Server Group.
Target server: NOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/servergroup/vip.json",
"type": "object",
"required": ["serverGroupName","ipAddress"],
"properties": {
"UUID": {
"type": "string",
"description": "VIP Identifier (*computed*)",
"example": "3907f4f5-130b-4f99-9c8f-8b5d32d6112",
"pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
},
"serverGroupName": {
"type": "string",
"description": "The name of the Server Group associated with this VIP"
},
"ipAddress":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/IPv4orIPv6/IPv4orIPv6.json",
"type": "string",
"pattern": "^$|^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])[.]){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$|^(default)$",
"example": "192.168.1.1"
}
}
}
Example
{
"UUID": "2760ea35-a33e-4dde-a28e-0c6aee4cd1cc",
"serverGroupName": "NO_SG",
"ipAddress": "23.55.0.6"
}
/topo/servergroups/{name}/vips/{uuid}
delete /topo/servergroups/{name}/vips/{uuid}
Deletes a Server Group VIP.
Target server: NOAM
Request
URI Parameters
- name: required (string)
- uuid: required (string)
Topo: Versions
The version of the MMI interface on the target for a given product. The version API is also available from the unversioned and unauthenticated alias:
The unversioned interface to /topo/versions will always return its version data as a JSON object including only these fields:
- product: the product name
- version: the product API version
- supports: an array of older supported API versions
/topo/versions
get /topo/versions
Retrieves both the current API version and a list of compatible versions.
Target server: NOAM or SOAM
Secured by x-other
Secured by none
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/topo/items/versionItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/topo/version/version.json",
"type": "object",
"properties" : {
"product": { "type": "string", "description": "The MMI product name" },
"version": { "type": "string", "description": "The MMI product version" },
"supports": {
"type": "array",
"description": "Older supported product versions",
"items": { "type": "string" },
"minItems": 0
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"product": "alexa",
"version": "v4.0",
"supports": [
"v3.0",
"v2.5",
"v2.1"
]
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
Vstp: Capacity
Capacity provides information about maximum allowed, currently configured, and free count of VSTP resources. This information is available system-wide and also for per STP-MP.
/vstp/capacity
get /vstp/capacity
Returns the capacity of VSTP resources in a valid GET request.
Target Server: SOAM
Secured by x-other
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/collections/capacityCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/capacity/capacity.json",
"properties": {
"freeCapacity":{
"description": "Allowed number of entries that can be additionally configured for the resourceName",
"maximum": 2147483647,
"minimum": 0,
"type": "integer"
},
"maximumCapacity":{
"description": "Maximum number of entries for the resourceName that can be configured in VSTP.",
"maximum": 2147483647,
"minimum": 1,
"type": "integer"
},
"resourceName":{
"description": "Resource Name",
"maxLength": 255,
"pattern": "^[a-zA-Z][a-zA-Z]*$",
"type": "string"
},
"scope":{
"description": "Scope depicts whether the capacity is system-wide or per STP-MP",
"enum": [
"Server",
"Network Element"
],
"type": "string"
},
"scopeName":{
"description": "MP Server hostname. Scope name is only valid for Server and not for Network Element",
"type": "string",
"pattern": "^(([A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])|([A-Za-z0-9]+))$",
"maxLength": 20
},
"usedCapacity":{
"description": "Number of entries that are already configured for the resourceName.",
"maximum": 2147483647,
"minimum": 0,
"type": "integer"
},
"required": [
"resourceName",
"scope",
"usedCapacity"
],
"type": "object"
}
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
[
{
"freeCapacity": 269999,
"maximumCapacity": "270000",
"resourceName": "globaltitleaddresses",
"scope": "Network Element",
"usedCapacity": "1"
},
{
"resourceName": "links",
"scope": "Server",
"scopeName": "MP1",
"usedCapacity": "2"
}
]
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
Vstp: Connection Configuration Sets
Connection Configuration Sets provide a way to tailor a VSTP Connection to account for the network quality of service and Remote Node (/vstp/remotenodes) requirements. A Connection Configuration Set is simply a collection of Connection (/vstp/connections) parameters that are grouped so the set can be easily assigned to multiple Connections.
The Connection Configuration Set named Default is always available. The Default Connection Configuration Set can be modified, but it cannot be deleted.
All attributes (except for the read-only configurationLevel) for Connection Configuration Sets are marked as required in the JSON schema. A client should GET the Default instance, copy it, modify any attributes, and POST the new instance. This way, all attributes have valid values.
All configuration of the Connection Configuration Set is done at the SOAM.
/vstp/connectionconfigurationsets
get /vstp/connectionconfigurationsets
Returns all Connection Configuration Sets that meet the criteria specified in the GET request. By default, all Connection Configuration Sets configured at the SOAM are returned. If paging parameters are supplied, only those Connection Configuration Sets meeting the request parameters are returned.
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (one of configurationLevel)
The field being matched
Only the configurationLevel field is supported.
Example:
filter_name=configurationLevel
- filter_op: (one of GREATER_THAN, GREATER_THAN_EQUAL)
The match operation (operator)
Example:
filter_op=GREATER_THAN
- filter_values: (string)
The matched value
The configurationLevel value by which the data is being filtered. Only a single value is supported.
Example:
filter_values=10
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/collections/connectionconfigurationsetCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/connectionconfigurationset/connectionconfigurationset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name associated with Connection configuration set which must be unique within the VSTP site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"sctpFragmentationEnabled": {
"description": "If true, a message exceeding the size of the path maximum transmission unit is fragmented and reassembled by the Remote Node (/vstp/remotenodes). Typical value is true.",
"type": "boolean"
},
"sctpHeartbeatInterval": {
"description": "The interval in milliseconds between sending SCTP heartbeat messages to a Remote Node (/vstp/remotenodes). Heartbeat messages are sent only when no user data has been sent for the duration of the sctpHeartbeatInterval. Setting sctpHeartbeatInterval to zero disables the heartbeat and is not recommended. When enabling the heartbeat, the minimum valid value is 100 ms - the VSTP rejects values between 1 and 99, inclusive. Typical value is 1000.",
"maximum": 300000,
"minimum": 0,
"type": "integer"
},
"sctpMaximumBurst": {
"description": "Specifies the maximum burst of packets that can be emitted by this Connection (/vstp/connections). Typical value is 4.",
"maximum": 4,
"minimum": 1,
"type": "integer"
},
"sctpMaximumSegmentSize": {
"description": "The maximum size (in bytes) of any outgoing SCTP DATA chunk. If a message is larger than the sctpMaximumSegmentSize bytes, VSTP fragments the message into chunks not exceeding this size. Set the sctpMaximumSegmentSize to zero to not stipulate a maximum segment size. When specifying a maximum segment size, the minimum allowable value is 88 - the VSTP rejects values between 1 and 87, inclusive. Typical value is 0.",
"maximum": 1460,
"minimum": 0,
"type": "integer"
},
"sctpNumberInboundStreams": {
"description": "Maximum number of inbound SCTP streams supported locally by the SCTP Connection (/vstp/connections). Typical value is 2.",
"maximum": 2,
"minimum": 1,
"type": "integer"
},
"sctpNumberOutboundStreams": {
"description": "Maximum number of outbound SCTP streams supported locally by the SCTP Connection (/vstp/connections). Typical value is 2.",
"maximum": 2,
"minimum": 1,
"type": "integer"
},
"sctpOrderedDelivery": {
"description": "If true, ordered delivery of the SCTP data chunk is performed; otherwise, delivery is unordered. Typical value is false.",
"type": "boolean"
},
"sctpRetransmissionAssociationFailure": {
"description": "Number of consecutive message retransmissions that cause an SCTP Connection (/vstp/connections) to be marked as failed. The sctpRetransmissionAssociationFailure value indicates how many SCTP retransmission attempts should be made to all destinations for an SCTP Connection before marking the Connection as failed. This value should not be greater than the sum of the retransmission attempts for all destinations within the connection. Typical value is 5.",
"maximum": 20,
"minimum": 1,
"type": "integer"
},
"sctpRetransmissionInitFailure": {
"description": "Number of consecutive retransmits for INIT and COOKIE-ECHO chunks that cause an SCTP Connection (/vstp/connections) to be marked as failed. The sctpRetransmissionInitFailure value indicates how many retransmission attempts should be made to the primary IP address for INIT and COOKIE-ECHO chunks (when a secondary IP address has not been configured) before marking the Connection as failed. If a secondary IP address has been configured, the retransmission attempts are alternated between the primary and secondary IP address. Typical value is 8.",
"maximum": 20,
"minimum": 1,
"type": "integer"
},
"sctpRetransmissionInitTimeout": {
"description": "Expected average network roundtrip time in milliseconds. sctpRetransmissionInitTimeout is used to initialize the roundtrip time value when a Connection (/vstp/connections) is started but the roundtrip time has not yet been measured. VSTP uses the roundtrip time to calculate when to retransmit chunks of messages. Typical value is 120.",
"maximum": 5000,
"minimum": 10,
"type": "integer"
},
"sctpRetransmissionMaximumTimeout": {
"description": "Maximum time (in milliseconds) to wait for an acknowledgment of a message sent. The sctpRetransmissionMaximumTimeout value places an upper boundary on the exponential back-off algorithm VSTP uses for SCTP retransmission timing. After the retransmit interval is reached, retransmits are sent at a constant rate until an acknowledgment is received or the maximum attempts is reached. Typical value is 120.",
"maximum": 10000,
"minimum": 10,
"type": "integer"
},
"sctpRetransmissionMaximumTimeoutInit": {
"description": "Maximum time (in milliseconds) to wait for an INIT to be acknowledged. The sctpRetransmissionMaximumTimeoutInit value overrides the sctpRetransmissionMaximumTimeout and is used to bound the initial setup time. A value of zero indicates the sctpRetransmissionMaximumTimeout is used for INITs as well. When specifying an INIT timeout different from sctpRetransmissionMaximumTimeout, the minimum allowable value is 10 - the VSTP rejects values between 1 and 9, inclusive. Typical value is 120.",
"maximum": 10000,
"minimum": 0,
"type": "integer"
},
"sctpRetransmissionMinimumTimeout": {
"description": "Minimum time (in milliseconds) to wait for an acknowledgment of a message sent. The sctpRetransmissionMinimumTimeout value prevents the retransmit timeout from becoming too small in networks with a very short roundtrip time. Typical value is 120.",
"maximum": 5000,
"minimum": 10,
"type": "integer"
},
"sctpRetransmissionPathFailure": {
"description": "Number of consecutive unsuccessful message retransmisssions that causes a path of the SCTP Connection (/vstp/connections) to be marked as failed. The sctpRetransmissionPathFailure value indicates how many SCTP retransmission attempts should be made to each destination of an SCTP Connection before marking the destination as failed. This value must be less than the sctpRetransmissionAssociationFailure value. Typical value is 3.",
"maximum": 10,
"minimum": 1,
"type": "integer"
},
"sctpSackDelay": {
"description": "The number of milliseconds to delay after receiving a data chunk and before sending a SACK. A non-zero value for sctpSackDelay gives the application time to bundle data chunks in the same SCTP message with the SACK, thereby reducing the number of packets in the network. Setting sctpSackDelay to zero disables this delay so that SACKs are sent as quickly as possible. Typical value is 10.",
"maximum": 200,
"minimum": 1,
"type": "integer"
},
"sctpSocketReceiveSize": {
"description": "Socket receive buffer size (in bytes) for incoming SCTP messages. The receive buffer size must be greater than or equal to the product of the bandwidth and the roundtrip delay for the Connection (/vstp/connections). Typical value is 1000000.",
"maximum": 5000000,
"minimum": 8000,
"type": "integer"
},
"sctpSocketSendSize": {
"description": "Socket send buffer size (in bytes) for outgoing SCTP messages. The send buffer size must be greater than or equal to the product of the bandwidth and the roundtrip delay for the Connection (/vstp/connections). Typical value is 1000000.",
"maximum": 5000000,
"minimum": 8000,
"type": "integer"
}
},
"required": [
"name",
"sctpFragmentationEnabled",
"sctpHeartbeatInterval",
"sctpMaximumBurst",
"sctpMaximumSegmentSize",
"sctpNumberInboundStreams",
"sctpNumberOutboundStreams",
"sctpOrderedDelivery",
"sctpRetransmissionAssociationFailure",
"sctpRetransmissionInitFailure",
"sctpRetransmissionInitTimeout",
"sctpRetransmissionMaximumTimeout",
"sctpRetransmissionMaximumTimeoutInit",
"sctpRetransmissionMinimumTimeout",
"sctpRetransmissionPathFailure",
"sctpSackDelay",
"sctpSocketReceiveSize",
"sctpSocketSendSize"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"configurationLevel": "52",
"connectionCfgSetName": "ConnectionConfigurationSet1",
"sctpFragmentationEnabled": true,
"sctpHeartbeatInterval": 500,
"sctpMaximumBurst": 4,
"sctpMaximumSegmentSize": 0,
"sctpNumberInboundStreams": 8,
"sctpNumberOutboundStreams": 8,
"sctpOrderedDelivery": false,
"sctpRetransmissionAssociationFailure": 5,
"sctpRetransmissionInitFailure": 8,
"sctpRetransmissionInitTimeout": 120,
"sctpRetransmissionMaximumTimeout": 120,
"sctpRetransmissionMaximumTimeoutInit": 120,
"sctpRetransmissionMinimumTimeout": 120,
"sctpRetransmissionPathFailure": 3,
"sctpSackDelay": 10,
"sctpSocketReceiveSize": 1000000,
"sctpSocketSendSize": 1000000
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /vstp/connectionconfigurationsets
Adds a new Connection Configuration Set to the VSTP configuration. The Connection Configuration Set name must be unique across all Connection Configuration Sets at the SOAM.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/connectionconfigurationset/connectionconfigurationset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name associated with Connection configuration set which must be unique within the VSTP site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"sctpFragmentationEnabled": {
"description": "If true, a message exceeding the size of the path maximum transmission unit is fragmented and reassembled by the Remote Node (/vstp/remotenodes). Typical value is true.",
"type": "boolean"
},
"sctpHeartbeatInterval": {
"description": "The interval in milliseconds between sending SCTP heartbeat messages to a Remote Node (/vstp/remotenodes). Heartbeat messages are sent only when no user data has been sent for the duration of the sctpHeartbeatInterval. Setting sctpHeartbeatInterval to zero disables the heartbeat and is not recommended. When enabling the heartbeat, the minimum valid value is 100 ms - the VSTP rejects values between 1 and 99, inclusive. Typical value is 1000.",
"maximum": 300000,
"minimum": 0,
"type": "integer"
},
"sctpMaximumBurst": {
"description": "Specifies the maximum burst of packets that can be emitted by this Connection (/vstp/connections). Typical value is 4.",
"maximum": 4,
"minimum": 1,
"type": "integer"
},
"sctpMaximumSegmentSize": {
"description": "The maximum size (in bytes) of any outgoing SCTP DATA chunk. If a message is larger than the sctpMaximumSegmentSize bytes, VSTP fragments the message into chunks not exceeding this size. Set the sctpMaximumSegmentSize to zero to not stipulate a maximum segment size. When specifying a maximum segment size, the minimum allowable value is 88 - the VSTP rejects values between 1 and 87, inclusive. Typical value is 0.",
"maximum": 1460,
"minimum": 0,
"type": "integer"
},
"sctpNumberInboundStreams": {
"description": "Maximum number of inbound SCTP streams supported locally by the SCTP Connection (/vstp/connections). Typical value is 2.",
"maximum": 2,
"minimum": 1,
"type": "integer"
},
"sctpNumberOutboundStreams": {
"description": "Maximum number of outbound SCTP streams supported locally by the SCTP Connection (/vstp/connections). Typical value is 2.",
"maximum": 2,
"minimum": 1,
"type": "integer"
},
"sctpOrderedDelivery": {
"description": "If true, ordered delivery of the SCTP data chunk is performed; otherwise, delivery is unordered. Typical value is false.",
"type": "boolean"
},
"sctpRetransmissionAssociationFailure": {
"description": "Number of consecutive message retransmissions that cause an SCTP Connection (/vstp/connections) to be marked as failed. The sctpRetransmissionAssociationFailure value indicates how many SCTP retransmission attempts should be made to all destinations for an SCTP Connection before marking the Connection as failed. This value should not be greater than the sum of the retransmission attempts for all destinations within the connection. Typical value is 5.",
"maximum": 20,
"minimum": 1,
"type": "integer"
},
"sctpRetransmissionInitFailure": {
"description": "Number of consecutive retransmits for INIT and COOKIE-ECHO chunks that cause an SCTP Connection (/vstp/connections) to be marked as failed. The sctpRetransmissionInitFailure value indicates how many retransmission attempts should be made to the primary IP address for INIT and COOKIE-ECHO chunks (when a secondary IP address has not been configured) before marking the Connection as failed. If a secondary IP address has been configured, the retransmission attempts are alternated between the primary and secondary IP address. Typical value is 8.",
"maximum": 20,
"minimum": 1,
"type": "integer"
},
"sctpRetransmissionInitTimeout": {
"description": "Expected average network roundtrip time in milliseconds. sctpRetransmissionInitTimeout is used to initialize the roundtrip time value when a Connection (/vstp/connections) is started but the roundtrip time has not yet been measured. VSTP uses the roundtrip time to calculate when to retransmit chunks of messages. Typical value is 120.",
"maximum": 5000,
"minimum": 10,
"type": "integer"
},
"sctpRetransmissionMaximumTimeout": {
"description": "Maximum time (in milliseconds) to wait for an acknowledgment of a message sent. The sctpRetransmissionMaximumTimeout value places an upper boundary on the exponential back-off algorithm VSTP uses for SCTP retransmission timing. After the retransmit interval is reached, retransmits are sent at a constant rate until an acknowledgment is received or the maximum attempts is reached. Typical value is 120.",
"maximum": 10000,
"minimum": 10,
"type": "integer"
},
"sctpRetransmissionMaximumTimeoutInit": {
"description": "Maximum time (in milliseconds) to wait for an INIT to be acknowledged. The sctpRetransmissionMaximumTimeoutInit value overrides the sctpRetransmissionMaximumTimeout and is used to bound the initial setup time. A value of zero indicates the sctpRetransmissionMaximumTimeout is used for INITs as well. When specifying an INIT timeout different from sctpRetransmissionMaximumTimeout, the minimum allowable value is 10 - the VSTP rejects values between 1 and 9, inclusive. Typical value is 120.",
"maximum": 10000,
"minimum": 0,
"type": "integer"
},
"sctpRetransmissionMinimumTimeout": {
"description": "Minimum time (in milliseconds) to wait for an acknowledgment of a message sent. The sctpRetransmissionMinimumTimeout value prevents the retransmit timeout from becoming too small in networks with a very short roundtrip time. Typical value is 120.",
"maximum": 5000,
"minimum": 10,
"type": "integer"
},
"sctpRetransmissionPathFailure": {
"description": "Number of consecutive unsuccessful message retransmisssions that causes a path of the SCTP Connection (/vstp/connections) to be marked as failed. The sctpRetransmissionPathFailure value indicates how many SCTP retransmission attempts should be made to each destination of an SCTP Connection before marking the destination as failed. This value must be less than the sctpRetransmissionAssociationFailure value. Typical value is 3.",
"maximum": 10,
"minimum": 1,
"type": "integer"
},
"sctpSackDelay": {
"description": "The number of milliseconds to delay after receiving a data chunk and before sending a SACK. A non-zero value for sctpSackDelay gives the application time to bundle data chunks in the same SCTP message with the SACK, thereby reducing the number of packets in the network. Setting sctpSackDelay to zero disables this delay so that SACKs are sent as quickly as possible. Typical value is 10.",
"maximum": 200,
"minimum": 1,
"type": "integer"
},
"sctpSocketReceiveSize": {
"description": "Socket receive buffer size (in bytes) for incoming SCTP messages. The receive buffer size must be greater than or equal to the product of the bandwidth and the roundtrip delay for the Connection (/vstp/connections). Typical value is 1000000.",
"maximum": 5000000,
"minimum": 8000,
"type": "integer"
},
"sctpSocketSendSize": {
"description": "Socket send buffer size (in bytes) for outgoing SCTP messages. The send buffer size must be greater than or equal to the product of the bandwidth and the roundtrip delay for the Connection (/vstp/connections). Typical value is 1000000.",
"maximum": 5000000,
"minimum": 8000,
"type": "integer"
}
},
"required": [
"name",
"sctpFragmentationEnabled",
"sctpHeartbeatInterval",
"sctpMaximumBurst",
"sctpMaximumSegmentSize",
"sctpNumberInboundStreams",
"sctpNumberOutboundStreams",
"sctpOrderedDelivery",
"sctpRetransmissionAssociationFailure",
"sctpRetransmissionInitFailure",
"sctpRetransmissionInitTimeout",
"sctpRetransmissionMaximumTimeout",
"sctpRetransmissionMaximumTimeoutInit",
"sctpRetransmissionMinimumTimeout",
"sctpRetransmissionPathFailure",
"sctpSackDelay",
"sctpSocketReceiveSize",
"sctpSocketSendSize"
],
"type": "object"
}
Example
{
"configurationLevel": "52",
"connectionCfgSetName": "ConnectionConfigurationSet1",
"sctpFragmentationEnabled": true,
"sctpHeartbeatInterval": 500,
"sctpMaximumBurst": 4,
"sctpMaximumSegmentSize": 0,
"sctpNumberInboundStreams": 8,
"sctpNumberOutboundStreams": 8,
"sctpOrderedDelivery": false,
"sctpRetransmissionAssociationFailure": 5,
"sctpRetransmissionInitFailure": 8,
"sctpRetransmissionInitTimeout": 120,
"sctpRetransmissionMaximumTimeout": 120,
"sctpRetransmissionMaximumTimeoutInit": 120,
"sctpRetransmissionMinimumTimeout": 120,
"sctpRetransmissionPathFailure": 3,
"sctpSackDelay": 10,
"sctpSocketReceiveSize": 1000000,
"sctpSocketSendSize": 1000000
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/vstp/connectionconfigurationsets/{name}
get /vstp/connectionconfigurationsets/{name}
Returns the configuration details for the specified Connection Configuration Set. If the Connection Configuration Set does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/items/connectionconfigurationsetItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/connectionconfigurationset/connectionconfigurationset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name associated with Connection configuration set which must be unique within the VSTP site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"sctpFragmentationEnabled": {
"description": "If true, a message exceeding the size of the path maximum transmission unit is fragmented and reassembled by the Remote Node (/vstp/remotenodes). Typical value is true.",
"type": "boolean"
},
"sctpHeartbeatInterval": {
"description": "The interval in milliseconds between sending SCTP heartbeat messages to a Remote Node (/vstp/remotenodes). Heartbeat messages are sent only when no user data has been sent for the duration of the sctpHeartbeatInterval. Setting sctpHeartbeatInterval to zero disables the heartbeat and is not recommended. When enabling the heartbeat, the minimum valid value is 100 ms - the VSTP rejects values between 1 and 99, inclusive. Typical value is 1000.",
"maximum": 300000,
"minimum": 0,
"type": "integer"
},
"sctpMaximumBurst": {
"description": "Specifies the maximum burst of packets that can be emitted by this Connection (/vstp/connections). Typical value is 4.",
"maximum": 4,
"minimum": 1,
"type": "integer"
},
"sctpMaximumSegmentSize": {
"description": "The maximum size (in bytes) of any outgoing SCTP DATA chunk. If a message is larger than the sctpMaximumSegmentSize bytes, VSTP fragments the message into chunks not exceeding this size. Set the sctpMaximumSegmentSize to zero to not stipulate a maximum segment size. When specifying a maximum segment size, the minimum allowable value is 88 - the VSTP rejects values between 1 and 87, inclusive. Typical value is 0.",
"maximum": 1460,
"minimum": 0,
"type": "integer"
},
"sctpNumberInboundStreams": {
"description": "Maximum number of inbound SCTP streams supported locally by the SCTP Connection (/vstp/connections). Typical value is 2.",
"maximum": 2,
"minimum": 1,
"type": "integer"
},
"sctpNumberOutboundStreams": {
"description": "Maximum number of outbound SCTP streams supported locally by the SCTP Connection (/vstp/connections). Typical value is 2.",
"maximum": 2,
"minimum": 1,
"type": "integer"
},
"sctpOrderedDelivery": {
"description": "If true, ordered delivery of the SCTP data chunk is performed; otherwise, delivery is unordered. Typical value is false.",
"type": "boolean"
},
"sctpRetransmissionAssociationFailure": {
"description": "Number of consecutive message retransmissions that cause an SCTP Connection (/vstp/connections) to be marked as failed. The sctpRetransmissionAssociationFailure value indicates how many SCTP retransmission attempts should be made to all destinations for an SCTP Connection before marking the Connection as failed. This value should not be greater than the sum of the retransmission attempts for all destinations within the connection. Typical value is 5.",
"maximum": 20,
"minimum": 1,
"type": "integer"
},
"sctpRetransmissionInitFailure": {
"description": "Number of consecutive retransmits for INIT and COOKIE-ECHO chunks that cause an SCTP Connection (/vstp/connections) to be marked as failed. The sctpRetransmissionInitFailure value indicates how many retransmission attempts should be made to the primary IP address for INIT and COOKIE-ECHO chunks (when a secondary IP address has not been configured) before marking the Connection as failed. If a secondary IP address has been configured, the retransmission attempts are alternated between the primary and secondary IP address. Typical value is 8.",
"maximum": 20,
"minimum": 1,
"type": "integer"
},
"sctpRetransmissionInitTimeout": {
"description": "Expected average network roundtrip time in milliseconds. sctpRetransmissionInitTimeout is used to initialize the roundtrip time value when a Connection (/vstp/connections) is started but the roundtrip time has not yet been measured. VSTP uses the roundtrip time to calculate when to retransmit chunks of messages. Typical value is 120.",
"maximum": 5000,
"minimum": 10,
"type": "integer"
},
"sctpRetransmissionMaximumTimeout": {
"description": "Maximum time (in milliseconds) to wait for an acknowledgment of a message sent. The sctpRetransmissionMaximumTimeout value places an upper boundary on the exponential back-off algorithm VSTP uses for SCTP retransmission timing. After the retransmit interval is reached, retransmits are sent at a constant rate until an acknowledgment is received or the maximum attempts is reached. Typical value is 120.",
"maximum": 10000,
"minimum": 10,
"type": "integer"
},
"sctpRetransmissionMaximumTimeoutInit": {
"description": "Maximum time (in milliseconds) to wait for an INIT to be acknowledged. The sctpRetransmissionMaximumTimeoutInit value overrides the sctpRetransmissionMaximumTimeout and is used to bound the initial setup time. A value of zero indicates the sctpRetransmissionMaximumTimeout is used for INITs as well. When specifying an INIT timeout different from sctpRetransmissionMaximumTimeout, the minimum allowable value is 10 - the VSTP rejects values between 1 and 9, inclusive. Typical value is 120.",
"maximum": 10000,
"minimum": 0,
"type": "integer"
},
"sctpRetransmissionMinimumTimeout": {
"description": "Minimum time (in milliseconds) to wait for an acknowledgment of a message sent. The sctpRetransmissionMinimumTimeout value prevents the retransmit timeout from becoming too small in networks with a very short roundtrip time. Typical value is 120.",
"maximum": 5000,
"minimum": 10,
"type": "integer"
},
"sctpRetransmissionPathFailure": {
"description": "Number of consecutive unsuccessful message retransmisssions that causes a path of the SCTP Connection (/vstp/connections) to be marked as failed. The sctpRetransmissionPathFailure value indicates how many SCTP retransmission attempts should be made to each destination of an SCTP Connection before marking the destination as failed. This value must be less than the sctpRetransmissionAssociationFailure value. Typical value is 3.",
"maximum": 10,
"minimum": 1,
"type": "integer"
},
"sctpSackDelay": {
"description": "The number of milliseconds to delay after receiving a data chunk and before sending a SACK. A non-zero value for sctpSackDelay gives the application time to bundle data chunks in the same SCTP message with the SACK, thereby reducing the number of packets in the network. Setting sctpSackDelay to zero disables this delay so that SACKs are sent as quickly as possible. Typical value is 10.",
"maximum": 200,
"minimum": 1,
"type": "integer"
},
"sctpSocketReceiveSize": {
"description": "Socket receive buffer size (in bytes) for incoming SCTP messages. The receive buffer size must be greater than or equal to the product of the bandwidth and the roundtrip delay for the Connection (/vstp/connections). Typical value is 1000000.",
"maximum": 5000000,
"minimum": 8000,
"type": "integer"
},
"sctpSocketSendSize": {
"description": "Socket send buffer size (in bytes) for outgoing SCTP messages. The send buffer size must be greater than or equal to the product of the bandwidth and the roundtrip delay for the Connection (/vstp/connections). Typical value is 1000000.",
"maximum": 5000000,
"minimum": 8000,
"type": "integer"
}
},
"required": [
"name",
"sctpFragmentationEnabled",
"sctpHeartbeatInterval",
"sctpMaximumBurst",
"sctpMaximumSegmentSize",
"sctpNumberInboundStreams",
"sctpNumberOutboundStreams",
"sctpOrderedDelivery",
"sctpRetransmissionAssociationFailure",
"sctpRetransmissionInitFailure",
"sctpRetransmissionInitTimeout",
"sctpRetransmissionMaximumTimeout",
"sctpRetransmissionMaximumTimeoutInit",
"sctpRetransmissionMinimumTimeout",
"sctpRetransmissionPathFailure",
"sctpSackDelay",
"sctpSocketReceiveSize",
"sctpSocketSendSize"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"configurationLevel": "52",
"connectionCfgSetName": "ConnectionConfigurationSet1",
"sctpFragmentationEnabled": true,
"sctpHeartbeatInterval": 500,
"sctpMaximumBurst": 4,
"sctpMaximumSegmentSize": 0,
"sctpNumberInboundStreams": 8,
"sctpNumberOutboundStreams": 8,
"sctpOrderedDelivery": false,
"sctpRetransmissionAssociationFailure": 5,
"sctpRetransmissionInitFailure": 8,
"sctpRetransmissionInitTimeout": 120,
"sctpRetransmissionMaximumTimeout": 120,
"sctpRetransmissionMaximumTimeoutInit": 120,
"sctpRetransmissionMinimumTimeout": 120,
"sctpRetransmissionPathFailure": 3,
"sctpSackDelay": 10,
"sctpSocketReceiveSize": 1000000,
"sctpSocketSendSize": 1000000
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /vstp/connectionconfigurationsets/{name}
Updates the configuration of the specified Connection Configuration Set. If the provided Connection Configuration Set data is invalid in any way, the update fails, resulting in one or more error messages returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/connectionconfigurationset/connectionconfigurationset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name associated with Connection configuration set which must be unique within the VSTP site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"sctpFragmentationEnabled": {
"description": "If true, a message exceeding the size of the path maximum transmission unit is fragmented and reassembled by the Remote Node (/vstp/remotenodes). Typical value is true.",
"type": "boolean"
},
"sctpHeartbeatInterval": {
"description": "The interval in milliseconds between sending SCTP heartbeat messages to a Remote Node (/vstp/remotenodes). Heartbeat messages are sent only when no user data has been sent for the duration of the sctpHeartbeatInterval. Setting sctpHeartbeatInterval to zero disables the heartbeat and is not recommended. When enabling the heartbeat, the minimum valid value is 100 ms - the VSTP rejects values between 1 and 99, inclusive. Typical value is 1000.",
"maximum": 300000,
"minimum": 0,
"type": "integer"
},
"sctpMaximumBurst": {
"description": "Specifies the maximum burst of packets that can be emitted by this Connection (/vstp/connections). Typical value is 4.",
"maximum": 4,
"minimum": 1,
"type": "integer"
},
"sctpMaximumSegmentSize": {
"description": "The maximum size (in bytes) of any outgoing SCTP DATA chunk. If a message is larger than the sctpMaximumSegmentSize bytes, VSTP fragments the message into chunks not exceeding this size. Set the sctpMaximumSegmentSize to zero to not stipulate a maximum segment size. When specifying a maximum segment size, the minimum allowable value is 88 - the VSTP rejects values between 1 and 87, inclusive. Typical value is 0.",
"maximum": 1460,
"minimum": 0,
"type": "integer"
},
"sctpNumberInboundStreams": {
"description": "Maximum number of inbound SCTP streams supported locally by the SCTP Connection (/vstp/connections). Typical value is 2.",
"maximum": 2,
"minimum": 1,
"type": "integer"
},
"sctpNumberOutboundStreams": {
"description": "Maximum number of outbound SCTP streams supported locally by the SCTP Connection (/vstp/connections). Typical value is 2.",
"maximum": 2,
"minimum": 1,
"type": "integer"
},
"sctpOrderedDelivery": {
"description": "If true, ordered delivery of the SCTP data chunk is performed; otherwise, delivery is unordered. Typical value is false.",
"type": "boolean"
},
"sctpRetransmissionAssociationFailure": {
"description": "Number of consecutive message retransmissions that cause an SCTP Connection (/vstp/connections) to be marked as failed. The sctpRetransmissionAssociationFailure value indicates how many SCTP retransmission attempts should be made to all destinations for an SCTP Connection before marking the Connection as failed. This value should not be greater than the sum of the retransmission attempts for all destinations within the connection. Typical value is 5.",
"maximum": 20,
"minimum": 1,
"type": "integer"
},
"sctpRetransmissionInitFailure": {
"description": "Number of consecutive retransmits for INIT and COOKIE-ECHO chunks that cause an SCTP Connection (/vstp/connections) to be marked as failed. The sctpRetransmissionInitFailure value indicates how many retransmission attempts should be made to the primary IP address for INIT and COOKIE-ECHO chunks (when a secondary IP address has not been configured) before marking the Connection as failed. If a secondary IP address has been configured, the retransmission attempts are alternated between the primary and secondary IP address. Typical value is 8.",
"maximum": 20,
"minimum": 1,
"type": "integer"
},
"sctpRetransmissionInitTimeout": {
"description": "Expected average network roundtrip time in milliseconds. sctpRetransmissionInitTimeout is used to initialize the roundtrip time value when a Connection (/vstp/connections) is started but the roundtrip time has not yet been measured. VSTP uses the roundtrip time to calculate when to retransmit chunks of messages. Typical value is 120.",
"maximum": 5000,
"minimum": 10,
"type": "integer"
},
"sctpRetransmissionMaximumTimeout": {
"description": "Maximum time (in milliseconds) to wait for an acknowledgment of a message sent. The sctpRetransmissionMaximumTimeout value places an upper boundary on the exponential back-off algorithm VSTP uses for SCTP retransmission timing. After the retransmit interval is reached, retransmits are sent at a constant rate until an acknowledgment is received or the maximum attempts is reached. Typical value is 120.",
"maximum": 10000,
"minimum": 10,
"type": "integer"
},
"sctpRetransmissionMaximumTimeoutInit": {
"description": "Maximum time (in milliseconds) to wait for an INIT to be acknowledged. The sctpRetransmissionMaximumTimeoutInit value overrides the sctpRetransmissionMaximumTimeout and is used to bound the initial setup time. A value of zero indicates the sctpRetransmissionMaximumTimeout is used for INITs as well. When specifying an INIT timeout different from sctpRetransmissionMaximumTimeout, the minimum allowable value is 10 - the VSTP rejects values between 1 and 9, inclusive. Typical value is 120.",
"maximum": 10000,
"minimum": 0,
"type": "integer"
},
"sctpRetransmissionMinimumTimeout": {
"description": "Minimum time (in milliseconds) to wait for an acknowledgment of a message sent. The sctpRetransmissionMinimumTimeout value prevents the retransmit timeout from becoming too small in networks with a very short roundtrip time. Typical value is 120.",
"maximum": 5000,
"minimum": 10,
"type": "integer"
},
"sctpRetransmissionPathFailure": {
"description": "Number of consecutive unsuccessful message retransmisssions that causes a path of the SCTP Connection (/vstp/connections) to be marked as failed. The sctpRetransmissionPathFailure value indicates how many SCTP retransmission attempts should be made to each destination of an SCTP Connection before marking the destination as failed. This value must be less than the sctpRetransmissionAssociationFailure value. Typical value is 3.",
"maximum": 10,
"minimum": 1,
"type": "integer"
},
"sctpSackDelay": {
"description": "The number of milliseconds to delay after receiving a data chunk and before sending a SACK. A non-zero value for sctpSackDelay gives the application time to bundle data chunks in the same SCTP message with the SACK, thereby reducing the number of packets in the network. Setting sctpSackDelay to zero disables this delay so that SACKs are sent as quickly as possible. Typical value is 10.",
"maximum": 200,
"minimum": 1,
"type": "integer"
},
"sctpSocketReceiveSize": {
"description": "Socket receive buffer size (in bytes) for incoming SCTP messages. The receive buffer size must be greater than or equal to the product of the bandwidth and the roundtrip delay for the Connection (/vstp/connections). Typical value is 1000000.",
"maximum": 5000000,
"minimum": 8000,
"type": "integer"
},
"sctpSocketSendSize": {
"description": "Socket send buffer size (in bytes) for outgoing SCTP messages. The send buffer size must be greater than or equal to the product of the bandwidth and the roundtrip delay for the Connection (/vstp/connections). Typical value is 1000000.",
"maximum": 5000000,
"minimum": 8000,
"type": "integer"
}
},
"required": [
"name",
"sctpFragmentationEnabled",
"sctpHeartbeatInterval",
"sctpMaximumBurst",
"sctpMaximumSegmentSize",
"sctpNumberInboundStreams",
"sctpNumberOutboundStreams",
"sctpOrderedDelivery",
"sctpRetransmissionAssociationFailure",
"sctpRetransmissionInitFailure",
"sctpRetransmissionInitTimeout",
"sctpRetransmissionMaximumTimeout",
"sctpRetransmissionMaximumTimeoutInit",
"sctpRetransmissionMinimumTimeout",
"sctpRetransmissionPathFailure",
"sctpSackDelay",
"sctpSocketReceiveSize",
"sctpSocketSendSize"
],
"type": "object"
}
Example
{
"configurationLevel": "52",
"connectionCfgSetName": "ConnectionConfigurationSet1",
"sctpFragmentationEnabled": true,
"sctpHeartbeatInterval": 500,
"sctpMaximumBurst": 4,
"sctpMaximumSegmentSize": 0,
"sctpNumberInboundStreams": 8,
"sctpNumberOutboundStreams": 8,
"sctpOrderedDelivery": false,
"sctpRetransmissionAssociationFailure": 5,
"sctpRetransmissionInitFailure": 8,
"sctpRetransmissionInitTimeout": 120,
"sctpRetransmissionMaximumTimeout": 120,
"sctpRetransmissionMaximumTimeoutInit": 120,
"sctpRetransmissionMinimumTimeout": 120,
"sctpRetransmissionPathFailure": 3,
"sctpSackDelay": 10,
"sctpSocketReceiveSize": 1000000,
"sctpSocketSendSize": 1000000
}
delete /vstp/connectionconfigurationsets/{name}
Deletes the specified Connection Configuration Set from the SOAM configuration. The Default Connection Configuration Set cannot be deleted. A Connection Configuration Set can only be deleted if all delete validation checks pass. In general, if the Connection Configuration Set is a part of the configuration of one or more Connections (/vstp/connections), the Connection Configuration Set cannot be deleted. If the Connection Configuration Set is named in a Connection, the Connection Configuration Set must first be removed from the Connection. Then the Connection Configuration Set can be deleted from the configuration. An attempt to delete a Connection Configuration Set that cannot be deleted results in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Vstp: Connections
A Connection is the VSTP's logical representation of an M3UA association or an MTPA assocation, accessible over one or more transport Connections, with which the VSTP can transact VSTP messages. The Connection resource encapsulates all the characteristics of the Connection that the VSTP must know about in order to communicate successfully with it.
All Connection configuration is done at the SOAM.
/vstp/connections
get /vstp/connections
Returns all Connections that meet the criteria specified in the GET request. By default, all Connections configured at the SOAM are returned. If paging parameters are supplied, only those Connections meeting the request parameters are returned.
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (one of configurationLevel)
The field being matched
Only the configurationLevel field is supported.
Example:
filter_name=configurationLevel
- filter_op: (one of GREATER_THAN, GREATER_THAN_EQUAL)
The match operation (operator)
Example:
filter_op=GREATER_THAN
- filter_values: (string)
The matched value
The configurationLevel value by which the data is being filtered. Only a single value is supported.
Example:
filter_values=10
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/collections/connectionCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/connection/connection.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"connCfgSetName": {
"description": "The Connection Configuration Set (/vstp/connectionconfigurationsets) assigned to this Connection. Default Connection Configuration Set name is 'Default'.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"connectionMode": {
"description": "This defines the mode of the Connection. When set to Client, the Connection is responsible to initiate STP messages. When set to Server, the Connection expects to receive STP messages. The Default value for M2pa Connections (/vstp/connections) is Server and Client M3ua Connections (/vstp/connections) is not supported by VSTP.",
"enum": [
"Client",
"Server"
],
"type": "string"
},
"connectionType": {
"description": "This defines the type of the Connection. When set to M3ua, traffic is sent to the M3UA layer. When set to M2pa, traffic is sent to the M2PA layer.",
"enum": [
"M3ua",
"M2pa"
],
"type": "string"
},
"localHostName": {
"description": "Name for the Local Host (/vstp/localhosts) associated with this Connection, must be unique within the VSTP site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"name": {
"description": "Name for the VSTP Connection, which must be unique within the DSR site. A name is required, and cannot be changed after the VSTP Connection is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"remoteHostName": {
"description": "Name for the Remote Host (/vstp/remotehosts) associated with this Connection, must be unique within the VSTP site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"connectionType",
"localHostName",
"name",
"remoteHostName"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"configurationLevel": "0",
"connCfgSetName": "Default",
"connectionMode": "Server",
"connectionType": "M3ua",
"localHostName": "LH4",
"name": "Conn7",
"remoteHostName": "RH7"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /vstp/connections
Adds a new Connection to the VSTP configuration. The new Connection must have a name that is unique across all Connections at the SOAM. In addition, the Connection's IP Port combination must also be unique across all Connections configured at the SOAM.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/connection/connection.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"connCfgSetName": {
"description": "The Connection Configuration Set (/vstp/connectionconfigurationsets) assigned to this Connection. Default Connection Configuration Set name is 'Default'.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"connectionMode": {
"description": "This defines the mode of the Connection. When set to Client, the Connection is responsible to initiate STP messages. When set to Server, the Connection expects to receive STP messages. The Default value for M2pa Connections (/vstp/connections) is Server and Client M3ua Connections (/vstp/connections) is not supported by VSTP.",
"enum": [
"Client",
"Server"
],
"type": "string"
},
"connectionType": {
"description": "This defines the type of the Connection. When set to M3ua, traffic is sent to the M3UA layer. When set to M2pa, traffic is sent to the M2PA layer.",
"enum": [
"M3ua",
"M2pa"
],
"type": "string"
},
"localHostName": {
"description": "Name for the Local Host (/vstp/localhosts) associated with this Connection, must be unique within the VSTP site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"name": {
"description": "Name for the VSTP Connection, which must be unique within the DSR site. A name is required, and cannot be changed after the VSTP Connection is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"remoteHostName": {
"description": "Name for the Remote Host (/vstp/remotehosts) associated with this Connection, must be unique within the VSTP site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"connectionType",
"localHostName",
"name",
"remoteHostName"
],
"type": "object"
}
Example
{
"configurationLevel": "0",
"connCfgSetName": "Default",
"connectionMode": "Server",
"connectionType": "M3ua",
"localHostName": "LH4",
"name": "Conn7",
"remoteHostName": "RH7"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/vstp/connections/status
get /vstp/connections/status
Returns the status of all Connections that meet the criteria specified in the request. This API supports filtering on any single attribute returned in the JSON data (except operationalReason, statusKnown - these attributes cannot be filtered). Non-enumerated string attributes can be filtered using EQUAL, NOT_EQUAL, LIKE, or IN. Enumerated strings and integers can be filtered using EQUAL, NOT_EQUAL, or IN. LIKE is not supported for these data types. Boolean attributes can be filtered using only EQUAL.
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (string)
The attribute name on which filtering occurs. Non-enumerated string attributes can be filtered using EQUAL, NOT_EQUAL, LIKE, or IN. Enumerated strings and integers can be filtered using EQUAL, NOT_EQUAL, and IN - LIKE is not supported for these data types.
Example:
filter_name=name
- filter_op: (one of EQUAL, NOT_EQUAL, LIKE, IN)
The filter operator.
Example:
filter_op=EQUAL
- filter_values: (string)
The value being filtered on. When the filter_op is IN, filter_values can be a comma-delimited list of strings or integers. Otherwise, filter_value should be a single value.
Example:
filter_values=Connection1
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/collections/connectionstatusCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/connection/connectionstatus.json",
"properties": {
"connAdminState": {
"description": "A Connection's administrative state can be either Enabled or Disabled. A Connection's configuration cannot be modified or deleted if its administrative state is Enabled.",
"enum": [
"Enabled",
"Disabled"
],
"type": "string"
},
"localHostName": {
"description": "Name for the Local Host (/vstp/localhosts) associated with this Connection.",
"type": "string"
},
"mpServerHostname": {
"description": "Name of the VSTP-MP server that is currently reporting the status of this Connection.",
"type": "string"
},
"name": {
"description": "The configured name for the VSTP Connection.",
"type": "string"
},
"operationalReason": {
"description": "Information elaborating on the current operationalStatus of the Connection.",
"type": "string"
},
"operationalStatus": {
"description": "The current operational state of the Connection. While this attribute can have a value of Down or Up, operationalReason attribute typically contains additional information elaborating on the reported operationalStatus.",
"enum": [
"Down",
"Up"
],
"type": "string"
},
"remoteHostName": {
"description": "Name for the Remote Host (/vstp/remotehosts) associated with this Connection.",
"type": "string"
},
"statusKnown": {
"description": "When set to false, current values for the run-time status attributes for this Connection are not known by the OAM. This could be due to merge issues within the VSTP, or some other cause preventing the OAM from having a current view of the status of this Connection. If the OAM has current status for this Connection, statusKnown is set to true.",
"type": "boolean"
},
"timeOfLastUpdate": {
"description": "The date/time the status for this Connection was last updated by the VSTP.",
"pattern": "^[0-9]{4}[-][0-1]{1}[0-9]{1}[-][0-3]{1}[0-9]{1}T[0-2]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}([.][0-9]{1,7})?[+-](?:2[0-3]|[0-1][0-9])[:][0-5][0-9]?$",
"type": "string"
}
},
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"connAdminState": "Disabled",
"localHostName": "LH1",
"mpServerHostname": "amisha-soa1",
"name": "Connection1",
"operationalReason": "Disabled",
"operationalStatus": "Down",
"remoteHostName": "RH7",
"statusKnown": true,
"timeOfLastUpdate": "1969-12-31T19:00:00-05:00"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
/vstp/connections/{name}
get /vstp/connections/{name}
Returns the configuration details for the specified Connection. If the specified Connection does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/items/connectionItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/connection/connection.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"connCfgSetName": {
"description": "The Connection Configuration Set (/vstp/connectionconfigurationsets) assigned to this Connection. Default Connection Configuration Set name is 'Default'.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"connectionMode": {
"description": "This defines the mode of the Connection. When set to Client, the Connection is responsible to initiate STP messages. When set to Server, the Connection expects to receive STP messages. The Default value for M2pa Connections (/vstp/connections) is Server and Client M3ua Connections (/vstp/connections) is not supported by VSTP.",
"enum": [
"Client",
"Server"
],
"type": "string"
},
"connectionType": {
"description": "This defines the type of the Connection. When set to M3ua, traffic is sent to the M3UA layer. When set to M2pa, traffic is sent to the M2PA layer.",
"enum": [
"M3ua",
"M2pa"
],
"type": "string"
},
"localHostName": {
"description": "Name for the Local Host (/vstp/localhosts) associated with this Connection, must be unique within the VSTP site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"name": {
"description": "Name for the VSTP Connection, which must be unique within the DSR site. A name is required, and cannot be changed after the VSTP Connection is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"remoteHostName": {
"description": "Name for the Remote Host (/vstp/remotehosts) associated with this Connection, must be unique within the VSTP site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"connectionType",
"localHostName",
"name",
"remoteHostName"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"configurationLevel": "0",
"connCfgSetName": "Default",
"connectionMode": "Server",
"connectionType": "M3ua",
"localHostName": "LH4",
"name": "Conn7",
"remoteHostName": "RH7"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /vstp/connections/{name}
Updates the configuration for the specified Connection. If the provided Connection data is invalid in any way, the update fails, resulting in one or more error messages returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/connection/connection.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"connCfgSetName": {
"description": "The Connection Configuration Set (/vstp/connectionconfigurationsets) assigned to this Connection. Default Connection Configuration Set name is 'Default'.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"connectionMode": {
"description": "This defines the mode of the Connection. When set to Client, the Connection is responsible to initiate STP messages. When set to Server, the Connection expects to receive STP messages. The Default value for M2pa Connections (/vstp/connections) is Server and Client M3ua Connections (/vstp/connections) is not supported by VSTP.",
"enum": [
"Client",
"Server"
],
"type": "string"
},
"connectionType": {
"description": "This defines the type of the Connection. When set to M3ua, traffic is sent to the M3UA layer. When set to M2pa, traffic is sent to the M2PA layer.",
"enum": [
"M3ua",
"M2pa"
],
"type": "string"
},
"localHostName": {
"description": "Name for the Local Host (/vstp/localhosts) associated with this Connection, must be unique within the VSTP site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"name": {
"description": "Name for the VSTP Connection, which must be unique within the DSR site. A name is required, and cannot be changed after the VSTP Connection is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"remoteHostName": {
"description": "Name for the Remote Host (/vstp/remotehosts) associated with this Connection, must be unique within the VSTP site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
}
},
"required": [
"connectionType",
"localHostName",
"name",
"remoteHostName"
],
"type": "object"
}
Example
{
"configurationLevel": "0",
"connCfgSetName": "Default",
"connectionMode": "Server",
"connectionType": "M3ua",
"localHostName": "LH4",
"name": "Conn7",
"remoteHostName": "RH7"
}
delete /vstp/connections/{name}
Deletes the specified Connection from the SOAM configuration. A Connection is only deleted if all delete validation checks pass. In general, if the Connection is part of the configuration of some other resource instance, the Connection cannot be deleted. For example, if the Connection is named in a VSTP Link Set (/vstp/linksets), the Connection must first be removed from the Link Set. Then the Connection can be deleted from the configuration. An attempt to delete a Connection that cannot be deleted results in an error message returned within the HTTP response.
Any Connection that is administratively enabled cannot be deleted. The Connection must first be administratively disabled before deletion is allowed.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
/vstp/connections/{name}/connectionadminstate
get /vstp/connections/{name}/connectionadminstate
Retrieves the administrative state, which can be either Enabled or Disabled, for the specified Connection.
Target server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schema/connectionadminstate.json",
"properties": {
"connectionAdminState": {
"description": "A Connection's administrative state can be either Enabled or Disabled. A Connection's configuration cannot be modified or deleted if its administrative state is Enabled.",
"enum": [
"Enabled",
"Disabled"
],
"example": "Enabled",
"type": "string"
}
},
"required": ["connectionAdminState"],
"type": "object"
}
Example
{
"connectionAdminState": "Enabled"
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /vstp/connections/{name}/connectionadminstate
Updates the administrative state for the specified VSTP Connection to either Enable or Disabled.
A Connection's configuration cannot be modified or deleted if its administrative state is Enabled.
Target server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schema/connectionadminstate.json",
"properties": {
"connectionAdminState": {
"description": "A Connection's administrative state can be either Enabled or Disabled. A Connection's configuration cannot be modified or deleted if its administrative state is Enabled.",
"enum": [
"Enabled",
"Disabled"
],
"example": "Enabled",
"type": "string"
}
},
"required": ["connectionAdminState"],
"type": "object"
}
Example
{
"connectionAdminState": "Enabled"
}
/vstp/connections/{name}/connectionadminstate/status
get /vstp/connections/{name}/connectionadminstate/status
Retrieves the operational status for the specified Connection.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/items/connectionstatusItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/connection/connectionstatus.json",
"properties": {
"connAdminState": {
"description": "A Connection's administrative state can be either Enabled or Disabled. A Connection's configuration cannot be modified or deleted if its administrative state is Enabled.",
"enum": [
"Enabled",
"Disabled"
],
"type": "string"
},
"localHostName": {
"description": "Name for the Local Host (/vstp/localhosts) associated with this Connection.",
"type": "string"
},
"mpServerHostname": {
"description": "Name of the VSTP-MP server that is currently reporting the status of this Connection.",
"type": "string"
},
"name": {
"description": "The configured name for the VSTP Connection.",
"type": "string"
},
"operationalReason": {
"description": "Information elaborating on the current operationalStatus of the Connection.",
"type": "string"
},
"operationalStatus": {
"description": "The current operational state of the Connection. While this attribute can have a value of Down or Up, operationalReason attribute typically contains additional information elaborating on the reported operationalStatus.",
"enum": [
"Down",
"Up"
],
"type": "string"
},
"remoteHostName": {
"description": "Name for the Remote Host (/vstp/remotehosts) associated with this Connection.",
"type": "string"
},
"statusKnown": {
"description": "When set to false, current values for the run-time status attributes for this Connection are not known by the OAM. This could be due to merge issues within the VSTP, or some other cause preventing the OAM from having a current view of the status of this Connection. If the OAM has current status for this Connection, statusKnown is set to true.",
"type": "boolean"
},
"timeOfLastUpdate": {
"description": "The date/time the status for this Connection was last updated by the VSTP.",
"pattern": "^[0-9]{4}[-][0-1]{1}[0-9]{1}[-][0-3]{1}[0-9]{1}T[0-2]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}([.][0-9]{1,7})?[+-](?:2[0-3]|[0-1][0-9])[:][0-5][0-9]?$",
"type": "string"
}
},
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"connAdminState": "Disabled",
"localHostName": "LH1",
"mpServerHostname": "amisha-soa1",
"name": "Connection1",
"operationalReason": "Disabled",
"operationalStatus": "Down",
"remoteHostName": "RH7",
"statusKnown": true,
"timeOfLastUpdate": "1969-12-31T19:00:00-05:00"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
Vstp: Feature Admin States
Feature Admin States provides the administrative state of the VSTP Features. The VSTP Features are initially in the disabled administrative state when the system is installed.
All administrative state changes of the VSTP Features are done at the SOAM.
/vstp/featureadminstates
get /vstp/featureadminstates
Returns the administrative state of all the VSTP-provided Features that meet the criteria specified in a valid GET request.
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (string)
The attribute name on which filtering occurs. Non-enumerated string attributes can be filtered using EQUAL, NOTEQUAL, LIKE, or IN. Enumerated strings and integers can be filtered using EQUAL, NOTEQUAL, and IN - LIKE is not supported for these data types.
Example:
filter_name=name
- filter_op: (one of EQUAL, NOT_EQUAL, LIKE, IN)
The filter operator.
Example:
filter_op=EQUAL
- filter_values: (string)
The value being filtered on. When the filter_op is IN, filter_values can be a comma-delimited list of strings or integers. Otherwise, filter_value should be a single value.
Example:
filter_values=FGTTLS
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/collections/featureadminstateCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schema/featureadminstate/featureadminstate.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the VSTP Feature. MMI clients never define VSTP Feature names, but instead discover the available names from the collection GET response. A client must then use the VSTP-provided Feature name string when making a GET or PUT request for a particular Feature.",
"type": "string"
},
"adminState": {
"description": "A VSTP Feature's administrative state can either be Enabled or Disabled. A VSTP Feature is initially in the Disabled administrative state when the system is installed and it cannot be Disabled once Enabled.",
"enum": [
"Disabled",
"Enabled"
],
"type": "string"
}
},
"required": [
"name",
"adminState"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"configurationLevel": "300",
"name": "FGTTLS",
"adminState": "Enabled"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
/vstp/featureadminstates/{name}
get /vstp/featureadminstates/{name}
Returns the administrative state for the specified VSTP Feature. If the VSTP Feature does not exist, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/items/featureadminstateItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schema/featureadminstate/featureadminstate.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the VSTP Feature. MMI clients never define VSTP Feature names, but instead discover the available names from the collection GET response. A client must then use the VSTP-provided Feature name string when making a GET or PUT request for a particular Feature.",
"type": "string"
},
"adminState": {
"description": "A VSTP Feature's administrative state can either be Enabled or Disabled. A VSTP Feature is initially in the Disabled administrative state when the system is installed and it cannot be Disabled once Enabled.",
"enum": [
"Disabled",
"Enabled"
],
"type": "string"
}
},
"required": [
"name",
"adminState"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"configurationLevel": "300",
"name": "FGTTLS",
"adminState": "Enabled"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /vstp/featureadminstates/{name}
Updates the administrative state of the specified VSTP Feature. If the provided administrative state value is not valid, the update fails, resulting in one or more error messages returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schema/featureadminstate/featureadminstate.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the VSTP Feature. MMI clients never define VSTP Feature names, but instead discover the available names from the collection GET response. A client must then use the VSTP-provided Feature name string when making a GET or PUT request for a particular Feature.",
"type": "string"
},
"adminState": {
"description": "A VSTP Feature's administrative state can either be Enabled or Disabled. A VSTP Feature is initially in the Disabled administrative state when the system is installed and it cannot be Disabled once Enabled.",
"enum": [
"Disabled",
"Enabled"
],
"type": "string"
}
},
"required": [
"name",
"adminState"
],
"type": "object"
}
Example
{
"configurationLevel": "300",
"name": "FGTTLS",
"adminState": "Enabled"
}
Vstp: Global Title Addresses
A Global Title Address (GTA) is an entity assigned to the GTT Set (/vstp/gttsets) and GTT Selector (/vstp/gttselectors).
All configuration of GTA is done at the SOAM.
/vstp/globaltitleaddresses
get /vstp/globaltitleaddresses
Returns all GTAs that meet the criteria specified in the GET request. By default, all GTAs configured at the SOAM are returned. If paging parameters are supplied, only those GTAs meeting the request parameters are returned. This API supports filtering on gttSetName along with the following combination (startAddress-endAddress) or (smapaddr-emapaddr) or (cdssn-ecdssn) or (cgssn-ecgssn) or cgpc or opc or (opcode-pkgtype-family) or (opcode-pkgtype-acn). The gttSetName attribute can be filtered using EQUAL, NOTEQUAL, or LIKE, while the other attributes can be filtered using only EQUAL or NOTEQUAL.
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (string)
The attribute name on which filtering occurs. Non-enumerated string attributes can be filtered using EQUAL, NOT_EQUAL, LIKE or IN. Enumerated strings and integers can be filtered using EQUAL, NOT_EQUAL, and IN - LIKE is not supported for these data types.
Example:
filter_name=gttSetName
- filter_op: (one of EQUAL, NOT_EQUAL, LIKE, IN)
The filter operator.
Example:
filter_op=EQUAL
- filter_values: (string)
The value being filtered on. When the filter_op is IN, filter_values can be a comma-delimited list of strings or integers. Otherwise, filter_value should be a single value.
Example:
filter_values=GttSet1
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/collections/gttaddressCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/gta/gta.json",
"properties": {
"acn": {
"description": "Application context name. This parameter specifies the ITU TCAP acn field in the incoming MSU. The acn supports up to 7 subfields separated by dash (e.g., 1-202-33-104-54-26-007).",
"maxLength": 27,
"pattern": "^(([0-1]?[0-9]?[0-9])|([2][0-4][0-9])|(25[0-5]))$|^(((([0-1]?[0-9]?[0-9])|([2][0-4][0-9])|(25[0-5]))-){1,6}(([0-1]?[0-9]?[0-9])|([2][0-4][0-9])|(25[0-5])))$|^([*])$|^(None)$",
"type": "string"
},
"actsn": {
"description": "GTT Action Set Name (/vstp/gttactionsetnames). 1 leading alphabetic character and up to 8 following alphanumeric characters.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"ccgt": {
"description": "Cancel called global title indicator.",
"default": "false",
"type": "boolean"
},
"cdselid": {
"description": "CdPA Selector ID (/vstp/gttselectors). ",
"maximum": 65534,
"minimum": 0,
"type": "integer"
},
"cdssn": {
"description": "Starting CdPA subsystem number.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"cgpc": {
"description": "Ansi originating point code with subfields network indicator-network cluster-network cluster member (ni-nc-ncm). ITU international originating point code with subfields zone-area-id. The prefix subfield indicates a spare point code (prefix-zone-area-id). ITU originating point code in the format of a 5-digit number (nnnnn); or 2, 3, or 4 numbers (members). The prefix subfield indicates a spare point code (prefix-nnnnn, prefix-nnnnn-gc, prefix-m1-m2-m3-m4, prefix-m1-m2-m3-m4-gc). 24-bit ITU national originating point code with subfields main signaling area-sub signaling area-signaling point (msa-ssa-sp).",
"maxLength": 11,
"pattern": "^([0-9]+-)*[0-9]+$",
"type": "string"
},
"cgpcaction": {
"description": "This parameter is used to provide the required abilities, indicating what any particular translation needs to do with CgPA PC.",
"enum": [
"Dflt",
"Ignore",
"Remove"
],
"default": "Dflt",
"type": "string"
},
"cgselid": {
"description": "CgPA Selector ID (/vstp/gttselectors).",
"maximum": 65534,
"minimum": 0,
"type": "integer"
},
"cgssn": {
"description": "Starting CgPA subsystem number.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"defmapvr": {
"description": "Default MAP version for MBR opcodes. This parameter is used to provide the default MAP version for supported MBR opcodes if Application Context Name (acn) is not present in an incoming MAP message.",
"enum": [
"V1",
"V2",
"V3"
],
"default": "V3",
"type": "string"
},
"domain": {
"description": "This defines the type of SS7 domain. This is applicable to cgpc and opc.",
"enum": [
"Ansi",
"Itui",
"Itun",
"Itun24"
],
"type": "string"
},
"ecdssn": {
"description": "Ending CdPA subsystem number.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"ecgssn": {
"description": "Ending CgPA subsystem number.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"emapaddr": {
"description": "MAP End Address (similar to endAddress). This parameter specifies the end of a range of MAP digits (IMSI/MSISDN).",
"maxLength": 21,
"pattern": "^([0-9]*)$",
"type": "string"
},
"endAddress": {
"description": "End global title address. This parameter specifies the end of a range of global title digits.",
"maxLength": 21,
"pattern": "^([0-9]*)$",
"type": "string"
},
"fallback": {
"description": "Fallback option. The action taken when the final translation does not match while performing GTT using a FLOBR-specific GTT mode.",
"enum": [
"Sysdflt",
"Yes",
"No"
],
"default": "Sysdflt",
"type": "string"
},
"family": {
"description": "The ANSI TCAP family field in the incoming MSU.",
"maxLength": 4,
"pattern": "^(([0-1]?[0-9]?[0-9])|([2][0-4][0-9])|(25[0-5]))$|^[*]$|^(None)$",
"type": "string"
},
"gttSetName": {
"description": "Defines the GTT Set name associated with this Global Title Address (GTA). 1 leading alphabetic character and up to 8 following alphanumeric characters.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"mapSetId": {
"description": "Defines the Map Set identifier associated with this Global Title Address (GTA). MAP Set id is a Mated Application set ID. MAP Set id is mandatory when routingIndicator is set to SSN.",
"maximum": 6000,
"minimum": 0,
"type": "integer"
},
"mrnSetId": {
"description": "Defines the Mated Relay Node (MRN) Set name associated with this Global Title Address (GTA). mrnSetId is the MRN Set ID. Default is 0 when routingIndicator is set to GT.",
"maximum": 1500,
"minimum": 0,
"type": "integer"
},
"opc": {
"description": "Ansi originating point code with subfields network indicator-network cluster-network cluster member (ni-nc-ncm). ITU international originating point code with subfields zone-area-id. The prefix subfield indicates a spare point code (prefix-zone-area-id). ITU originating point code in the format of a 5-digit number (nnnnn); or 2, 3, or 4 numbers (members). The prefix subfield indicates a spare point code (prefix-nnnnn, prefix-nnnnn-gc, prefix-m1-m2-m3-m4, prefix-m1-m2-m3-m4-gc). 24-bit ITU national originating point code with subfields main signaling area-sub signaling area-signaling point (msa-ssa-sp).",
"maxLength": 11,
"pattern": "^([0-9]+-)*[0-9]+$",
"type": "string"
},
"opcode": {
"description": "The TCAP opcode field in the incoming MSU.",
"maxLength": 4,
"pattern": "^(([0-1]?[0-9]?[0-9])|([2][0-4][0-9])|(25[0-5]))$|^[*]$|^(None)$",
"type": "string"
},
"opcsn": {
"description": "The OPC GTT set name. 1 leading alphabetic character and up to 8 following alphanumeric characters",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"optsn": {
"description": "Optional gtt set name. 1 leading alphabetic character and up to 8 following alphanumeric characters",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"pkgtype": {
"description": "The ANSI and ITU TCAP package type.",
"enum": [
"Bgn",
"End",
"Cnt",
"Ituabort",
"Ituuni",
"Qwp",
"Qwop",
"Resp",
"Cwp",
"Cwop",
"Ansiabort",
"Ansiuni",
"Any"
],
"default": "Invalidpkgtype",
"type": "string"
},
"routingIndicator": {
"description": "Routing indicator. GT allow a called party address with a routing indicator value of 'global title'. SSN allow a called party address with a routing indicator value of 'DPC/SSN'.",
"enum": [
"Gt",
"Ssn"
],
"type": "string"
},
"rspName": {
"description": "Defines the Remote Signaling Point name (/vstp/remotesignalingpoints) associated with this Global Title Address (GTA).",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"smapaddr": {
"description": "Start Address (similar to startAddress). This parameter specifies the beginning of a range of MAP digits (IMSI/MSISDN).",
"maxLength": 21,
"pattern": "^([0-9]*)$",
"type": "string"
},
"startAddress": {
"description": "Defines the start of a range of this Global Title Address. This specifies the start of a range of MAP digits (IMSI/MSISDN/VLRNB/SMRPOA/SMRPDA).",
"maxLength": 21,
"pattern": "^([0-9]*)$",
"type": "string"
},
"splitAction": {
"description": "Splitting of address range is not supported in GTA.",
"enum": [
"None"
],
"type": "string"
},
"subsystem": {
"description": "New translated subsystem number.",
"maximum": 255,
"minimum": 2,
"type": "integer"
},
"translateIndicator": {
"description": "Defines translation actions and routing actions for this Global Title Address (GTA). If translationIndicator is set as None, either startAddress or endAddress, and gttSetName should be set. If translateIndicator is set as Dpc, then routingIndicator, rspName, subsystem, mapSetId, and mrnSetId should be set. If translateIndicator is set as Dpcngt, then routingIndicator is set as Gt. If translateIndicator is set as Dpcssn, then routingIndicator is set as Ssn.",
"enum": [
"Dpc",
"Dpcngt",
"Dpcssn",
"None"
],
"type": "string"
},
"uniqueIdentifier": {
"description": "Defines a unique identifier for this Global Title Address (GTA). This Unique identifier value will be used for PUT and DELETE operations.",
"maxLength": 36,
"readOnly": true,
"type": "string"
}
},
"required": [
"gttSetName",
"translateIndicator"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"actsn": "actSn1",
"cdselid": 1,
"endAddress": "2234567891",
"fallback": "No",
"gttSetName": "ANSI1",
"mapSetId": 0,
"routingIndicator": "Ssn",
"rspName": "rsp1",
"splitAction": "None",
"startAddress": "1234567891",
"subsystem": 5,
"translateIndicator": "Dpcssn"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /vstp/globaltitleaddresses
Adds a new GTA to the VSTP configuration. The GTT Set name and start address combination must be unique for inserting a new GTA assigned to a GTT Set (/vstp/gttsets) at the SOAM.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/gta/gta.json",
"properties": {
"acn": {
"description": "Application context name. This parameter specifies the ITU TCAP acn field in the incoming MSU. The acn supports up to 7 subfields separated by dash (e.g., 1-202-33-104-54-26-007).",
"maxLength": 27,
"pattern": "^(([0-1]?[0-9]?[0-9])|([2][0-4][0-9])|(25[0-5]))$|^(((([0-1]?[0-9]?[0-9])|([2][0-4][0-9])|(25[0-5]))-){1,6}(([0-1]?[0-9]?[0-9])|([2][0-4][0-9])|(25[0-5])))$|^([*])$|^(None)$",
"type": "string"
},
"actsn": {
"description": "GTT Action Set Name (/vstp/gttactionsetnames). 1 leading alphabetic character and up to 8 following alphanumeric characters.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"ccgt": {
"description": "Cancel called global title indicator.",
"default": "false",
"type": "boolean"
},
"cdselid": {
"description": "CdPA Selector ID (/vstp/gttselectors). ",
"maximum": 65534,
"minimum": 0,
"type": "integer"
},
"cdssn": {
"description": "Starting CdPA subsystem number.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"cgpc": {
"description": "Ansi originating point code with subfields network indicator-network cluster-network cluster member (ni-nc-ncm). ITU international originating point code with subfields zone-area-id. The prefix subfield indicates a spare point code (prefix-zone-area-id). ITU originating point code in the format of a 5-digit number (nnnnn); or 2, 3, or 4 numbers (members). The prefix subfield indicates a spare point code (prefix-nnnnn, prefix-nnnnn-gc, prefix-m1-m2-m3-m4, prefix-m1-m2-m3-m4-gc). 24-bit ITU national originating point code with subfields main signaling area-sub signaling area-signaling point (msa-ssa-sp).",
"maxLength": 11,
"pattern": "^([0-9]+-)*[0-9]+$",
"type": "string"
},
"cgpcaction": {
"description": "This parameter is used to provide the required abilities, indicating what any particular translation needs to do with CgPA PC.",
"enum": [
"Dflt",
"Ignore",
"Remove"
],
"default": "Dflt",
"type": "string"
},
"cgselid": {
"description": "CgPA Selector ID (/vstp/gttselectors).",
"maximum": 65534,
"minimum": 0,
"type": "integer"
},
"cgssn": {
"description": "Starting CgPA subsystem number.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"defmapvr": {
"description": "Default MAP version for MBR opcodes. This parameter is used to provide the default MAP version for supported MBR opcodes if Application Context Name (acn) is not present in an incoming MAP message.",
"enum": [
"V1",
"V2",
"V3"
],
"default": "V3",
"type": "string"
},
"domain": {
"description": "This defines the type of SS7 domain. This is applicable to cgpc and opc.",
"enum": [
"Ansi",
"Itui",
"Itun",
"Itun24"
],
"type": "string"
},
"ecdssn": {
"description": "Ending CdPA subsystem number.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"ecgssn": {
"description": "Ending CgPA subsystem number.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"emapaddr": {
"description": "MAP End Address (similar to endAddress). This parameter specifies the end of a range of MAP digits (IMSI/MSISDN).",
"maxLength": 21,
"pattern": "^([0-9]*)$",
"type": "string"
},
"endAddress": {
"description": "End global title address. This parameter specifies the end of a range of global title digits.",
"maxLength": 21,
"pattern": "^([0-9]*)$",
"type": "string"
},
"fallback": {
"description": "Fallback option. The action taken when the final translation does not match while performing GTT using a FLOBR-specific GTT mode.",
"enum": [
"Sysdflt",
"Yes",
"No"
],
"default": "Sysdflt",
"type": "string"
},
"family": {
"description": "The ANSI TCAP family field in the incoming MSU.",
"maxLength": 4,
"pattern": "^(([0-1]?[0-9]?[0-9])|([2][0-4][0-9])|(25[0-5]))$|^[*]$|^(None)$",
"type": "string"
},
"gttSetName": {
"description": "Defines the GTT Set name associated with this Global Title Address (GTA). 1 leading alphabetic character and up to 8 following alphanumeric characters.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"mapSetId": {
"description": "Defines the Map Set identifier associated with this Global Title Address (GTA). MAP Set id is a Mated Application set ID. MAP Set id is mandatory when routingIndicator is set to SSN.",
"maximum": 6000,
"minimum": 0,
"type": "integer"
},
"mrnSetId": {
"description": "Defines the Mated Relay Node (MRN) Set name associated with this Global Title Address (GTA). mrnSetId is the MRN Set ID. Default is 0 when routingIndicator is set to GT.",
"maximum": 1500,
"minimum": 0,
"type": "integer"
},
"opc": {
"description": "Ansi originating point code with subfields network indicator-network cluster-network cluster member (ni-nc-ncm). ITU international originating point code with subfields zone-area-id. The prefix subfield indicates a spare point code (prefix-zone-area-id). ITU originating point code in the format of a 5-digit number (nnnnn); or 2, 3, or 4 numbers (members). The prefix subfield indicates a spare point code (prefix-nnnnn, prefix-nnnnn-gc, prefix-m1-m2-m3-m4, prefix-m1-m2-m3-m4-gc). 24-bit ITU national originating point code with subfields main signaling area-sub signaling area-signaling point (msa-ssa-sp).",
"maxLength": 11,
"pattern": "^([0-9]+-)*[0-9]+$",
"type": "string"
},
"opcode": {
"description": "The TCAP opcode field in the incoming MSU.",
"maxLength": 4,
"pattern": "^(([0-1]?[0-9]?[0-9])|([2][0-4][0-9])|(25[0-5]))$|^[*]$|^(None)$",
"type": "string"
},
"opcsn": {
"description": "The OPC GTT set name. 1 leading alphabetic character and up to 8 following alphanumeric characters",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"optsn": {
"description": "Optional gtt set name. 1 leading alphabetic character and up to 8 following alphanumeric characters",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"pkgtype": {
"description": "The ANSI and ITU TCAP package type.",
"enum": [
"Bgn",
"End",
"Cnt",
"Ituabort",
"Ituuni",
"Qwp",
"Qwop",
"Resp",
"Cwp",
"Cwop",
"Ansiabort",
"Ansiuni",
"Any"
],
"default": "Invalidpkgtype",
"type": "string"
},
"routingIndicator": {
"description": "Routing indicator. GT allow a called party address with a routing indicator value of 'global title'. SSN allow a called party address with a routing indicator value of 'DPC/SSN'.",
"enum": [
"Gt",
"Ssn"
],
"type": "string"
},
"rspName": {
"description": "Defines the Remote Signaling Point name (/vstp/remotesignalingpoints) associated with this Global Title Address (GTA).",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"smapaddr": {
"description": "Start Address (similar to startAddress). This parameter specifies the beginning of a range of MAP digits (IMSI/MSISDN).",
"maxLength": 21,
"pattern": "^([0-9]*)$",
"type": "string"
},
"startAddress": {
"description": "Defines the start of a range of this Global Title Address. This specifies the start of a range of MAP digits (IMSI/MSISDN/VLRNB/SMRPOA/SMRPDA).",
"maxLength": 21,
"pattern": "^([0-9]*)$",
"type": "string"
},
"splitAction": {
"description": "Splitting of address range is not supported in GTA.",
"enum": [
"None"
],
"type": "string"
},
"subsystem": {
"description": "New translated subsystem number.",
"maximum": 255,
"minimum": 2,
"type": "integer"
},
"translateIndicator": {
"description": "Defines translation actions and routing actions for this Global Title Address (GTA). If translationIndicator is set as None, either startAddress or endAddress, and gttSetName should be set. If translateIndicator is set as Dpc, then routingIndicator, rspName, subsystem, mapSetId, and mrnSetId should be set. If translateIndicator is set as Dpcngt, then routingIndicator is set as Gt. If translateIndicator is set as Dpcssn, then routingIndicator is set as Ssn.",
"enum": [
"Dpc",
"Dpcngt",
"Dpcssn",
"None"
],
"type": "string"
},
"uniqueIdentifier": {
"description": "Defines a unique identifier for this Global Title Address (GTA). This Unique identifier value will be used for PUT and DELETE operations.",
"maxLength": 36,
"readOnly": true,
"type": "string"
}
},
"required": [
"gttSetName",
"translateIndicator"
],
"type": "object"
}
Example
{
"actsn": "actSn1",
"cdselid": 1,
"endAddress": "2234567891",
"fallback": "No",
"gttSetName": "ANSI1",
"mapSetId": 0,
"routingIndicator": "Ssn",
"rspName": "rsp1",
"splitAction": "None",
"startAddress": "1234567891",
"subsystem": 5,
"translateIndicator": "Dpcssn"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/vstp/globaltitleaddresses/{uniqueIdentifier}
get /vstp/globaltitleaddresses/{uniqueIdentifier}
Returns the configuration details for the specified GTA. If the GTA does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- uniqueIdentifier: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/items/gttaddressItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/gta/gta.json",
"properties": {
"acn": {
"description": "Application context name. This parameter specifies the ITU TCAP acn field in the incoming MSU. The acn supports up to 7 subfields separated by dash (e.g., 1-202-33-104-54-26-007).",
"maxLength": 27,
"pattern": "^(([0-1]?[0-9]?[0-9])|([2][0-4][0-9])|(25[0-5]))$|^(((([0-1]?[0-9]?[0-9])|([2][0-4][0-9])|(25[0-5]))-){1,6}(([0-1]?[0-9]?[0-9])|([2][0-4][0-9])|(25[0-5])))$|^([*])$|^(None)$",
"type": "string"
},
"actsn": {
"description": "GTT Action Set Name (/vstp/gttactionsetnames). 1 leading alphabetic character and up to 8 following alphanumeric characters.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"ccgt": {
"description": "Cancel called global title indicator.",
"default": "false",
"type": "boolean"
},
"cdselid": {
"description": "CdPA Selector ID (/vstp/gttselectors). ",
"maximum": 65534,
"minimum": 0,
"type": "integer"
},
"cdssn": {
"description": "Starting CdPA subsystem number.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"cgpc": {
"description": "Ansi originating point code with subfields network indicator-network cluster-network cluster member (ni-nc-ncm). ITU international originating point code with subfields zone-area-id. The prefix subfield indicates a spare point code (prefix-zone-area-id). ITU originating point code in the format of a 5-digit number (nnnnn); or 2, 3, or 4 numbers (members). The prefix subfield indicates a spare point code (prefix-nnnnn, prefix-nnnnn-gc, prefix-m1-m2-m3-m4, prefix-m1-m2-m3-m4-gc). 24-bit ITU national originating point code with subfields main signaling area-sub signaling area-signaling point (msa-ssa-sp).",
"maxLength": 11,
"pattern": "^([0-9]+-)*[0-9]+$",
"type": "string"
},
"cgpcaction": {
"description": "This parameter is used to provide the required abilities, indicating what any particular translation needs to do with CgPA PC.",
"enum": [
"Dflt",
"Ignore",
"Remove"
],
"default": "Dflt",
"type": "string"
},
"cgselid": {
"description": "CgPA Selector ID (/vstp/gttselectors).",
"maximum": 65534,
"minimum": 0,
"type": "integer"
},
"cgssn": {
"description": "Starting CgPA subsystem number.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"defmapvr": {
"description": "Default MAP version for MBR opcodes. This parameter is used to provide the default MAP version for supported MBR opcodes if Application Context Name (acn) is not present in an incoming MAP message.",
"enum": [
"V1",
"V2",
"V3"
],
"default": "V3",
"type": "string"
},
"domain": {
"description": "This defines the type of SS7 domain. This is applicable to cgpc and opc.",
"enum": [
"Ansi",
"Itui",
"Itun",
"Itun24"
],
"type": "string"
},
"ecdssn": {
"description": "Ending CdPA subsystem number.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"ecgssn": {
"description": "Ending CgPA subsystem number.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"emapaddr": {
"description": "MAP End Address (similar to endAddress). This parameter specifies the end of a range of MAP digits (IMSI/MSISDN).",
"maxLength": 21,
"pattern": "^([0-9]*)$",
"type": "string"
},
"endAddress": {
"description": "End global title address. This parameter specifies the end of a range of global title digits.",
"maxLength": 21,
"pattern": "^([0-9]*)$",
"type": "string"
},
"fallback": {
"description": "Fallback option. The action taken when the final translation does not match while performing GTT using a FLOBR-specific GTT mode.",
"enum": [
"Sysdflt",
"Yes",
"No"
],
"default": "Sysdflt",
"type": "string"
},
"family": {
"description": "The ANSI TCAP family field in the incoming MSU.",
"maxLength": 4,
"pattern": "^(([0-1]?[0-9]?[0-9])|([2][0-4][0-9])|(25[0-5]))$|^[*]$|^(None)$",
"type": "string"
},
"gttSetName": {
"description": "Defines the GTT Set name associated with this Global Title Address (GTA). 1 leading alphabetic character and up to 8 following alphanumeric characters.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"mapSetId": {
"description": "Defines the Map Set identifier associated with this Global Title Address (GTA). MAP Set id is a Mated Application set ID. MAP Set id is mandatory when routingIndicator is set to SSN.",
"maximum": 6000,
"minimum": 0,
"type": "integer"
},
"mrnSetId": {
"description": "Defines the Mated Relay Node (MRN) Set name associated with this Global Title Address (GTA). mrnSetId is the MRN Set ID. Default is 0 when routingIndicator is set to GT.",
"maximum": 1500,
"minimum": 0,
"type": "integer"
},
"opc": {
"description": "Ansi originating point code with subfields network indicator-network cluster-network cluster member (ni-nc-ncm). ITU international originating point code with subfields zone-area-id. The prefix subfield indicates a spare point code (prefix-zone-area-id). ITU originating point code in the format of a 5-digit number (nnnnn); or 2, 3, or 4 numbers (members). The prefix subfield indicates a spare point code (prefix-nnnnn, prefix-nnnnn-gc, prefix-m1-m2-m3-m4, prefix-m1-m2-m3-m4-gc). 24-bit ITU national originating point code with subfields main signaling area-sub signaling area-signaling point (msa-ssa-sp).",
"maxLength": 11,
"pattern": "^([0-9]+-)*[0-9]+$",
"type": "string"
},
"opcode": {
"description": "The TCAP opcode field in the incoming MSU.",
"maxLength": 4,
"pattern": "^(([0-1]?[0-9]?[0-9])|([2][0-4][0-9])|(25[0-5]))$|^[*]$|^(None)$",
"type": "string"
},
"opcsn": {
"description": "The OPC GTT set name. 1 leading alphabetic character and up to 8 following alphanumeric characters",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"optsn": {
"description": "Optional gtt set name. 1 leading alphabetic character and up to 8 following alphanumeric characters",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"pkgtype": {
"description": "The ANSI and ITU TCAP package type.",
"enum": [
"Bgn",
"End",
"Cnt",
"Ituabort",
"Ituuni",
"Qwp",
"Qwop",
"Resp",
"Cwp",
"Cwop",
"Ansiabort",
"Ansiuni",
"Any"
],
"default": "Invalidpkgtype",
"type": "string"
},
"routingIndicator": {
"description": "Routing indicator. GT allow a called party address with a routing indicator value of 'global title'. SSN allow a called party address with a routing indicator value of 'DPC/SSN'.",
"enum": [
"Gt",
"Ssn"
],
"type": "string"
},
"rspName": {
"description": "Defines the Remote Signaling Point name (/vstp/remotesignalingpoints) associated with this Global Title Address (GTA).",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"smapaddr": {
"description": "Start Address (similar to startAddress). This parameter specifies the beginning of a range of MAP digits (IMSI/MSISDN).",
"maxLength": 21,
"pattern": "^([0-9]*)$",
"type": "string"
},
"startAddress": {
"description": "Defines the start of a range of this Global Title Address. This specifies the start of a range of MAP digits (IMSI/MSISDN/VLRNB/SMRPOA/SMRPDA).",
"maxLength": 21,
"pattern": "^([0-9]*)$",
"type": "string"
},
"splitAction": {
"description": "Splitting of address range is not supported in GTA.",
"enum": [
"None"
],
"type": "string"
},
"subsystem": {
"description": "New translated subsystem number.",
"maximum": 255,
"minimum": 2,
"type": "integer"
},
"translateIndicator": {
"description": "Defines translation actions and routing actions for this Global Title Address (GTA). If translationIndicator is set as None, either startAddress or endAddress, and gttSetName should be set. If translateIndicator is set as Dpc, then routingIndicator, rspName, subsystem, mapSetId, and mrnSetId should be set. If translateIndicator is set as Dpcngt, then routingIndicator is set as Gt. If translateIndicator is set as Dpcssn, then routingIndicator is set as Ssn.",
"enum": [
"Dpc",
"Dpcngt",
"Dpcssn",
"None"
],
"type": "string"
},
"uniqueIdentifier": {
"description": "Defines a unique identifier for this Global Title Address (GTA). This Unique identifier value will be used for PUT and DELETE operations.",
"maxLength": 36,
"readOnly": true,
"type": "string"
}
},
"required": [
"gttSetName",
"translateIndicator"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"actsn": "actSn1",
"cdselid": 1,
"endAddress": "2234567891",
"fallback": "No",
"gttSetName": "ANSI1",
"mapSetId": 0,
"routingIndicator": "Ssn",
"rspName": "rsp1",
"splitAction": "None",
"startAddress": "1234567891",
"subsystem": 5,
"translateIndicator": "Dpcssn"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /vstp/globaltitleaddresses/{uniqueIdentifier}
Updates the configuration of the specified GTA. If the provided GTA data is invalid in any way, the update fails, resulting in one or more error messages returned within the HTTP response. If the input start and end address values differ from the existing address values of the GTA, splitting of the GTA takes place.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- uniqueIdentifier: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/gta/gta.json",
"properties": {
"acn": {
"description": "Application context name. This parameter specifies the ITU TCAP acn field in the incoming MSU. The acn supports up to 7 subfields separated by dash (e.g., 1-202-33-104-54-26-007).",
"maxLength": 27,
"pattern": "^(([0-1]?[0-9]?[0-9])|([2][0-4][0-9])|(25[0-5]))$|^(((([0-1]?[0-9]?[0-9])|([2][0-4][0-9])|(25[0-5]))-){1,6}(([0-1]?[0-9]?[0-9])|([2][0-4][0-9])|(25[0-5])))$|^([*])$|^(None)$",
"type": "string"
},
"actsn": {
"description": "GTT Action Set Name (/vstp/gttactionsetnames). 1 leading alphabetic character and up to 8 following alphanumeric characters.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"ccgt": {
"description": "Cancel called global title indicator.",
"default": "false",
"type": "boolean"
},
"cdselid": {
"description": "CdPA Selector ID (/vstp/gttselectors). ",
"maximum": 65534,
"minimum": 0,
"type": "integer"
},
"cdssn": {
"description": "Starting CdPA subsystem number.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"cgpc": {
"description": "Ansi originating point code with subfields network indicator-network cluster-network cluster member (ni-nc-ncm). ITU international originating point code with subfields zone-area-id. The prefix subfield indicates a spare point code (prefix-zone-area-id). ITU originating point code in the format of a 5-digit number (nnnnn); or 2, 3, or 4 numbers (members). The prefix subfield indicates a spare point code (prefix-nnnnn, prefix-nnnnn-gc, prefix-m1-m2-m3-m4, prefix-m1-m2-m3-m4-gc). 24-bit ITU national originating point code with subfields main signaling area-sub signaling area-signaling point (msa-ssa-sp).",
"maxLength": 11,
"pattern": "^([0-9]+-)*[0-9]+$",
"type": "string"
},
"cgpcaction": {
"description": "This parameter is used to provide the required abilities, indicating what any particular translation needs to do with CgPA PC.",
"enum": [
"Dflt",
"Ignore",
"Remove"
],
"default": "Dflt",
"type": "string"
},
"cgselid": {
"description": "CgPA Selector ID (/vstp/gttselectors).",
"maximum": 65534,
"minimum": 0,
"type": "integer"
},
"cgssn": {
"description": "Starting CgPA subsystem number.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"defmapvr": {
"description": "Default MAP version for MBR opcodes. This parameter is used to provide the default MAP version for supported MBR opcodes if Application Context Name (acn) is not present in an incoming MAP message.",
"enum": [
"V1",
"V2",
"V3"
],
"default": "V3",
"type": "string"
},
"domain": {
"description": "This defines the type of SS7 domain. This is applicable to cgpc and opc.",
"enum": [
"Ansi",
"Itui",
"Itun",
"Itun24"
],
"type": "string"
},
"ecdssn": {
"description": "Ending CdPA subsystem number.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"ecgssn": {
"description": "Ending CgPA subsystem number.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"emapaddr": {
"description": "MAP End Address (similar to endAddress). This parameter specifies the end of a range of MAP digits (IMSI/MSISDN).",
"maxLength": 21,
"pattern": "^([0-9]*)$",
"type": "string"
},
"endAddress": {
"description": "End global title address. This parameter specifies the end of a range of global title digits.",
"maxLength": 21,
"pattern": "^([0-9]*)$",
"type": "string"
},
"fallback": {
"description": "Fallback option. The action taken when the final translation does not match while performing GTT using a FLOBR-specific GTT mode.",
"enum": [
"Sysdflt",
"Yes",
"No"
],
"default": "Sysdflt",
"type": "string"
},
"family": {
"description": "The ANSI TCAP family field in the incoming MSU.",
"maxLength": 4,
"pattern": "^(([0-1]?[0-9]?[0-9])|([2][0-4][0-9])|(25[0-5]))$|^[*]$|^(None)$",
"type": "string"
},
"gttSetName": {
"description": "Defines the GTT Set name associated with this Global Title Address (GTA). 1 leading alphabetic character and up to 8 following alphanumeric characters.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"mapSetId": {
"description": "Defines the Map Set identifier associated with this Global Title Address (GTA). MAP Set id is a Mated Application set ID. MAP Set id is mandatory when routingIndicator is set to SSN.",
"maximum": 6000,
"minimum": 0,
"type": "integer"
},
"mrnSetId": {
"description": "Defines the Mated Relay Node (MRN) Set name associated with this Global Title Address (GTA). mrnSetId is the MRN Set ID. Default is 0 when routingIndicator is set to GT.",
"maximum": 1500,
"minimum": 0,
"type": "integer"
},
"opc": {
"description": "Ansi originating point code with subfields network indicator-network cluster-network cluster member (ni-nc-ncm). ITU international originating point code with subfields zone-area-id. The prefix subfield indicates a spare point code (prefix-zone-area-id). ITU originating point code in the format of a 5-digit number (nnnnn); or 2, 3, or 4 numbers (members). The prefix subfield indicates a spare point code (prefix-nnnnn, prefix-nnnnn-gc, prefix-m1-m2-m3-m4, prefix-m1-m2-m3-m4-gc). 24-bit ITU national originating point code with subfields main signaling area-sub signaling area-signaling point (msa-ssa-sp).",
"maxLength": 11,
"pattern": "^([0-9]+-)*[0-9]+$",
"type": "string"
},
"opcode": {
"description": "The TCAP opcode field in the incoming MSU.",
"maxLength": 4,
"pattern": "^(([0-1]?[0-9]?[0-9])|([2][0-4][0-9])|(25[0-5]))$|^[*]$|^(None)$",
"type": "string"
},
"opcsn": {
"description": "The OPC GTT set name. 1 leading alphabetic character and up to 8 following alphanumeric characters",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"optsn": {
"description": "Optional gtt set name. 1 leading alphabetic character and up to 8 following alphanumeric characters",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"pkgtype": {
"description": "The ANSI and ITU TCAP package type.",
"enum": [
"Bgn",
"End",
"Cnt",
"Ituabort",
"Ituuni",
"Qwp",
"Qwop",
"Resp",
"Cwp",
"Cwop",
"Ansiabort",
"Ansiuni",
"Any"
],
"default": "Invalidpkgtype",
"type": "string"
},
"routingIndicator": {
"description": "Routing indicator. GT allow a called party address with a routing indicator value of 'global title'. SSN allow a called party address with a routing indicator value of 'DPC/SSN'.",
"enum": [
"Gt",
"Ssn"
],
"type": "string"
},
"rspName": {
"description": "Defines the Remote Signaling Point name (/vstp/remotesignalingpoints) associated with this Global Title Address (GTA).",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"smapaddr": {
"description": "Start Address (similar to startAddress). This parameter specifies the beginning of a range of MAP digits (IMSI/MSISDN).",
"maxLength": 21,
"pattern": "^([0-9]*)$",
"type": "string"
},
"startAddress": {
"description": "Defines the start of a range of this Global Title Address. This specifies the start of a range of MAP digits (IMSI/MSISDN/VLRNB/SMRPOA/SMRPDA).",
"maxLength": 21,
"pattern": "^([0-9]*)$",
"type": "string"
},
"splitAction": {
"description": "Splitting of address range is not supported in GTA.",
"enum": [
"None"
],
"type": "string"
},
"subsystem": {
"description": "New translated subsystem number.",
"maximum": 255,
"minimum": 2,
"type": "integer"
},
"translateIndicator": {
"description": "Defines translation actions and routing actions for this Global Title Address (GTA). If translationIndicator is set as None, either startAddress or endAddress, and gttSetName should be set. If translateIndicator is set as Dpc, then routingIndicator, rspName, subsystem, mapSetId, and mrnSetId should be set. If translateIndicator is set as Dpcngt, then routingIndicator is set as Gt. If translateIndicator is set as Dpcssn, then routingIndicator is set as Ssn.",
"enum": [
"Dpc",
"Dpcngt",
"Dpcssn",
"None"
],
"type": "string"
},
"uniqueIdentifier": {
"description": "Defines a unique identifier for this Global Title Address (GTA). This Unique identifier value will be used for PUT and DELETE operations.",
"maxLength": 36,
"readOnly": true,
"type": "string"
}
},
"required": [
"gttSetName",
"translateIndicator"
],
"type": "object"
}
Example
{
"actsn": "actSn1",
"cdselid": 1,
"endAddress": "2234567891",
"fallback": "No",
"gttSetName": "ANSI1",
"mapSetId": 0,
"routingIndicator": "Ssn",
"rspName": "rsp1",
"splitAction": "None",
"startAddress": "1234567891",
"subsystem": 5,
"translateIndicator": "Dpcssn"
}
delete /vstp/globaltitleaddresses/{uniqueIdentifier}
Deletes the specified GTA from the SOAM configuration. A GTA can only be deleted if all delete validation checks pass. In general, if the GTA is associated with GTT Set (/vstp/gttsets) or Selector (/vstp/gttselectors), the GTA cannot be deleted. An attempt to delete a GTA that cannot be deleted results in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- uniqueIdentifier: required (string)
Vstp: GTT Actions
A GTT Action entry consists of an Action ID, an action, and action-specific data. The action specified in the entry determines the actions to be performed on MSU during translation.
All configuration of the GTT Actions is done at the SOAM.
/vstp/gttactions
get /vstp/gttactions
Returns all GTT Actions that meet the criteria specified in the GET request. By default, all GTT Actions configured at the SOAM are returned. If paging parameters are supplied, only those GTT Actions meeting the request parameters are returned.
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/collections/gttactionCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/gttaction/gttaction.json",
"properties": {
"act": {
"description": "The action applied to the message.",
"enum": [
"Disc",
"Dup",
"Fwd",
"Tcaperr",
"Udts"
],
"type": "string"
},
"actid": {
"description": "This parameter specifies the Action ID associated with the GTT action entry. 1 leading alphabetic character and up to 8 following alphanumeric characters.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"atcaperr": {
"description": "The reason for discarding the message containing the ANSI TCAP portion that is associated with the TCAP GTT Action.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"cgpc": {
"description": "Ansi originating point code with subfields network indicator-network cluster-network cluster member (ni-nc-ncm). ITU international originating point code with subfields zone-area-id. The prefix subfield indicates a spare point code (prefix-zone-area-id). ITU originating point code in the format of a 5-digit number (nnnnn); or 2, 3, or 4 numbers (members). The prefix subfield indicates a spare point code (prefix-nnnnn, prefix-nnnnn-gc, prefix-m1-m2-m3-m4, prefix-m1-m2-m3-m4-gc). 24-bit ITU national originating point code with subfields main signaling area-sub signaling area-signaling point (msa-ssa-sp)",
"maxLength": 11,
"pattern": "^([0-9]+-)*[0-9]+$",
"type": "string"
},
"cgpcogmsg": {
"description": "The data that is used as the Calling Party Point Code in the outgoing message. Dflt - The standard Global Title Translation process supplies the CgPA PC. Cgpcicmsg - CgPA PC data from the incoming MSU. Opcicmsg - OPC data from the incoming MSU. Provcgpc - provisioned CGPC data in the GTT Action. Remove - CGPC will be removed from outgoing MSU.",
"enum": [
"Dflt",
"Cgpcicmsg",
"Opcicmsg",
"Provcgpc",
"Remove"
],
"default": "Dflt",
"type": "string"
},
"defactid": {
"description": "The default action that is performed when the fwd GTT Action fails to route the MSU. 1 leading alphabetic character followed by 8 alphanumeric characters. The defactid parameter can take one of the following values: 1)GTT Action ID with a GTT Action of disc, udts, or tcaperr. This value must already be defined in the GTT Action table. 2)fallback - The MSU is routed using routing data in the translated MSU when action is fwd.",
"maxLength": 9,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"default": "fallback",
"type": "string"
},
"domain": {
"description": "This defines the type of CGPC domain.",
"enum": [
"Ansi",
"Itui",
"Itun",
"Itun24"
],
"type": "string"
},
"itcaperr": {
"description": "The reason for discarding the message containing the ITU TCAP portion that is associated with the TCAPERR GTT Action.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"mapSetId": {
"description": "This parameter specifies the Mated Application Set ID.",
"maximum": 6000,
"minimum": 0,
"type": "integer"
},
"mrnSetId": {
"description": "The Mated Relay Node Set ID.",
"maximum": 1500,
"minimum": 0,
"type": "integer"
},
"ri": {
"description": "The routing indicator in the SCCP called party address of the duplicated copy of MSU.",
"enum": [
"Gt",
"Ssn"
],
"default": "Ssn",
"type": "string"
},
"rspName": {
"description": "Defines the Remote Signaling Point name (/vstp/remotesignalingpoints) associated with this Global Title Address (GTA).",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"ssn": {
"description": "The subsystem number in the SCCP called party address of the MSU.",
"maximum": 255,
"minimum": 2,
"type": "integer"
},
"udtserr": {
"description": "The reason associated with the UDTS GTT Action for discarding the message.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"uimreqd": {
"description": "This specifies whether a UIM should be generated. When set to true, UIM is not generated.",
"default": false,
"type": "boolean"
},
"useicmsg": {
"description": "This specifies whether to apply GTT Action data to the message as the message was received (OFF).",
"type": "boolean"
}
},
"required": [
"act",
"actid"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"act": "Fwd",
"actid": "actfwd1",
"mrnset": 10,
"ri": "Gt",
"rspName": "RSP1"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /vstp/gttactions
Adds a new GTT Action to the VSTP configuration. The GTT Action name must be unique across all GTT Actions at the SOAM. GTT Action Id can not be specified as fallback.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/gttaction/gttaction.json",
"properties": {
"act": {
"description": "The action applied to the message.",
"enum": [
"Disc",
"Dup",
"Fwd",
"Tcaperr",
"Udts"
],
"type": "string"
},
"actid": {
"description": "This parameter specifies the Action ID associated with the GTT action entry. 1 leading alphabetic character and up to 8 following alphanumeric characters.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"atcaperr": {
"description": "The reason for discarding the message containing the ANSI TCAP portion that is associated with the TCAP GTT Action.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"cgpc": {
"description": "Ansi originating point code with subfields network indicator-network cluster-network cluster member (ni-nc-ncm). ITU international originating point code with subfields zone-area-id. The prefix subfield indicates a spare point code (prefix-zone-area-id). ITU originating point code in the format of a 5-digit number (nnnnn); or 2, 3, or 4 numbers (members). The prefix subfield indicates a spare point code (prefix-nnnnn, prefix-nnnnn-gc, prefix-m1-m2-m3-m4, prefix-m1-m2-m3-m4-gc). 24-bit ITU national originating point code with subfields main signaling area-sub signaling area-signaling point (msa-ssa-sp)",
"maxLength": 11,
"pattern": "^([0-9]+-)*[0-9]+$",
"type": "string"
},
"cgpcogmsg": {
"description": "The data that is used as the Calling Party Point Code in the outgoing message. Dflt - The standard Global Title Translation process supplies the CgPA PC. Cgpcicmsg - CgPA PC data from the incoming MSU. Opcicmsg - OPC data from the incoming MSU. Provcgpc - provisioned CGPC data in the GTT Action. Remove - CGPC will be removed from outgoing MSU.",
"enum": [
"Dflt",
"Cgpcicmsg",
"Opcicmsg",
"Provcgpc",
"Remove"
],
"default": "Dflt",
"type": "string"
},
"defactid": {
"description": "The default action that is performed when the fwd GTT Action fails to route the MSU. 1 leading alphabetic character followed by 8 alphanumeric characters. The defactid parameter can take one of the following values: 1)GTT Action ID with a GTT Action of disc, udts, or tcaperr. This value must already be defined in the GTT Action table. 2)fallback - The MSU is routed using routing data in the translated MSU when action is fwd.",
"maxLength": 9,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"default": "fallback",
"type": "string"
},
"domain": {
"description": "This defines the type of CGPC domain.",
"enum": [
"Ansi",
"Itui",
"Itun",
"Itun24"
],
"type": "string"
},
"itcaperr": {
"description": "The reason for discarding the message containing the ITU TCAP portion that is associated with the TCAPERR GTT Action.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"mapSetId": {
"description": "This parameter specifies the Mated Application Set ID.",
"maximum": 6000,
"minimum": 0,
"type": "integer"
},
"mrnSetId": {
"description": "The Mated Relay Node Set ID.",
"maximum": 1500,
"minimum": 0,
"type": "integer"
},
"ri": {
"description": "The routing indicator in the SCCP called party address of the duplicated copy of MSU.",
"enum": [
"Gt",
"Ssn"
],
"default": "Ssn",
"type": "string"
},
"rspName": {
"description": "Defines the Remote Signaling Point name (/vstp/remotesignalingpoints) associated with this Global Title Address (GTA).",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"ssn": {
"description": "The subsystem number in the SCCP called party address of the MSU.",
"maximum": 255,
"minimum": 2,
"type": "integer"
},
"udtserr": {
"description": "The reason associated with the UDTS GTT Action for discarding the message.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"uimreqd": {
"description": "This specifies whether a UIM should be generated. When set to true, UIM is not generated.",
"default": false,
"type": "boolean"
},
"useicmsg": {
"description": "This specifies whether to apply GTT Action data to the message as the message was received (OFF).",
"type": "boolean"
}
},
"required": [
"act",
"actid"
],
"type": "object"
}
Example
{
"act": "Fwd",
"actid": "actfwd1",
"mrnset": 10,
"ri": "Gt",
"rspName": "RSP1"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/vstp/gttactions/{name}
get /vstp/gttactions/{name}
Returns the configuration details for the specified GTT Action. If the GTT Action does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/items/gttactionItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/gttaction/gttaction.json",
"properties": {
"act": {
"description": "The action applied to the message.",
"enum": [
"Disc",
"Dup",
"Fwd",
"Tcaperr",
"Udts"
],
"type": "string"
},
"actid": {
"description": "This parameter specifies the Action ID associated with the GTT action entry. 1 leading alphabetic character and up to 8 following alphanumeric characters.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"atcaperr": {
"description": "The reason for discarding the message containing the ANSI TCAP portion that is associated with the TCAP GTT Action.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"cgpc": {
"description": "Ansi originating point code with subfields network indicator-network cluster-network cluster member (ni-nc-ncm). ITU international originating point code with subfields zone-area-id. The prefix subfield indicates a spare point code (prefix-zone-area-id). ITU originating point code in the format of a 5-digit number (nnnnn); or 2, 3, or 4 numbers (members). The prefix subfield indicates a spare point code (prefix-nnnnn, prefix-nnnnn-gc, prefix-m1-m2-m3-m4, prefix-m1-m2-m3-m4-gc). 24-bit ITU national originating point code with subfields main signaling area-sub signaling area-signaling point (msa-ssa-sp)",
"maxLength": 11,
"pattern": "^([0-9]+-)*[0-9]+$",
"type": "string"
},
"cgpcogmsg": {
"description": "The data that is used as the Calling Party Point Code in the outgoing message. Dflt - The standard Global Title Translation process supplies the CgPA PC. Cgpcicmsg - CgPA PC data from the incoming MSU. Opcicmsg - OPC data from the incoming MSU. Provcgpc - provisioned CGPC data in the GTT Action. Remove - CGPC will be removed from outgoing MSU.",
"enum": [
"Dflt",
"Cgpcicmsg",
"Opcicmsg",
"Provcgpc",
"Remove"
],
"default": "Dflt",
"type": "string"
},
"defactid": {
"description": "The default action that is performed when the fwd GTT Action fails to route the MSU. 1 leading alphabetic character followed by 8 alphanumeric characters. The defactid parameter can take one of the following values: 1)GTT Action ID with a GTT Action of disc, udts, or tcaperr. This value must already be defined in the GTT Action table. 2)fallback - The MSU is routed using routing data in the translated MSU when action is fwd.",
"maxLength": 9,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"default": "fallback",
"type": "string"
},
"domain": {
"description": "This defines the type of CGPC domain.",
"enum": [
"Ansi",
"Itui",
"Itun",
"Itun24"
],
"type": "string"
},
"itcaperr": {
"description": "The reason for discarding the message containing the ITU TCAP portion that is associated with the TCAPERR GTT Action.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"mapSetId": {
"description": "This parameter specifies the Mated Application Set ID.",
"maximum": 6000,
"minimum": 0,
"type": "integer"
},
"mrnSetId": {
"description": "The Mated Relay Node Set ID.",
"maximum": 1500,
"minimum": 0,
"type": "integer"
},
"ri": {
"description": "The routing indicator in the SCCP called party address of the duplicated copy of MSU.",
"enum": [
"Gt",
"Ssn"
],
"default": "Ssn",
"type": "string"
},
"rspName": {
"description": "Defines the Remote Signaling Point name (/vstp/remotesignalingpoints) associated with this Global Title Address (GTA).",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"ssn": {
"description": "The subsystem number in the SCCP called party address of the MSU.",
"maximum": 255,
"minimum": 2,
"type": "integer"
},
"udtserr": {
"description": "The reason associated with the UDTS GTT Action for discarding the message.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"uimreqd": {
"description": "This specifies whether a UIM should be generated. When set to true, UIM is not generated.",
"default": false,
"type": "boolean"
},
"useicmsg": {
"description": "This specifies whether to apply GTT Action data to the message as the message was received (OFF).",
"type": "boolean"
}
},
"required": [
"act",
"actid"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"act": "Fwd",
"actid": "actfwd1",
"mrnset": 10,
"ri": "Gt",
"rspName": "RSP1"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /vstp/gttactions/{name}
Updates the configuration of the specified GTT Action. If the provided GTT Action data is invalid in any way, the update fails, resulting in one or more error messages returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/gttaction/gttaction.json",
"properties": {
"act": {
"description": "The action applied to the message.",
"enum": [
"Disc",
"Dup",
"Fwd",
"Tcaperr",
"Udts"
],
"type": "string"
},
"actid": {
"description": "This parameter specifies the Action ID associated with the GTT action entry. 1 leading alphabetic character and up to 8 following alphanumeric characters.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"atcaperr": {
"description": "The reason for discarding the message containing the ANSI TCAP portion that is associated with the TCAP GTT Action.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"cgpc": {
"description": "Ansi originating point code with subfields network indicator-network cluster-network cluster member (ni-nc-ncm). ITU international originating point code with subfields zone-area-id. The prefix subfield indicates a spare point code (prefix-zone-area-id). ITU originating point code in the format of a 5-digit number (nnnnn); or 2, 3, or 4 numbers (members). The prefix subfield indicates a spare point code (prefix-nnnnn, prefix-nnnnn-gc, prefix-m1-m2-m3-m4, prefix-m1-m2-m3-m4-gc). 24-bit ITU national originating point code with subfields main signaling area-sub signaling area-signaling point (msa-ssa-sp)",
"maxLength": 11,
"pattern": "^([0-9]+-)*[0-9]+$",
"type": "string"
},
"cgpcogmsg": {
"description": "The data that is used as the Calling Party Point Code in the outgoing message. Dflt - The standard Global Title Translation process supplies the CgPA PC. Cgpcicmsg - CgPA PC data from the incoming MSU. Opcicmsg - OPC data from the incoming MSU. Provcgpc - provisioned CGPC data in the GTT Action. Remove - CGPC will be removed from outgoing MSU.",
"enum": [
"Dflt",
"Cgpcicmsg",
"Opcicmsg",
"Provcgpc",
"Remove"
],
"default": "Dflt",
"type": "string"
},
"defactid": {
"description": "The default action that is performed when the fwd GTT Action fails to route the MSU. 1 leading alphabetic character followed by 8 alphanumeric characters. The defactid parameter can take one of the following values: 1)GTT Action ID with a GTT Action of disc, udts, or tcaperr. This value must already be defined in the GTT Action table. 2)fallback - The MSU is routed using routing data in the translated MSU when action is fwd.",
"maxLength": 9,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"default": "fallback",
"type": "string"
},
"domain": {
"description": "This defines the type of CGPC domain.",
"enum": [
"Ansi",
"Itui",
"Itun",
"Itun24"
],
"type": "string"
},
"itcaperr": {
"description": "The reason for discarding the message containing the ITU TCAP portion that is associated with the TCAPERR GTT Action.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"mapSetId": {
"description": "This parameter specifies the Mated Application Set ID.",
"maximum": 6000,
"minimum": 0,
"type": "integer"
},
"mrnSetId": {
"description": "The Mated Relay Node Set ID.",
"maximum": 1500,
"minimum": 0,
"type": "integer"
},
"ri": {
"description": "The routing indicator in the SCCP called party address of the duplicated copy of MSU.",
"enum": [
"Gt",
"Ssn"
],
"default": "Ssn",
"type": "string"
},
"rspName": {
"description": "Defines the Remote Signaling Point name (/vstp/remotesignalingpoints) associated with this Global Title Address (GTA).",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"ssn": {
"description": "The subsystem number in the SCCP called party address of the MSU.",
"maximum": 255,
"minimum": 2,
"type": "integer"
},
"udtserr": {
"description": "The reason associated with the UDTS GTT Action for discarding the message.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"uimreqd": {
"description": "This specifies whether a UIM should be generated. When set to true, UIM is not generated.",
"default": false,
"type": "boolean"
},
"useicmsg": {
"description": "This specifies whether to apply GTT Action data to the message as the message was received (OFF).",
"type": "boolean"
}
},
"required": [
"act",
"actid"
],
"type": "object"
}
Example
{
"act": "Fwd",
"actid": "actfwd1",
"mrnset": 10,
"ri": "Gt",
"rspName": "RSP1"
}
delete /vstp/gttactions/{name}
Deletes the specified GTT Action from the SOAM configuration. An attempt to delete a GTT Action which does not exist results in an error message returned within the HTTP response. GTT Action cannot be removed if already used by GTT Action Set.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Vstp: GTT Selectors
A Global Title Translation (GTT) Selector is an entity assigned to a GTT set (/vstp/gttsets).
All configuration of GTT Selector is done at the SOAM.
/vstp/gttselectors
get /vstp/gttselectors
Returns all GTT Selectors that meet the criteria specified in the GET request. By default, all GTT Selector configured at the SOAM are returned. If paging parameters are supplied, only those GTT Selectors meeting the request parameters are returned.
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (string)
The attribute name on which filtering occurs. Non-enumerated string attributes can be filtered using EQUAL, NOT_EQUAL, LIKE or IN. Enumerated strings and integers can be filtered using EQUAL, NOT_EQUAL, and IN - LIKE is not supported for these data types.
Example:
filter_name=name
- filter_op: (one of EQUAL, NOT_EQUAL, LIKE, IN)
The filter operator.
Example:
filter_op=EQUAL
- filter_values: (string)
The value being filtered on. When the filter_op is IN, filter_values can be a comma-delimited list of strings or integers. Otherwise, filter_value should be a single value.
Example:
filter_values=GttSel1
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/collections/gttselectorCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/gttselector/gttselector.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"cdgttsn": {
"description": "CdPA GTT set name (/vstp/gttsets) associated with this GTT Selector. Valid names are strings between one and 9 characters, inclusive. Valid characters are alphanumeric. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"cggttsn": {
"description": "CgPA GTT set name (/vstp/gttsets) associated with this GTT Selector. Valid names are strings between one and 9 characters, inclusive. Valid characters are alphanumeric. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"cgssn": {
"description": "CgPA subsystem number.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"domain": {
"description": "Defines the type of incoming message network domain. Default is Ansi.",
"enum": [
"Ansi",
"Itui",
"Itun",
"Itun24"
],
"type": "string"
},
"globalTitleIndicator": {
"description": "Defines the domain for this GTT Selector. When set to NoGlobal, then 0 value is assigned corresponding to the domain that is set. When set to TtNumEncodingNature, then 4 value is assigned corresponding to the itu domain set. When set to TtOnly, then 2 value is assigned corresponding to the domain that is set. Only one entry for NoGlobal can be set corresponding to each domain and multiple entries can exist for TtOnly corresponding to each domain.",
"enum": [
"NoGlobal",
"TtNumEncodingNature",
"TtOnly"
],
"type": "string"
},
"gttSetName": {
"description": "Name of the SCCP GTT Set (/vstp/gttsets) associated with this GTT Selector.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"linksetName": {
"description": "Linkset name (/vstp/linksets) associated with this GTT Selector.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"name": {
"description": "Name for this SCCP GTT Selector. Valid names are strings between one and 10 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 9,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"natureOfAddressIndicator": {
"description": "Defines Nature of Address indicator for this GTT Selector. When set to International, then Nature of Address indicator (NAI) is International number. When set to National, then Nature of Address indicator (NAI) is National significant number. When set to Reserved, then Nature of Address indicator (NAI) is Reserverd for National use. When set to Subscriber, then Nature of Address indicator (NAI) is Subscriber Number. Either natureOfAddressIndicator or natureOfAddressIndicatorValue can be specified at a time.",
"enum": [
"International",
"National",
"Reserved",
"Subscriber"
],
"type": "string"
},
"natureOfAddressIndicatorValue": {
"description": "Value for the nature of Address indicator. Value 1 refers to Subscriber natureOfAddressIndicator, value 2 refers to Reserved natureOfAddressIndicator, value 3 refers to National natureOfAddressIndicator, value 4 refers to International natureOfAddressIndicator, value 5-127 refer to spare values, value 0 refers to unknown natureOfAddressIndicator. There is no enum corresponding to 0 and 5-127 range. For these values, only natureOfAddressIndicatorValue can be set.",
"maximum": 127,
"minimum": 0,
"type": "integer"
},
"numberingPlan": {
"description": "Defines Numbering plan (NP) for this GTT Selector. When set to E164, then Numbering plan is ISDN/telephony numbering plan. When set to X121, then Numbering plan is Data numbering plan. When set to F69, then Numbering plan is Telex numbering plan. When set to E210, then Numbering plan is Maritime mobile numbering plan. When set to E212, then Numbering plan is Land mobile numbering plan. When set to E214, then Numbering plan is ISDN/mobile numbering plan. When set to Private, then Numbering plan is Private network or network-specific numbering plan. When set to Generic, then Numbering plan is Generic numbering plan. Either numberingPlan or numberingPlanValue can be specified at a time.",
"enum": [
"E164",
"E210",
"E212",
"E214",
"F69",
"Generic",
"Private",
"X121"
],
"type": "string"
},
"numberingPlanValue": {
"description": "Value for the numbering plan. Value 1 refers to Isdn numberingPlanValue, value 2 refers to Generic numberingPlanValue, value 3 refers to Data numberingPlanValue, value 4 refers to Telex numberingPlanValue, value 5 refers to Maritime numberingPlanValue, value 6 refers to Land, value 7 refers to IsdnMobile numberingPlanValue, value 8 refers to Private numberingPlanValue, value 9-15 refers to Spare nnumberingPlanValue and value 0 refer to Unknown numberingPlanValue. There is no enum corresponding to 0 and 9-15 range. For these values, only numberingPlanValue can be set.",
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"selid": {
"description": "Selector ID.",
"maximum": 65534,
"minimum": 0,
"type": "integer"
},
"translationType": {
"description": "Defines the translation type (TT) for this GTT Selector.",
"maximum": 255,
"minimum": 0,
"type": "integer"
}
},
"required": [
"domain",
"name",
"globalTitleIndicator"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"configurationLevel": "0",
"domain": "Itui",
"globalTitleIndicator": "TtNumEncodingNature",
"gttSetName": "GTTSET1",
"name": "GttSel1",
"natureOfAddressIndicatorValue": 4,
"numberingPlanValue": 3,
"translationType": 2
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /vstp/gttselectors
Adds a new GTT Selector to the VSTP configuration. The GTT Selector name must be unique as it refers to the GTT Set name at the SOAM.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/gttselector/gttselector.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"cdgttsn": {
"description": "CdPA GTT set name (/vstp/gttsets) associated with this GTT Selector. Valid names are strings between one and 9 characters, inclusive. Valid characters are alphanumeric. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"cggttsn": {
"description": "CgPA GTT set name (/vstp/gttsets) associated with this GTT Selector. Valid names are strings between one and 9 characters, inclusive. Valid characters are alphanumeric. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"cgssn": {
"description": "CgPA subsystem number.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"domain": {
"description": "Defines the type of incoming message network domain. Default is Ansi.",
"enum": [
"Ansi",
"Itui",
"Itun",
"Itun24"
],
"type": "string"
},
"globalTitleIndicator": {
"description": "Defines the domain for this GTT Selector. When set to NoGlobal, then 0 value is assigned corresponding to the domain that is set. When set to TtNumEncodingNature, then 4 value is assigned corresponding to the itu domain set. When set to TtOnly, then 2 value is assigned corresponding to the domain that is set. Only one entry for NoGlobal can be set corresponding to each domain and multiple entries can exist for TtOnly corresponding to each domain.",
"enum": [
"NoGlobal",
"TtNumEncodingNature",
"TtOnly"
],
"type": "string"
},
"gttSetName": {
"description": "Name of the SCCP GTT Set (/vstp/gttsets) associated with this GTT Selector.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"linksetName": {
"description": "Linkset name (/vstp/linksets) associated with this GTT Selector.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"name": {
"description": "Name for this SCCP GTT Selector. Valid names are strings between one and 10 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 9,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"natureOfAddressIndicator": {
"description": "Defines Nature of Address indicator for this GTT Selector. When set to International, then Nature of Address indicator (NAI) is International number. When set to National, then Nature of Address indicator (NAI) is National significant number. When set to Reserved, then Nature of Address indicator (NAI) is Reserverd for National use. When set to Subscriber, then Nature of Address indicator (NAI) is Subscriber Number. Either natureOfAddressIndicator or natureOfAddressIndicatorValue can be specified at a time.",
"enum": [
"International",
"National",
"Reserved",
"Subscriber"
],
"type": "string"
},
"natureOfAddressIndicatorValue": {
"description": "Value for the nature of Address indicator. Value 1 refers to Subscriber natureOfAddressIndicator, value 2 refers to Reserved natureOfAddressIndicator, value 3 refers to National natureOfAddressIndicator, value 4 refers to International natureOfAddressIndicator, value 5-127 refer to spare values, value 0 refers to unknown natureOfAddressIndicator. There is no enum corresponding to 0 and 5-127 range. For these values, only natureOfAddressIndicatorValue can be set.",
"maximum": 127,
"minimum": 0,
"type": "integer"
},
"numberingPlan": {
"description": "Defines Numbering plan (NP) for this GTT Selector. When set to E164, then Numbering plan is ISDN/telephony numbering plan. When set to X121, then Numbering plan is Data numbering plan. When set to F69, then Numbering plan is Telex numbering plan. When set to E210, then Numbering plan is Maritime mobile numbering plan. When set to E212, then Numbering plan is Land mobile numbering plan. When set to E214, then Numbering plan is ISDN/mobile numbering plan. When set to Private, then Numbering plan is Private network or network-specific numbering plan. When set to Generic, then Numbering plan is Generic numbering plan. Either numberingPlan or numberingPlanValue can be specified at a time.",
"enum": [
"E164",
"E210",
"E212",
"E214",
"F69",
"Generic",
"Private",
"X121"
],
"type": "string"
},
"numberingPlanValue": {
"description": "Value for the numbering plan. Value 1 refers to Isdn numberingPlanValue, value 2 refers to Generic numberingPlanValue, value 3 refers to Data numberingPlanValue, value 4 refers to Telex numberingPlanValue, value 5 refers to Maritime numberingPlanValue, value 6 refers to Land, value 7 refers to IsdnMobile numberingPlanValue, value 8 refers to Private numberingPlanValue, value 9-15 refers to Spare nnumberingPlanValue and value 0 refer to Unknown numberingPlanValue. There is no enum corresponding to 0 and 9-15 range. For these values, only numberingPlanValue can be set.",
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"selid": {
"description": "Selector ID.",
"maximum": 65534,
"minimum": 0,
"type": "integer"
},
"translationType": {
"description": "Defines the translation type (TT) for this GTT Selector.",
"maximum": 255,
"minimum": 0,
"type": "integer"
}
},
"required": [
"domain",
"name",
"globalTitleIndicator"
],
"type": "object"
}
Example
{
"configurationLevel": "0",
"domain": "Itui",
"globalTitleIndicator": "TtNumEncodingNature",
"gttSetName": "GTTSET1",
"name": "GttSel1",
"natureOfAddressIndicatorValue": 4,
"numberingPlanValue": 3,
"translationType": 2
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/vstp/gttselectors/{name}
get /vstp/gttselectors/{name}
Returns the configuration details for the specified GTT Selector. If the GTT does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/items/gttselectorItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/gttselector/gttselector.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"cdgttsn": {
"description": "CdPA GTT set name (/vstp/gttsets) associated with this GTT Selector. Valid names are strings between one and 9 characters, inclusive. Valid characters are alphanumeric. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"cggttsn": {
"description": "CgPA GTT set name (/vstp/gttsets) associated with this GTT Selector. Valid names are strings between one and 9 characters, inclusive. Valid characters are alphanumeric. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"cgssn": {
"description": "CgPA subsystem number.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"domain": {
"description": "Defines the type of incoming message network domain. Default is Ansi.",
"enum": [
"Ansi",
"Itui",
"Itun",
"Itun24"
],
"type": "string"
},
"globalTitleIndicator": {
"description": "Defines the domain for this GTT Selector. When set to NoGlobal, then 0 value is assigned corresponding to the domain that is set. When set to TtNumEncodingNature, then 4 value is assigned corresponding to the itu domain set. When set to TtOnly, then 2 value is assigned corresponding to the domain that is set. Only one entry for NoGlobal can be set corresponding to each domain and multiple entries can exist for TtOnly corresponding to each domain.",
"enum": [
"NoGlobal",
"TtNumEncodingNature",
"TtOnly"
],
"type": "string"
},
"gttSetName": {
"description": "Name of the SCCP GTT Set (/vstp/gttsets) associated with this GTT Selector.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"linksetName": {
"description": "Linkset name (/vstp/linksets) associated with this GTT Selector.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"name": {
"description": "Name for this SCCP GTT Selector. Valid names are strings between one and 10 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 9,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"natureOfAddressIndicator": {
"description": "Defines Nature of Address indicator for this GTT Selector. When set to International, then Nature of Address indicator (NAI) is International number. When set to National, then Nature of Address indicator (NAI) is National significant number. When set to Reserved, then Nature of Address indicator (NAI) is Reserverd for National use. When set to Subscriber, then Nature of Address indicator (NAI) is Subscriber Number. Either natureOfAddressIndicator or natureOfAddressIndicatorValue can be specified at a time.",
"enum": [
"International",
"National",
"Reserved",
"Subscriber"
],
"type": "string"
},
"natureOfAddressIndicatorValue": {
"description": "Value for the nature of Address indicator. Value 1 refers to Subscriber natureOfAddressIndicator, value 2 refers to Reserved natureOfAddressIndicator, value 3 refers to National natureOfAddressIndicator, value 4 refers to International natureOfAddressIndicator, value 5-127 refer to spare values, value 0 refers to unknown natureOfAddressIndicator. There is no enum corresponding to 0 and 5-127 range. For these values, only natureOfAddressIndicatorValue can be set.",
"maximum": 127,
"minimum": 0,
"type": "integer"
},
"numberingPlan": {
"description": "Defines Numbering plan (NP) for this GTT Selector. When set to E164, then Numbering plan is ISDN/telephony numbering plan. When set to X121, then Numbering plan is Data numbering plan. When set to F69, then Numbering plan is Telex numbering plan. When set to E210, then Numbering plan is Maritime mobile numbering plan. When set to E212, then Numbering plan is Land mobile numbering plan. When set to E214, then Numbering plan is ISDN/mobile numbering plan. When set to Private, then Numbering plan is Private network or network-specific numbering plan. When set to Generic, then Numbering plan is Generic numbering plan. Either numberingPlan or numberingPlanValue can be specified at a time.",
"enum": [
"E164",
"E210",
"E212",
"E214",
"F69",
"Generic",
"Private",
"X121"
],
"type": "string"
},
"numberingPlanValue": {
"description": "Value for the numbering plan. Value 1 refers to Isdn numberingPlanValue, value 2 refers to Generic numberingPlanValue, value 3 refers to Data numberingPlanValue, value 4 refers to Telex numberingPlanValue, value 5 refers to Maritime numberingPlanValue, value 6 refers to Land, value 7 refers to IsdnMobile numberingPlanValue, value 8 refers to Private numberingPlanValue, value 9-15 refers to Spare nnumberingPlanValue and value 0 refer to Unknown numberingPlanValue. There is no enum corresponding to 0 and 9-15 range. For these values, only numberingPlanValue can be set.",
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"selid": {
"description": "Selector ID.",
"maximum": 65534,
"minimum": 0,
"type": "integer"
},
"translationType": {
"description": "Defines the translation type (TT) for this GTT Selector.",
"maximum": 255,
"minimum": 0,
"type": "integer"
}
},
"required": [
"domain",
"name",
"globalTitleIndicator"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"configurationLevel": "0",
"domain": "Itui",
"globalTitleIndicator": "TtNumEncodingNature",
"gttSetName": "GTTSET1",
"name": "GttSel1",
"natureOfAddressIndicatorValue": 4,
"numberingPlanValue": 3,
"translationType": 2
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /vstp/gttselectors/{name}
Updates the configuration of the specified GTT Selector. If the provided GTT Selector data is invalid in any way, the update fails, resulting in one or more error messages returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/gttselector/gttselector.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"cdgttsn": {
"description": "CdPA GTT set name (/vstp/gttsets) associated with this GTT Selector. Valid names are strings between one and 9 characters, inclusive. Valid characters are alphanumeric. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"cggttsn": {
"description": "CgPA GTT set name (/vstp/gttsets) associated with this GTT Selector. Valid names are strings between one and 9 characters, inclusive. Valid characters are alphanumeric. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"cgssn": {
"description": "CgPA subsystem number.",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"domain": {
"description": "Defines the type of incoming message network domain. Default is Ansi.",
"enum": [
"Ansi",
"Itui",
"Itun",
"Itun24"
],
"type": "string"
},
"globalTitleIndicator": {
"description": "Defines the domain for this GTT Selector. When set to NoGlobal, then 0 value is assigned corresponding to the domain that is set. When set to TtNumEncodingNature, then 4 value is assigned corresponding to the itu domain set. When set to TtOnly, then 2 value is assigned corresponding to the domain that is set. Only one entry for NoGlobal can be set corresponding to each domain and multiple entries can exist for TtOnly corresponding to each domain.",
"enum": [
"NoGlobal",
"TtNumEncodingNature",
"TtOnly"
],
"type": "string"
},
"gttSetName": {
"description": "Name of the SCCP GTT Set (/vstp/gttsets) associated with this GTT Selector.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"linksetName": {
"description": "Linkset name (/vstp/linksets) associated with this GTT Selector.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"name": {
"description": "Name for this SCCP GTT Selector. Valid names are strings between one and 10 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 9,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"natureOfAddressIndicator": {
"description": "Defines Nature of Address indicator for this GTT Selector. When set to International, then Nature of Address indicator (NAI) is International number. When set to National, then Nature of Address indicator (NAI) is National significant number. When set to Reserved, then Nature of Address indicator (NAI) is Reserverd for National use. When set to Subscriber, then Nature of Address indicator (NAI) is Subscriber Number. Either natureOfAddressIndicator or natureOfAddressIndicatorValue can be specified at a time.",
"enum": [
"International",
"National",
"Reserved",
"Subscriber"
],
"type": "string"
},
"natureOfAddressIndicatorValue": {
"description": "Value for the nature of Address indicator. Value 1 refers to Subscriber natureOfAddressIndicator, value 2 refers to Reserved natureOfAddressIndicator, value 3 refers to National natureOfAddressIndicator, value 4 refers to International natureOfAddressIndicator, value 5-127 refer to spare values, value 0 refers to unknown natureOfAddressIndicator. There is no enum corresponding to 0 and 5-127 range. For these values, only natureOfAddressIndicatorValue can be set.",
"maximum": 127,
"minimum": 0,
"type": "integer"
},
"numberingPlan": {
"description": "Defines Numbering plan (NP) for this GTT Selector. When set to E164, then Numbering plan is ISDN/telephony numbering plan. When set to X121, then Numbering plan is Data numbering plan. When set to F69, then Numbering plan is Telex numbering plan. When set to E210, then Numbering plan is Maritime mobile numbering plan. When set to E212, then Numbering plan is Land mobile numbering plan. When set to E214, then Numbering plan is ISDN/mobile numbering plan. When set to Private, then Numbering plan is Private network or network-specific numbering plan. When set to Generic, then Numbering plan is Generic numbering plan. Either numberingPlan or numberingPlanValue can be specified at a time.",
"enum": [
"E164",
"E210",
"E212",
"E214",
"F69",
"Generic",
"Private",
"X121"
],
"type": "string"
},
"numberingPlanValue": {
"description": "Value for the numbering plan. Value 1 refers to Isdn numberingPlanValue, value 2 refers to Generic numberingPlanValue, value 3 refers to Data numberingPlanValue, value 4 refers to Telex numberingPlanValue, value 5 refers to Maritime numberingPlanValue, value 6 refers to Land, value 7 refers to IsdnMobile numberingPlanValue, value 8 refers to Private numberingPlanValue, value 9-15 refers to Spare nnumberingPlanValue and value 0 refer to Unknown numberingPlanValue. There is no enum corresponding to 0 and 9-15 range. For these values, only numberingPlanValue can be set.",
"maximum": 15,
"minimum": 0,
"type": "integer"
},
"selid": {
"description": "Selector ID.",
"maximum": 65534,
"minimum": 0,
"type": "integer"
},
"translationType": {
"description": "Defines the translation type (TT) for this GTT Selector.",
"maximum": 255,
"minimum": 0,
"type": "integer"
}
},
"required": [
"domain",
"name",
"globalTitleIndicator"
],
"type": "object"
}
Example
{
"configurationLevel": "0",
"domain": "Itui",
"globalTitleIndicator": "TtNumEncodingNature",
"gttSetName": "GTTSET1",
"name": "GttSel1",
"natureOfAddressIndicatorValue": 4,
"numberingPlanValue": 3,
"translationType": 2
}
delete /vstp/gttselectors/{name}
Deletes the specified GTT Selector from the SOAM configuration. A GTT Selector can only be deleted if all delete validation checks pass. In general, if the GTT Selector is associated with a GTT Set (/vstp/gttsets), the GTT Selector cannot be deleted. An attempt to delete a GTT Selector that cannot be deleted results in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Vstp: GTT Sets
A GTT Set is a an entity to which Global Title Addresses (/vstp/globaltitleaddresses) and Selectors (/vstp/gttselectors) are assigned.
All configuration of GTT Sets is done at the SOAM.
/vstp/gttsets
get /vstp/gttsets
Returns all GTT Sets that meet the criteria specified in the GET request. By default, all GTT Sets configured at the SOAM are returned. If paging parameters are supplied, only those GTT Sets meeting the request parameters are returned.
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (one of configurationLevel)
The field being matched
Only the configurationLevel field is supported.
Example:
filter_name=configurationLevel
- filter_op: (one of GREATER_THAN, GREATER_THAN_EQUAL)
The match operation (operator)
Example:
filter_op=GREATER_THAN
- filter_values: (string)
The matched value
The configurationLevel value by which the data is being filtered. Only a single value is supported.
Example:
filter_values=10
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/collections/gttsetCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/gttset/gttset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"domain": {
"description": "Defines the type of incoming message network domain. This GTTSET MO does not distinguish between ITU national or ITU international.",
"enum": [
"Ansi",
"Itu"
],
"type": "string"
},
"gttSetType": {
"description": "Defines the type of GTT Set.",
"default": "Cdgta",
"enum": [
"Cdgta",
"Cdssn",
"Cggta",
"Cgpc",
"Cgssn",
"Imsi",
"Msisdn",
"Opc",
"Opcode"
],
"type": "string"
},
"name": {
"description": "Name for the SCCP GTT Set, which must be unique within the VSTP site. Valid names are strings between one and 9 characters, inclusive. Valid characters are alphanumeric. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"npsn": {
"description": "GTT set name (Not Present Set Name). This parameter can have Imsi/Msisdn GTT set types. 1 leading alphabetic character and up to 8 following alphanumeric characters.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
}
},
"required": [
"domain",
"name"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"configurationLevel": "1",
"domain": "Ansi",
"gttSetType": "Cdgta",
"name": "gttset1"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /vstp/gttsets
Adds a new GTT Set to the VSTP configuration. The GTT Set name must be unique across all GTT Sets at the SOAM.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/gttset/gttset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"domain": {
"description": "Defines the type of incoming message network domain. This GTTSET MO does not distinguish between ITU national or ITU international.",
"enum": [
"Ansi",
"Itu"
],
"type": "string"
},
"gttSetType": {
"description": "Defines the type of GTT Set.",
"default": "Cdgta",
"enum": [
"Cdgta",
"Cdssn",
"Cggta",
"Cgpc",
"Cgssn",
"Imsi",
"Msisdn",
"Opc",
"Opcode"
],
"type": "string"
},
"name": {
"description": "Name for the SCCP GTT Set, which must be unique within the VSTP site. Valid names are strings between one and 9 characters, inclusive. Valid characters are alphanumeric. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"npsn": {
"description": "GTT set name (Not Present Set Name). This parameter can have Imsi/Msisdn GTT set types. 1 leading alphabetic character and up to 8 following alphanumeric characters.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
}
},
"required": [
"domain",
"name"
],
"type": "object"
}
Example
{
"configurationLevel": "1",
"domain": "Ansi",
"gttSetType": "Cdgta",
"name": "gttset1"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/vstp/gttsets/{name}
get /vstp/gttsets/{name}
Returns the configuration details for the specified GTT Set. If the GTT Set does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/items/gttsetItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/gttset/gttset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"domain": {
"description": "Defines the type of incoming message network domain. This GTTSET MO does not distinguish between ITU national or ITU international.",
"enum": [
"Ansi",
"Itu"
],
"type": "string"
},
"gttSetType": {
"description": "Defines the type of GTT Set.",
"default": "Cdgta",
"enum": [
"Cdgta",
"Cdssn",
"Cggta",
"Cgpc",
"Cgssn",
"Imsi",
"Msisdn",
"Opc",
"Opcode"
],
"type": "string"
},
"name": {
"description": "Name for the SCCP GTT Set, which must be unique within the VSTP site. Valid names are strings between one and 9 characters, inclusive. Valid characters are alphanumeric. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"npsn": {
"description": "GTT set name (Not Present Set Name). This parameter can have Imsi/Msisdn GTT set types. 1 leading alphabetic character and up to 8 following alphanumeric characters.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
}
},
"required": [
"domain",
"name"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"configurationLevel": "1",
"domain": "Ansi",
"gttSetType": "Cdgta",
"name": "gttset1"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /vstp/gttsets/{name}
delete /vstp/gttsets/{name}
Deletes the specified GTT Set from the SOAM configuration. A GTT Set can only be deleted if all delete validation checks pass. If the GTT Set is part of the configuration of one or more GTT Selector (/vstp/gttselector) or Global Title Address (/vstp/globaltitleaddresses) instances, the GTT Set must first be removed from the GTT Selector (/vstp/gttselector) and Global Title Address (/vstp/globaltitleaddresses). An attempt to delete a GTT Set that cannot be deleted results in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Vstp: GTT Action Sets
A GTT Action Set consists of an Action Set name and a group of actions. The specified actions determine what actions are applied to the MSU during translation.
All configuration of GTT Action Sets is done at the SOAM.
/vstp/gttactionsets
get /vstp/gttactionsets
Returns all GTT Action Sets that meet the criteria specified in the GET request. By default, all GTT Action Sets configured at the SOAM are returned. If paging parameters are supplied, only those GTT Action Sets meeting the request parameters are returned.
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/collections/gttactionsetCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/gttactionset/gttactionset.json",
"properties": {
"actsn": {
"description": "GTT Action Set Name. 1 leading alphabetic character and up to 8 following alphanumeric characters.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"actid1": {
"description": "GTT Action ID 1 (/vstp/gttactions). The first action ID associated with the GTT action set. 1 leading alphabetic character and up to 8 following alphanumeric characters.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"actid2": {
"description": "GTT Action ID 2 (/vstp/gttactions). The second action ID associated with the GTT action set. 1 leading alphabetic character and up to 8 following alphanumeric characters.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
}
},
"required": [
"actsn"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"actsn": "actset1",
"actid1": "dup1",
"actid2": "disc1"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /vstp/gttactionsets
Adds a new GTT Action Set to the VSTP configuration. The GTT Action Set name must be unique across all GTT Action Sets at the SOAM.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/gttactionset/gttactionset.json",
"properties": {
"actsn": {
"description": "GTT Action Set Name. 1 leading alphabetic character and up to 8 following alphanumeric characters.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"actid1": {
"description": "GTT Action ID 1 (/vstp/gttactions). The first action ID associated with the GTT action set. 1 leading alphabetic character and up to 8 following alphanumeric characters.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"actid2": {
"description": "GTT Action ID 2 (/vstp/gttactions). The second action ID associated with the GTT action set. 1 leading alphabetic character and up to 8 following alphanumeric characters.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
}
},
"required": [
"actsn"
],
"type": "object"
}
Example
{
"actsn": "actset1",
"actid1": "dup1",
"actid2": "disc1"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/vstp/gttactionsets/{name}
get /vstp/gttactionsets/{name}
Returns the configuration details for the specified GTT Action Set. If the GTT Action Set does not exist in the SOAM configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/items/gttactionsetItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/gttactionset/gttactionset.json",
"properties": {
"actsn": {
"description": "GTT Action Set Name. 1 leading alphabetic character and up to 8 following alphanumeric characters.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"actid1": {
"description": "GTT Action ID 1 (/vstp/gttactions). The first action ID associated with the GTT action set. 1 leading alphabetic character and up to 8 following alphanumeric characters.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"actid2": {
"description": "GTT Action ID 2 (/vstp/gttactions). The second action ID associated with the GTT action set. 1 leading alphabetic character and up to 8 following alphanumeric characters.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
}
},
"required": [
"actsn"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"actsn": "actset1",
"actid1": "dup1",
"actid2": "disc1"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /vstp/gttactionsets/{name}
Updates the configuration of the specified GTT Action Set. If the provided GTT Action Set data is invalid in any way, the update fails, resulting in one or more error messages returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/gttactionset/gttactionset.json",
"properties": {
"actsn": {
"description": "GTT Action Set Name. 1 leading alphabetic character and up to 8 following alphanumeric characters.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"actid1": {
"description": "GTT Action ID 1 (/vstp/gttactions). The first action ID associated with the GTT action set. 1 leading alphabetic character and up to 8 following alphanumeric characters.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
},
"actid2": {
"description": "GTT Action ID 2 (/vstp/gttactions). The second action ID associated with the GTT action set. 1 leading alphabetic character and up to 8 following alphanumeric characters.",
"maxLength": 9,
"pattern": "^[a-zA-Z][a-zA-Z0-9]*$",
"type": "string"
}
},
"required": [
"actsn"
],
"type": "object"
}
Example
{
"actsn": "actset1",
"actid1": "dup1",
"actid2": "disc1"
}
delete /vstp/gttactionsets/{name}
Deletes the specified GTT Action Set from the SOAM configuration. A GTT Action Set can only be deleted if all delete validation checks pass. If the GTT Action Set is part of the configuration of one or more Global Title Address (/vstp/globaltitleaddresses) instances, the GTT Action Set must first be removed from the Global Title Address (/vstp/globaltitleaddresses). An attempt to delete a GTT Action Set that cannot be deleted results in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Vstp: Links
A Link carries signaling within a Linkset (/vstp/linksets) using a specific Connection (/vstp/connections). A Link can belong to only one Linkset and one Connection. If a Link fails, the Signaling Network Interface attempts to divert signaling traffic to another Link in the same Linkset. Links cannot be edited. A Link can be changed only by deleting it and adding the changed Link.
All configuration of the Links is done at the SOAM.
/vstp/links
get /vstp/links
Returns all Links that meet the criteria specified in the GET request. By default, all Links configured at the SOAM are returned. If paging parameters are supplied, only those Links meeting the request parameters are returned.
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (one of configurationLevel)
The field being matched
Only the configurationLevel field is supported.
Example:
filter_name=configurationLevel
- filter_op: (one of GREATER_THAN, GREATER_THAN_EQUAL)
The match operation (operator)
Example:
filter_op=GREATER_THAN
- filter_values: (string)
The matched value
The configurationLevel value by which the data is being filtered. Only a single value is supported.
Example:
filter_values=10
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/collections/linkCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/link/links.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"connectionName": {
"description": "This defines the name of the Connection (/vstp/connections) associated with this Link.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"linksetName": {
"description": "This defines the name of the Linkset (/vstp/linksets) associated with this Link.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"name": {
"description": "Name for this Link, which must be unique within the VSTP site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"signalingLinkCode": {
"description": "Defines the Signaling Link Code (SLC). The SLC must be unique within the Link Set (/vstp/linksets), and it must have the same value at both the VSTP and the distant Node.",
"maximum": 15,
"minimum": 0,
"type": "integer"
}
},
"required": [
"connectionName",
"linksetName",
"name",
"signalingLinkCode"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"configurationLevel": "1",
"connectionName": "Conn1",
"linksetName": "ls1",
"name": "link1",
"signalingLinkCode": 5
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /vstp/links
Adds a new Link to the VSTP configuration. The Link name must be unique across all Links at the SOAM.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/link/links.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"connectionName": {
"description": "This defines the name of the Connection (/vstp/connections) associated with this Link.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"linksetName": {
"description": "This defines the name of the Linkset (/vstp/linksets) associated with this Link.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"name": {
"description": "Name for this Link, which must be unique within the VSTP site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"signalingLinkCode": {
"description": "Defines the Signaling Link Code (SLC). The SLC must be unique within the Link Set (/vstp/linksets), and it must have the same value at both the VSTP and the distant Node.",
"maximum": 15,
"minimum": 0,
"type": "integer"
}
},
"required": [
"connectionName",
"linksetName",
"name",
"signalingLinkCode"
],
"type": "object"
}
Example
{
"configurationLevel": "1",
"connectionName": "Conn1",
"linksetName": "ls1",
"name": "link1",
"signalingLinkCode": 5
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/vstp/links/status
get /vstp/links/status
Returns the status of all Links that meet the criteria specified in the request. This API supports filtering on any single attribute returned in the JSON data (except operationalReason, statusKnown - these attributes cannot be filtered). Non-enumerated string attributes can be filtered using EQUAL, NOT_EQUAL, LIKE, or IN. Enumerated strings and integers can be filtered using EQUAL, NOT_EQUAL, or IN. LIKE is not supported for these data types. Boolean attributes can be filtered using only EQUAL.
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (string)
The attribute name on which filtering occurs. Non-enumerated string attributes can be filtered using EQUAL, NOT_EQUAL, LIKE or IN. Enumerated strings and integers can be filtered using EQUAL, NOT_EQUAL, and IN - LIKE is not supported for these data types.
Example:
filter_name=linksetName
- filter_op: (one of EQUAL, NOT_EQUAL, LIKE, IN)
The filter operator.
Example:
filter_op=EQUAL
- filter_values: (string)
The value being filtered on. When the filter_op is IN, filter_values can be a comma-delimited list of strings or integers. Otherwise, filter_value should be a single value.
Example:
filter_values=link1
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/collections/linkstatusCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/link/linkstatus.json",
"properties": {
"linkAdminState": {
"description": "The administrative state of this Link. A Link in the Disabled state cannot become established; it must first be placed into the Enabled state to bring the Link to the ASP-Active state. It indicates to a Remote Host (/vstp/remotehosts) that VSTP-MP server is active and ready for use.",
"enum": [
"Enabled",
"Disabled"
],
"type": "string"
},
"linksetName": {
"description": "The name of the Linkset (/vstp/linksets) associated with this Link.",
"type": "string"
},
"linkType": {
"description": "This defines the type of link. When set to M3ua, the Link is of type MTP3 User Adaptation Layer. When set to M2pa, the Link is of type MTP2 User Peer-to-Peer Adaptation Layer.",
"enum": [
"M3ua",
"M2pa"
],
"type": "string"
},
"mpServerHostname": {
"description": "mpServerHostname indicates the name of the VSTP-MP server that is currently reporting the status of this Link.",
"type": "string"
},
"name": {
"description": "The configured name of the Link.",
"type": "string"
},
"operationalReason": {
"description": "Information elaborating on the current operationalStatus of the Link.",
"type": "string"
},
"operationalStatus": {
"description": "The current operational state of the Link. While this attribute can have a value of OOS, Alignment, Proving, Ready, Busy, InService, or Retrieval, the operationalReason attribute typically contains additional information elaborating on the reported operationalStatus.",
"enum": [
"OOS",
"Alignment",
"Proving",
"Ready",
"Busy",
"InService",
"Retrieval"
],
"type": "string"
},
"statusKnown": {
"description": "When set to false, current values for the run-time status attributes for this Link are not known by the OAM. This could be due to merge issues within the VSTP, or some other cause preventing the OAM from having a current view of the status of this Connection. If the OAM has current status for this Link, statusKnown is set to true.",
"type": "boolean"
},
"timeOfLastUpdate": {
"description": "The date/time the status for this Link was last updated by the VSTP.",
"pattern": "^[0-9]{4}[-][0-1]{1}[0-9]{1}[-][0-3]{1}[0-9]{1}T[0-2]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}([.][0-9]{1,7})?[+-](?:2[0-3]|[0-1][0-9])[:][0-5][0-9]?$",
"type": "string"
}
},
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"linkAdminState": "Disabled",
"linksetName": "LinkTestLinkset1",
"linkType": "M3ua",
"mpServerHostname": "VSTPMP1",
"name": "LinkTestLink1",
"operationalReason": "Disabled by Application",
"operationalStatus": "OOS",
"statusKnown": true,
"timeOfLastUpdate": "1969-12-31T19:00:00-05:00"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
/vstp/links/{name}
get /vstp/links/{name}
Returns the configuration details for the specified Link. If the Link does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/items/linkItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/link/links.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"connectionName": {
"description": "This defines the name of the Connection (/vstp/connections) associated with this Link.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"linksetName": {
"description": "This defines the name of the Linkset (/vstp/linksets) associated with this Link.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"name": {
"description": "Name for this Link, which must be unique within the VSTP site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"signalingLinkCode": {
"description": "Defines the Signaling Link Code (SLC). The SLC must be unique within the Link Set (/vstp/linksets), and it must have the same value at both the VSTP and the distant Node.",
"maximum": 15,
"minimum": 0,
"type": "integer"
}
},
"required": [
"connectionName",
"linksetName",
"name",
"signalingLinkCode"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"configurationLevel": "1",
"connectionName": "Conn1",
"linksetName": "ls1",
"name": "link1",
"signalingLinkCode": 5
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /vstp/links/{name}
delete /vstp/links/{name}
Deletes the specified Link from the SOAM configuration. A Link can only be deleted if all delete validation checks pass. In general, if the Link is enabled, the Link cannot be deleted. The Link must first be disabled, then it can be deleted from the configuration. An attempt to delete a Link that cannot be deleted results in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
/vstp/links/{name}/status
get /vstp/links/{name}/status
Retrieves the operational status for the specified Link.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/items/linkstatusItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/link/linkstatus.json",
"properties": {
"linkAdminState": {
"description": "The administrative state of this Link. A Link in the Disabled state cannot become established; it must first be placed into the Enabled state to bring the Link to the ASP-Active state. It indicates to a Remote Host (/vstp/remotehosts) that VSTP-MP server is active and ready for use.",
"enum": [
"Enabled",
"Disabled"
],
"type": "string"
},
"linksetName": {
"description": "The name of the Linkset (/vstp/linksets) associated with this Link.",
"type": "string"
},
"linkType": {
"description": "This defines the type of link. When set to M3ua, the Link is of type MTP3 User Adaptation Layer. When set to M2pa, the Link is of type MTP2 User Peer-to-Peer Adaptation Layer.",
"enum": [
"M3ua",
"M2pa"
],
"type": "string"
},
"mpServerHostname": {
"description": "mpServerHostname indicates the name of the VSTP-MP server that is currently reporting the status of this Link.",
"type": "string"
},
"name": {
"description": "The configured name of the Link.",
"type": "string"
},
"operationalReason": {
"description": "Information elaborating on the current operationalStatus of the Link.",
"type": "string"
},
"operationalStatus": {
"description": "The current operational state of the Link. While this attribute can have a value of OOS, Alignment, Proving, Ready, Busy, InService, or Retrieval, the operationalReason attribute typically contains additional information elaborating on the reported operationalStatus.",
"enum": [
"OOS",
"Alignment",
"Proving",
"Ready",
"Busy",
"InService",
"Retrieval"
],
"type": "string"
},
"statusKnown": {
"description": "When set to false, current values for the run-time status attributes for this Link are not known by the OAM. This could be due to merge issues within the VSTP, or some other cause preventing the OAM from having a current view of the status of this Connection. If the OAM has current status for this Link, statusKnown is set to true.",
"type": "boolean"
},
"timeOfLastUpdate": {
"description": "The date/time the status for this Link was last updated by the VSTP.",
"pattern": "^[0-9]{4}[-][0-1]{1}[0-9]{1}[-][0-3]{1}[0-9]{1}T[0-2]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}([.][0-9]{1,7})?[+-](?:2[0-3]|[0-1][0-9])[:][0-5][0-9]?$",
"type": "string"
}
},
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"linkAdminState": "Disabled",
"linksetName": "LinkTestLinkset1",
"linkType": "M3ua",
"mpServerHostname": "VSTPMP1",
"name": "LinkTestLink1",
"operationalReason": "Disabled by Application",
"operationalStatus": "OOS",
"statusKnown": true,
"timeOfLastUpdate": "1969-12-31T19:00:00-05:00"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
/vstp/links/{name}/linkadminstate
get /vstp/links/{name}/linkadminstate
Retrieves the administrative state, which can be either Enabled or Disabled, for the specified Link.
Target server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/items/linkadminstateItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schema/vstp/link/linkadminstate.json",
"properties": {
"adminState": {
"description": "A Link's administrative state can be either Enabled or Disabled. A Link's configuration cannot be modified or deleted if its administrative state is Enabled.",
"enum": [
"Enabled",
"Disabled"
],
"example": "Enabled",
"type": "string"
}
},
"required": ["adminState"],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"adminState": "Enabled"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /vstp/links/{name}/linkadminstate
Updates the administrative state for the specified VSTP Link to either Enabled or Disabled.
A Link's configuration cannot be modified or deleted if its administrative state is Enabled.
Target server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schema/vstp/link/linkadminstate.json",
"properties": {
"adminState": {
"description": "A Link's administrative state can be either Enabled or Disabled. A Link's configuration cannot be modified or deleted if its administrative state is Enabled.",
"enum": [
"Enabled",
"Disabled"
],
"example": "Enabled",
"type": "string"
}
},
"required": ["adminState"],
"type": "object"
}
Example
{
"adminState": "Enabled"
}
Vstp: Link Sets
A Link Set is a logical element representing link attributes assigned to a Link (/vstp/links) and a far-end point assigned to a Route (/vstp/routes).
All configuration of Link Sets is done at the SOAM.
/vstp/linksets
get /vstp/linksets
Returns all Link Sets that meet the criteria specified in the GET request. By default, all Link Sets configured at the SOAM are returned. If paging parameters are supplied, only those Link Sets meeting the request parameters are returned.
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (one of configurationLevel)
The field being matched
Only the configurationLevel field is supported.
Example:
filter_name=configurationLevel
- filter_op: (one of GREATER_THAN, GREATER_THAN_EQUAL)
The match operation (operator)
Example:
filter_op=GREATER_THAN
- filter_values: (string)
The matched value
The configurationLevel value by which the data is being filtered. Only a single value is supported.
Example:
filter_values=10
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/collections/linksetCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/links/linksets.json",
"properties": {
"asNotification": {
"description": "Application Server (AS) notification. Only applies when the adaptor type (type attribute) is set to M3ua. When asNotification is set to true, AS notifications are sent on M3ua linksets. When set to false, AS notifications are not sent. Default is true.",
"type": "boolean"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"enableBroadcastException": {
"description": "When the linkset status changes, the VSTP broadcasts TFP/TFA to adjacent nodes. When enableBroadcastException is set to true, this broadcast is not performed. Typical value is false.",
"type": "boolean"
},
"gttmode": {
"description": "Global title translation mode. The GTT Mode hierarchy for this link set.",
"enum": [
"Cd",
"Fcd",
"Fcg",
"Fcgfcd",
"Fcdfcg",
"Sysdflt"
],
"default": "Sysdflt",
"type": "string"
},
"ituTransferRestricted": {
"description": "ITU TFR (Transfer Restricted) indicator. When set to true, the TFR procedure is turned off for this linkset. ituTransferRestricted only applies to ITU national linksets. Typical value is false.",
"type": "boolean"
},
"linkTransactionsPerSecond": {
"description": "Maximum Link (/vstp/links) transactions per second defined for the links of this Link Set.",
"maximum": 10000,
"minimum": 10,
"type": "integer"
},
"localSignalingPointName": {
"description": "Name of the Local Signaling Point (/vstp/localsignalingpoints) associated with this Link Set.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"name": {
"description": "Name for this Link Set, which must be unique within the VSTP site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"numberSignalingLinkAllowedThreshold": {
"description": "Threshold value for number of Links (/vstp/links) which can be allowed with this Link Set. This is applicable only for M3ua linksets. Default is 1.",
"maximum": 16,
"minimum": 0,
"type": "integer"
},
"numberSignalingLinkProhibitedThreshold": {
"description": "Threshold value for number of Links (/vstp/links) which can be prohibited with this Link Set. This is applicable only for M3ua linksets. Default is 1.",
"maximum": 16,
"minimum": 0,
"type": "integer"
},
"remoteSignalingPointName": {
"description": "Name of the Adjacent Remote Signaling Point (/vstp/remotesignalingpoints) associated with this Link Set.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"routingContext": {
"description": "When the linkset type is M3ua, this value defines the routing context associated with the Link Set.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"type": {
"description": "Type of the VSTP adapter layer.",
"enum": [
"M3ua",
"M2pa"
],
"type": "string"
}
},
"required": [
"localSignalingPointName",
"linkTransactionsPerSecond",
"name",
"remoteSignalingPointName",
"type"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"asNotification": true,
"configurationLevel": "0",
"enableBroadcastException": true,
"gttmode": "Fcd",
"ituTransferRestricted": false,
"linkTransactionsPerSecond": 20,
"localSignalingPointName": "TestItua",
"name": "Test",
"numberSignalingLinkAllowedThreshold": 1,
"numberSignalingLinkProhibitedThreshold": 1,
"remoteSignalingPointName": "gkAnsi",
"routingContext": 8,
"type": "M3ua"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /vstp/linksets
Adds a new Link Set to the VSTP configuration. The Link Set name must be unique across all Link Sets at the SOAM.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/links/linksets.json",
"properties": {
"asNotification": {
"description": "Application Server (AS) notification. Only applies when the adaptor type (type attribute) is set to M3ua. When asNotification is set to true, AS notifications are sent on M3ua linksets. When set to false, AS notifications are not sent. Default is true.",
"type": "boolean"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"enableBroadcastException": {
"description": "When the linkset status changes, the VSTP broadcasts TFP/TFA to adjacent nodes. When enableBroadcastException is set to true, this broadcast is not performed. Typical value is false.",
"type": "boolean"
},
"gttmode": {
"description": "Global title translation mode. The GTT Mode hierarchy for this link set.",
"enum": [
"Cd",
"Fcd",
"Fcg",
"Fcgfcd",
"Fcdfcg",
"Sysdflt"
],
"default": "Sysdflt",
"type": "string"
},
"ituTransferRestricted": {
"description": "ITU TFR (Transfer Restricted) indicator. When set to true, the TFR procedure is turned off for this linkset. ituTransferRestricted only applies to ITU national linksets. Typical value is false.",
"type": "boolean"
},
"linkTransactionsPerSecond": {
"description": "Maximum Link (/vstp/links) transactions per second defined for the links of this Link Set.",
"maximum": 10000,
"minimum": 10,
"type": "integer"
},
"localSignalingPointName": {
"description": "Name of the Local Signaling Point (/vstp/localsignalingpoints) associated with this Link Set.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"name": {
"description": "Name for this Link Set, which must be unique within the VSTP site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"numberSignalingLinkAllowedThreshold": {
"description": "Threshold value for number of Links (/vstp/links) which can be allowed with this Link Set. This is applicable only for M3ua linksets. Default is 1.",
"maximum": 16,
"minimum": 0,
"type": "integer"
},
"numberSignalingLinkProhibitedThreshold": {
"description": "Threshold value for number of Links (/vstp/links) which can be prohibited with this Link Set. This is applicable only for M3ua linksets. Default is 1.",
"maximum": 16,
"minimum": 0,
"type": "integer"
},
"remoteSignalingPointName": {
"description": "Name of the Adjacent Remote Signaling Point (/vstp/remotesignalingpoints) associated with this Link Set.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"routingContext": {
"description": "When the linkset type is M3ua, this value defines the routing context associated with the Link Set.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"type": {
"description": "Type of the VSTP adapter layer.",
"enum": [
"M3ua",
"M2pa"
],
"type": "string"
}
},
"required": [
"localSignalingPointName",
"linkTransactionsPerSecond",
"name",
"remoteSignalingPointName",
"type"
],
"type": "object"
}
Example
{
"asNotification": true,
"configurationLevel": "0",
"enableBroadcastException": true,
"gttmode": "Fcd",
"ituTransferRestricted": false,
"linkTransactionsPerSecond": 20,
"localSignalingPointName": "TestItua",
"name": "Test",
"numberSignalingLinkAllowedThreshold": 1,
"numberSignalingLinkProhibitedThreshold": 1,
"remoteSignalingPointName": "gkAnsi",
"routingContext": 8,
"type": "M3ua"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/vstp/linksets/status
get /vstp/linksets/status
Returns the status of all Link Sets that meet the criteria specified in the request. This API supports filtering on any single attribute returned in the JSON data (except statusKnown - this attribute cannot be filtered). Non-enumerated string attributes can be filtered using EQUAL, NOT_EQUAL, LIKE, or IN. Enumerated strings and integers can be filtered using EQUAL, NOT_EQUAL, or IN. LIKE is not supported for these data types. Boolean attributes can be filtered using only EQUAL.
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (string)
The attribute name on which filtering occurs. Non-enumerated string attributes can be filtered using EQUAL, NOTEQUAL, LIKE, or IN. Enumerated strings and integers can be filtered using EQUAL, NOTEQUAL, and IN - LIKE is not supported for these data types.
Example:
filter_name=name
- filter_op: (one of EQUAL, NOT_EQUAL, LIKE, IN)
The filter operator.
Example:
filter_op=EQUAL
- filter_values: (string)
The value being filtered on. When the filter_op is IN, filter_values can be a comma-delimited list of strings or integers. Otherwise, filter_value should be a single value.
Example:
filter_values=Linkset1
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/collections/linksetstatusCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/links/linksetstatus.json",
"properties": {
"congestionLevel": {
"description": "The congestion level of the Link Set. This is the lowest of the congestion levels of all the Links (/vstp/links) configured in the Link Set.",
"enum": [
"Normal",
"CL1",
"CL2",
"CL3"
],
"type": "string"
},
"mpServerHostname": {
"description": "The name of the VSTP-MP server that is currently reporting the status of the Link Set.",
"type": "string"
},
"name": {
"description": "The configured name of the Link Set.",
"type": "string"
},
"operationalReason": {
"description": "Information elaborating on the current operationalStatus of the Link Set. This attribute can have values of All Links Normal, X of Y Links Normal, or Application Disabled. This value depends on the number of Links (/vstp/links) in the Link Set that are in their normal state and the state of the application on the MP server.",
"type": "string"
},
"operationalStatus": {
"description": "The current operational state of the Link Set. This attribute can have a value of Up or Down. When set to Up, the application is running on an active server and at least one Link (/vstp/links) is up. When set to Down, no Links (/vstp/links) are normal or the application is not running on the MP server.",
"enum": [
"Down",
"Up"
],
"type": "string"
},
"statusKnown": {
"description": "When set to false, it implies that the current values for the run-time status attributes for this Link Set are not known by the OAM. This could be due to merge issues within the VSTP, or some other cause preventing the OAM from having a current view of the status of this Link Set. If the OAM has current status for this Link Set, statusKnown is set to true.",
"type": "boolean"
},
"timeOfLastUpdate": {
"description": "The date/time the operationalStatus for this Link Set was last updated.",
"pattern": "^[0-9]{4}[-][0-1]{1}[0-9]{1}[-][0-3]{1}[0-9]{1}T[0-2]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}([.][0-9]{1,7})?[+-](?:2[0-3]|[0-1][0-9])[:][0-5][0-9]?$",
"type": "string"
}
},
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"congestionLevel": "Normal",
"mpServerHostname": "Mp1",
"name": "LinkTestLinkset1",
"operationalReason": "No Link Defined",
"operationalStatus": "Down",
"statusKnown": true,
"timeOfLastUpdate": "2017-03-06T19:59:09-05:00"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
/vstp/linksets/{name}
get /vstp/linksets/{name}
Returns the configuration details for the specified Link Set. If the Link Set does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/items/linksetItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/links/linksets.json",
"properties": {
"asNotification": {
"description": "Application Server (AS) notification. Only applies when the adaptor type (type attribute) is set to M3ua. When asNotification is set to true, AS notifications are sent on M3ua linksets. When set to false, AS notifications are not sent. Default is true.",
"type": "boolean"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"enableBroadcastException": {
"description": "When the linkset status changes, the VSTP broadcasts TFP/TFA to adjacent nodes. When enableBroadcastException is set to true, this broadcast is not performed. Typical value is false.",
"type": "boolean"
},
"gttmode": {
"description": "Global title translation mode. The GTT Mode hierarchy for this link set.",
"enum": [
"Cd",
"Fcd",
"Fcg",
"Fcgfcd",
"Fcdfcg",
"Sysdflt"
],
"default": "Sysdflt",
"type": "string"
},
"ituTransferRestricted": {
"description": "ITU TFR (Transfer Restricted) indicator. When set to true, the TFR procedure is turned off for this linkset. ituTransferRestricted only applies to ITU national linksets. Typical value is false.",
"type": "boolean"
},
"linkTransactionsPerSecond": {
"description": "Maximum Link (/vstp/links) transactions per second defined for the links of this Link Set.",
"maximum": 10000,
"minimum": 10,
"type": "integer"
},
"localSignalingPointName": {
"description": "Name of the Local Signaling Point (/vstp/localsignalingpoints) associated with this Link Set.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"name": {
"description": "Name for this Link Set, which must be unique within the VSTP site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"numberSignalingLinkAllowedThreshold": {
"description": "Threshold value for number of Links (/vstp/links) which can be allowed with this Link Set. This is applicable only for M3ua linksets. Default is 1.",
"maximum": 16,
"minimum": 0,
"type": "integer"
},
"numberSignalingLinkProhibitedThreshold": {
"description": "Threshold value for number of Links (/vstp/links) which can be prohibited with this Link Set. This is applicable only for M3ua linksets. Default is 1.",
"maximum": 16,
"minimum": 0,
"type": "integer"
},
"remoteSignalingPointName": {
"description": "Name of the Adjacent Remote Signaling Point (/vstp/remotesignalingpoints) associated with this Link Set.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"routingContext": {
"description": "When the linkset type is M3ua, this value defines the routing context associated with the Link Set.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"type": {
"description": "Type of the VSTP adapter layer.",
"enum": [
"M3ua",
"M2pa"
],
"type": "string"
}
},
"required": [
"localSignalingPointName",
"linkTransactionsPerSecond",
"name",
"remoteSignalingPointName",
"type"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"asNotification": true,
"configurationLevel": "0",
"enableBroadcastException": true,
"gttmode": "Fcd",
"ituTransferRestricted": false,
"linkTransactionsPerSecond": 20,
"localSignalingPointName": "TestItua",
"name": "Test",
"numberSignalingLinkAllowedThreshold": 1,
"numberSignalingLinkProhibitedThreshold": 1,
"remoteSignalingPointName": "gkAnsi",
"routingContext": 8,
"type": "M3ua"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /vstp/linksets/{name}
Updates the configuration of the specified Link Set. If the provided Link Set data is invalid in any way, the update fails, resulting in one or more error messages returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/links/linksets.json",
"properties": {
"asNotification": {
"description": "Application Server (AS) notification. Only applies when the adaptor type (type attribute) is set to M3ua. When asNotification is set to true, AS notifications are sent on M3ua linksets. When set to false, AS notifications are not sent. Default is true.",
"type": "boolean"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"enableBroadcastException": {
"description": "When the linkset status changes, the VSTP broadcasts TFP/TFA to adjacent nodes. When enableBroadcastException is set to true, this broadcast is not performed. Typical value is false.",
"type": "boolean"
},
"gttmode": {
"description": "Global title translation mode. The GTT Mode hierarchy for this link set.",
"enum": [
"Cd",
"Fcd",
"Fcg",
"Fcgfcd",
"Fcdfcg",
"Sysdflt"
],
"default": "Sysdflt",
"type": "string"
},
"ituTransferRestricted": {
"description": "ITU TFR (Transfer Restricted) indicator. When set to true, the TFR procedure is turned off for this linkset. ituTransferRestricted only applies to ITU national linksets. Typical value is false.",
"type": "boolean"
},
"linkTransactionsPerSecond": {
"description": "Maximum Link (/vstp/links) transactions per second defined for the links of this Link Set.",
"maximum": 10000,
"minimum": 10,
"type": "integer"
},
"localSignalingPointName": {
"description": "Name of the Local Signaling Point (/vstp/localsignalingpoints) associated with this Link Set.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"name": {
"description": "Name for this Link Set, which must be unique within the VSTP site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"numberSignalingLinkAllowedThreshold": {
"description": "Threshold value for number of Links (/vstp/links) which can be allowed with this Link Set. This is applicable only for M3ua linksets. Default is 1.",
"maximum": 16,
"minimum": 0,
"type": "integer"
},
"numberSignalingLinkProhibitedThreshold": {
"description": "Threshold value for number of Links (/vstp/links) which can be prohibited with this Link Set. This is applicable only for M3ua linksets. Default is 1.",
"maximum": 16,
"minimum": 0,
"type": "integer"
},
"remoteSignalingPointName": {
"description": "Name of the Adjacent Remote Signaling Point (/vstp/remotesignalingpoints) associated with this Link Set.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"routingContext": {
"description": "When the linkset type is M3ua, this value defines the routing context associated with the Link Set.",
"maximum": 4294967295,
"minimum": 0,
"type": "integer"
},
"type": {
"description": "Type of the VSTP adapter layer.",
"enum": [
"M3ua",
"M2pa"
],
"type": "string"
}
},
"required": [
"localSignalingPointName",
"linkTransactionsPerSecond",
"name",
"remoteSignalingPointName",
"type"
],
"type": "object"
}
Example
{
"asNotification": true,
"configurationLevel": "0",
"enableBroadcastException": true,
"gttmode": "Fcd",
"ituTransferRestricted": false,
"linkTransactionsPerSecond": 20,
"localSignalingPointName": "TestItua",
"name": "Test",
"numberSignalingLinkAllowedThreshold": 1,
"numberSignalingLinkProhibitedThreshold": 1,
"remoteSignalingPointName": "gkAnsi",
"routingContext": 8,
"type": "M3ua"
}
delete /vstp/linksets/{name}
Deletes the specified Link Set from the SOAM configuration. A Link Set can only be deleted if all delete validation checks pass. If the Link Set is part of the configuration of one or more Links (/vstp/links), the Link Set must first be removed from the Link (/vstp/links). An attempt to delete a Link Set that cannot be deleted results in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
/vstp/linksets/{name}/status
get /vstp/linksets/{name}/status
Retrieves the operational status for the specified Link Set.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/collections/linksetstatusCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/links/linksetstatus.json",
"properties": {
"congestionLevel": {
"description": "The congestion level of the Link Set. This is the lowest of the congestion levels of all the Links (/vstp/links) configured in the Link Set.",
"enum": [
"Normal",
"CL1",
"CL2",
"CL3"
],
"type": "string"
},
"mpServerHostname": {
"description": "The name of the VSTP-MP server that is currently reporting the status of the Link Set.",
"type": "string"
},
"name": {
"description": "The configured name of the Link Set.",
"type": "string"
},
"operationalReason": {
"description": "Information elaborating on the current operationalStatus of the Link Set. This attribute can have values of All Links Normal, X of Y Links Normal, or Application Disabled. This value depends on the number of Links (/vstp/links) in the Link Set that are in their normal state and the state of the application on the MP server.",
"type": "string"
},
"operationalStatus": {
"description": "The current operational state of the Link Set. This attribute can have a value of Up or Down. When set to Up, the application is running on an active server and at least one Link (/vstp/links) is up. When set to Down, no Links (/vstp/links) are normal or the application is not running on the MP server.",
"enum": [
"Down",
"Up"
],
"type": "string"
},
"statusKnown": {
"description": "When set to false, it implies that the current values for the run-time status attributes for this Link Set are not known by the OAM. This could be due to merge issues within the VSTP, or some other cause preventing the OAM from having a current view of the status of this Link Set. If the OAM has current status for this Link Set, statusKnown is set to true.",
"type": "boolean"
},
"timeOfLastUpdate": {
"description": "The date/time the operationalStatus for this Link Set was last updated.",
"pattern": "^[0-9]{4}[-][0-1]{1}[0-9]{1}[-][0-3]{1}[0-9]{1}T[0-2]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}([.][0-9]{1,7})?[+-](?:2[0-3]|[0-1][0-9])[:][0-5][0-9]?$",
"type": "string"
}
},
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"congestionLevel": "Normal",
"mpServerHostname": "Mp1",
"name": "LinkTestLinkset1",
"operationalReason": "No Link Defined",
"operationalStatus": "Down",
"statusKnown": true,
"timeOfLastUpdate": "2017-03-06T19:59:09-05:00"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
Vstp: Local Hosts
A Local Host is the VSTP's logical representation of a local node, accessible over one or more transport connections, with which the VSTP can transact VSTP messages. The Local Host managed object encapsulates all the characteristics of the local node that the VSTP must know about in order to communicate successfully with it.
All Local Host configuration is done at the SOAM.
/vstp/localhosts
get /vstp/localhosts
Returns all Local Hosts that meet the criteria specified in the GET request. By default, all Local Hosts configured at the SOAM are returned. If paging parameters are supplied, only those Local Hosts meeting the request parameters are returned.
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (one of configurationLevel)
The field being matched
Only the configurationLevel field is supported.
Example:
filter_name=configurationLevel
- filter_op: (one of GREATER_THAN, GREATER_THAN_EQUAL)
The match operation (operator)
Example:
filter_op=GREATER_THAN
- filter_values: (string)
The matched value
The configurationLevel value by which the data is being filtered. Only a single value is supported.
Example:
filter_values=10
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/collections/localhostCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/localhost/localhost.json",
"properties": {
"localHostName": {
"description": "Name for the Local Host, which must be unique within the VSTP site. A name is required, and cannot be changed after the Peer Node is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"localHostPort": {
"description": "Listen Port number of this Local Host. This is mandatory attribute for local host.",
"maximum": 65535,
"minimum": 1024,
"type": "integer"
},
"localHostPriIPAddress": {
"description": "Primary IP address of this Local Host. Each value provided must be a valid IPv4 or IPv6 address. This is mandatory attribute for local host.",
"maximum": 39,
"minimum": 3,
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"localHostSecIPAddress": {
"description": "Secondary IP address of this Local Host. Each value provided must be a valid IPv4 or IPv6 address. This is optional.",
"maximum": 39,
"minimum": 3,
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
}
},
"required": [
"localHostName",
"localHostPort",
"localHostPriIPAddress"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"configurationLevel": "0",
"localHostName": "LocalHost1",
"localHostPort": 2346,
"localHostPriIPAddress": "10.10.1.10",
"localHostSecIPAddress": "10.10.1.11",
"localHostType": "Local"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /vstp/localhosts
Adds a new Local Host to the VSTP configuration. The new Local Host must have a name that is unique across all Local Hosts at the SOAM. In addition, the Local Host's IP Port combination must also be unique across all Local Hosts configured at the SOAM.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/localhost/localhost.json",
"properties": {
"localHostName": {
"description": "Name for the Local Host, which must be unique within the VSTP site. A name is required, and cannot be changed after the Peer Node is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"localHostPort": {
"description": "Listen Port number of this Local Host. This is mandatory attribute for local host.",
"maximum": 65535,
"minimum": 1024,
"type": "integer"
},
"localHostPriIPAddress": {
"description": "Primary IP address of this Local Host. Each value provided must be a valid IPv4 or IPv6 address. This is mandatory attribute for local host.",
"maximum": 39,
"minimum": 3,
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"localHostSecIPAddress": {
"description": "Secondary IP address of this Local Host. Each value provided must be a valid IPv4 or IPv6 address. This is optional.",
"maximum": 39,
"minimum": 3,
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
}
},
"required": [
"localHostName",
"localHostPort",
"localHostPriIPAddress"
],
"type": "object"
}
Example
{
"configurationLevel": "0",
"localHostName": "LocalHost1",
"localHostPort": 2346,
"localHostPriIPAddress": "10.10.1.10",
"localHostSecIPAddress": "10.10.1.11",
"localHostType": "Local"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/vstp/localhosts/{name}
get /vstp/localhosts/{name}
Returns the configuration details for the specified Local Host. If the specified Local Host does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/items/localhostItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/localhost/localhost.json",
"properties": {
"localHostName": {
"description": "Name for the Local Host, which must be unique within the VSTP site. A name is required, and cannot be changed after the Peer Node is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"localHostPort": {
"description": "Listen Port number of this Local Host. This is mandatory attribute for local host.",
"maximum": 65535,
"minimum": 1024,
"type": "integer"
},
"localHostPriIPAddress": {
"description": "Primary IP address of this Local Host. Each value provided must be a valid IPv4 or IPv6 address. This is mandatory attribute for local host.",
"maximum": 39,
"minimum": 3,
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"localHostSecIPAddress": {
"description": "Secondary IP address of this Local Host. Each value provided must be a valid IPv4 or IPv6 address. This is optional.",
"maximum": 39,
"minimum": 3,
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
}
},
"required": [
"localHostName",
"localHostPort",
"localHostPriIPAddress"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"configurationLevel": "0",
"localHostName": "LocalHost1",
"localHostPort": 2346,
"localHostPriIPAddress": "10.10.1.10",
"localHostSecIPAddress": "10.10.1.11",
"localHostType": "Local"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /vstp/localhosts/{name}
Updates the configuration for the specified Local Host. If the provided Local Host data is invalid in any way, the update fails, resulting in one or more error messages returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/localhost/localhost.json",
"properties": {
"localHostName": {
"description": "Name for the Local Host, which must be unique within the VSTP site. A name is required, and cannot be changed after the Peer Node is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"localHostPort": {
"description": "Listen Port number of this Local Host. This is mandatory attribute for local host.",
"maximum": 65535,
"minimum": 1024,
"type": "integer"
},
"localHostPriIPAddress": {
"description": "Primary IP address of this Local Host. Each value provided must be a valid IPv4 or IPv6 address. This is mandatory attribute for local host.",
"maximum": 39,
"minimum": 3,
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"localHostSecIPAddress": {
"description": "Secondary IP address of this Local Host. Each value provided must be a valid IPv4 or IPv6 address. This is optional.",
"maximum": 39,
"minimum": 3,
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
}
},
"required": [
"localHostName",
"localHostPort",
"localHostPriIPAddress"
],
"type": "object"
}
Example
{
"configurationLevel": "0",
"localHostName": "LocalHost1",
"localHostPort": 2346,
"localHostPriIPAddress": "10.10.1.10",
"localHostSecIPAddress": "10.10.1.11",
"localHostType": "Local"
}
delete /vstp/localhosts/{name}
Deletes the specified Local Host from the SOAM configuration. A Local Host is only deleted if all delete validation checks pass. In general, if the Local Host is part of the configuration of some other resource instance, the Local Host cannot be deleted. For example, if the Local Host is named in a Connection (/vstp/connections), the Local Host must first be removed from the Connection. Then the Local Host can be deleted from the configuration. An attempt to delete a Local Host that cannot be deleted results in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Vstp: Local Signaling Points
A Signaling Point is a set of signaling equipment represented by a unique point code within an SS7 domain. A Local Signaling Point (LSP) is a logical element representing an SS7 Signaling Point assigned to an MP Server Group. An LSP has an SS7 domain and a true point code. The LSP may optionally be assigned up to two Capability Point Codes (CPCs), which are point codes that can be shared with other LSPs.
All configuration of Local Signaling Points is done at the SOAM.
/vstp/localsignalingpoints
get /vstp/localsignalingpoints
Returns all Local Signaling Points that meet the criteria specified in the GET request. By default, all Local Signaling Points configured at the SOAM are returned. If paging parameters are supplied, only those Local Signaling Points meeting the request parameters are returned.
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (one of configurationLevel)
The field being matched
Only the configurationLevel field is supported.
Example:
filter_name=configurationLevel
- filter_op: (one of GREATER_THAN, GREATER_THAN_EQUAL)
The match operation (operator)
Example:
filter_op=GREATER_THAN
- filter_values: (string)
The matched value
The configurationLevel value by which the data is being filtered. Only a single value is supported.
Example:
filter_values=10
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/collections/localsignalingpointCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/localsignalingpoint/localsignalingpoint.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"mtpTruePointCode": {
"description": "The MTP Point Code that identifies this LSP. Only one LSP can have this MTP True Point Code.",
"maxLength": 12,
"pattern": "^([0-9]+-)*[0-9]+$",
"type": "string"
},
"mtpPrimaryCapabilityPointCode": {
"description": "The MTP Capability Point Code if this LSP shares a Point Code with one or more other LSPs. The mtpPrimaryCapabilityPointCode value cannot duplicate any MTP True Point Code present in the configuration.",
"pattern": "^([0-9]+-)*[0-9]*$",
"type": "string"
},
"name": {
"description": "The name of the Local Signaling Point, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"ss7DomainType": {
"description": "This defines the type of SS7 domain.",
"enum": [
"Ansi",
"Itui",
"Itun",
"Itun24"
],
"type": "string"
}
},
"required": [
"mtpTruePointCode",
"name",
"ss7DomainType"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"configurationLevel": "0",
"mtpTruePointCode": "1-1-1",
"mtpPrimaryCapabilityPointCode": "2-2-2",
"name": "LSP1",
"ss7DomainType": "Ansi"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /vstp/localsignalingpoints
Adds a new Local Signaling Point to the VSTP configuration. The Local Signaling Point name must be unique across all Local Signaling Points at the SOAM.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/localsignalingpoint/localsignalingpoint.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"mtpTruePointCode": {
"description": "The MTP Point Code that identifies this LSP. Only one LSP can have this MTP True Point Code.",
"maxLength": 12,
"pattern": "^([0-9]+-)*[0-9]+$",
"type": "string"
},
"mtpPrimaryCapabilityPointCode": {
"description": "The MTP Capability Point Code if this LSP shares a Point Code with one or more other LSPs. The mtpPrimaryCapabilityPointCode value cannot duplicate any MTP True Point Code present in the configuration.",
"pattern": "^([0-9]+-)*[0-9]*$",
"type": "string"
},
"name": {
"description": "The name of the Local Signaling Point, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"ss7DomainType": {
"description": "This defines the type of SS7 domain.",
"enum": [
"Ansi",
"Itui",
"Itun",
"Itun24"
],
"type": "string"
}
},
"required": [
"mtpTruePointCode",
"name",
"ss7DomainType"
],
"type": "object"
}
Example
{
"configurationLevel": "0",
"mtpTruePointCode": "1-1-1",
"mtpPrimaryCapabilityPointCode": "2-2-2",
"name": "LSP1",
"ss7DomainType": "Ansi"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/vstp/localsignalingpoints/{name}
get /vstp/localsignalingpoints/{name}
Returns the configuration details for the specified Local Signaling Point. If the Local Signaling Point does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/items/localsignalingpointItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/localsignalingpoint/localsignalingpoint.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"mtpTruePointCode": {
"description": "The MTP Point Code that identifies this LSP. Only one LSP can have this MTP True Point Code.",
"maxLength": 12,
"pattern": "^([0-9]+-)*[0-9]+$",
"type": "string"
},
"mtpPrimaryCapabilityPointCode": {
"description": "The MTP Capability Point Code if this LSP shares a Point Code with one or more other LSPs. The mtpPrimaryCapabilityPointCode value cannot duplicate any MTP True Point Code present in the configuration.",
"pattern": "^([0-9]+-)*[0-9]*$",
"type": "string"
},
"name": {
"description": "The name of the Local Signaling Point, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"ss7DomainType": {
"description": "This defines the type of SS7 domain.",
"enum": [
"Ansi",
"Itui",
"Itun",
"Itun24"
],
"type": "string"
}
},
"required": [
"mtpTruePointCode",
"name",
"ss7DomainType"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"configurationLevel": "0",
"mtpTruePointCode": "1-1-1",
"mtpPrimaryCapabilityPointCode": "2-2-2",
"name": "LSP1",
"ss7DomainType": "Ansi"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /vstp/localsignalingpoints/{name}
Updates the configuration of the specified Local Signaling Point. If the provided Local Signaling Point data is invalid in any way, the update fails, resulting in one or more error messages returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/localsignalingpoint/localsignalingpoint.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"mtpTruePointCode": {
"description": "The MTP Point Code that identifies this LSP. Only one LSP can have this MTP True Point Code.",
"maxLength": 12,
"pattern": "^([0-9]+-)*[0-9]+$",
"type": "string"
},
"mtpPrimaryCapabilityPointCode": {
"description": "The MTP Capability Point Code if this LSP shares a Point Code with one or more other LSPs. The mtpPrimaryCapabilityPointCode value cannot duplicate any MTP True Point Code present in the configuration.",
"pattern": "^([0-9]+-)*[0-9]*$",
"type": "string"
},
"name": {
"description": "The name of the Local Signaling Point, which must be unique within the DSR site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"ss7DomainType": {
"description": "This defines the type of SS7 domain.",
"enum": [
"Ansi",
"Itui",
"Itun",
"Itun24"
],
"type": "string"
}
},
"required": [
"mtpTruePointCode",
"name",
"ss7DomainType"
],
"type": "object"
}
Example
{
"configurationLevel": "0",
"mtpTruePointCode": "1-1-1",
"mtpPrimaryCapabilityPointCode": "2-2-2",
"name": "LSP1",
"ss7DomainType": "Ansi"
}
delete /vstp/localsignalingpoints/{name}
Deletes the specified Local Signaling Point from the SOAM configuration. A Local Signaling Point can only be deleted if all delete validation checks pass. If the Local Signaling Point is part of the configuration of one or more Linksets (/vstp/linksets), the Local Signaling Point must first be removed from the Linkset (/vstp/linksets). An attempt to delete a Local Signaling Point that cannot be deleted results in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Vstp: M2PA Options
The Message Transfer Part 2 (MTP2) - User Peer-to-Peer Adaptation Layer (M2PA) Options are those configuration values that govern the overall M2PA functionality. There is a single instance of this resource, which contains each of the individual options that can be retrieved and set. Because there is no collection of instances, there is no collection GET action. No new M2PA Options resource can be created, so there is no POST action, and the single instance cannot be removed, so there is no DELETE action. The single instance GET is used to retrieve the options, and PUT is used to update one or more values within the set of options. A name for this single, non-deletable instance is neither required nor expected.
All M2PA Options configuration is done at the SOAM.
/vstp/m2paoptions
get /vstp/m2paoptions
Returns the set of current values for the M2PA Options.
Target Server: SOAM
Response
HTTP status code 200
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/items/m2paoptionItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/m2paoption/m2paoption.json",
"properties": {
"t1Timer": {
"description": "Ready timer. The amount of time (in milliseconds) M2PA waits to receive a Link Status Ready message from the peer. Typical value is 10000.",
"maximum": 350000,
"minimum": 1000,
"type": "integer"
},
"t2Timer": {
"description": "Alignment timer. The amount of time (in milliseconds) M2PA waits to receive Link Status Alignment message from the peer. Typical value is 10000.",
"maximum": 150000,
"minimum": 5000,
"type": "integer"
},
"t3Timer": {
"description": "Proving timer. The amount of time (in milliseconds) M2PA waits to receive Link Status Proving message from the peer. Typical value is 2000.",
"maximum": 60000,
"minimum": 1000,
"type": "integer"
},
"t4EmergencyTimer": {
"description": "Emergency proving timer. The amount of time (in milliseconds) M2PA sends Link Status Proving messages during emergency proving. Typical value is 500.",
"maximum": 5000,
"minimum": 400,
"type": "integer"
},
"t4NormalTimer": {
"description": "Normal proving timer. The amount of time (in milliseconds) M2PA sends Link Status Proving messages during normal proving. Typical value is 10000.",
"maximum": 70000,
"minimum": 1000,
"type": "integer"
},
"t5Timer": {
"description": "Busy rate timer. The amount of time (in milliseconds) between sending Link Status Busy messages while the link is in service. Typical value is 100.",
"maximum": 10000,
"minimum": 100,
"type": "integer"
},
"t6Timer": {
"description": "Remote congestion timer. The amount of time (in milliseconds) that a congested link will remain in service. Typical value is 3000.",
"maximum": 6000,
"minimum": 1000,
"type": "integer"
},
"t7Timer": {
"description": "Excessive acknowledgement delay timer. The amount of time (in milliseconds) for which M2PA waits between transmission of a user data message and receipt of an acknowledgement for that message from the peer. If this timer expires, the link is taken out of service. Typical value is 1200.",
"maximum": 2000,
"minimum": 200,
"type": "integer"
},
"t16Timer": {
"description": "Proving rate timer. The amount of time (in microseconds) for which M2PA waits before sending another Link Status Proving messages to the peer and prior to expiration of t4EmergencyTimer or t4NormalTimer. Typical value is 200000.",
"maximum": 500000,
"minimum": 100,
"type": "integer"
},
"t17Timer": {
"description": "Ready rate timer. The amount of time (in milliseconds) for which M2PA waits between transmission of two consecutive Link Status Ready messages and prior to expiration of t1Timer. Typical value is 250.",
"maximum": 500,
"minimum": 100,
"type": "integer"
}
},
"required": [
"t1Timer",
"t2Timer",
"t3Timer",
"t4EmergencyTimer",
"t4NormalTimer",
"t5Timer",
"t6Timer",
"t7Timer",
"t16Timer",
"t17Timer"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"t1Timer": 1000,
"t2Timer": 5500,
"t3Timer": 1100,
"t4EmergencyTimer": 500,
"t4Timer": 1200,
"t5Timer": 300,
"t6Timer": 1400,
"t7Timer": 1500,
"t16Timer": 400,
"t17Timer": 200
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
put /vstp/m2paoptions
Update the M2PA Options with the values supplied. To update just one of the individual options, GET the set, modify the value for the option that needs to be changed, then PUT the options.
Target Server: SOAM
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/m2paoption/m2paoption.json",
"properties": {
"t1Timer": {
"description": "Ready timer. The amount of time (in milliseconds) M2PA waits to receive a Link Status Ready message from the peer. Typical value is 10000.",
"maximum": 350000,
"minimum": 1000,
"type": "integer"
},
"t2Timer": {
"description": "Alignment timer. The amount of time (in milliseconds) M2PA waits to receive Link Status Alignment message from the peer. Typical value is 10000.",
"maximum": 150000,
"minimum": 5000,
"type": "integer"
},
"t3Timer": {
"description": "Proving timer. The amount of time (in milliseconds) M2PA waits to receive Link Status Proving message from the peer. Typical value is 2000.",
"maximum": 60000,
"minimum": 1000,
"type": "integer"
},
"t4EmergencyTimer": {
"description": "Emergency proving timer. The amount of time (in milliseconds) M2PA sends Link Status Proving messages during emergency proving. Typical value is 500.",
"maximum": 5000,
"minimum": 400,
"type": "integer"
},
"t4NormalTimer": {
"description": "Normal proving timer. The amount of time (in milliseconds) M2PA sends Link Status Proving messages during normal proving. Typical value is 10000.",
"maximum": 70000,
"minimum": 1000,
"type": "integer"
},
"t5Timer": {
"description": "Busy rate timer. The amount of time (in milliseconds) between sending Link Status Busy messages while the link is in service. Typical value is 100.",
"maximum": 10000,
"minimum": 100,
"type": "integer"
},
"t6Timer": {
"description": "Remote congestion timer. The amount of time (in milliseconds) that a congested link will remain in service. Typical value is 3000.",
"maximum": 6000,
"minimum": 1000,
"type": "integer"
},
"t7Timer": {
"description": "Excessive acknowledgement delay timer. The amount of time (in milliseconds) for which M2PA waits between transmission of a user data message and receipt of an acknowledgement for that message from the peer. If this timer expires, the link is taken out of service. Typical value is 1200.",
"maximum": 2000,
"minimum": 200,
"type": "integer"
},
"t16Timer": {
"description": "Proving rate timer. The amount of time (in microseconds) for which M2PA waits before sending another Link Status Proving messages to the peer and prior to expiration of t4EmergencyTimer or t4NormalTimer. Typical value is 200000.",
"maximum": 500000,
"minimum": 100,
"type": "integer"
},
"t17Timer": {
"description": "Ready rate timer. The amount of time (in milliseconds) for which M2PA waits between transmission of two consecutive Link Status Ready messages and prior to expiration of t1Timer. Typical value is 250.",
"maximum": 500,
"minimum": 100,
"type": "integer"
}
},
"required": [
"t1Timer",
"t2Timer",
"t3Timer",
"t4EmergencyTimer",
"t4NormalTimer",
"t5Timer",
"t6Timer",
"t7Timer",
"t16Timer",
"t17Timer"
],
"type": "object"
}
Example
{
"t1Timer": 1000,
"t2Timer": 5500,
"t3Timer": 1100,
"t4EmergencyTimer": 500,
"t4Timer": 1200,
"t5Timer": 300,
"t6Timer": 1400,
"t7Timer": 1500,
"t16Timer": 400,
"t17Timer": 200
}
Vstp: MTP3 Options
The Message Transfer Part level 3 (MTP3) Options are configuration values that govern the overall MTP3 functionality. There is a single instance of this resource, which contains each of the individual options that can be retrieved and set. The single instance GET is used to retrieve the options, and PUT is used to update one or more values within the set of options. A name for this single, non-deletable instance is neither required nor expected. Because there is no collection of instances, there is no collection GET action. No new MTP3 Options resource can be created, so there is no POST action, and the single instance cannot be removed, so there is no DELETE action.
All MTP3 Options configuration is done at the SOAM.
/vstp/m3rloptions
get /vstp/m3rloptions
Returns the set of current values for the MTP3 Options.
Target Server: SOAM
Response
HTTP status code 200
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/items/m3rloptionItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/m3rloption/m3rloption.json",
"properties": {
"lsOnHoldTimer": {
"description": "Link addition/deletion changeover timer duration. This timer introduces a delay to help prevent message mis-sequencing on link add/deletion. Typical value is 60.",
"type": "integer",
"minimum": 10,
"maximum": 2000
},
"sltT1Timer": {
"description": "Supervision timer for signaling link test acknowledgement message. Typical value is 12000.",
"type": "integer",
"minimum": 4000,
"maximum": 12000
},
"sltT2Timer": {
"description": "Interval timer for sending signaling link test messages. Typical value is 30000.",
"type": "integer",
"minimum": 30000,
"maximum": 90000
},
"slsRotation": {
"description": "This parameter specifies whether the signaling link selector (SLS) of the incoming ANSI linkset is rotated before routing the messages to network. When set to true, 8 bit SLS of the incoming linkset is considered for bit rotation.",
"type": "boolean"
},
"t10Timer": {
"description": "Timer 10 - Wait to repeat signaling route set test (SRST) message. Typical value is 30000.",
"type": "integer",
"minimum": 20000,
"maximum": 90000
},
"t11Timer": {
"description": "Timer 11 - Transfer restricted; in milliseconds. Typical value is 30000.",
"type": "integer",
"minimum": 1000,
"maximum": 90000
},
"t15Timer": {
"description": "Timer 15 - Wait for repeat route set congestion test (RSCT). Typical value is 3000.",
"type": "integer",
"minimum": 200,
"maximum": 4000
},
"t16Timer": {
"description": "Timer 16 - Wait for route set congestion test (RSCT) updates. Typical value is 1400.",
"type": "integer",
"minimum": 200,
"maximum": 3000
},
"t17Timer": {
"description": "Timer 17 - Delay to avoid oscillation of initial alignment failure. Typical value is 2000.",
"type": "integer",
"minimum": 500,
"maximum": 2000
},
"t18Timer": {
"description": "Timer 18 - Repeat transfer restricted (TFR) once by response method. Typical value is 10000.",
"type": "integer",
"minimum": 2000,
"maximum": 20000
},
"t1Timer": {
"description": "Timer 1 - Changeover delay. Also used as isolation timer for ITU MTP Restart. Typical value is 800.",
"type": "integer",
"minimum": 100,
"maximum": 2000
},
"t2Timer": {
"description": "Timer 2 - Wait for changeover acknowledgement (COA). Typical value is 1400.",
"type": "integer",
"minimum": 100,
"maximum": 3000
},
"t3Timer": {
"description": "Timer 3 - Time controlled diversion on changeback. Typical value is 800.",
"type": "integer",
"minimum": 100,
"maximum": 2000
},
"t4Timer": {
"description": "Timer 4 - Wait for changeback acknowledgement (CBA) #1. Typical value is 800.",
"type": "integer",
"minimum": 100,
"maximum": 2000
},
"t5Timer": {
"description": "Timer 5 - Wait for changeback acknowledgement (CBA) #2. Typical value is 800.",
"type": "integer",
"minimum": 100,
"maximum": 2000
},
"t6Timer": {
"description": "Timer 6 - Controlled reroute. Typical value is 800.",
"type": "integer",
"minimum": 100,
"maximum": 2000
},
"t8Timer": {
"description": "Timer 8 - Transfer prohibited (TFP) inhibit. Typical value is 800.",
"type": "integer",
"minimum": 500,
"maximum": 2000
}
},
"required": [
"lsOnHoldTimer",
"sltT1Timer",
"sltT2Timer",
"slsRotation",
"t10Timer",
"t11Timer",
"t15Timer",
"t16Timer",
"t17Timer",
"t18Timer",
"t1Timer",
"t2Timer",
"t3Timer",
"t4Timer",
"t5Timer",
"t6Timer",
"t8Timer"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"OnHoldTimer": 200,
"sltT1Timer": 8000,
"sltT2Timer": 35000,
"slsRotation": false,
"t10Timer": 25000,
"t11Timer": 3000,
"t15Timer": 600,
"t16Timer": 800,
"t17Timer": 800,
"t18Timer": 3000,
"t1Timer": 800,
"t2Timer": 800,
"t3Timer": 800,
"t4Timer": 600,
"t5Timer": 600,
"t6Timer": 800,
"t8Timer": 800
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
put /vstp/m3rloptions
Update the MTP3 Options with the values supplied. To update just one of the individual options, GET the set, modify the value for the option that needs to be changed, and PUT the options.
Target Server: SOAM
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/m3rloption/m3rloption.json",
"properties": {
"lsOnHoldTimer": {
"description": "Link addition/deletion changeover timer duration. This timer introduces a delay to help prevent message mis-sequencing on link add/deletion. Typical value is 60.",
"type": "integer",
"minimum": 10,
"maximum": 2000
},
"sltT1Timer": {
"description": "Supervision timer for signaling link test acknowledgement message. Typical value is 12000.",
"type": "integer",
"minimum": 4000,
"maximum": 12000
},
"sltT2Timer": {
"description": "Interval timer for sending signaling link test messages. Typical value is 30000.",
"type": "integer",
"minimum": 30000,
"maximum": 90000
},
"slsRotation": {
"description": "This parameter specifies whether the signaling link selector (SLS) of the incoming ANSI linkset is rotated before routing the messages to network. When set to true, 8 bit SLS of the incoming linkset is considered for bit rotation.",
"type": "boolean"
},
"t10Timer": {
"description": "Timer 10 - Wait to repeat signaling route set test (SRST) message. Typical value is 30000.",
"type": "integer",
"minimum": 20000,
"maximum": 90000
},
"t11Timer": {
"description": "Timer 11 - Transfer restricted; in milliseconds. Typical value is 30000.",
"type": "integer",
"minimum": 1000,
"maximum": 90000
},
"t15Timer": {
"description": "Timer 15 - Wait for repeat route set congestion test (RSCT). Typical value is 3000.",
"type": "integer",
"minimum": 200,
"maximum": 4000
},
"t16Timer": {
"description": "Timer 16 - Wait for route set congestion test (RSCT) updates. Typical value is 1400.",
"type": "integer",
"minimum": 200,
"maximum": 3000
},
"t17Timer": {
"description": "Timer 17 - Delay to avoid oscillation of initial alignment failure. Typical value is 2000.",
"type": "integer",
"minimum": 500,
"maximum": 2000
},
"t18Timer": {
"description": "Timer 18 - Repeat transfer restricted (TFR) once by response method. Typical value is 10000.",
"type": "integer",
"minimum": 2000,
"maximum": 20000
},
"t1Timer": {
"description": "Timer 1 - Changeover delay. Also used as isolation timer for ITU MTP Restart. Typical value is 800.",
"type": "integer",
"minimum": 100,
"maximum": 2000
},
"t2Timer": {
"description": "Timer 2 - Wait for changeover acknowledgement (COA). Typical value is 1400.",
"type": "integer",
"minimum": 100,
"maximum": 3000
},
"t3Timer": {
"description": "Timer 3 - Time controlled diversion on changeback. Typical value is 800.",
"type": "integer",
"minimum": 100,
"maximum": 2000
},
"t4Timer": {
"description": "Timer 4 - Wait for changeback acknowledgement (CBA) #1. Typical value is 800.",
"type": "integer",
"minimum": 100,
"maximum": 2000
},
"t5Timer": {
"description": "Timer 5 - Wait for changeback acknowledgement (CBA) #2. Typical value is 800.",
"type": "integer",
"minimum": 100,
"maximum": 2000
},
"t6Timer": {
"description": "Timer 6 - Controlled reroute. Typical value is 800.",
"type": "integer",
"minimum": 100,
"maximum": 2000
},
"t8Timer": {
"description": "Timer 8 - Transfer prohibited (TFP) inhibit. Typical value is 800.",
"type": "integer",
"minimum": 500,
"maximum": 2000
}
},
"required": [
"lsOnHoldTimer",
"sltT1Timer",
"sltT2Timer",
"slsRotation",
"t10Timer",
"t11Timer",
"t15Timer",
"t16Timer",
"t17Timer",
"t18Timer",
"t1Timer",
"t2Timer",
"t3Timer",
"t4Timer",
"t5Timer",
"t6Timer",
"t8Timer"
],
"type": "object"
}
Example
{
"OnHoldTimer": 200,
"sltT1Timer": 8000,
"sltT2Timer": 35000,
"slsRotation": false,
"t10Timer": 25000,
"t11Timer": 3000,
"t15Timer": 600,
"t16Timer": 800,
"t17Timer": 800,
"t18Timer": 3000,
"t1Timer": 800,
"t2Timer": 800,
"t3Timer": 800,
"t4Timer": 600,
"t5Timer": 600,
"t6Timer": 800,
"t8Timer": 800
}
Vstp: MAP Sets
A Mated Application Part (MAP) Set is a logical grouping of Remote Signaling Points (/vstp/remotesignalingpoints) referred to as a load sharing group. The Default MAP Set (the MAP Set with mapSetId equal to 0) can have multiple load sharing groups. All other MAP Sets can have only one load sharing group associated with them. A load sharing group can have at most 32 RSPs.
All configuration of MAP Sets is done at the SOAM.
/vstp/mapsets
get /vstp/mapsets
Returns all MAP Sets that meet the criteria specified in the GET request. By default, all MAP Sets configured at the SOAM are returned. If paging parameters are supplied, only those MAP Sets meeting the request parameters are returned.
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (one of configurationLevel)
The field being matched
Only the configurationLevel field is supported.
Example:
filter_name=configurationLevel
- filter_op: (one of GREATER_THAN, GREATER_THAN_EQUAL)
The match operation (operator)
Example:
filter_op=GREATER_THAN
- filter_values: (string)
The matched value
The configurationLevel value by which the data is being filtered. Only a single value is supported.
Example:
filter_values=10
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/collections/mapsetCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/mapset/mapset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"groupId": {
"description": "Defines the id of a load sharing group. groupId can be any integer in the allowable range, and must be unique across load sharing groups.",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"rspName": {
"description": "Defines the Remote Signaling Point name (/vstp/remotesignalingpoints) associated with this MAP Set.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"mapSetId": {
"description": "Id of this MAP Set. mapSetId can be any integer in the allowable range, and must be unique across MAP Sets. If a mate RSP (/vstp/remotesignalingpoints) is being added to an existing MAP Set, the mapSetId must be the same as assigned to the MAP Set instance containing the primary RSP.",
"maximum": 6000,
"minimum": 0,
"type": "integer"
},
"messageRouteCongestion": {
"description": "Must be set to Yes if the Class 0 messages to the specified RSP (/vstp/remotesignalingpoints) can be routed to the next preferred node/subsystem when that RSP is congested. No otherwise. If domain of RSP is ANSI, Default is equivalent to Yes. If domain of RSP is ITU, Defalut is equivalent to No. If not specified by user the value for messageRouteCongestion is set to Default.[This attribute is NOT currently in use. Will be used in future.]",
"enum": [
"Default",
"Yes",
"No"
],
"type": "string"
},
"relativeCost": {
"description": "Defines the relative cost of the route for the RSP (/vstp/remotesignalingpoints) of this MAP Set. For the primary RSP, the default value is 10 and for a mate RSP the default value is 50.",
"maximum": 99,
"minimum": 0,
"type":"integer"
},
"ssn": {
"description": "Defines the application's subsystem number.",
"maximum": 255,
"minimum": 2,
"type": "integer"
},
"subsystemRoutingMessage": {
"description": "Must be set to Yes if the subsystem routing messages (SBR, SNR) are transmitted between the mated applications, No otherwise. If domain of RSP is ANSI, Default is equivalent to Yes. If domain of RSP is ITU, Defalut is equivalent to No. If not specified by user the value for subsystemRoutingMessage is set to Default.[This attribute is NOT currently in use. Will be used in future.]",
"enum": [
"Default",
"Yes",
"No"
],
"type": "string"
},
"subsystemStatusOption": {
"description": "Must be set to Yes if the RSP (/vstp/remotesignalingpoints) specified by rspName initiates a subsystem test when a RESUME message is received, No otherwise. Default is equivalent to No. If not specified by user the value for subsystemStatusOption is set to Default.[This attribute is NOT currently in use. Will be used in future.]",
"enum": [
"Default",
"Yes",
"No"
],
"type": "string"
},
"threshold": {
"description": "Defines the in-service threshold assigned to each combination of RSP (/vstp/remotesignalingpoints) and SSN in this MAP Set having the same relativeCost. The Weighted GTT Loadsharing feature must be enabled (using the GTT Feature Control (/vstp/featureadminstates)) before this parameter can be specified. If this parameter is not specified, a value of 1% is assigned to each RSP in this MAP Set.",
"maximum": 100,
"minimum": 1,
"type":"integer"
},
"uniqueIdentifier": {
"description": "Defines a unique identifier for this MAP Set. The unique identifier value is a combination of mapSetId, ssn and rspName. This identifier is created and assigned by vSTP. An example of a unique identifier is 3-2-Rsp1, where 3 is the MAP Set Id, 2 is the ssn and Rsp1 is the RSP (/vstp/remotesignalingpoints) name.",
"readOnly": true,
"pattern": "^([0-9]*)(-)([0-9]*)(-)(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"weight": {
"description": "Defines the weight assigned to the primary RSP (/vstp/remotesignalingpoints) of this MAP Set. Weight is not applicable for solitary and dominant modes. Weight is only valid for load sharing mode and its default is 1.",
"maximum": 99,
"minimum": 1,
"type":"integer"
}
},
"required": [
"groupId",
"mapSetId",
"relativeCost",
"rspName",
"ssn"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"configurationLevel": "1",
"groupId": 1,
"rspName": "Rsp1",
"mapSetId": 1,
"messageRouteCongestion": "No",
"relativeCost": 1,
"ssn": 2,
"subsystemRoutingMessage": "No",
"subsystemStatusOption": "No",
"threshold": 1,
"uniqueIdentifier": "1-2-Rsp1",
"weight": 1
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /vstp/mapsets
Adds a new MAP Set entry to the vSTP configuration. The combination of mapSetId, rspName and ssn must be unique across all MAP Set entries at the SOAM.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/mapset/mapset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"groupId": {
"description": "Defines the id of a load sharing group. groupId can be any integer in the allowable range, and must be unique across load sharing groups.",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"rspName": {
"description": "Defines the Remote Signaling Point name (/vstp/remotesignalingpoints) associated with this MAP Set.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"mapSetId": {
"description": "Id of this MAP Set. mapSetId can be any integer in the allowable range, and must be unique across MAP Sets. If a mate RSP (/vstp/remotesignalingpoints) is being added to an existing MAP Set, the mapSetId must be the same as assigned to the MAP Set instance containing the primary RSP.",
"maximum": 6000,
"minimum": 0,
"type": "integer"
},
"messageRouteCongestion": {
"description": "Must be set to Yes if the Class 0 messages to the specified RSP (/vstp/remotesignalingpoints) can be routed to the next preferred node/subsystem when that RSP is congested. No otherwise. If domain of RSP is ANSI, Default is equivalent to Yes. If domain of RSP is ITU, Defalut is equivalent to No. If not specified by user the value for messageRouteCongestion is set to Default.[This attribute is NOT currently in use. Will be used in future.]",
"enum": [
"Default",
"Yes",
"No"
],
"type": "string"
},
"relativeCost": {
"description": "Defines the relative cost of the route for the RSP (/vstp/remotesignalingpoints) of this MAP Set. For the primary RSP, the default value is 10 and for a mate RSP the default value is 50.",
"maximum": 99,
"minimum": 0,
"type":"integer"
},
"ssn": {
"description": "Defines the application's subsystem number.",
"maximum": 255,
"minimum": 2,
"type": "integer"
},
"subsystemRoutingMessage": {
"description": "Must be set to Yes if the subsystem routing messages (SBR, SNR) are transmitted between the mated applications, No otherwise. If domain of RSP is ANSI, Default is equivalent to Yes. If domain of RSP is ITU, Defalut is equivalent to No. If not specified by user the value for subsystemRoutingMessage is set to Default.[This attribute is NOT currently in use. Will be used in future.]",
"enum": [
"Default",
"Yes",
"No"
],
"type": "string"
},
"subsystemStatusOption": {
"description": "Must be set to Yes if the RSP (/vstp/remotesignalingpoints) specified by rspName initiates a subsystem test when a RESUME message is received, No otherwise. Default is equivalent to No. If not specified by user the value for subsystemStatusOption is set to Default.[This attribute is NOT currently in use. Will be used in future.]",
"enum": [
"Default",
"Yes",
"No"
],
"type": "string"
},
"threshold": {
"description": "Defines the in-service threshold assigned to each combination of RSP (/vstp/remotesignalingpoints) and SSN in this MAP Set having the same relativeCost. The Weighted GTT Loadsharing feature must be enabled (using the GTT Feature Control (/vstp/featureadminstates)) before this parameter can be specified. If this parameter is not specified, a value of 1% is assigned to each RSP in this MAP Set.",
"maximum": 100,
"minimum": 1,
"type":"integer"
},
"uniqueIdentifier": {
"description": "Defines a unique identifier for this MAP Set. The unique identifier value is a combination of mapSetId, ssn and rspName. This identifier is created and assigned by vSTP. An example of a unique identifier is 3-2-Rsp1, where 3 is the MAP Set Id, 2 is the ssn and Rsp1 is the RSP (/vstp/remotesignalingpoints) name.",
"readOnly": true,
"pattern": "^([0-9]*)(-)([0-9]*)(-)(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"weight": {
"description": "Defines the weight assigned to the primary RSP (/vstp/remotesignalingpoints) of this MAP Set. Weight is not applicable for solitary and dominant modes. Weight is only valid for load sharing mode and its default is 1.",
"maximum": 99,
"minimum": 1,
"type":"integer"
}
},
"required": [
"groupId",
"mapSetId",
"relativeCost",
"rspName",
"ssn"
],
"type": "object"
}
Example
{
"configurationLevel": "1",
"groupId": 1,
"rspName": "Rsp1",
"mapSetId": 1,
"messageRouteCongestion": "No",
"relativeCost": 1,
"ssn": 2,
"subsystemRoutingMessage": "No",
"subsystemStatusOption": "No",
"threshold": 1,
"uniqueIdentifier": "1-2-Rsp1",
"weight": 1
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/vstp/mapsets/{uniqueIdentifier}
get /vstp/mapsets/{uniqueIdentifier}
Returns the configuration details for the specified MAP Set. If the MAP Set does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- uniqueIdentifier: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/items/mapsetItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/mapset/mapset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"groupId": {
"description": "Defines the id of a load sharing group. groupId can be any integer in the allowable range, and must be unique across load sharing groups.",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"rspName": {
"description": "Defines the Remote Signaling Point name (/vstp/remotesignalingpoints) associated with this MAP Set.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"mapSetId": {
"description": "Id of this MAP Set. mapSetId can be any integer in the allowable range, and must be unique across MAP Sets. If a mate RSP (/vstp/remotesignalingpoints) is being added to an existing MAP Set, the mapSetId must be the same as assigned to the MAP Set instance containing the primary RSP.",
"maximum": 6000,
"minimum": 0,
"type": "integer"
},
"messageRouteCongestion": {
"description": "Must be set to Yes if the Class 0 messages to the specified RSP (/vstp/remotesignalingpoints) can be routed to the next preferred node/subsystem when that RSP is congested. No otherwise. If domain of RSP is ANSI, Default is equivalent to Yes. If domain of RSP is ITU, Defalut is equivalent to No. If not specified by user the value for messageRouteCongestion is set to Default.[This attribute is NOT currently in use. Will be used in future.]",
"enum": [
"Default",
"Yes",
"No"
],
"type": "string"
},
"relativeCost": {
"description": "Defines the relative cost of the route for the RSP (/vstp/remotesignalingpoints) of this MAP Set. For the primary RSP, the default value is 10 and for a mate RSP the default value is 50.",
"maximum": 99,
"minimum": 0,
"type":"integer"
},
"ssn": {
"description": "Defines the application's subsystem number.",
"maximum": 255,
"minimum": 2,
"type": "integer"
},
"subsystemRoutingMessage": {
"description": "Must be set to Yes if the subsystem routing messages (SBR, SNR) are transmitted between the mated applications, No otherwise. If domain of RSP is ANSI, Default is equivalent to Yes. If domain of RSP is ITU, Defalut is equivalent to No. If not specified by user the value for subsystemRoutingMessage is set to Default.[This attribute is NOT currently in use. Will be used in future.]",
"enum": [
"Default",
"Yes",
"No"
],
"type": "string"
},
"subsystemStatusOption": {
"description": "Must be set to Yes if the RSP (/vstp/remotesignalingpoints) specified by rspName initiates a subsystem test when a RESUME message is received, No otherwise. Default is equivalent to No. If not specified by user the value for subsystemStatusOption is set to Default.[This attribute is NOT currently in use. Will be used in future.]",
"enum": [
"Default",
"Yes",
"No"
],
"type": "string"
},
"threshold": {
"description": "Defines the in-service threshold assigned to each combination of RSP (/vstp/remotesignalingpoints) and SSN in this MAP Set having the same relativeCost. The Weighted GTT Loadsharing feature must be enabled (using the GTT Feature Control (/vstp/featureadminstates)) before this parameter can be specified. If this parameter is not specified, a value of 1% is assigned to each RSP in this MAP Set.",
"maximum": 100,
"minimum": 1,
"type":"integer"
},
"uniqueIdentifier": {
"description": "Defines a unique identifier for this MAP Set. The unique identifier value is a combination of mapSetId, ssn and rspName. This identifier is created and assigned by vSTP. An example of a unique identifier is 3-2-Rsp1, where 3 is the MAP Set Id, 2 is the ssn and Rsp1 is the RSP (/vstp/remotesignalingpoints) name.",
"readOnly": true,
"pattern": "^([0-9]*)(-)([0-9]*)(-)(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"weight": {
"description": "Defines the weight assigned to the primary RSP (/vstp/remotesignalingpoints) of this MAP Set. Weight is not applicable for solitary and dominant modes. Weight is only valid for load sharing mode and its default is 1.",
"maximum": 99,
"minimum": 1,
"type":"integer"
}
},
"required": [
"groupId",
"mapSetId",
"relativeCost",
"rspName",
"ssn"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"configurationLevel": "1",
"groupId": 1,
"rspName": "Rsp1",
"mapSetId": 1,
"messageRouteCongestion": "No",
"relativeCost": 1,
"ssn": 2,
"subsystemRoutingMessage": "No",
"subsystemStatusOption": "No",
"threshold": 1,
"uniqueIdentifier": "1-2-Rsp1",
"weight": 1
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /vstp/mapsets/{uniqueIdentifier}
Updates the configuration of the specified MAP Set. If the provided MAP Set data is invalid in any way, the update fails, resulting in one or more error messages returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- uniqueIdentifier: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/mapset/mapset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"groupId": {
"description": "Defines the id of a load sharing group. groupId can be any integer in the allowable range, and must be unique across load sharing groups.",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"rspName": {
"description": "Defines the Remote Signaling Point name (/vstp/remotesignalingpoints) associated with this MAP Set.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"mapSetId": {
"description": "Id of this MAP Set. mapSetId can be any integer in the allowable range, and must be unique across MAP Sets. If a mate RSP (/vstp/remotesignalingpoints) is being added to an existing MAP Set, the mapSetId must be the same as assigned to the MAP Set instance containing the primary RSP.",
"maximum": 6000,
"minimum": 0,
"type": "integer"
},
"messageRouteCongestion": {
"description": "Must be set to Yes if the Class 0 messages to the specified RSP (/vstp/remotesignalingpoints) can be routed to the next preferred node/subsystem when that RSP is congested. No otherwise. If domain of RSP is ANSI, Default is equivalent to Yes. If domain of RSP is ITU, Defalut is equivalent to No. If not specified by user the value for messageRouteCongestion is set to Default.[This attribute is NOT currently in use. Will be used in future.]",
"enum": [
"Default",
"Yes",
"No"
],
"type": "string"
},
"relativeCost": {
"description": "Defines the relative cost of the route for the RSP (/vstp/remotesignalingpoints) of this MAP Set. For the primary RSP, the default value is 10 and for a mate RSP the default value is 50.",
"maximum": 99,
"minimum": 0,
"type":"integer"
},
"ssn": {
"description": "Defines the application's subsystem number.",
"maximum": 255,
"minimum": 2,
"type": "integer"
},
"subsystemRoutingMessage": {
"description": "Must be set to Yes if the subsystem routing messages (SBR, SNR) are transmitted between the mated applications, No otherwise. If domain of RSP is ANSI, Default is equivalent to Yes. If domain of RSP is ITU, Defalut is equivalent to No. If not specified by user the value for subsystemRoutingMessage is set to Default.[This attribute is NOT currently in use. Will be used in future.]",
"enum": [
"Default",
"Yes",
"No"
],
"type": "string"
},
"subsystemStatusOption": {
"description": "Must be set to Yes if the RSP (/vstp/remotesignalingpoints) specified by rspName initiates a subsystem test when a RESUME message is received, No otherwise. Default is equivalent to No. If not specified by user the value for subsystemStatusOption is set to Default.[This attribute is NOT currently in use. Will be used in future.]",
"enum": [
"Default",
"Yes",
"No"
],
"type": "string"
},
"threshold": {
"description": "Defines the in-service threshold assigned to each combination of RSP (/vstp/remotesignalingpoints) and SSN in this MAP Set having the same relativeCost. The Weighted GTT Loadsharing feature must be enabled (using the GTT Feature Control (/vstp/featureadminstates)) before this parameter can be specified. If this parameter is not specified, a value of 1% is assigned to each RSP in this MAP Set.",
"maximum": 100,
"minimum": 1,
"type":"integer"
},
"uniqueIdentifier": {
"description": "Defines a unique identifier for this MAP Set. The unique identifier value is a combination of mapSetId, ssn and rspName. This identifier is created and assigned by vSTP. An example of a unique identifier is 3-2-Rsp1, where 3 is the MAP Set Id, 2 is the ssn and Rsp1 is the RSP (/vstp/remotesignalingpoints) name.",
"readOnly": true,
"pattern": "^([0-9]*)(-)([0-9]*)(-)(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"weight": {
"description": "Defines the weight assigned to the primary RSP (/vstp/remotesignalingpoints) of this MAP Set. Weight is not applicable for solitary and dominant modes. Weight is only valid for load sharing mode and its default is 1.",
"maximum": 99,
"minimum": 1,
"type":"integer"
}
},
"required": [
"groupId",
"mapSetId",
"relativeCost",
"rspName",
"ssn"
],
"type": "object"
}
Example
{
"configurationLevel": "1",
"groupId": 1,
"rspName": "Rsp1",
"mapSetId": 1,
"messageRouteCongestion": "No",
"relativeCost": 1,
"ssn": 2,
"subsystemRoutingMessage": "No",
"subsystemStatusOption": "No",
"threshold": 1,
"uniqueIdentifier": "1-2-Rsp1",
"weight": 1
}
delete /vstp/mapsets/{uniqueIdentifier}
Deletes the specified RSP (/vstp/remotesignalingpoints) from the MAP Set. If only one RSP is associated with the MAP Set, it is deleted and the groupId and mapSetId assigned to this MAP Set becomes available to configure a new MAP Set.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- uniqueIdentifier: required (string)
Vstp: MP Leader
An MP leader is an MP designated as a leader in an MP server group (/topo/servergroups). The MP leader is used internally by software for status reporting.
/vstp/mpleader
get /vstp/mpleader
Returns Active MP leader. If no MP leader is present or multiple MP leaaders are present, an error message is returned within the HTTP response.
Target Server: SOAM
Response
HTTP status code 200
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/items/mpleaderItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/mpleader/mpleader.json",
"properties": {
"name": {
"description": "Name of the VSTP MP leader.",
"maxLength": 20,
"pattern": "^(([A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])|([A-Za-z0-9]+))$",
"type": "string"
}
},
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"name": "VSTPMP1"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
Vstp: MRN Sets
A Mated Relay Node (MRN) Set is a logical grouping of Remote Signaling Points (/vstp/remotesignalingpoints) referred as a load sharing group. The Default MRN Set (the MRN Set with mrnSetId equal to 0) can have multiple load sharing groups. All other MRN Sets can have only one load sharing group. A load sharing group can have at most 32 RSPs.
All configuration of MRN Sets is done at the SOAM.
/vstp/mrnsets
get /vstp/mrnsets
Returns all MRN Sets that meet the criteria specified in the GET request. By default, all MRN Sets configured at the SOAM are returned. If paging parameters are supplied, only those MRN Sets meeting the request parameters are returned.
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (one of configurationLevel)
The field being matched
Only the configurationLevel field is supported.
Example:
filter_name=configurationLevel
- filter_op: (one of GREATER_THAN, GREATER_THAN_EQUAL)
The match operation (operator)
Example:
filter_op=GREATER_THAN
- filter_values: (string)
The matched value
The configurationLevel value by which the data is being filtered. Only a single value is supported.
Example:
filter_values=10
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/collections/mrnsetCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/mrnset/mrnset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"groupId": {
"description": "Defines the id of a load sharing group. groupId can be any integer in the allowable range, and must be unique across load sharing groups.",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"mrnSetId": {
"description": "Id of this MRN Set. mrnSetId can be any integer in the range. It must be unique across MRN sets. An MRN Set with mrnSetId set to 0 is called the default MRN Set.",
"maximum": 1500,
"minimum": 0,
"type": "integer"
},
"relativeCost": {
"description": "Defines the relative cost of the route for the RSP (/vstp/remotesignalingpoints) of this MRN Set.",
"maximum": 99,
"minimum": 0,
"type":"integer"
},
"rspName": {
"description": "Defines the Remote Signaling Point name (/vstp/remotesignalingpoints) associated with this MRN Set.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"threshold": {
"description": "Defines the in-service threshold for all RSP (/vstp/remotesignalingpoints) in this MRN Set having the same relativeCost. The Weighted GTT Loadsharing feature must be enabled (using the GTT Feature Control (/vstp/featureadminstates)) before this parameter can be specified. If value is not specified, threshold value of 1% will be assigned to all RSPs in this MRN Set.",
"maximum": 100,
"minimum": 1,
"type":"integer"
},
"uniqueIdentifier": {
"description": "Defines a unique identifier for this MRN Set. The unique identifier value is a combination of mrnSetId and rspName. This identifier is created and assigned by vSTP. An example of a unique identifier is 3-rsp1, where 3 is the MRN Set Id and rsp1 is the RSP name.",
"readOnly": true,
"pattern": "^(([0-9]*))(-)(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"weight": {
"description": "Defines the weight assigned to the RSP (/vstp/remotesignalingpoints) of this MRN Set. Weight is not applicable for solitary and dominant modes. Weight is only valid for load sharing mode and its default is 1.",
"maximum": 99,
"minimum": 1,
"type":"integer"
}
},
"required": [
"groupId",
"mrnSetId",
"rspName",
"relativeCost"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"configurationLevel": "1",
"groupId": 1,
"mrnSetId": 1,
"relativeCost": 1,
"rspName": "Rsp1",
"threshold": 1,
"uniqueIdentifier": "1-Rsp1",
"weight": 1
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /vstp/mrnsets
Adds a new MRN Set entry to the VSTP configuration. The combination of mrnSetId, groupId and rspName must be unique across all MRN Set entries at the SOAM.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/mrnset/mrnset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"groupId": {
"description": "Defines the id of a load sharing group. groupId can be any integer in the allowable range, and must be unique across load sharing groups.",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"mrnSetId": {
"description": "Id of this MRN Set. mrnSetId can be any integer in the range. It must be unique across MRN sets. An MRN Set with mrnSetId set to 0 is called the default MRN Set.",
"maximum": 1500,
"minimum": 0,
"type": "integer"
},
"relativeCost": {
"description": "Defines the relative cost of the route for the RSP (/vstp/remotesignalingpoints) of this MRN Set.",
"maximum": 99,
"minimum": 0,
"type":"integer"
},
"rspName": {
"description": "Defines the Remote Signaling Point name (/vstp/remotesignalingpoints) associated with this MRN Set.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"threshold": {
"description": "Defines the in-service threshold for all RSP (/vstp/remotesignalingpoints) in this MRN Set having the same relativeCost. The Weighted GTT Loadsharing feature must be enabled (using the GTT Feature Control (/vstp/featureadminstates)) before this parameter can be specified. If value is not specified, threshold value of 1% will be assigned to all RSPs in this MRN Set.",
"maximum": 100,
"minimum": 1,
"type":"integer"
},
"uniqueIdentifier": {
"description": "Defines a unique identifier for this MRN Set. The unique identifier value is a combination of mrnSetId and rspName. This identifier is created and assigned by vSTP. An example of a unique identifier is 3-rsp1, where 3 is the MRN Set Id and rsp1 is the RSP name.",
"readOnly": true,
"pattern": "^(([0-9]*))(-)(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"weight": {
"description": "Defines the weight assigned to the RSP (/vstp/remotesignalingpoints) of this MRN Set. Weight is not applicable for solitary and dominant modes. Weight is only valid for load sharing mode and its default is 1.",
"maximum": 99,
"minimum": 1,
"type":"integer"
}
},
"required": [
"groupId",
"mrnSetId",
"rspName",
"relativeCost"
],
"type": "object"
}
Example
{
"configurationLevel": "1",
"groupId": 1,
"mrnSetId": 1,
"relativeCost": 1,
"rspName": "Rsp1",
"threshold": 1,
"uniqueIdentifier": "1-Rsp1",
"weight": 1
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/vstp/mrnsets/{uniqueIdentifier}
get /vstp/mrnsets/{uniqueIdentifier}
Returns the configuration details for the specified MRN Set. If the MRN Set does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- uniqueIdentifier: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/items/mrnsetItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/mrnset/mrnset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"groupId": {
"description": "Defines the id of a load sharing group. groupId can be any integer in the allowable range, and must be unique across load sharing groups.",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"mrnSetId": {
"description": "Id of this MRN Set. mrnSetId can be any integer in the range. It must be unique across MRN sets. An MRN Set with mrnSetId set to 0 is called the default MRN Set.",
"maximum": 1500,
"minimum": 0,
"type": "integer"
},
"relativeCost": {
"description": "Defines the relative cost of the route for the RSP (/vstp/remotesignalingpoints) of this MRN Set.",
"maximum": 99,
"minimum": 0,
"type":"integer"
},
"rspName": {
"description": "Defines the Remote Signaling Point name (/vstp/remotesignalingpoints) associated with this MRN Set.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"threshold": {
"description": "Defines the in-service threshold for all RSP (/vstp/remotesignalingpoints) in this MRN Set having the same relativeCost. The Weighted GTT Loadsharing feature must be enabled (using the GTT Feature Control (/vstp/featureadminstates)) before this parameter can be specified. If value is not specified, threshold value of 1% will be assigned to all RSPs in this MRN Set.",
"maximum": 100,
"minimum": 1,
"type":"integer"
},
"uniqueIdentifier": {
"description": "Defines a unique identifier for this MRN Set. The unique identifier value is a combination of mrnSetId and rspName. This identifier is created and assigned by vSTP. An example of a unique identifier is 3-rsp1, where 3 is the MRN Set Id and rsp1 is the RSP name.",
"readOnly": true,
"pattern": "^(([0-9]*))(-)(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"weight": {
"description": "Defines the weight assigned to the RSP (/vstp/remotesignalingpoints) of this MRN Set. Weight is not applicable for solitary and dominant modes. Weight is only valid for load sharing mode and its default is 1.",
"maximum": 99,
"minimum": 1,
"type":"integer"
}
},
"required": [
"groupId",
"mrnSetId",
"rspName",
"relativeCost"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"configurationLevel": "1",
"groupId": 1,
"mrnSetId": 1,
"relativeCost": 1,
"rspName": "Rsp1",
"threshold": 1,
"uniqueIdentifier": "1-Rsp1",
"weight": 1
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /vstp/mrnsets/{uniqueIdentifier}
Updates the configuration of the specified MRN Set. If the provided MRN Set data is invalid in any way, the update fails, resulting in one or more error messages returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- uniqueIdentifier: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/mrnset/mrnset.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"groupId": {
"description": "Defines the id of a load sharing group. groupId can be any integer in the allowable range, and must be unique across load sharing groups.",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"mrnSetId": {
"description": "Id of this MRN Set. mrnSetId can be any integer in the range. It must be unique across MRN sets. An MRN Set with mrnSetId set to 0 is called the default MRN Set.",
"maximum": 1500,
"minimum": 0,
"type": "integer"
},
"relativeCost": {
"description": "Defines the relative cost of the route for the RSP (/vstp/remotesignalingpoints) of this MRN Set.",
"maximum": 99,
"minimum": 0,
"type":"integer"
},
"rspName": {
"description": "Defines the Remote Signaling Point name (/vstp/remotesignalingpoints) associated with this MRN Set.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"threshold": {
"description": "Defines the in-service threshold for all RSP (/vstp/remotesignalingpoints) in this MRN Set having the same relativeCost. The Weighted GTT Loadsharing feature must be enabled (using the GTT Feature Control (/vstp/featureadminstates)) before this parameter can be specified. If value is not specified, threshold value of 1% will be assigned to all RSPs in this MRN Set.",
"maximum": 100,
"minimum": 1,
"type":"integer"
},
"uniqueIdentifier": {
"description": "Defines a unique identifier for this MRN Set. The unique identifier value is a combination of mrnSetId and rspName. This identifier is created and assigned by vSTP. An example of a unique identifier is 3-rsp1, where 3 is the MRN Set Id and rsp1 is the RSP name.",
"readOnly": true,
"pattern": "^(([0-9]*))(-)(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"weight": {
"description": "Defines the weight assigned to the RSP (/vstp/remotesignalingpoints) of this MRN Set. Weight is not applicable for solitary and dominant modes. Weight is only valid for load sharing mode and its default is 1.",
"maximum": 99,
"minimum": 1,
"type":"integer"
}
},
"required": [
"groupId",
"mrnSetId",
"rspName",
"relativeCost"
],
"type": "object"
}
Example
{
"configurationLevel": "1",
"groupId": 1,
"mrnSetId": 1,
"relativeCost": 1,
"rspName": "Rsp1",
"threshold": 1,
"uniqueIdentifier": "1-Rsp1",
"weight": 1
}
delete /vstp/mrnsets/{uniqueIdentifier}
Deletes the specified RSP (/vstp/remotesignalingpoints) from the MRN Set. If only one RSP is associated with the MRN Set, it is deleted and the groupId and mrnSetId assigned to this MRN Set becomes available to configure a new MRN Set.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- uniqueIdentifier: required (string)
Vstp: Remote Hosts
A Remote Host is the VSTP's logical representation of a remote node, accessible over one or more transport connections, with which the VSTP can transact Vstp messages. The Remote Host managed object encapsulates all the characteristics of the remote node that the VSTP must know about in order to communicate successfully with it.
All Remote Host configuration is done at the SOAM.
/vstp/remotehosts
get /vstp/remotehosts
Returns all Remote Hosts that meet the criteria specified in the GET request. By default, all Remote Hosts configured at the SOAM will be returned. If paging parameters are supplied, only those Remote Hosts meeting the request parameters will be returned.
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (one of configurationLevel)
The field being matched
Only the configurationLevel field is supported.
Example:
filter_name=configurationLevel
- filter_op: (one of GREATER_THAN, GREATER_THAN_EQUAL)
The match operation (operator)
Example:
filter_op=GREATER_THAN
- filter_values: (string)
The matched value
The configurationLevel value by which the data is being filtered. Only a single value is supported.
Example:
filter_values=10
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/collections/remotehostCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/remotehost/remotehost.json",
"properties": {
"remoteHostName": {
"description": "Name for the Remote Host, which must be unique within the VSTP site. A name is required, and cannot be changed after the Peer Node is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"remoteHostPort": {
"description": "Listen Port number of this Remote Host. This is mandatory attribute for remote host.",
"maximum": 65535,
"minimum": 1024,
"type": "integer"
},
"remoteHostPriIPAddress": {
"description": "Primary IP address of this Remote Host. Each value provided must be a valid IPv4 or IPv6 address. This is mandatory attribute for remote host.",
"maximum": 39,
"minimum": 3,
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"remoteHostSecIPAddress": {
"description": "Secondary IP address of this Remote Host. Each value provided must be a valid IPv4 or IPv6 address. This is optional.",
"maximum": 39,
"minimum": 3,
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
}
},
"required": [
"remoteHostName",
"remoteHostPort",
"remoteHostPriIPAddress"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"configurationLevel": "0",
"remoteHostName": "RemoteHost1",
"remoteHostPort": 2346,
"remoteHostPriIPAddress": "10.10.1.10",
"remoteHostSecIPAddress": "10.10.1.11",
"remoteHostType": "Remote"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /vstp/remotehosts
Adds a new Remote Host to the VSTP configuration. The new Remote Host must have a name that is unique across all Remote Hosts at the SOAM. In addition, the Remote Host's IP Port combination must also be unique across all Remote Hosts configured at the SOAM.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/remotehost/remotehost.json",
"properties": {
"remoteHostName": {
"description": "Name for the Remote Host, which must be unique within the VSTP site. A name is required, and cannot be changed after the Peer Node is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"remoteHostPort": {
"description": "Listen Port number of this Remote Host. This is mandatory attribute for remote host.",
"maximum": 65535,
"minimum": 1024,
"type": "integer"
},
"remoteHostPriIPAddress": {
"description": "Primary IP address of this Remote Host. Each value provided must be a valid IPv4 or IPv6 address. This is mandatory attribute for remote host.",
"maximum": 39,
"minimum": 3,
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"remoteHostSecIPAddress": {
"description": "Secondary IP address of this Remote Host. Each value provided must be a valid IPv4 or IPv6 address. This is optional.",
"maximum": 39,
"minimum": 3,
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
}
},
"required": [
"remoteHostName",
"remoteHostPort",
"remoteHostPriIPAddress"
],
"type": "object"
}
Example
{
"configurationLevel": "0",
"remoteHostName": "RemoteHost1",
"remoteHostPort": 2346,
"remoteHostPriIPAddress": "10.10.1.10",
"remoteHostSecIPAddress": "10.10.1.11",
"remoteHostType": "Remote"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/vstp/remotehosts/{name}
get /vstp/remotehosts/{name}
Returns the configuration details for the specified Remote Host. If the specified Remote Host does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/items/remotehostItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/remotehost/remotehost.json",
"properties": {
"remoteHostName": {
"description": "Name for the Remote Host, which must be unique within the VSTP site. A name is required, and cannot be changed after the Peer Node is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"remoteHostPort": {
"description": "Listen Port number of this Remote Host. This is mandatory attribute for remote host.",
"maximum": 65535,
"minimum": 1024,
"type": "integer"
},
"remoteHostPriIPAddress": {
"description": "Primary IP address of this Remote Host. Each value provided must be a valid IPv4 or IPv6 address. This is mandatory attribute for remote host.",
"maximum": 39,
"minimum": 3,
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"remoteHostSecIPAddress": {
"description": "Secondary IP address of this Remote Host. Each value provided must be a valid IPv4 or IPv6 address. This is optional.",
"maximum": 39,
"minimum": 3,
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
}
},
"required": [
"remoteHostName",
"remoteHostPort",
"remoteHostPriIPAddress"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"configurationLevel": "0",
"remoteHostName": "RemoteHost1",
"remoteHostPort": 2346,
"remoteHostPriIPAddress": "10.10.1.10",
"remoteHostSecIPAddress": "10.10.1.11",
"remoteHostType": "Remote"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /vstp/remotehosts/{name}
Updates the configuration for the specified Remote Host. If the provided Remote Host data is invalid in any way, the update will fail, resulting in one or more error messages returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/remotehost/remotehost.json",
"properties": {
"remoteHostName": {
"description": "Name for the Remote Host, which must be unique within the VSTP site. A name is required, and cannot be changed after the Peer Node is initially configured. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"remoteHostPort": {
"description": "Listen Port number of this Remote Host. This is mandatory attribute for remote host.",
"maximum": 65535,
"minimum": 1024,
"type": "integer"
},
"remoteHostPriIPAddress": {
"description": "Primary IP address of this Remote Host. Each value provided must be a valid IPv4 or IPv6 address. This is mandatory attribute for remote host.",
"maximum": 39,
"minimum": 3,
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"remoteHostSecIPAddress": {
"description": "Secondary IP address of this Remote Host. Each value provided must be a valid IPv4 or IPv6 address. This is optional.",
"maximum": 39,
"minimum": 3,
"pattern": "^((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))$|^([0-9A-Fa-f:]){1,46}$|^([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\\.]*[0-9A-Fa-f]){0,46}$",
"type": "string"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
}
},
"required": [
"remoteHostName",
"remoteHostPort",
"remoteHostPriIPAddress"
],
"type": "object"
}
Example
{
"configurationLevel": "0",
"remoteHostName": "RemoteHost1",
"remoteHostPort": 2346,
"remoteHostPriIPAddress": "10.10.1.10",
"remoteHostSecIPAddress": "10.10.1.11",
"remoteHostType": "Remote"
}
delete /vstp/remotehosts/{name}
Deletes the specified Remote Host from the SOAM configuration. A Remote Host will only be deleted if all delete validation checks pass.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Vstp: Remote Signaling Points
A Remote Signaling Point represents an SS7 network node (point code) with which a VSTP Local Node (/vstp/localhosts) communicates. A Remote Signaling Point resource encapsulates the characteristics required to route the signaling to the Remote Host (/vstp/remotehosts).
All configuration of the Remote Signaling Points is done at the SOAM.
/vstp/remotesignalingpoints
get /vstp/remotesignalingpoints
Returns all Remote Signaling Points that meet the criteria specified in the GET request. By default, all Remote Signaling Points configured at the SOAM are returned. If paging parameters are supplied, only those Remote Signaling Points meeting the request parameters are returned.
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (one of configurationLevel)
The field being matched
Only the configurationLevel field is supported.
Example:
filter_name=configurationLevel
- filter_op: (one of GREATER_THAN, GREATER_THAN_EQUAL)
The match operation (operator)
Example:
filter_op=GREATER_THAN
- filter_values: (string)
The matched value
The configurationLevel value by which the data is being filtered. Only a single value is supported.
Example:
filter_values=10
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/collections/remotesignalingpointCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/remotesignalingpoint/remotesignalingpoint.json",
"properties": {
"enableBroadcastException": {
"description": "When set to true, the VSTP does not broadcast TFP/TFA to the adjacent node whenever the Linksets (/vstp/linksets) status is changed. Typical value is false.",
"type": "boolean"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"mtpPointCode": {
"description": "mtpPointCode is the unique address for this Remote Signaling Point, and is used in MTP layer 3 to identify the destination of a Message Signal Unit (MSU).",
"maxLength": 12,
"pattern": "^([0-9]+-)*[0-9]+$",
"type": "string"
},
"name": {
"description": "Name for this Remote Signaling Point, which must be unique within the VSTP site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit. If name is not provided by user, the name will be automatically generated as ss7DomainType_mtpPointCode. E.g. Ansi_3_3_3 for ss7DomainType is Ansi and mtpPointCode 3-3-3.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"ss7DomainType": {
"description": "This defines the type of SS7 domain.",
"enum": [
"Ansi",
"Itui",
"Itun",
"Itun24"
],
"type": "string"
}
},
"required": [
"mtpPointCode",
"ss7DomainType"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"enableBroadcastException": true,
"configurationLevel": "0",
"mtpPointCode": "1-1-1"
"name": "RSP1",
"ss7DomainType": "Ansi"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /vstp/remotesignalingpoints
Adds a new Remote Signaling Point to the VSTP configuration. The Remote Signaling Point name must be unique across all Remote Signaling Points at the SOAM.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/remotesignalingpoint/remotesignalingpoint.json",
"properties": {
"enableBroadcastException": {
"description": "When set to true, the VSTP does not broadcast TFP/TFA to the adjacent node whenever the Linksets (/vstp/linksets) status is changed. Typical value is false.",
"type": "boolean"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"mtpPointCode": {
"description": "mtpPointCode is the unique address for this Remote Signaling Point, and is used in MTP layer 3 to identify the destination of a Message Signal Unit (MSU).",
"maxLength": 12,
"pattern": "^([0-9]+-)*[0-9]+$",
"type": "string"
},
"name": {
"description": "Name for this Remote Signaling Point, which must be unique within the VSTP site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit. If name is not provided by user, the name will be automatically generated as ss7DomainType_mtpPointCode. E.g. Ansi_3_3_3 for ss7DomainType is Ansi and mtpPointCode 3-3-3.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"ss7DomainType": {
"description": "This defines the type of SS7 domain.",
"enum": [
"Ansi",
"Itui",
"Itun",
"Itun24"
],
"type": "string"
}
},
"required": [
"mtpPointCode",
"ss7DomainType"
],
"type": "object"
}
Example
{
"enableBroadcastException": true,
"configurationLevel": "0",
"mtpPointCode": "1-1-1"
"name": "RSP1",
"ss7DomainType": "Ansi"
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/vstp/remotesignalingpoints/status
get /vstp/remotesignalingpoints/status
Returns the status of all Remote Signaling Points that meet the criteria specified in the request. This API supports filtering on any single attribute returned in the JSON data (except statusKnown - this attribute cannot be filtered). Non-enumerated string attributes can be filtered using EQUAL, NOT_EQUAL, LIKE, or IN. Enumerated strings and integers can be filtered using EQUAL, NOT_EQUAL, or IN. LIKE is not supported for these data types. Boolean attributes can be filtered using only EQUAL.
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (string)
The attribute name on which filtering occurs. Non-enumerated string attributes can be filtered using EQUAL, NOT_EQUAL, LIKE or IN. Enumerated strings and integers can be filtered using EQUAL, NOT_EQUAL, and IN - LIKE is not supported for these data types.
Example:
filter_name=name
- filter_op: (one of EQUAL, NOT_EQUAL, LIKE, IN)
The filter operator.
Example:
filter_op=EQUAL
- filter_values: (string)
The value being filtered on. When the filter_op is IN, filter_values can be a comma-delimited list of strings or integers. Otherwise, filter_value should be a single value.
Example:
filter_values=Rsp1
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/collections/remotesignalingpointstatusCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/remotesignalingpoint/remotesignalingpointstatus.json",
"properties": {
"mpServerHostname": {
"description": "mpServerHostname indicates the name of the VSTP-MP server that is currently reporting the status of this Remote Signaling Point.",
"type": "string"
},
"name": {
"description": "The configured name of the Remote Signaling Point.",
"type": "string"
},
"operationalStatus": {
"description": "The operational status for this Remote Signaling Point. When set to Available, it shows the Routes configured corresponding to this Remote Signaling Point are Available. When set to Unavailable, it shows the Routes configured corresponding to this Remote Signaling Point are Unavailable. When set to Congested, it shows the destination to the configured Routes corresponding to this Remote Signaling Point is congested even though the Routes are Available. When set to NonPreferred, it shows that one of the Routes configured corresponding to this Remote Signaling Point is not preferred over the other Route configured. When set to ApplDown, application is not running on this Remote Signaling Point. Default operationalStatus of a Remote Signaling Point is Available.",
"enum": [
"Available",
"Unavailable",
"Congested",
"NonPreferred",
"ApplDown"
],
"type": "string"
},
"pointCode": {
"description": "The unique address for this Remote Signaling Point.",
"type": "string"
},
"routes": {
"description": "A Remote Signaling Point can have up to two Routes (/vstp/routes) configured, and any Route listed here must be configured in an associated Route Table.",
"items": {
"properties": {
"routeAdjacentStatus": {
"description": "The status of the adjacent part. When set to Down, the adjacent part to this Remote Signaling Point is down. When set to Up, the adjacent part to this Remote Signaling Point is up. When set to Unassigned, the adjacent part to this Remote Signaling Point is not assigned to any other Remote Signaling Point.",
"enum": [
"Down",
"Up",
"Unassigned"
],
"type": "string"
},
"routeName": {
"description": "The name of this Route (/vstp/routes).",
"type": "string"
},
"routeRemoteStatus": {
"description": "The status of the non adjacent part. When set to Available, the non adjacent part to this Remote Signaling Point is Available. When set to Unavailable, the non adjacent part to this Remote Signaling Point is not available. When set to Restricted, the non adjacent part to this Remote Signaling Point is Restricted. When set to Unassigned, the non adjacent part to this Remote Signaling Point is not assigned to other Remote Signaling Point. The default status is Available.",
"enum": [
"Available",
"Unavailable",
"Restricted",
"Unassigned"
],
"type": "string"
}
},
"type": "object"
},
"maxItems": 2,
"minItems": 0,
"type": "array"
},
"ss7DomainType": {
"description": "This defines the type of SS7 domain.",
"enum": [
"Ansi",
"Itui",
"Itun",
"Itun24"
],
"type": "string"
},
"statusKnown": {
"description": "When set to false, current values for the run-time status attributes for this RSP are not known by the OAM. This could be due to merge issues within the VSTP, or some other cause preventing the OAM from having a current view of the status of this RSP. If the OAM has current status for this RSP, statusKnown is set to true.",
"type": "boolean"
},
"timeOfLastUpdate": {
"description": "The date/time status for the destination last updated by the VSTP.",
"pattern": "^[0-9]{4}[-][0-1]{1}[0-9]{1}[-][0-3]{1}[0-9]{1}T[0-2]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}([.][0-9]{1,7})?[+-](?:2[0-3]|[0-1][0-9])[:][0-5][0-9]?$",
"type": "string"
}
},
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"mpServerHostname": "amisha-so1mp1",
"name": "TestRemoteSp1",
"operationalStatus": "Available",
"pointCode": "004-004-004",
"routes": [
{
"routeAdjacentStatus": "Available",
"routeName": "RouteTest11",
"routeRemoteStatus": "Available"
},
{
"routeAdjacentStatus": "Down",
"routeName": "RouteTest12",
"routeRemoteStatus": "Available"
}
],
"ss7DomainType":"Ansi",
"statusKnown": true,
"timeOfLastUpdate": "1969-12-31T19:00:00-05:00"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
/vstp/remotesignalingpoints/{name}
get /vstp/remotesignalingpoints/{name}
Returns the configuration details for the specified Remote Signaling Point. If the Remote Signaling Point does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/items/remotesignalingpointItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/remotesignalingpoint/remotesignalingpoint.json",
"properties": {
"enableBroadcastException": {
"description": "When set to true, the VSTP does not broadcast TFP/TFA to the adjacent node whenever the Linksets (/vstp/linksets) status is changed. Typical value is false.",
"type": "boolean"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"mtpPointCode": {
"description": "mtpPointCode is the unique address for this Remote Signaling Point, and is used in MTP layer 3 to identify the destination of a Message Signal Unit (MSU).",
"maxLength": 12,
"pattern": "^([0-9]+-)*[0-9]+$",
"type": "string"
},
"name": {
"description": "Name for this Remote Signaling Point, which must be unique within the VSTP site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit. If name is not provided by user, the name will be automatically generated as ss7DomainType_mtpPointCode. E.g. Ansi_3_3_3 for ss7DomainType is Ansi and mtpPointCode 3-3-3.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"ss7DomainType": {
"description": "This defines the type of SS7 domain.",
"enum": [
"Ansi",
"Itui",
"Itun",
"Itun24"
],
"type": "string"
}
},
"required": [
"mtpPointCode",
"ss7DomainType"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"enableBroadcastException": true,
"configurationLevel": "0",
"mtpPointCode": "1-1-1"
"name": "RSP1",
"ss7DomainType": "Ansi"
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /vstp/remotesignalingpoints/{name}
Updates the configuration of the specified Remote Signaling Point. If the provided Remote Signaling Point data is invalid in any way, the update fails, resulting in one or more error messages returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/remotesignalingpoint/remotesignalingpoint.json",
"properties": {
"enableBroadcastException": {
"description": "When set to true, the VSTP does not broadcast TFP/TFA to the adjacent node whenever the Linksets (/vstp/linksets) status is changed. Typical value is false.",
"type": "boolean"
},
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"mtpPointCode": {
"description": "mtpPointCode is the unique address for this Remote Signaling Point, and is used in MTP layer 3 to identify the destination of a Message Signal Unit (MSU).",
"maxLength": 12,
"pattern": "^([0-9]+-)*[0-9]+$",
"type": "string"
},
"name": {
"description": "Name for this Remote Signaling Point, which must be unique within the VSTP site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit. If name is not provided by user, the name will be automatically generated as ss7DomainType_mtpPointCode. E.g. Ansi_3_3_3 for ss7DomainType is Ansi and mtpPointCode 3-3-3.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"ss7DomainType": {
"description": "This defines the type of SS7 domain.",
"enum": [
"Ansi",
"Itui",
"Itun",
"Itun24"
],
"type": "string"
}
},
"required": [
"mtpPointCode",
"ss7DomainType"
],
"type": "object"
}
Example
{
"enableBroadcastException": true,
"configurationLevel": "0",
"mtpPointCode": "1-1-1"
"name": "RSP1",
"ss7DomainType": "Ansi"
}
delete /vstp/remotesignalingpoints/{name}
Deletes the specified Remote Signaling Point from the SOAM configuration. A Remote Signaling Point can only be deleted if all delete validation checks pass. In general, if the Remote Signaling Point is a part of the configuration of Linksets (/vstp/linksets) or Routes (/vstp/routes), the Remote Signaling Point cannot be deleted. If the Remote Signaling Point is named in a Linkset or Route, the Remote Signaling Point must first be removed from the Linksets and Route. Then the Remote Signaling Point can be deleted from the configuration. An attempt to delete a Remote Signaling Point that cannot be deleted results in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
/vstp/remotesignalingpoints/{name}/status
get /vstp/remotesignalingpoints/{name}/status
Retrieves the operational status for the specified Remote Signaling Point.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/collections/remotesignalingpointstatusCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/remotesignalingpoint/remotesignalingpointstatus.json",
"properties": {
"mpServerHostname": {
"description": "mpServerHostname indicates the name of the VSTP-MP server that is currently reporting the status of this Remote Signaling Point.",
"type": "string"
},
"name": {
"description": "The configured name of the Remote Signaling Point.",
"type": "string"
},
"operationalStatus": {
"description": "The operational status for this Remote Signaling Point. When set to Available, it shows the Routes configured corresponding to this Remote Signaling Point are Available. When set to Unavailable, it shows the Routes configured corresponding to this Remote Signaling Point are Unavailable. When set to Congested, it shows the destination to the configured Routes corresponding to this Remote Signaling Point is congested even though the Routes are Available. When set to NonPreferred, it shows that one of the Routes configured corresponding to this Remote Signaling Point is not preferred over the other Route configured. When set to ApplDown, application is not running on this Remote Signaling Point. Default operationalStatus of a Remote Signaling Point is Available.",
"enum": [
"Available",
"Unavailable",
"Congested",
"NonPreferred",
"ApplDown"
],
"type": "string"
},
"pointCode": {
"description": "The unique address for this Remote Signaling Point.",
"type": "string"
},
"routes": {
"description": "A Remote Signaling Point can have up to two Routes (/vstp/routes) configured, and any Route listed here must be configured in an associated Route Table.",
"items": {
"properties": {
"routeAdjacentStatus": {
"description": "The status of the adjacent part. When set to Down, the adjacent part to this Remote Signaling Point is down. When set to Up, the adjacent part to this Remote Signaling Point is up. When set to Unassigned, the adjacent part to this Remote Signaling Point is not assigned to any other Remote Signaling Point.",
"enum": [
"Down",
"Up",
"Unassigned"
],
"type": "string"
},
"routeName": {
"description": "The name of this Route (/vstp/routes).",
"type": "string"
},
"routeRemoteStatus": {
"description": "The status of the non adjacent part. When set to Available, the non adjacent part to this Remote Signaling Point is Available. When set to Unavailable, the non adjacent part to this Remote Signaling Point is not available. When set to Restricted, the non adjacent part to this Remote Signaling Point is Restricted. When set to Unassigned, the non adjacent part to this Remote Signaling Point is not assigned to other Remote Signaling Point. The default status is Available.",
"enum": [
"Available",
"Unavailable",
"Restricted",
"Unassigned"
],
"type": "string"
}
},
"type": "object"
},
"maxItems": 2,
"minItems": 0,
"type": "array"
},
"ss7DomainType": {
"description": "This defines the type of SS7 domain.",
"enum": [
"Ansi",
"Itui",
"Itun",
"Itun24"
],
"type": "string"
},
"statusKnown": {
"description": "When set to false, current values for the run-time status attributes for this RSP are not known by the OAM. This could be due to merge issues within the VSTP, or some other cause preventing the OAM from having a current view of the status of this RSP. If the OAM has current status for this RSP, statusKnown is set to true.",
"type": "boolean"
},
"timeOfLastUpdate": {
"description": "The date/time status for the destination last updated by the VSTP.",
"pattern": "^[0-9]{4}[-][0-1]{1}[0-9]{1}[-][0-3]{1}[0-9]{1}T[0-2]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}[:][0-5]{1}[0-9]{1}([.][0-9]{1,7})?[+-](?:2[0-3]|[0-1][0-9])[:][0-5][0-9]?$",
"type": "string"
}
},
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"mpServerHostname": "amisha-so1mp1",
"name": "TestRemoteSp1",
"operationalStatus": "Available",
"pointCode": "004-004-004",
"routes": [
{
"routeAdjacentStatus": "Available",
"routeName": "RouteTest11",
"routeRemoteStatus": "Available"
},
{
"routeAdjacentStatus": "Down",
"routeName": "RouteTest12",
"routeRemoteStatus": "Available"
}
],
"ss7DomainType":"Ansi",
"statusKnown": true,
"timeOfLastUpdate": "1969-12-31T19:00:00-05:00"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
Vstp: Routes
A Route is a user-configured resource that represents a signaling path from a Local Signaling Point (/vstp/localsignalingpoints) point code to a Remote Signaling Point (RSP) (/vstp/remotesignalingpoints) point code using a given Link Set (/vstp/linksets). Routes are needed for adjacent RSP to route network management signaling. A Route consists of an RSP, a Link Set, and a relative cost.
All configuration of the Routes is done at the SOAM.
/vstp/routes
get /vstp/routes
Returns all Routes that meet the criteria specified in the GET request. By default, all Routes configured at the SOAM are returned. If paging parameters are supplied, only those Routes meeting the request parameters are returned.
Target Server: SOAM
Secured by x-other
Request
Query Parameters
- filter_name: (one of configurationLevel)
The field being matched
Only the configurationLevel field is supported.
Example:
filter_name=configurationLevel
- filter_op: (one of GREATER_THAN, GREATER_THAN_EQUAL)
The match operation (operator)
Example:
filter_op=GREATER_THAN
- filter_values: (string)
The matched value
The configurationLevel value by which the data is being filtered. Only a single value is supported.
Example:
filter_values=10
- start: (integer)
The first item to return
A zero-based numerical starting point.
Example:
start=15 - count: (integer - default: 1000)
The number of items to return
A maximum of 1000 records is returned if this parameter is not provided.
Example:
count=30
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/collections/routeCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/route/routes.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"linksetName": {
"description": "Name of the Link Set (/vstp/linksets) associated with this Route.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"name": {
"description": "Name for this Route, which must be unique within the VSTP site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"remoteSignalingPointName": {
"description": "Name of the Remote Signaling Point (/vstp/remotesignalingpoints) associated with this Route.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"routeCost": {
"description": "The relative cost assigned to this route. Lower cost routes are preferred over higher cost routes.",
"maximum": 99,
"minimum": 0,
"type": "integer"
}
},
"required": [
"linksetName",
"name",
"remoteSignalingPointName",
"routeCost"
],
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"configurationLevel": "1",
"linksetName": "ls1",
"name": "route1",
"remoteSignalingPointName": "rsp1",
"routeCost": 56
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
post /vstp/routes
Adds a new Route to the VSTP configuration. The Route name must be unique across all Routes at the SOAM.
Target Server: SOAM
Secured by x-other
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/route/routes.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"linksetName": {
"description": "Name of the Link Set (/vstp/linksets) associated with this Route.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"name": {
"description": "Name for this Route, which must be unique within the VSTP site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"remoteSignalingPointName": {
"description": "Name of the Remote Signaling Point (/vstp/remotesignalingpoints) associated with this Route.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"routeCost": {
"description": "The relative cost assigned to this route. Lower cost routes are preferred over higher cost routes.",
"maximum": 99,
"minimum": 0,
"type": "integer"
}
},
"required": [
"linksetName",
"name",
"remoteSignalingPointName",
"routeCost"
],
"type": "object"
}
Example
{
"configurationLevel": "1",
"linksetName": "ls1",
"name": "route1",
"remoteSignalingPointName": "rsp1",
"routeCost": 56
}
Response
HTTP status code 201
Request succeeded - resource created
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/items/creationItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/appworks/creation/creation.json",
"type": "string",
"description": "object identifier",
"example": "6961034c-6439-43da-b935-5238d6616f84"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
"6961034c-6439-43da-b935-5238d6616f84",
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 500
Internal server error
/vstp/routes/{name}
get /vstp/routes/{name}
Returns the configuration details for the specified Route. If the Route does not exist in the SOAM's configuration, an error message is returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Response
HTTP status code 200
Request succeeded
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/items/routeItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/route/routes.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"linksetName": {
"description": "Name of the Link Set (/vstp/linksets) associated with this Route.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"name": {
"description": "Name for this Route, which must be unique within the VSTP site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"remoteSignalingPointName": {
"description": "Name of the Remote Signaling Point (/vstp/remotesignalingpoints) associated with this Route.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"routeCost": {
"description": "The relative cost assigned to this route. Lower cost routes are preferred over higher cost routes.",
"maximum": 99,
"minimum": 0,
"type": "integer"
}
},
"required": [
"linksetName",
"name",
"remoteSignalingPointName",
"routeCost"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"configurationLevel": "1",
"linksetName": "ls1",
"name": "route1",
"remoteSignalingPointName": "rsp1",
"routeCost": 56
},
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
HTTP status code 404
Not found
put /vstp/routes/{name}
Updates the configuration of the specified Route. If the provided Route data is invalid in any way, the update fails, resulting in one or more error messages returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/link/links.json",
"properties": {
"configurationLevel": {
"description": "The configuration level of the database when this instance is inserted or updated. configurationLevel is read-only.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"connectionName": {
"description": "This defines the name of the Connection (/vstp/connections) associated with this Link.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"linksetName": {
"description": "This defines the name of the Linkset (/vstp/linksets) associated with this Link.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"name": {
"description": "Name for this Link, which must be unique within the VSTP site. Valid names are strings between one and 32 characters, inclusive. Valid characters are alphanumeric and underscore. The name must contain at least one alpha and must not start with a digit.",
"maxLength": 32,
"pattern": "^(([A-Za-z][A-Za-z0-9_]*)|(_[A-Za-z0-9_]*[A-Za-z][A-Za-z0-9_]*))$",
"type": "string"
},
"signalingLinkCode": {
"description": "Defines the Signaling Link Code (SLC). The SLC must be unique within the Link Set (/vstp/linksets), and it must have the same value at both the VSTP and the distant Node.",
"maximum": 15,
"minimum": 0,
"type": "integer"
}
},
"required": [
"connectionName",
"linksetName",
"name",
"signalingLinkCode"
],
"type": "object"
}
Example
{
"configurationLevel": "1",
"connectionName": "Conn1",
"linksetName": "ls1",
"name": "link1",
"signalingLinkCode": 5
}
delete /vstp/routes/{name}
Deletes the specified Route from the SOAM configuration. An attempt to delete a Route which does not exist results in an error message returned within the HTTP response.
Target Server: SOAM
Secured by x-other
Request
URI Parameters
- name: required (string)
Vstp: SCCP Options
The Signaling Connection Control Part (SCCP) Options are those configuration values that govern the overall SCCP functionality . There is a single instance of this resource, which contains each of the individual options that can be retrieved and set. Because there is no collection of instances, there is no collection GET action. No new SCCP Options resource can be created, so there is no POST action, and the single instance cannot be removed, so there is no DELETE action. The single instance GET is used to retrieve the options, and PUT is used to update one or more values within the set of options. A name for this single, non-deletable instance is neither required nor expected.
All SCCP Options configuration is done at the SOAM.
/vstp/sccpoptions
get /vstp/sccpoptions
Returns the set of current values for the SCCP Options.
Target Server: SOAM
Response
HTTP status code 200
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/items/sccpoptionItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/sccpoption/sccpoption.json",
"properties": {
"class1seq": {
"description": "Enables or disables Class 1 message sequencing. When set to Enabled, Class 1 messages are guaranteed to be sequenced, but the messages are not load shared. When set to Disabled, Class 1 message sequencing is not guaranteed, but the messages might be load shared (if appropriate configuration exists).",
"enum" : [
"Enabled",
"Disabled"
],
"type": "string"
},
"dfltfallback": {
"description": "Default fallback option. This parameter specifies the action that is taken if the last translation doesn't match when performing GTT using a FLOBR-specific GTT mode. When set to false, GTT fails and the MSU is discarded. When set to true, GTT is performed based on the last matched entry.",
"default": false,
"type": "boolean"
},
"dfltgttmode": {
"description": "Default GTT mode. The system default value of the GTT mode hierarchy used by the DSR when performing GTT.",
"enum" : [
"Cd",
"Fcd",
"Fcg",
"Fcgfcd",
"Fcdfcg"
],
"default" : "Cd",
"type": "string"
},
"tgtt0": {
"description": "When set to Udt, transaction-based GTT loadsharing is enabled for UDTS and Class0 UDT messages. When set to Xudt, transaction-based GTT loadsharing is enabled for XUDTS and Class0 XUDT messages. When set to Both, transaction-based GTT loadsharing is enabled for UDTS, XUDTS, Class0 UDT and Class0 XUDT messages. When set to None, transaction-based GTT loadsharing is disabled for UDTS, XUDTS, Class0 UDT and Class0 XUDT messages. To update this parameter, the Transaction Based GTT Loadsharing feature must be enabled (using the GTT Feature Control (/vstp/featureadminstates)).",
"enum" : [
"Both",
"None",
"Udt",
"Xudt"
],
"type": "string"
},
"tgtt1": {
"description": "When set to Udt, transaction-based GTT loadsharing is enabled for UDTS and Class1 UDT messages. When set to Xudt, transaction-based GTT loadsharing is enabled for XUDTS and Class1 XUDT messages. When set to Both, transaction-based GTT loadsharing is enabled for UDTS, XUDTS, Class1 UDT and XUDT messages. When set to None, transaction-based GTT loadsharing is disabled for UDTS, XUDTS, Class1 UDT and Class1 XUDT messages. To update this parameter, the Transaction Based GTT Loadsharing feature must be enabled (using the GTT Feature Control (/vstp/featureadminstates)).",
"enum" : [
"Both",
"None",
"Udt",
"Xudt"
],
"type": "string"
},
"tgttudtkey": {
"description": "Defines the transaction parameter for incoming UDT(S) messages. Messages with this parameter are routed to the same load-shared remote Point Code within a MAPGROUP or MRNGROUP. When set to Mtp, transaction-based GTT loadsharing is performed using the MTP algorithm. When set to Tcap, transaction-based GTT loadsharing is performed using the TCAP algorithm. When set to Sccp, transaction-based GTT loadsharing is performed using the SCCP algorithm. When set to Enhmtp, transaction-based GTT loadsharing is performed using the ENHMTP algorithm. To update this parameter, the Transaction Based GTT Loadsharing feature must be enabled (using the GTT Feature Control (/vstp/featureadminstates)).",
"enum" : [
"Enhmtp",
"Mtp",
"Sccp",
"Tcap"
],
"type": "string"
},
"tgttxudtkey": {
"description": "Defines the transaction parameter for incoming XUDT(S) messages. Messages with this parameter are routed to the same load-shared remote Point Code within a MAPGROUP or MRNGROUP. When set to Mtp, transaction-based GTT loadsharing is performed using the MTP algorithm. When set to Sccp, transaction-based GTT loadsharing is performed using the SCCP algorithm. When set to Enhmtp, transaction-based GTT loadsharing is performed using the ENHMTP algorithm. To update this parameter, the Transaction Based GTT Loadsharing feature must be enabled (using the GTT Feature Control (/vstp/featureadminstates)).",
"enum" : [
"Enhmtp",
"Mtp",
"Sccp"
],
"type": "string"
}
},
"required": [
"class1seq",
"tgtt0",
"tgtt1",
"tgttudtkey",
"tgttxudtkey"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"class1seq":"Disabled",
"dfltfallback": false,
"dfltgttmode": "Fcd",
"tgtt0": "None",
"tgtt1": "None",
"tgttudtkey": "Mtp",
"tgttxudtkey": "Mtp"
}
,
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
put /vstp/sccpoptions
Update the SCCP Options with the values supplied. To update just one of the individual options, GET the set, modify the value for the option that needs to be changed, then PUT the options.
Target Server: SOAM
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/sccpoption/sccpoption.json",
"properties": {
"class1seq": {
"description": "Enables or disables Class 1 message sequencing. When set to Enabled, Class 1 messages are guaranteed to be sequenced, but the messages are not load shared. When set to Disabled, Class 1 message sequencing is not guaranteed, but the messages might be load shared (if appropriate configuration exists).",
"enum" : [
"Enabled",
"Disabled"
],
"type": "string"
},
"dfltfallback": {
"description": "Default fallback option. This parameter specifies the action that is taken if the last translation doesn't match when performing GTT using a FLOBR-specific GTT mode. When set to false, GTT fails and the MSU is discarded. When set to true, GTT is performed based on the last matched entry.",
"default": false,
"type": "boolean"
},
"dfltgttmode": {
"description": "Default GTT mode. The system default value of the GTT mode hierarchy used by the DSR when performing GTT.",
"enum" : [
"Cd",
"Fcd",
"Fcg",
"Fcgfcd",
"Fcdfcg"
],
"default" : "Cd",
"type": "string"
},
"tgtt0": {
"description": "When set to Udt, transaction-based GTT loadsharing is enabled for UDTS and Class0 UDT messages. When set to Xudt, transaction-based GTT loadsharing is enabled for XUDTS and Class0 XUDT messages. When set to Both, transaction-based GTT loadsharing is enabled for UDTS, XUDTS, Class0 UDT and Class0 XUDT messages. When set to None, transaction-based GTT loadsharing is disabled for UDTS, XUDTS, Class0 UDT and Class0 XUDT messages. To update this parameter, the Transaction Based GTT Loadsharing feature must be enabled (using the GTT Feature Control (/vstp/featureadminstates)).",
"enum" : [
"Both",
"None",
"Udt",
"Xudt"
],
"type": "string"
},
"tgtt1": {
"description": "When set to Udt, transaction-based GTT loadsharing is enabled for UDTS and Class1 UDT messages. When set to Xudt, transaction-based GTT loadsharing is enabled for XUDTS and Class1 XUDT messages. When set to Both, transaction-based GTT loadsharing is enabled for UDTS, XUDTS, Class1 UDT and XUDT messages. When set to None, transaction-based GTT loadsharing is disabled for UDTS, XUDTS, Class1 UDT and Class1 XUDT messages. To update this parameter, the Transaction Based GTT Loadsharing feature must be enabled (using the GTT Feature Control (/vstp/featureadminstates)).",
"enum" : [
"Both",
"None",
"Udt",
"Xudt"
],
"type": "string"
},
"tgttudtkey": {
"description": "Defines the transaction parameter for incoming UDT(S) messages. Messages with this parameter are routed to the same load-shared remote Point Code within a MAPGROUP or MRNGROUP. When set to Mtp, transaction-based GTT loadsharing is performed using the MTP algorithm. When set to Tcap, transaction-based GTT loadsharing is performed using the TCAP algorithm. When set to Sccp, transaction-based GTT loadsharing is performed using the SCCP algorithm. When set to Enhmtp, transaction-based GTT loadsharing is performed using the ENHMTP algorithm. To update this parameter, the Transaction Based GTT Loadsharing feature must be enabled (using the GTT Feature Control (/vstp/featureadminstates)).",
"enum" : [
"Enhmtp",
"Mtp",
"Sccp",
"Tcap"
],
"type": "string"
},
"tgttxudtkey": {
"description": "Defines the transaction parameter for incoming XUDT(S) messages. Messages with this parameter are routed to the same load-shared remote Point Code within a MAPGROUP or MRNGROUP. When set to Mtp, transaction-based GTT loadsharing is performed using the MTP algorithm. When set to Sccp, transaction-based GTT loadsharing is performed using the SCCP algorithm. When set to Enhmtp, transaction-based GTT loadsharing is performed using the ENHMTP algorithm. To update this parameter, the Transaction Based GTT Loadsharing feature must be enabled (using the GTT Feature Control (/vstp/featureadminstates)).",
"enum" : [
"Enhmtp",
"Mtp",
"Sccp"
],
"type": "string"
}
},
"required": [
"class1seq",
"tgtt0",
"tgtt1",
"tgttudtkey",
"tgttxudtkey"
],
"type": "object"
}
Example
{
"class1seq":"Disabled",
"dfltfallback": false,
"dfltgttmode": "Fcd",
"tgtt0": "None",
"tgtt1": "None",
"tgttudtkey": "Mtp",
"tgttxudtkey": "Mtp"
}
Vstp: MP Peer Status
Returns MP peer opertional status.
/vstp/mppeers/status
get /vstp/mppeers/status
Returns operational status for all MPs and corresponding peer MPs.
Target Server: SOAM
Response
HTTP status code 200
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/collections/mppeerstatusCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/mppeers/mppeerstatus.json",
"properties": {
"mp": {
"description": "Name of the VSTP-MP server.",
"pattern": "^(([A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])|([A-Za-z0-9]+))$",
"maxLength": 20,
"type": "string"
},
"peerMp": {
"description": "Name of the Peer VSTP-MP server.",
"pattern": "^(([A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])|([A-Za-z0-9]+))$",
"maxLength": 20,
"type": "string"
},
"status": {
"description": "This indicates the operational status of the VSTP-MP server.",
"enum": [
"Available",
"Unavailable",
"Degraded",
"Unknown"
],
"type": "string"
},
"cpl": {
"description": "This is the Connection Priority Level of VSTP-MP server.",
"maximum": 99,
"minimum": 0,
"type": "integer"
},
"cplReason": {
"description": "Reason for CPL setting.",
"type": "string"
}
},
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"mp": "MP1",
"peerMp": "MP12",
"status": "Available",
"cpl": 0,
"cplReason": "Available"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
/vstp/mppeers/{mp}/status
get /vstp/mppeers/{mp}/status
Returns operational status for specified MP and corresponding peer MPs.
Target Server: SOAM
Request
URI Parameters
- mp: required (string)
Response
HTTP status code 200
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/collections/mppeerstatusCollection.json",
"type": "object",
"properties": {
"data": {
"type": "array",
"items":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/mppeers/mppeerstatus.json",
"properties": {
"mp": {
"description": "Name of the VSTP-MP server.",
"pattern": "^(([A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])|([A-Za-z0-9]+))$",
"maxLength": 20,
"type": "string"
},
"peerMp": {
"description": "Name of the Peer VSTP-MP server.",
"pattern": "^(([A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])|([A-Za-z0-9]+))$",
"maxLength": 20,
"type": "string"
},
"status": {
"description": "This indicates the operational status of the VSTP-MP server.",
"enum": [
"Available",
"Unavailable",
"Degraded",
"Unknown"
],
"type": "string"
},
"cpl": {
"description": "This is the Connection Priority Level of VSTP-MP server.",
"maximum": 99,
"minimum": 0,
"type": "integer"
},
"cplReason": {
"description": "Reason for CPL setting.",
"type": "string"
}
},
"type": "object"
}
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data": [
{
"mp": "MP1",
"peerMp": "MP12",
"status": "Available",
"cpl": 0,
"cplReason": "Available"
}
],
"messages":
[
],
"links":
{
},
"status":
true
}
Vstp: VSTP Alarm Aggregation Options
The VSTP Alarm Aggregation Options are those configuration values that manages aggregation of vstp alarms . There is a single instance of this resource, which contains each of the individual options that can be retrieved and set. Because there is no collection of instances, there is no collection GET action. No new VSTP Alarm Aggregation Options resource can be created, so there is no POST action, and the single instance cannot be removed, so there is no DELETE action. The single instance GET is used to retrieve the options, and PUT is used to update one or more values within the set of options. A name for this single, non-deletable instance is neither required nor expected.
All VSTP Alarm Aggregation Options configuration is done at the SOAM.
/vstp/alarmaggregationoptions
get /vstp/alarmaggregationoptions
Returns the set of current values for the VSTP Alarm Aggregation Options.
Target Server: SOAM
Response
HTTP status code 200
Body
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/items/vstpalarmaggregationoptionItem.json",
"type": "object",
"properties": {
"data":
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/vstpalarmaggregationoption/vstpalarmaggregationoption.json",
"properties": {
"alarmBudget": {
"description": "The total number of alarms allowed in the alarm budget. This is a fixed value. The sum of (associationMajorAggAlarmThreshold * # VSTP-MPs), (linkMajorAggAlarmThreshold * # VSTP-MPs), linksetCriticalAggAlarmThreshold, routeCriticalAggAlarmThreshold, and rspCriticalAggAlarmThreshold cannot exceed alarmBudget.",
"readOnly": true,
"type": "integer"
},
"associationCriticalAggAlarmThreshold": {
"description": "When the number of Connection (/vstp/connections) failure alarms raised by a single VSTP-MP exceeds this threshold: 1) the already-raised major aggregate Connection failure alarm for that VSTP-MP is cleared, and 2) a single aggregate Connection failure alarm of critical severity is raised by the SOAM against that VSTP-MP. The value of associationCriticalAggAlarmThreshold is not included in the available alarm budget. Set associationCriticalAggAlarmThreshold to zero to prevent entirely the raising of a critical aggregate alarm for Connection failures.",
"default": 200,
"minimum": 0,
"type": "integer"
},
"associationMajorAggAlarmThreshold": {
"description": "When the number of Connection (/vstp/connections) failure alarms raised by a single VSTP-MP exceeds this threshold: 1) all individual Connection failure alarms raised to that point are cleared, and 2) a single aggregate Connection failure alarm of major severity is raised by the SOAM against that VSTP-MP. The value of associationMajorAggAlarmThreshold is included in the available alarm budget, multiplied by the number of VSTP-MP in the DSR. So the sum of (associationMajorAggAlarmThreshold * # VSTP-MPs), (linkMajorAggAlarmThreshold * # VSTP-MPs), linksetCriticalAggAlarmThreshold, routeCriticalAggAlarmThreshold, and rspCriticalAggAlarmThreshold cannot exceed alarmBudget.",
"default": 100,
"minimum": 1,
"type": "integer"
},
"linkCriticalAggAlarmThreshold": {
"description": "When the number of Link (/vstp/links) failure alarms raised by a single VSTP-MP exceeds this threshold: 1) the already-raised major aggregate Link failure alarm for that VSTP-MP is cleared, and 2) a single aggregate Link failure alarm of critical severity is raised by the SOAM against that VSTP-MP. The value of linkCriticalAggAlarmThreshold is not included in the available alarm budget. Set linkCriticalAggAlarmThreshold to zero to prevent entirely the raising of a critical aggregate alarm for Link failures.",
"minimum": 0,
"default": 200,
"type": "integer"
},
"linkMajorAggAlarmThreshold": {
"description": "When the number of Link (/vstp/links) failure alarms raised by a single VSTP-MP exceeds this threshold: 1) all individual Link failure alarms raised to that point are cleared, and 2) a single aggregate Link failure alarm of major severity is raised by the SOAM against that VSTP-MP. The value of linkMajorAggAlarmThreshold is included in the available alarm budget, multiplied by the number of VSTP-MP in the DSR. So the sum of (associationMajorAggAlarmThreshold * # VSTP-MPs), (linkMajorAggAlarmThreshold * # VSTP-MPs), linksetCriticalAggAlarmThreshold, routeCriticalAggAlarmThreshold, and rspCriticalAggAlarmThreshold cannot exceed alarmBudget.",
"default": 100,
"minimum": 1,
"type": "integer"
},
"linksetCriticalAggAlarmThreshold": {
"description": "When the number of Linkset (/vstp/linksets) failure alarms raised by the VSTP exceeds this threshold: 1) all individual Linkset failure alarms raised to that point are cleared, and 2) a single aggregate Linkset failure alarm of critical severity is raised by the SOAM. So the sum of (associationMajorAggAlarmThreshold * # VSTP-MPs), (linkMajorAggAlarmThreshold * # VSTP-MPs), linksetCriticalAggAlarmThreshold, routeCriticalAggAlarmThreshold, and rspCriticalAggAlarmThreshold cannot exceed alarmBudget.",
"default": 300,
"minimum": 1,
"type": "integer"
},
"routeCriticalAggAlarmThreshold": {
"description": "When the number of Route (/vstp/routes) failure alarms raised by the VSTP exceeds this threshold: 1) all individual Route failure alarms raised to that point are cleared, and 2) a single aggregate Route failure alarm of critical severity is raised by the SOAM. So the sum of (associationMajorAggAlarmThreshold * # VSTP-MPs), (linkMajorAggAlarmThreshold * # VSTP-MPs), linksetCriticalAggAlarmThreshold, routeCriticalAggAlarmThreshold, and rspCriticalAggAlarmThreshold cannot exceed alarmBudget.",
"default": 600,
"minimum": 1,
"type": "integer"
},
"rspCriticalAggAlarmThreshold": {
"description": "When the number of Remote Signaling Point (/vstp/remotesignalingpoints) failure alarms raised by the VSTP exceeds this threshold: 1) all individual Remote Signaling Point failure alarms raised to that point are cleared, and 2) a single aggregate Remote Signaling Point failure alarm of critical severity is raised by the SOAM. So the sum of (associationMajorAggAlarmThreshold * # VSTP-MPs), (linkMajorAggAlarmThreshold * # VSTP-MPs), linksetCriticalAggAlarmThreshold, routeCriticalAggAlarmThreshold, and rspCriticalAggAlarmThreshold cannot exceed alarmBudget.",
"default": 600,
"minimum": 1,
"type": "integer"
}
},
"required": [
"associationCriticalAggAlarmThreshold",
"associationMajorAggAlarmThreshold",
"linkCriticalAggAlarmThreshold",
"linkMajorAggAlarmThreshold",
"linksetCriticalAggAlarmThreshold",
"routeCriticalAggAlarmThreshold",
"rspCriticalAggAlarmThreshold"
],
"type": "object"
},
"messages":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/messages.json",
"type" :"array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"description": "A timestamp in an ISO 8601 format.",
"type": "string"
},
"severity": {
"description": "A severity code between 1 (critical) and 7 (debug)",
"type": "number",
"minimum": 1,
"maximum": 7
},
"area": {
"description": "The module producing the error",
"type": "string"
},
"message": {
"description": "The message text",
"type": "string"
},
"details": {
"description": "Additional details",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["timestamp", "severity", "area", "message" ]
}
},
"links":
{
"id" : "http://dsr.cgbu.oracle.com/schemas/links.json",
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : {
"type" : { "type": "string", "description": "The type of this link" },
"href" : { "type": "string", "description": "A link to a resource" },
"action" : { "type": "string", "description": "the http action to be used" },
"description" : { "type": "string", "description": "The purpose of this link" }
}
}
},
"status":
{ "type": "boolean" }
}
}
Example
{
"data":
{
"associationCriticalAggAlarmThreshold": 200,
"associationMajorAggAlarmThreshold": 100,
"linkCriticalAggAlarmThreshold": 200,
"linkMajorAggAlarmThreshold": 100,
"linksetCriticalAggAlarmThreshold": 300,
"routeCriticalAggAlarmThreshold": 600,
"rspCriticalAggAlarmThreshold": 600
}
,
"messages":
[
],
"links":
{
},
"status":
true
}
HTTP status code 400
Invalid request
HTTP status code 401
Not authenticated
HTTP status code 403
Not authorized
put /vstp/alarmaggregationoptions
Update the VSTP Alarm Aggregation Options with the values supplied. To update just one of the individual options, GET the set, modify the value for the option that needs to be changed, then PUT the options.
Target Server: SOAM
Request
Body
Type: application/json
Schema
{
"id": "http://dsr.cgbu.oracle.com/schemas/vstp/vstpalarmaggregationoption/vstpalarmaggregationoption.json",
"properties": {
"alarmBudget": {
"description": "The total number of alarms allowed in the alarm budget. This is a fixed value. The sum of (associationMajorAggAlarmThreshold * # VSTP-MPs), (linkMajorAggAlarmThreshold * # VSTP-MPs), linksetCriticalAggAlarmThreshold, routeCriticalAggAlarmThreshold, and rspCriticalAggAlarmThreshold cannot exceed alarmBudget.",
"readOnly": true,
"type": "integer"
},
"associationCriticalAggAlarmThreshold": {
"description": "When the number of Connection (/vstp/connections) failure alarms raised by a single VSTP-MP exceeds this threshold: 1) the already-raised major aggregate Connection failure alarm for that VSTP-MP is cleared, and 2) a single aggregate Connection failure alarm of critical severity is raised by the SOAM against that VSTP-MP. The value of associationCriticalAggAlarmThreshold is not included in the available alarm budget. Set associationCriticalAggAlarmThreshold to zero to prevent entirely the raising of a critical aggregate alarm for Connection failures.",
"default": 200,
"minimum": 0,
"type": "integer"
},
"associationMajorAggAlarmThreshold": {
"description": "When the number of Connection (/vstp/connections) failure alarms raised by a single VSTP-MP exceeds this threshold: 1) all individual Connection failure alarms raised to that point are cleared, and 2) a single aggregate Connection failure alarm of major severity is raised by the SOAM against that VSTP-MP. The value of associationMajorAggAlarmThreshold is included in the available alarm budget, multiplied by the number of VSTP-MP in the DSR. So the sum of (associationMajorAggAlarmThreshold * # VSTP-MPs), (linkMajorAggAlarmThreshold * # VSTP-MPs), linksetCriticalAggAlarmThreshold, routeCriticalAggAlarmThreshold, and rspCriticalAggAlarmThreshold cannot exceed alarmBudget.",
"default": 100,
"minimum": 1,
"type": "integer"
},
"linkCriticalAggAlarmThreshold": {
"description": "When the number of Link (/vstp/links) failure alarms raised by a single VSTP-MP exceeds this threshold: 1) the already-raised major aggregate Link failure alarm for that VSTP-MP is cleared, and 2) a single aggregate Link failure alarm of critical severity is raised by the SOAM against that VSTP-MP. The value of linkCriticalAggAlarmThreshold is not included in the available alarm budget. Set linkCriticalAggAlarmThreshold to zero to prevent entirely the raising of a critical aggregate alarm for Link failures.",
"minimum": 0,
"default": 200,
"type": "integer"
},
"linkMajorAggAlarmThreshold": {
"description": "When the number of Link (/vstp/links) failure alarms raised by a single VSTP-MP exceeds this threshold: 1) all individual Link failure alarms raised to that point are cleared, and 2) a single aggregate Link failure alarm of major severity is raised by the SOAM against that VSTP-MP. The value of linkMajorAggAlarmThreshold is included in the available alarm budget, multiplied by the number of VSTP-MP in the DSR. So the sum of (associationMajorAggAlarmThreshold * # VSTP-MPs), (linkMajorAggAlarmThreshold * # VSTP-MPs), linksetCriticalAggAlarmThreshold, routeCriticalAggAlarmThreshold, and rspCriticalAggAlarmThreshold cannot exceed alarmBudget.",
"default": 100,
"minimum": 1,
"type": "integer"
},
"linksetCriticalAggAlarmThreshold": {
"description": "When the number of Linkset (/vstp/linksets) failure alarms raised by the VSTP exceeds this threshold: 1) all individual Linkset failure alarms raised to that point are cleared, and 2) a single aggregate Linkset failure alarm of critical severity is raised by the SOAM. So the sum of (associationMajorAggAlarmThreshold * # VSTP-MPs), (linkMajorAggAlarmThreshold * # VSTP-MPs), linksetCriticalAggAlarmThreshold, routeCriticalAggAlarmThreshold, and rspCriticalAggAlarmThreshold cannot exceed alarmBudget.",
"default": 300,
"minimum": 1,
"type": "integer"
},
"routeCriticalAggAlarmThreshold": {
"description": "When the number of Route (/vstp/routes) failure alarms raised by the VSTP exceeds this threshold: 1) all individual Route failure alarms raised to that point are cleared, and 2) a single aggregate Route failure alarm of critical severity is raised by the SOAM. So the sum of (associationMajorAggAlarmThreshold * # VSTP-MPs), (linkMajorAggAlarmThreshold * # VSTP-MPs), linksetCriticalAggAlarmThreshold, routeCriticalAggAlarmThreshold, and rspCriticalAggAlarmThreshold cannot exceed alarmBudget.",
"default": 600,
"minimum": 1,
"type": "integer"
},
"rspCriticalAggAlarmThreshold": {
"description": "When the number of Remote Signaling Point (/vstp/remotesignalingpoints) failure alarms raised by the VSTP exceeds this threshold: 1) all individual Remote Signaling Point failure alarms raised to that point are cleared, and 2) a single aggregate Remote Signaling Point failure alarm of critical severity is raised by the SOAM. So the sum of (associationMajorAggAlarmThreshold * # VSTP-MPs), (linkMajorAggAlarmThreshold * # VSTP-MPs), linksetCriticalAggAlarmThreshold, routeCriticalAggAlarmThreshold, and rspCriticalAggAlarmThreshold cannot exceed alarmBudget.",
"default": 600,
"minimum": 1,
"type": "integer"
}
},
"required": [
"associationCriticalAggAlarmThreshold",
"associationMajorAggAlarmThreshold",
"linkCriticalAggAlarmThreshold",
"linkMajorAggAlarmThreshold",
"linksetCriticalAggAlarmThreshold",
"routeCriticalAggAlarmThreshold",
"rspCriticalAggAlarmThreshold"
],
"type": "object"
}
Example
{
"associationCriticalAggAlarmThreshold": 200,
"associationMajorAggAlarmThreshold": 100,
"linkCriticalAggAlarmThreshold": 200,
"linkMajorAggAlarmThreshold": 100,
"linksetCriticalAggAlarmThreshold": 300,
"routeCriticalAggAlarmThreshold": 600,
"rspCriticalAggAlarmThreshold": 600
}
Bulk Export XSD Schema
This section contains the export XSD schema that is used to validate the XML file generated by a Bulk Configurator (/bulk/configurator) GET request.
<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<xsd:simpleType name="requiredString">
<xsd:restriction base="xsd:string">
<xsd:minLength value="1"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="IPv4">
<xsd:restriction base="xsd:string">
<xsd:pattern value="(([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5])"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="IPv4orIPv6">
<xsd:restriction base="xsd:string">
<xsd:pattern value="((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))|([0-9A-Fa-f:]){1,46}|([0-9A-Fa-f]*[:]{1,2}[0-9A-Fa-f\.]*[0-9A-Fa-f]){0,46}"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="IPv4orIPv6NetMask">
<xsd:restriction base="xsd:string">
<xsd:pattern value="((([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]).){3}([01]?[0-9]?[0-9]|2[0-4][0-9]|25[0-5]))|/[0-9]{1,3}"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="yesNo">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="yes"/>
<xsd:enumeration value="no"/>
</xsd:restriction>
</xsd:simpleType>
<!-- Peer Node Object -->
<xsd:complexType name="PeerNode">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="aaaProtocol" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="altRouteName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="altRtOnAnswerResultCode" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="altRtOnAnswerTimeout" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="altRtOnConnFailure" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="answerOnAnyEnabledConnection" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="0" name="appRouteTableName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="avpRemovalListName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="dtlsPort" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="fqdn" type="xsd:string"/>
<xsd:element maxOccurs="128" minOccurs="0" name="ip" type="IPAddress"/>
<xsd:element maxOccurs="1" minOccurs="0" name="isDynamic" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="0" name="maxAltRouteAttempts" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="minConnCapacity" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="msgPriorityCfgSetName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="msgPrioritySetting" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="peerNodeGroupName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="peerRouteTableName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="pendingAnswerTimerName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="realm" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="replaceDestHost" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="0" name="replaceDestRealm" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="0" name="routingOptionSetName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="sctpPort" type="xsd:integer"/>
<xsd:element maxOccurs="10" minOccurs="0" name="serverPort" type="Port"/>
<xsd:element maxOccurs="1" minOccurs="0" name="tcpPort" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="tlsPort" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="topologyHidingEnabled" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="0" name="transactionCfgSetName" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
<xsd:simpleType name="Port">
<xsd:restriction base="xsd:integer"></xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="IPAddress">
<xsd:restriction base="xsd:string"></xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="yesNoType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Yes"/>
<xsd:enumeration value="No"/>
</xsd:restriction>
</xsd:simpleType>
<!-- Local Node Object -->
<xsd:complexType name="LocalNode">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="certName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="certType" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="certVerifyMode" type="VerifyMode"/>
<xsd:element maxOccurs="1" minOccurs="1" name="cexCfgSetName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="connCfgSetName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="dtlsPort" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="endClientPort" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="fqdn" type="xsd:string"/>
<xsd:element maxOccurs="128" minOccurs="1" name="ip" type="LocalNodeIp"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="radiusClientPortEnabled" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="1" name="realm" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="sctpPort" type="xsd:integer"/>
<xsd:element maxOccurs="10" minOccurs="0" name="serverPort" type="Port"/>
<xsd:element maxOccurs="1" minOccurs="0" name="startClientPort" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="tcpPort" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="tlsPort" type="xsd:integer"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="LocalNodeIp">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="ipAddr" type="IPAddress"/>
<xsd:element maxOccurs="1" minOccurs="1" name="ipType" type="localIPType"/>
</xsd:sequence>
</xsd:complexType>
<xsd:simpleType name="localIPType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="LocalIp"/>
<xsd:enumeration value="IpfeTsa"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="VerifyMode">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="SslVerifyNone"/>
<xsd:enumeration value="SslVerifyPeer"/>
<xsd:enumeration value="SslVerifyPeerFailIfNoPeerCert"/>
<xsd:enumeration value="SslVerifyPeerVerifyClientOnce"/>
</xsd:restriction>
</xsd:simpleType>
<!-- Connection Object -->
<xsd:complexType name="Connection">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="aaaProtocol" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="altLocalIp" type="ipAddressType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="altPeerIp" type="ipAddressType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="capacityCfgSetName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="cexCfgSetName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="connCfgSetName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="connectionMode" type="connectionType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="ipfeInitiatorDampIp" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="isDynamic" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="0" name="localInitiatePort" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="localIp" type="ipAddressType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="localIpOwner" type="ipAddressType"/>
<xsd:element maxOccurs="1" minOccurs="1" name="localNodeName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="msgAuthCfgSetName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="msgConvCfgSetName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="msgPriorityCfgSetName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="msgPrioritySetting" type="connMsgPrioritySetting"/>
<xsd:element maxOccurs="1" minOccurs="0" name="msgThrottlingCfgSetName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="peerIdentification" type="connectionPeerIdent"/>
<xsd:element maxOccurs="1" minOccurs="0" name="peerIp" type="ipAddressType"/>
<xsd:element maxOccurs="1" minOccurs="1" name="peerNodeName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="remoteBusyTimeout" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="remoteBusyUsage" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="0" name="sharedSecretCfgSetName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="statusServerCfgSetName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="suppressConnAttempt" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="0" name="suppressConnUnavailableAlarm" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="0" name="testMode" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="0" name="transportCongTimeout" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="transportFqdn" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="transportProtocol" type="connectionProtocol"/>
<xsd:element maxOccurs="1" minOccurs="0" name="udpPort" type="xsd:integer"/>
</xsd:sequence>
</xsd:complexType>
<xsd:simpleType name="ipAddressType">
<xsd:restriction base="xsd:string"></xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="enabledDisabledType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Enabled"/>
<xsd:enumeration value="Disabled"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="connectionType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="FullySpecified"/>
<xsd:enumeration value="LocalMpInitiator"/>
<xsd:enumeration value="LocalMpResponder"/>
<xsd:enumeration value="RadiusServer"/>
<xsd:enumeration value="RadiusClient"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="connectionProtocol">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Sctp"/>
<xsd:enumeration value="Dtls"/>
<xsd:enumeration value="Tcp"/>
<xsd:enumeration value="Tls"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="connectionPeerIdent">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Ip"/>
<xsd:enumeration value="TransportFqdn"/>
<xsd:enumeration value="PeerFqdn"/>
<xsd:enumeration value="None"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="connMsgPrioritySetting">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="None"/>
<xsd:enumeration value="RequestMessage"/>
<xsd:enumeration value="UserConfigured"/>
</xsd:restriction>
</xsd:simpleType>
<!-- Peer Route Table -->
<xsd:complexType name="PeerRouteTable">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
<!-- Route Group Object -->
<xsd:complexType name="RouteGroup">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="512" minOccurs="0" name="connection" type="ConnRouteGroup"/>
<xsd:element maxOccurs="1" minOccurs="0" name="isDynamic" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="0" name="isTrafficMeasuringEnabled" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="0" name="name" type="xsd:string"/>
<xsd:element maxOccurs="160" minOccurs="0" name="peerNode" type="PeerRouteGroup"/>
<xsd:element maxOccurs="1" minOccurs="1" name="type" type="RouteGroupType"/>
</xsd:sequence>
</xsd:complexType>
<xsd:simpleType name="RouteGroupType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Peer"/>
<xsd:enumeration value="Connection"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:complexType name="PeerRouteGroup">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="peerNodeName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="peerNodeWeight" type="xsd:integer"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="ConnRouteGroup">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="connectionName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="connectionWeight" type="xsd:integer"/>
</xsd:sequence>
</xsd:complexType>
<!-- Peer Routing Rules -->
<xsd:complexType name="PeerRouteRule">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="action" type="peerRouteRuleAction"/>
<xsd:element maxOccurs="1" minOccurs="1" name="conditions" type="RuleConditions"/>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="diamAnsCode" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="errorMessage" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="msgCpyCfgSetName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="msgPriority" type="peerRouteRuleMsgPriority"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="peerRouteTableName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="priority" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="routeListName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="targetPrtName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="vendorId" type="xsd:integer"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="RuleConditions">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="appId" type="IntegerValueRuleCondition"/>
<xsd:element maxOccurs="1" minOccurs="1" name="cmdCode" type="StringValueRuleCondition"/>
<xsd:element maxOccurs="1" minOccurs="1" name="destHost" type="StringValueRuleCondition"/>
<xsd:element maxOccurs="1" minOccurs="1" name="destRealm" type="StringValueRuleCondition"/>
<xsd:element maxOccurs="1" minOccurs="1" name="origHost" type="StringValueRuleCondition"/>
<xsd:element maxOccurs="1" minOccurs="1" name="origRealm" type="StringValueRuleCondition"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="IntegerValueRuleCondition">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="operator" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="value" type="xsd:integer"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="StringValueRuleCondition">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="operator" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="value" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
<xsd:simpleType name="peerRouteRuleAction">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="RouteToPeer"/>
<xsd:enumeration value="SendAnswer"/>
<xsd:enumeration value="AbandonWithNoAns"/>
<xsd:enumeration value="RouteToPrt"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="peerRouteRuleMsgPriority">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Nc"/>
<xsd:enumeration value="Pr0"/>
<xsd:enumeration value="Pr1"/>
<xsd:enumeration value="Pr2"/>
<xsd:enumeration value="Pr3"/>
<xsd:enumeration value="Pr4"/>
<xsd:enumeration value="Pr5"/>
<xsd:enumeration value="Pr6"/>
<xsd:enumeration value="Pr7"/>
<xsd:enumeration value="Pr8"/>
<xsd:enumeration value="Pr9"/>
<xsd:enumeration value="Pr10"/>
<xsd:enumeration value="Pr11"/>
<xsd:enumeration value="Pr12"/>
<xsd:enumeration value="Pr13"/>
<xsd:enumeration value="Pr14"/>
<xsd:enumeration value="Pr15"/>
</xsd:restriction>
</xsd:simpleType>
<!-- DPD Realms -->
<xsd:complexType name="DpdRealm">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="description" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="realm" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
<!-- DPD DNS Sets -->
<xsd:complexType name="DpdDnsSet">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="numRetries" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="primaryIp" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="queryTimeout" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="secondaryIp" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
<!-- DPD Attribute Sets -->
<xsd:complexType name="DpdAttributeSet">
<xsd:sequence>
<xsd:element maxOccurs="10" minOccurs="1" name="applications" type="DpdAttributeApplications"/>
<xsd:element maxOccurs="1" minOccurs="1" name="capacityCfgSetName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="connCfgSetName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="connectionMode" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="dnsSet" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="followProtoPref" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="ipfeInitiatorDAMPIp" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="localIp" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="localNode" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="realm" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="realmPrefix" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="DpdAttributeApplications">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="appId" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="appIdType" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="dtlsPref" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="maxConnections" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="maxPeers" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpPref" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="tcpPref" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="tlsPref" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="vendorId" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
<!-- Traffic Throttle Point -->
<xsd:complexType name="TrafficThrottlePoint">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="altImplicitRouteListName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="appId" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="maxEtr" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="maxLossPercentThresh" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="peerNodeName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="ttpConfigurationSetName" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
<!-- Traffic Throttle Group -->
<xsd:complexType name="TrafficThrottleGroup">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="appId" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="shared" type="xsd:boolean"/>
<xsd:element maxOccurs="20" minOccurs="1" name="trafficThrottlePointName" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
<!-- Connection Configuration Set -->
<xsd:complexType name="ConnCfgSet">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="cl1MinPriorityAllowed" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="cl2MinPriorityAllowed" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="cl3MinPriorityAllowed" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="diameterCexHostIpValidationEnabled" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="1" name="diameterCexTimer" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="diameterDisconnectTimer" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="diameterPendingTransactionsPerConnection" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="diameterProvingDeviceWatchdogRequestsToSend" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="diameterProvingMode" type="provingMode"/>
<xsd:element maxOccurs="1" minOccurs="1" name="diameterProvingTimeout" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="diameterTransportConnectionTimer" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="diameterWatchdogTimerInitValue" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="radiusCachedResponseDuration" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="radiusPendingTransactionsPerConnection" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="radiusPreventDuplicateEgressRetransmission" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="1" name="radiusPreventDuplicateIngressRetransmission" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpDatagramBundlingEnabled" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpFragmentationEnabled" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpHeartbeatInterval" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpMaximumBurst" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpMaximumSegmentSize" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpNumberInboundStreams" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpNumberOutboundStreams" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpOrderedDelivery" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpRetransmissionAssociationFailure" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpRetransmissionInitFailure" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpRetransmissionInitTimeout" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpRetransmissionMaximumTimeout" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpRetransmissionMaximumTimeoutInit" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpRetransmissionMinimumTimeout" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpRetransmissionPathFailure" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpSackDelay" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpSocketReceiveSize" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpSocketSendSize" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="tcpKeepAliveEnabled" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="1" name="tcpKeepAliveIdleTime" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="tcpKeepAliveMaximumCount" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="tcpKeepAliveProbeInterval" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="tcpMaximumSegmentSize" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="tcpNagleEnabled" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="1" name="tcpSocketReceiveSize" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="tcpSocketSendSize" type="xsd:integer"/>
</xsd:sequence>
</xsd:complexType>
<xsd:simpleType name="provingMode">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Always"/>
<xsd:enumeration value="Suspect"/>
<xsd:enumeration value="Never"/>
</xsd:restriction>
</xsd:simpleType>
<!-- Capacity Configuration Set -->
<xsd:complexType name="CapCfgSet">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="convergenceTime" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="ingressMpsMajorAlarmThreshold" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="ingressMpsMinorAlarmThreshold" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="maxIngressMps" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="reservedIngressMps" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="reservedIngressMpsAbatementTime" type="xsd:integer"/>
</xsd:sequence>
</xsd:complexType>
<!-- Egress Message Throttling Configuration Set -->
<xsd:complexType name="MsgThrottlingCfgSet">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="abatementThresh1" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="abatementThresh2" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="abatementThresh3" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="abatementTime" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="convergenceTime" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="maxEgressMessageRate" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="throttleThresh1" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="throttleThresh2" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="throttleThresh3" type="xsd:integer"/>
</xsd:sequence>
</xsd:complexType>
<!-- Message Copy Configuration Set -->
<xsd:complexType name="MessageCopyCfgSet">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="answerIncluded" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="dasAnswerResultCode" type="MCCSDasAnswerResultCodeType"/>
<xsd:element maxOccurs="4" minOccurs="1" name="maxRetryAttempts" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="originalAnswerResultCode" type="MCCSOriginalAnswerType"/>
<xsd:element maxOccurs="1" minOccurs="1" name="requestType" type="MCCSRequestTypeType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="routeListName" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
<xsd:simpleType name="MCCSDasAnswerResultCodeType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="2xxx"/>
<xsd:enumeration value="Any"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="MCCSOriginalAnswerType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="2xxx"/>
<xsd:enumeration value="Any"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="MCCSRequestTypeType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Ingress"/>
<xsd:enumeration value="Egress"/>
</xsd:restriction>
</xsd:simpleType>
<!-- Rate Limiting Configuration Set -->
<xsd:complexType name="RateCfgSet">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="maxRate" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="rateAbateThresh1" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="rateAbateThresh2" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="rateAbateThresh3" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="rateAbateTime" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="rateConvergenceTime" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="rateOnsetThresh1" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="rateOnsetThresh2" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="rateOnsetThresh3" type="xsd:integer"/>
</xsd:sequence>
</xsd:complexType>
<!-- Pending Transaction Rate Limiting Configuration Set -->
<xsd:complexType name="PendTransCfgSet">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="maxPendTrans" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="pendConvergenceTime" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="pendTransAbateThresh1" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="pendTransAbateThresh2" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="pendTransAbateThresh3" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="pendTransAbateTime" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="pendTransOnsetThresh1" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="pendTransOnsetThresh2" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="pendTransOnsetThresh3" type="xsd:integer"/>
</xsd:sequence>
</xsd:complexType>
<!-- Traffic Throttle Point Configurarion Set -->
<xsd:complexType name="TrafficThrPointCfgSet">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="abatementRecoveryRate" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="defaultReductionPercentage" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="defaultValidityDuration" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="overrideMessagePriorityThreshold" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="rateConvergenceTime" type="xsd:integer"/>
</xsd:sequence>
</xsd:complexType>
<!-- Transaction Configuration Set -->
<xsd:complexType name="TransactionCfgSet">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
<xsd:element maxOccurs="1000" minOccurs="0" name="transactionRule" type="TransactionCfgRule"/>
</xsd:sequence>
</xsd:complexType>
<!-- Transaction Configuration Rule -->
<xsd:complexType name="TransactionCfgRule">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="appId" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="applicationRouteTableName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="cmdCode" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="peerRouteTableName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="pendingAnswerTimerName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="routingOptionSetName" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
<!-- Message Priority Configuration Set -->
<xsd:complexType name="MsgPriorityCfgSet">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="50" minOccurs="1" name="messagePriorityRule" type="MessagePriorityRule"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="MessagePriorityRule">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="appId" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="cmdCode" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="priority" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="ruleAppliesToAllAppIds" type="xsd:boolean"/>
</xsd:sequence>
</xsd:complexType>
<!-- Capabilities Exchange Configuration Set -->
<xsd:complexType name="CexCfgSet">
<xsd:sequence>
<xsd:element maxOccurs="10" minOccurs="0" name="clientMustIncludeAppIds" type="CexParameterCexCfgSet"/>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="10" minOccurs="0" name="dsrSupportedAppIds" type="CexParameterCexCfgSet"/>
<xsd:element maxOccurs="10" minOccurs="0" name="dsrSupportedVendorIds" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="includeDsrFeatureStatusAvp" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="0" name="isDynamic" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="CexParameterCexCfgSet">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="appId" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="appIdType" type="CexParameterAppIdType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="vendorId" type="xsd:integer"/>
</xsd:sequence>
</xsd:complexType>
<xsd:simpleType name="CexParameterAppIdType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Authentication"/>
<xsd:enumeration value="Accounting"/>
</xsd:restriction>
</xsd:simpleType>
<!-- MCC MNC Mapping -->
<xsd:complexType name="MccMncMapping">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="ccndc" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="country" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="description" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="mcc" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="mnc" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="networkname" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="prefix" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="realm" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
<!-- Egress Throttle List -->
<xsd:complexType name="Etl">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="3" minOccurs="2" name="etg" type="siteEtgNameGrp"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="pendingTransLimitingCfgSetName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="rateLimitingCfgSetName" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="siteEtgNameGrp">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="connectionFailurePercentReduction" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="egressThrottleGroupName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="siteName" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
<!-- MP Profile Assignment -->
<xsd:complexType name="MpProfileAssignment">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="hostname" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="profileName" type="ProfileType"/>
</xsd:sequence>
</xsd:complexType>
<xsd:simpleType name="ProfileType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Unassigned"/>
<xsd:enumeration value="G6_Relay"/>
<xsd:enumeration value="G8G9_Relay"/>
<xsd:enumeration value="G7_Relay"/>
<xsd:enumeration value="G6_Database"/>
<xsd:enumeration value="G8G9_Database"/>
<xsd:enumeration value="G7_Database"/>
<xsd:enumeration value="G6_Session"/>
<xsd:enumeration value="G8G9_Session"/>
<xsd:enumeration value="G7_Session"/>
<xsd:enumeration value="G6_Session_Database"/>
<xsd:enumeration value="G8G9_Session_Database"/>
<xsd:enumeration value="G7_Session_Database"/>
<xsd:enumeration value="VM_Relay"/>
<xsd:enumeration value="VM_Database"/>
<xsd:enumeration value="VM_6K_Mps"/>
<xsd:enumeration value="VM_8K_Mps"/>
<xsd:enumeration value="VM_10K_Mps"/>
<xsd:enumeration value="VM_12K_Mps"/>
<xsd:enumeration value="VM_14K_Mps"/>
<xsd:enumeration value="VM_16K_Mps"/>
<xsd:enumeration value="VM_18K_Mps"/>
<xsd:enumeration value="VM_21K_Mps"/>
<xsd:enumeration value="VM_24K_Mps"/>
<xsd:enumeration value="VM_27K_Mps"/>
<xsd:enumeration value="VM_30K_Mps"/>
<xsd:enumeration value="G8G9_MDIWF"/>
<xsd:enumeration value="VM_MDIWF"/>
</xsd:restriction>
</xsd:simpleType>
<!-- Route List Object -->
<xsd:complexType name="RouteList">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="isDynamic" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="1" name="minCapacity" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="rarg" type="xsd:boolean"/>
<xsd:element maxOccurs="3" minOccurs="1" name="routeListRouteGroup" type="RouteListRouteGroup"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="RouteListRouteGroup">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="priority" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="routeGroupName" type="xsd:string"/>
<xsd:element maxOccurs="10" minOccurs="0" name="routeListRouteGroupTtg" type="RouteListRouteGroupTtg"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="RouteListRouteGroupTtg">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="lossPercentThreshold" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="siteName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="ttgName" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
<!-- IPFE Options -->
<xsd:complexType name="IpfeOption">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="clusterRebalancingAndAccounting" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="globalPacketRateLimit" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="gratuitousArpType" type="GratuitousArpType"/>
<xsd:element maxOccurs="1" minOccurs="1" name="imbalanceDetectionThroughputMinimum" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="ipfeA1IpAddress" type="IPAddress"/>
<xsd:element maxOccurs="1" minOccurs="0" name="ipfeA2IpAddress" type="IPAddress"/>
<xsd:element maxOccurs="1" minOccurs="0" name="ipfeB1IpAddress" type="IPAddress"/>
<xsd:element maxOccurs="1" minOccurs="0" name="ipfeB2IpAddress" type="IPAddress"/>
<xsd:element maxOccurs="1" minOccurs="1" name="leastLoadThreshold" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="monitoringConnectionTimeout" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="monitoringConnectionTryInterval" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="monitoringPort" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="monitoringProtocol" type="MonitoringProtocolType"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpRejectOption" type="SctpRejectOptionType"/>
<xsd:element maxOccurs="1" minOccurs="1" name="stateSyncReconnectInterval" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="stateSyncTcpPort" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="tcpRejectOption" type="TcpRejectOptionType"/>
</xsd:sequence>
</xsd:complexType>
<xsd:simpleType name="GratuitousArpType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="ArpRequest"/>
<xsd:enumeration value="ArpReply"/>
<xsd:enumeration value="ArpBoth"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="MonitoringProtocolType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Heartbeat"/>
<xsd:enumeration value="None"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="SctpRejectOptionType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Drop"/>
<xsd:enumeration value="IcmpAdminProhibited"/>
<xsd:enumeration value="IcmpHostUnreachable"/>
<xsd:enumeration value="IcmpPortUnreachable"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="TcpRejectOptionType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Drop"/>
<xsd:enumeration value="IcmpAdminProhibited"/>
<xsd:enumeration value="IcmpHostUnreachable"/>
<xsd:enumeration value="IcmpPortUnreachable"/>
<xsd:enumeration value="TcpReset"/>
</xsd:restriction>
</xsd:simpleType>
<!-- IPFE Target Sets -->
<xsd:complexType name="IpfeTargetSet">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="allowedDeviation" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="alternateIpAddress" type="IPAddress"/>
<xsd:element maxOccurs="1" minOccurs="0" name="alternatePreferredIpfeServer" type="PreferredIpfeServerType"/>
<xsd:element maxOccurs="16" minOccurs="1" name="applicationServerIp" type="ApplicationServerIp"/>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="deleteAge" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="disabled" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="1" name="ipAddress" type="IPAddress"/>
<xsd:element maxOccurs="1" minOccurs="1" name="loadBalanceAlgorithm" type="LoadBalanceAlgorithmType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="loadFactorConnectionCount" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="loadFactorMps" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="number" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="peerNodeAwareEnabled" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="0" name="peerNodeGroupDistributionThreshold" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="preferredIpfeServer" type="PreferredIpfeServerType"/>
<xsd:element maxOccurs="1" minOccurs="1" name="protocols" type="ProtocolsType"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="ApplicationServerIp">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="alternateIpAddress" type="IPAddress"/>
<xsd:element maxOccurs="1" minOccurs="1" name="ipAddress" type="IPAddress"/>
<xsd:element maxOccurs="1" minOccurs="0" name="serverDescription" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="weight" type="xsd:integer"/>
</xsd:sequence>
</xsd:complexType>
<xsd:simpleType name="LoadBalanceAlgorithmType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Hash"/>
<xsd:enumeration value="LeastLoad"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="PreferredIpfeServerType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="IpfeA1"/>
<xsd:enumeration value="IpfeA2"/>
<xsd:enumeration value="IpfeB1"/>
<xsd:enumeration value="IpfeB2"/>
<xsd:enumeration value="IpfeC1"/>
<xsd:enumeration value="IpfeC2"/>
<xsd:enumeration value="IpfeD1"/>
<xsd:enumeration value="IpfeD2"/>
<xsd:enumeration value="IpfeE1"/>
<xsd:enumeration value="IpfeE2"/>
<xsd:enumeration value="IpfeF1"/>
<xsd:enumeration value="IpfeF2"/>
<xsd:enumeration value="IpfeG1"/>
<xsd:enumeration value="IpfeG2"/>
<xsd:enumeration value="IpfeH1"/>
<xsd:enumeration value="IpfeH2"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="ProtocolsType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Sctp"/>
<xsd:enumeration value="Tcp"/>
<xsd:enumeration value="SctpAndTcp"/>
</xsd:restriction>
</xsd:simpleType>
<!-- DNS Options -->
<xsd:complexType name="DnsOption">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="primaryIp" type="IPAddress"/>
<xsd:element maxOccurs="1" minOccurs="1" name="queryDuration" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="secondaryIp" type="IPAddress"/>
</xsd:sequence>
</xsd:complexType>
<!-- Routing Option Sets -->
<xsd:complexType name="RoutingOptionSet">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="connCongestionAction" type="ActionType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="connCongestionErrMsg" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="connCongestionResultCode" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="connCongestionVendorId" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="connFailureAction" type="ActionType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="connFailureErrMsg" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="connFailureResultCode" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="connFailureVendorId" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="destRealmNotServedAction" type="ActionType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="destRealmNotServedErrMsg" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="destRealmNotServedResultCode" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="destRealmNotServedVendorId" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="maxPerMsgFwdAllowed" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="nestedArtPrtErrorAction" type="ActionType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="nestedArtPrtErrorErrMsg" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="nestedArtPrtErrorResultCode" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="nestedArtPrtErrorVendorId" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="noPeerResponseAction" type="ActionType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="noPeerResponseErrMsg" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="noPeerResponseResultCode" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="noPeerResponseVendorId" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="peerRptCongestionAction" type="ActionType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="peerRptCongestionErrMsg" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="peerRptCongestionResultCode" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="peerRptCongestionVendorId" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="pendingAnswerTimerName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="resExhAction" type="ActionType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="resExhErrMsg" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="resExhResultCode" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="resExhVendorId" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="transactionLifetime" type="xsd:integer"/>
</xsd:sequence>
</xsd:complexType>
<xsd:simpleType name="ActionType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Abandon"/>
<xsd:enumeration value="SendAnswer"/>
</xsd:restriction>
</xsd:simpleType>
<!-- Options -->
<xsd:complexType name="Option">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="alarmBudget" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="congestionDiscardPolicy" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="connCriticalAggAlarmThreshold" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="connMajorAggAlarmThreshold" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="connReservedIngressMpsScaling" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="diameterEngMessageSize" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="dpdRealmExpiryMajAlarmThresholdHrs" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="dpdRealmExpiryMinAlarmThresholdHrs" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="encodeFqdnInLowerCase" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="0" name="etgMode" type="etgModeType"/>
<xsd:element maxOccurs="1" minOccurs="1" name="excessiveRerouteAbateThreshold" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="excessiveRerouteOnsetThreshold" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="ipfeConnCriticalAggAlarmThreshold" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="ipfeConnMajorAggAlarmThreshold" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="msgCopyDisableCongLevel" type="congLevelType"/>
<xsd:element maxOccurs="1" minOccurs="1" name="msgCopyFeatureEnabled" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="0" name="ngnPs16PriorityAdminStateEnabled" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="1" name="ngnPsAdminStateEnabled" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="0" name="ngnPsAnswerPriorityMode" type="answerPriorityModeType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="ngnPsCxAdminStateEnabled" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="0" name="ngnPsDhAdminStateEnabled" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="0" name="ngnPsGxAdminStateEnabled" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="0" name="ngnPsGxAdvancedPriority" type="gxAdvancedPriorityType"/>
<xsd:element maxOccurs="5" minOccurs="0" name="ngnPsGxArp" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="ngnPsMaxMessageRatePercentage" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="ngnPsMaxNormalRequestPriority" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="ngnPsMaxPriority0Allowed" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="ngnPsMaxPriority1Allowed" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="ngnPsMaxPriority2Allowed" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="ngnPsMinimumAnswerPriority" type="answerPriorityType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="ngnPsMinimumInviolablePriority" type="inviolablePriorityType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="ngnPsRxAdminStateEnabled" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="0" name="ngnPsRxMpsAvpValue" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="peerNodeCriticalAggAlarmThreshold" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="peerPingFeatureEnabled" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="1" name="radiusUdpClientSockRecvSize" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="radiusUdpClientSockSendSize" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="radiusUdpServerSockRecvSize" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="radiusUdpServerSockSendSize" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="redirectAnsProcessingEnabled" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="0" name="redirectApplicationRouteTableName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="redirectPeerRouteTableName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="routeListCriticalAggAlarmThreshold" type="xsd:integer"/>
</xsd:sequence>
</xsd:complexType>
<!-- Application Priority Option -->
<xsd:complexType name="ApplicationPriorityOption">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="answerDrmpAvpAdminStateEnabled" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="1" name="appId" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="ngnPs3gppAvpAdminStateEnabled" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="0" name="ngnPsDrmpAvpAdminStateEnabled" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="0" name="requestDrmpAvpAdminStateEnabled" type="xsd:boolean"/>
</xsd:sequence>
</xsd:complexType>
<xsd:simpleType name="congLevelType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Cl1"/>
<xsd:enumeration value="Cl2"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="gxAdvancedPriorityType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Hss"/>
<xsd:enumeration value="None"/>
<xsd:enumeration value="Spr"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="answerPriorityType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="P0"/>
<xsd:enumeration value="P3"/>
<xsd:enumeration value="P14"/>
<xsd:enumeration value="P15"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="inviolablePriorityType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="P3"/>
<xsd:enumeration value="P4"/>
<xsd:enumeration value="P15"/>
<xsd:enumeration value="P99"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="etgModeType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Threshold"/>
<xsd:enumeration value="Limit"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="answerPriorityModeType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="HighestPriority"/>
<xsd:enumeration value="RequestPriority"/>
</xsd:restriction>
</xsd:simpleType>
<!-- Application Ids -->
<xsd:complexType name="ApplicationId">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="appId" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
<!-- Application Route Table -->
<xsd:complexType name="ApplicationRouteTable">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
<!-- Peer Node Group -->
<xsd:complexType name="PeerNodeGroup">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
<xsd:element maxOccurs="32" minOccurs="0" name="peerNode" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
<!-- Pending Answer Timer -->
<xsd:complexType name="PendingAnswerTimer">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="value" type="xsd:integer"/>
</xsd:sequence>
</xsd:complexType>
<!-- Command Code -->
<xsd:complexType name="CommandCode">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="cmdCode" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
<xsd:simpleType name="appIdType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Accounting"/>
<xsd:enumeration value="Authentication"/>
</xsd:restriction>
</xsd:simpleType>
<!-- Reserved MCC Range -->
<xsd:complexType name="ReservedMccRange">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="endMccRange" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="startMccRange" type="xsd:integer"/>
</xsd:sequence>
</xsd:complexType>
<!-- AVP Removal List -->
<xsd:complexType name="AvpRemovalList">
<xsd:sequence>
<xsd:element maxOccurs="10" minOccurs="1" name="avp" type="AvpRemovalListType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="direction" type="RemovalDirectionType"/>
<xsd:element maxOccurs="1" minOccurs="1" name="messageType" type="RemovalType"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="AvpRemovalListType">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="avpCode" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="avpName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="vendorId" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="vendorName" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
<xsd:simpleType name="RemovalDirectionType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Egress"/>
<xsd:enumeration value="Ingress"/>
<xsd:enumeration value="IngressAndEgress"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="RemovalType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="AnswerOnly"/>
<xsd:enumeration value="RequestOnly"/>
<xsd:enumeration value="RequestAndAnswer"/>
</xsd:restriction>
</xsd:simpleType>
<!-- Reroute On Answer -->
<xsd:complexType name="RerouteOnAnswer">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="ansResultCode" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="appId" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="id" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="ruleAppliesToAllAppIds" type="xsd:boolean"/>
</xsd:sequence>
</xsd:complexType>
<!-- Application Route Rule -->
<xsd:complexType name="ApplicationRouteRule">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="action" type="appRouteRuleAction"/>
<xsd:element maxOccurs="1" minOccurs="0" name="ansErrorMessage" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="ansResultCode" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="appName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="appRouteTableName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="conditions" type="RuleConditions"/>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="forwardToTableName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="gxPrimeRequest" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="priority" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="vendorId" type="xsd:integer"/>
</xsd:sequence>
</xsd:complexType>
<xsd:simpleType name="appRouteRuleAction">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="AbandonWithNoAns"/>
<xsd:enumeration value="ForwardToEgressRouting"/>
<xsd:enumeration value="RouteToAppl"/>
<xsd:enumeration value="SendAnswer"/>
<xsd:enumeration value="ForwardToArt"/>
<xsd:enumeration value="ForwardToPrt"/>
</xsd:restriction>
</xsd:simpleType>
<!-- Egress Throttle Group -->
<xsd:complexType name="EgressThrottleGroup">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="128" minOccurs="0" name="connectionName" type="xsd:string"/>
<xsd:element minOccurs="1" name="etgControlScope" type="etgControlScopeType"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
<xsd:element maxOccurs="128" minOccurs="0" name="peerNodeName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="pendingTransLimitingCfgSetName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="rateLimitingCfgSetName" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
<xsd:simpleType name="etgControlScopeType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Etg"/>
<xsd:enumeration value="Etl"/>
</xsd:restriction>
</xsd:simpleType>
<!-- CEX Parameter -->
<xsd:complexType name="CexParameter">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="appId" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="appIdType" type="CexParameterAppIdType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="id" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="vendorId" type="xsd:integer"/>
</xsd:sequence>
</xsd:complexType>
<!-- Remote Host Object -->
<xsd:complexType name="VstpRemoteHost">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="remoteHostName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="remoteHostType" type="hostType"/>
<xsd:element maxOccurs="1" minOccurs="1" name="remoteHostPort" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="remoteHostPriIPAddress" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="remoteHostSecIPAddress" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
<!-- Local Host Object -->
<xsd:complexType name="VstpLocalHost">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="localHostName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="localHostType" type="hostType"/>
<xsd:element maxOccurs="1" minOccurs="1" name="localHostPort" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="localHostPriIPAddress" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="localHostSecIPAddress" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
<!-- Connection Object -->
<xsd:complexType name="VstpConnection">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="connCfgSetName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="connectionType" type="connType"/>
<xsd:element maxOccurs="1" minOccurs="1" name="connectionMode" type="connMode"/>
<xsd:element maxOccurs="1" minOccurs="1" name="localHostName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="remoteHostName" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
<!-- Renote Signaling Point Object -->
<xsd:complexType name="VstpRemoteSignalingPoint">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="enableBroadcastException" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="mtpPointCode" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="ss7DomainType" type="domainType"/>
</xsd:sequence>
</xsd:complexType>
<!-- Connection Configuration Set -->
<xsd:complexType name="VstpConnCfgSet">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpFragmentationEnabled" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpHeartbeatInterval" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpMaximumBurst" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpMaximumSegmentSize" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpNumberInboundStreams" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpNumberOutboundStreams" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpOrderedDelivery" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpRetransmissionAssociationFailure" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpRetransmissionInitFailure" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpRetransmissionInitTimeout" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpRetransmissionMaximumTimeout" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpRetransmissionMaximumTimeoutInit" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpRetransmissionMinimumTimeout" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpRetransmissionPathFailure" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpSackDelay" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpSocketReceiveSize" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="sctpSocketSendSize" type="xsd:integer"/>
</xsd:sequence>
</xsd:complexType>
<!-- Local Signaling Point Object -->
<xsd:complexType name="VstpLocalSignalingPoint">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="mtpTruePointCode" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="mtpPrimaryCapabilityPointCode" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="ss7DomainType" type="domainType"/>
</xsd:sequence>
</xsd:complexType>
<!-- Link -->
<xsd:complexType name="VstpLink">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="connectionName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="linksetName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="signalingLinkCode" type="xsd:integer"/>
</xsd:sequence>
</xsd:complexType>
<!-- Link Set Object -->
<xsd:complexType name="VstpLinkSet">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="asNotification" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="0" name="enableBroadcastException" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="ituTransferRestricted" type="xsd:boolean"/>
<xsd:element maxOccurs="1" minOccurs="1" name="linkTransactionsPerSecond" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="localSignalingPointName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="numberSignalingLinkAllowedThreshold" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="numberSignalingLinkProhibitedThreshold" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="remoteSignalingPointName" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="routingContext" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="type" type="connType"/>
</xsd:sequence>
</xsd:complexType>
<!-- Route Object -->
<xsd:complexType name="VstpRoute">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="linksetName" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="remoteSignalingPoint" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="routeCost" type="xsd:integer"/>
</xsd:sequence>
</xsd:complexType>
<!-- GTT Set object -->
<xsd:complexType name="VstpGttSet">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="configurationLevel" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="1" name="domain" type="gttSetDomainType"/>
<xsd:element maxOccurs="1" minOccurs="1" name="gttSetType" type="setType"/>
<xsd:element maxOccurs="1" minOccurs="1" name="name" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
<xsd:simpleType name="hostType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Local"/>
<xsd:enumeration value="Remote"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="connType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="M3ua"/>
<xsd:enumeration value="M2pa"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="connMode">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Client"/>
<xsd:enumeration value="Server"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="adminState">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Enabled"/>
<xsd:enumeration value="Disabled"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="domainType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Ansi"/>
<xsd:enumeration value="Itui"/>
<xsd:enumeration value="Itun"/>
<xsd:enumeration value="Itun24"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="gttSetDomainType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Ansi"/>
<xsd:enumeration value="Cross"/>
<xsd:enumeration value="Itu"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="setType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Cdpagta"/>
</xsd:restriction>
</xsd:simpleType>
<!-- M2PA Options -->
<xsd:complexType name="VstpM2paOption">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1" name="t1Timer" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="t2Timer" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="t3Timer" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="t4EmergencyTimer" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="t4NormalTimer" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="t5Timer" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="t6Timer" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="t7Timer" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="t16Timer" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="1" name="t17Timer" type="xsd:integer"/>
</xsd:sequence>
</xsd:complexType>
<!--
- Copyright (C) 2013, 2017, Oracle and/or its affiliates. All rights reserved.
-->
<xsd:complexType name="diameterArea">
<xsd:choice maxOccurs="unbounded" minOccurs="0">
<xsd:element name="applicationId" type="ApplicationId"/>
<xsd:element name="applicationPriorityOption" type="ApplicationPriorityOption"/>
<xsd:element name="applicationRouteRule" type="ApplicationRouteRule"/>
<xsd:element name="applicationRouteTable" type="ApplicationRouteTable"/>
<xsd:element name="avpRemovalList" type="AvpRemovalList"/>
<xsd:element name="cexConfigurationSet" type="CexCfgSet"/>
<xsd:element name="capacityConfigurationSet" type="CapCfgSet"/>
<xsd:element name="cexParameter" type="CexParameter"/>
<xsd:element name="commandCode" type="CommandCode"/>
<xsd:element name="connection" type="Connection"/>
<xsd:element name="connectionConfigurationSet" type="ConnCfgSet"/>
<xsd:element name="dnsOption" type="DnsOption"/>
<xsd:element name="dpdAttributeSet" type="DpdAttributeSet"/>
<xsd:element name="dpdDnsSet" type="DpdDnsSet"/>
<xsd:element name="dpdRealm" type="DpdRealm"/>
<xsd:element name="egressMessageThrottlingConfigurationSet" type="MsgThrottlingCfgSet"/>
<xsd:element name="egressThrottleGroup" type="EgressThrottleGroup"/>
<xsd:element name="etl" type="Etl"/>
<xsd:element name="ipfeOption" type="IpfeOption"/>
<xsd:element name="ipfeTargetSet" type="IpfeTargetSet"/>
<xsd:element name="localNode" type="LocalNode"/>
<xsd:element name="mccMncMapping" type="MccMncMapping"/>
<xsd:element name="messageCopyConfigurationSet" type="MessageCopyCfgSet"/>
<xsd:element name="messagePriorityConfigurationSet" type="MsgPriorityCfgSet"/>
<xsd:element name="mpProfileAssignment" type="MpProfileAssignment"/>
<xsd:element name="option" type="Option"/>
<xsd:element name="peerNode" type="PeerNode"/>
<xsd:element name="peerNodeGroup" type="PeerNodeGroup"/>
<xsd:element name="peerRouteRule" type="PeerRouteRule"/>
<xsd:element name="peerRouteTable" type="PeerRouteTable"/>
<xsd:element name="pendingAnswerTimer" type="PendingAnswerTimer"/>
<xsd:element name="pendingTransactionLimitingConfigurationSet" type="PendTransCfgSet"/>
<xsd:element name="rateLimitingConfigurationSet" type="RateCfgSet"/>
<xsd:element name="rerouteOnAnswer" type="RerouteOnAnswer"/>
<xsd:element name="routeGroup" type="RouteGroup"/>
<xsd:element name="routeList" type="RouteList"/>
<xsd:element name="routingOptionSet" type="RoutingOptionSet"/>
<xsd:element name="trafficThrottleGroup" type="TrafficThrottleGroup"/>
<xsd:element name="trafficThrottlePoint" type="TrafficThrottlePoint"/>
<xsd:element name="trafficThrottlePointConfigurationSet" type="TrafficThrPointCfgSet"/>
<xsd:element name="transactionConfigurationSet" type="TransactionCfgSet"/>
</xsd:choice>
</xsd:complexType>
<xsd:simpleType name="sgLevel">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="A"/>
<xsd:enumeration value="B"/>
<xsd:enumeration value="C"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="serverRole">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Noam"/>
<xsd:enumeration value="Soam"/>
<xsd:enumeration value="Mp"/>
<xsd:enumeration value="QueryServer"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="deviceType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Bonding"/>
<xsd:enumeration value="Vlan"/>
<xsd:enumeration value="Alias"/>
<xsd:enumeration value="Ethernet"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:complexType name="deviceInterface">
<xsd:sequence>
<xsd:element minOccurs="0" name="ipAddress" type="IPv4orIPv6"/>
<xsd:element name="networkName" type="requiredString"/>
</xsd:sequence>
</xsd:complexType>
<xsd:simpleType name="routeType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Net"/>
<xsd:enumeration value="Host"/>
<xsd:enumeration value="Default"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="bootProtoType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="None"/>
<xsd:enumeration value="Dhcp"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="monitorType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Mii"/>
<xsd:enumeration value="Arp"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="arpValidationType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="None"/>
<xsd:enumeration value="Active"/>
<xsd:enumeration value="Backup"/>
<xsd:enumeration value="All"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="svcAction">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="insert"/>
<xsd:enumeration value="update"/>
<xsd:enumeration value="delete"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="scopeType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Server"/>
<xsd:enumeration value="ServerGroup"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="rolePref">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Default"/>
<xsd:enumeration value="Active"/>
<xsd:enumeration value="Standby"/>
<xsd:enumeration value="Spare"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:complexType name="ntpServer">
<xsd:sequence>
<xsd:element name="ipAddress" type="IPv4orIPv6"/>
<xsd:element name="prefer" type="xsd:boolean"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="networkElement">
<xsd:sequence>
<xsd:element name="name" type="requiredString"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="configHostname">
<xsd:sequence>
<xsd:element name="hostname" type="requiredString"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="network">
<xsd:sequence>
<xsd:element name="name" type="requiredString"/>
<xsd:element minOccurs="0" name="UUID" type="xsd:string"/>
<xsd:element minOccurs="0" name="neName" type="xsd:string"/>
<xsd:element minOccurs="0" name="type" type="xsd:string"/>
<xsd:element name="vlanId" type="xsd:string"/>
<xsd:element name="ipAddress" type="IPv4orIPv6"/>
<xsd:element name="subnetMask" type="IPv4orIPv6NetMask"/>
<xsd:element minOccurs="0" name="gatewayAddress" type="IPv4orIPv6"/>
<xsd:element name="isDefault" type="xsd:boolean"/>
<xsd:element name="isRoutable" type="xsd:boolean"/>
<xsd:element name="locked" type="xsd:boolean"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="ntpref">
<xsd:sequence>
<xsd:element name="NTP_Reference" type="IPv4"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="servicePath">
<xsd:sequence>
<xsd:element name="name" type="requiredString"/>
<xsd:element name="intraSitePath" type="requiredString"/>
<xsd:element name="interSitePath" type="requiredString"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="server">
<xsd:sequence>
<xsd:element name="hostname" type="requiredString"/>
<xsd:element name="networkElementName" type="requiredString"/>
<xsd:element minOccurs="0" name="serverGroupName" type="xsd:string"/>
<xsd:element name="profileName" type="requiredString"/>
<xsd:element name="location" type="xsd:string"/>
<xsd:element name="role" type="serverRole"/>
<xsd:element name="systemId" type="xsd:string"/>
<xsd:element name="ntpServers">
<xsd:complexType>
<xsd:sequence>
<xsd:element maxOccurs="unbounded" name="ntpServer" type="ntpServer"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="serverGroup">
<xsd:sequence>
<xsd:element name="name" type="requiredString"/>
<xsd:element name="level" type="sgLevel"/>
<xsd:element name="parentSgName" type="xsd:string"/>
<xsd:element name="functionName" type="xsd:string"/>
<xsd:element minOccurs="0" name="numWanRepConn" type="xsd:positiveInteger"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="networkDevice">
<xsd:sequence>
<xsd:element minOccurs="0" name="port" type="xsd:string"/>
<xsd:element name="type" type="deviceType"/>
<xsd:element minOccurs="0" name="status" type="xsd:string"/>
<xsd:element minOccurs="0" name="UUID" type="xsd:string"/>
<xsd:element name="hostname" type="requiredString"/>
<xsd:element minOccurs="0" name="interfaces">
<xsd:complexType>
<xsd:sequence>
<xsd:element maxOccurs="unbounded" minOccurs="0" name="interface" type="deviceInterface"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="options">
<xsd:complexType>
<xsd:all>
<xsd:element minOccurs="1" name="onboot" type="xsd:boolean"/>
<xsd:element minOccurs="1" name="bootProto" type="bootProtoType"/>
<xsd:element minOccurs="0" name="mtu" type="xsd:integer"/>
<xsd:element minOccurs="0" name="baseDevice">
<xsd:complexType>
<xsd:sequence>
<xsd:element maxOccurs="unbounded" minOccurs="1" name="baseDeviceItem" type="requiredString"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element maxOccurs="1" minOccurs="0" name="monitorType" type="monitorType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="primary" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="miimon" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="updelay" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="downdelay" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="arpInterval" type="xsd:integer"/>
<xsd:element maxOccurs="1" minOccurs="0" name="arpValidate" type="arpValidationType"/>
<xsd:element maxOccurs="1" minOccurs="0" name="arpIpTarget" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="hwAddr" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="persistentDhclient" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="ethtoolOpts" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="ethtoolAccelOpts" type="xsd:string"/>
</xsd:all>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="networkRoute">
<xsd:sequence>
<xsd:element name="hostname" type="xsd:string"/>
<xsd:element minOccurs="0" name="UUID" type="xsd:string"/>
<xsd:element name="type" type="routeType"/>
<xsd:element name="port" type="xsd:string"/>
<xsd:element minOccurs="0" name="networkAddress" type="IPv4orIPv6"/>
<xsd:element minOccurs="0" name="subnetMask" type="IPv4orIPv6NetMask"/>
<xsd:element name="gatewayAddress" type="IPv4orIPv6"/>
<xsd:element name="scope" type="xsd:string"/>
<xsd:element name="scopeType" type="scopeType"/>
<xsd:element minOccurs="0" name="status" type="xsd:string"/>
<xsd:element minOccurs="0" name="statusDetails" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="resourceDomain">
<xsd:sequence>
<xsd:element name="name" type="requiredString"/>
<xsd:element name="profileName" type="xsd:string"/>
<xsd:element minOccurs="0" name="sgNames">
<xsd:complexType>
<xsd:sequence>
<xsd:element maxOccurs="unbounded" name="sgName" type="requiredString"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="place">
<xsd:sequence>
<xsd:element name="name" type="requiredString"/>
<xsd:element minOccurs="0" name="parentPlaceName" type="xsd:string"/>
<xsd:element name="typeName" type="requiredString"/>
<xsd:element minOccurs="0" name="serverList">
<xsd:complexType>
<xsd:sequence>
<xsd:element maxOccurs="unbounded" name="serverListItem" type="requiredString"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="placeAssociation">
<xsd:sequence>
<xsd:element name="name" type="requiredString"/>
<xsd:element name="typeName" type="requiredString"/>
<xsd:element minOccurs="0" name="placeList">
<xsd:complexType>
<xsd:sequence>
<xsd:element maxOccurs="unbounded" name="placeListItem" type="requiredString"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="dscpInterfaceRule">
<xsd:sequence>
<xsd:element minOccurs="0" name="UUID" type="xsd:string"/>
<xsd:element name="interface" type="requiredString"/>
<xsd:element name="dscp" type="xsd:integer"/>
<xsd:element name="protocol" type="protocolType"/>
<xsd:element name="scope" type="xsd:string"/>
<xsd:element name="scopeType" type="scopeType"/>
</xsd:sequence>
</xsd:complexType>
<xsd:simpleType name="protocolType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Tcp"/>
<xsd:enumeration value="Sctp"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:complexType name="dscpPortRule">
<xsd:sequence>
<xsd:element minOccurs="0" name="UUID" type="xsd:string"/>
<xsd:element name="port" type="xsd:integer"/>
<xsd:element name="dscp" type="xsd:integer"/>
<xsd:element name="protocol" type="protocolType"/>
<xsd:element name="scope" type="xsd:string"/>
<xsd:element name="scopeType" type="scopeType"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="vip">
<xsd:sequence>
<xsd:element minOccurs="0" name="UUID" type="xsd:string"/>
<xsd:element name="serverGroupName" type="requiredString"/>
<xsd:element name="ipAddress" type="IPv4orIPv6"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="member">
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="0" name="haRolePreference" type="rolePref"/>
<xsd:element maxOccurs="1" minOccurs="1" name="hostname" type="requiredString"/>
<xsd:element maxOccurs="1" minOccurs="1" name="serverGroupName" type="requiredString"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="topoArea">
<xsd:choice maxOccurs="unbounded" minOccurs="0">
<xsd:element name="configHostname" type="configHostname"/>
<xsd:element name="networkElement" type="networkElement"/>
<xsd:element name="network" type="network"/>
<xsd:element name="servicePath" type="servicePath"/>
<xsd:element name="server" type="server"/>
<xsd:element name="serverGroup" type="serverGroup"/>
<xsd:element name="networkDevice" type="networkDevice"/>
<xsd:element name="networkRoute" type="networkRoute"/>
<xsd:element name="resourceDomain" type="resourceDomain"/>
<xsd:element name="place" type="place"/>
<xsd:element name="placeAssociation" type="placeAssociation"/>
<xsd:element name="dscpInterfaceRule" type="dscpInterfaceRule"/>
<xsd:element name="dscpPortRule" type="dscpPortRule"/>
<xsd:element name="member" type="member"/>
<xsd:element name="vip" type="vip"/>
</xsd:choice>
</xsd:complexType>
<xsd:complexType name="vstpArea">
<xsd:choice maxOccurs="unbounded" minOccurs="0">
<xsd:element name="connection" type="VstpConnection"/>
<xsd:element name="connectionConfigurationSet" type="VstpConnCfgSet"/>
<xsd:element name="gttset" type="VstpGttSet"/>
<xsd:element name="link" type="VstpLink"/>
<xsd:element name="linkset" type="VstpLinkSet"/>
<xsd:element name="localHost" type="VstpLocalHost"/>
<xsd:element name="localSignalingPoint" type="VstpRemoteSignalingPoint"/>
<xsd:element name="remoteHost" type="VstpRemoteHost"/>
<xsd:element name="remoteSignalingPoint" type="VstpLocalSignalingPoint"/>
<xsd:element name="route" type="VstpRoute"/>
<xsd:element name="m2paoption" type="VstpM2paOption"/>
</xsd:choice>
</xsd:complexType>
<xsd:element name="configuration">
<xsd:complexType>
<xsd:all>
<xsd:element minOccurs="0" name="diameter" type="diameterArea"/>
<xsd:element minOccurs="0" name="topo" type="topoArea"/>
<xsd:element minOccurs="0" name="vstp" type="vstpArea"/>
</xsd:all>
</xsd:complexType>
</xsd:element>
</xsd:schema>
Copyright
Oracle Communications Diameter Signaling Router Machine to Machine Interface
Copyright 2013, 2017, Oracle and/or its affiliates. All rights reserved.
This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.
If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable:
U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.
This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.
This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.