QoS Options

This page describes operations you can perform on qos_options. List, and get details for.

List Qos Option

List all visible qos_options.

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{endpoint}/v2.0/qos_options

HTTP Request Parameters

Parameter Style Type Format Enumeration Description Required
aws_service_id query string hyph-uuid-or-empty - AWS Service for which this QoS option is available no
azure_service_id query string hyph-uuid-or-empty - Azure Service for which this QoS option is available no
bandwidth query string - - Bandwidth assigned with this QoS Option no
description query string - - Description of the QoS Policy no
fic_service_id query string hyph-uuid-or-empty - FIC Service for which this QoS option is available no
gcp_service_id query string hyph-uuid-or-empty - GCP Service for which this QoS option is available no
id query string hyph-uuid - Unique ID of the QoS Policy no
interdc_service_id query string hyph-uuid-or-empty - Inter DC Service for which this QoS option is available no
internet_service_id query string hyph-uuid-or-empty - Internet Service this policy is available from no
name query string - - Name of the QoS Policy no
qos_type query string - [‘besteffort’, ‘guarantee’] Type of QoS Option no
service_type query string - [‘aws’, ‘azure’, ‘fic’, ‘gcp’, ‘vpn’, ‘internet’, ‘interdc’] Service type for this option no
status query string - - QoS Option status. no
vpn_service_id query string hyph-uuid-or-empty - VPN Service for which this QoS option is available no

Response

HTTP Response Code List

Response Code Description
200 OK
400 Bad Request
401 UnAuthorized
404 Not Found
500 Internal Server Error

HTTP Response Parameters

Parameter Type Format Description
qos_options array<object> QoS Options -
aws_service_id string hyph-uuid-or-empty AWS Service for which this QoS option is available
azure_service_id string hyph-uuid-or-empty Azure Service for which this QoS option is available
bandwidth string - Bandwidth assigned with this QoS Option
description string - Description of the QoS Policy
fic_service_id string hyph-uuid-or-empty FIC Service for which this QoS option is available
gcp_service_id string hyph-uuid-or-empty GCP Service for which this QoS option is available
id string hyph-uuid Unique ID of the QoS Policy
interdc_service_id string hyph-uuid-or-empty Inter DC Service for which this QoS option is available
internet_service_id string hyph-uuid-or-empty Internet Service this policy is available from
name string - Name of the QoS Policy
qos_type string - Type of QoS Option
service_type string - Service type for this option
status string - QoS Option status.
vpn_service_id string hyph-uuid-or-empty VPN Service for which this QoS option is available

Examples

Sample Request Body

This operation does not send a request body.

Sample Response Body

{
  "qos_options": [
    {
      "aws_service_id": null,
      "azure_service_id": null,
      "bandwidth": "100",
      "description": "lab3-100M-besteffort-menu",
      "fic_service_id": null,
      "gcp_service_id": null,
      "id": "284a7ca9-f26e-4242-8baa-938f48360c2c",
      "interdc_service_id": null,
      "internet_service_id": "5536154d-9a00-4b11-81fb-b185c9111d90",
      "name": "Lab3-100M-BE",
      "qos_type": "besteffort",
      "service_type": "internet",
      "status": "ACTIVE",
      "vpn_service_id": null
    },
    {
      "aws_service_id": null,
      "azure_service_id": null,
      "bandwidth": "20",
      "description": "lab3-20M-guarantee-menu",
      "fic_service_id": null,
      "gcp_service_id": null,
      "id": "35a7bed1-12ce-401d-be5a-27765a1159f5",
      "interdc_service_id": null,
      "internet_service_id": "5536154d-9a00-4b11-81fb-b185c9111d90",
      "name": "Lab3-20M-GA",
      "qos_type": "guarantee",
      "service_type": "internet",
      "status": "ACTIVE",
      "vpn_service_id": null
    }
  ]
}

Show Qos Option

Show details for qos_option.

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{endpoint}/v2.0/qos_options/{qos_option_id}

HTTP Request Parameters

Parameter Style Type Format Enumeration Description Required
qos_option_id URI string hyph-uuid - Unique ID of the QoS Policy yes

Response

HTTP Response Code List

Response Code Description
200 OK
400 Bad Request
401 UnAuthorized
404 Not Found
500 Internal Server Error

HTTP Response Parameters

Parameter Type Format Description
qos_option object QoS Options -
aws_service_id string hyph-uuid-or-empty AWS Service for which this QoS option is available
azure_service_id string hyph-uuid-or-empty Azure Service for which this QoS option is available
bandwidth string - Bandwidth assigned with this QoS Option
description string - Description of the QoS Policy
fic_service_id string hyph-uuid-or-empty FIC Service for which this QoS option is available
gcp_service_id string hyph-uuid-or-empty GCP Service for which this QoS option is available
id string hyph-uuid Unique ID of the QoS Policy
interdc_service_id string hyph-uuid-or-empty Inter DC Service for which this QoS option is available
internet_service_id string hyph-uuid-or-empty Internet Service this policy is available from
name string - Name of the QoS Policy
qos_type string - Type of QoS Option
service_type string - Service type for this option
status string - QoS Option status.
vpn_service_id string hyph-uuid-or-empty VPN Service for which this QoS option is available

Examples

Sample Request Body

This operation does not send a request body.

Sample Response Body

{
  "qos_option": {
    "aws_service_id": null,
    "azure_service_id": null,
    "bandwidth": "100",
    "description": "lab3-100M-besteffort-menu",
    "fic_service_id": null,
    "gcp_service_id": null,
    "id": "284a7ca9-f26e-4242-8baa-938f48360c2c",
    "interdc_service_id": null,
    "internet_service_id": "5536154d-9a00-4b11-81fb-b185c9111d90",
    "name": "Lab3-100M-BE",
    "qos_type": "besteffort",
    "service_type": "internet",
    "status": "ACTIVE",
    "vpn_service_id": null
  }
}