Sign in
Quality-of-Service on Demand v1.0.0

Return QoD settings for your devices.

Return device communication Quality-on-Demand settings for your devices.

get/quality-on-demand/v1/sessions

Headers

x-rapidapi-hoststring required
Example:network-as-code.p-eu.rapidapi.com

The API's Host value as defined in the RapidAPI Hub.

Response

qosProfilestring string required

A unique name for identifying a specific QoS profile. This may follow different formats depending on the service providers implementation. Some options addresses:

  • A UUID style string
  • Support for predefined profiles QOS_S, QOS_M, QOS_L, and QOS_E
  • A searchable descriptive name
sinkstring uri

The address to which events about all status changes of the session (e.g. session termination) shall be delivered using the selected protocol.

sessionIdstring uuid required

Session ID in UUID format

durationinteger required
startedAtstring int64

Timestamp of session start in seconds since Unix epoch

expiresAtstring int64

Timestamp of session expiration if the session was not deleted, in seconds since Unix epoch

qosStatus'REQUESTED' | 'AVAILABLE' | 'UNAVAILABLE' required

The current status of the requested QoS session. The status can be one of the following:

  • REQUESTED - QoS has been requested by creating a session
  • AVAILABLE - The requested QoS has been provided by the network
  • UNAVAILABLE - The requested QoS cannot be provided by the network due to some reason
statusInfo'DURATION_EXPIRED' | 'NETWORK_TERMINATED' | 'DELETE_REQUESTED'

Reason for the new qosStatus. Currently statusInfo is only applicable when qosStatus is 'UNAVAILABLE'.

  • DURATION_EXPIRED - Session terminated due to requested duration expired
  • NETWORK_TERMINATED - Network terminated the session before the requested duration expired
  • DELETE_REQUESTED- User requested the deletion of the session before the requested duration expired

Changes