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

Get QoS session information

Querying for QoS session resource information details

get/quality-on-demand/v1/sessions/{sessionId}

Path parameters

sessionIdstring uuid required

Session ID in UUID format

Session ID that was obtained from the createSession operation

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 date-time

Date and time when the QoS status became "AVAILABLE". Not to be returned when qosStatus is "REQUESTED". Format must follow RFC 3339 and must indicate time zone (UTC or local).

expiresAtstring date-time

Date and time of the QoS session expiration. Format must follow RFC 3339 and must indicate time zone (UTC or local).

  • When qosStatus is "AVAILABLE", it is the limit time when the session is scheduled to finnish, if not terminated by other means.
  • When qosStatus is "UNAVAILABLE", it is the time when the session was terminated.
  • Not to be returned when qosStatus is "REQUESTED". When the session is extended, the value is the new expiration time of the session.
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

Changed in 1 of the 2 revisions of this API.2

  • fdd5f5a56b882See the full diff
    • ▲

      the allOf[subschema #2]/expiresAt response's property type/format changed from string/int64 to string/date-time for status 200

      response-property-type-changed

    • ▲

      the allOf[subschema #2]/startedAt response's property type/format changed from string/int64 to string/date-time for status 200

      response-property-type-changed