List Virtual Network Appliance Plan

Summary

List all visible Virtual Network Appliance Plan.

Type

  • List

Synchronous/Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{api_endpoint}/v1.0/virtual_network_appliance_plans

HTTP Request Header

Content-Type: application/json
Accept: application/json
X-Auth-Token: <token_id>

HTTP Request Body

Parameters

Input Parameters
name style datatype format description required/optional default value action for invalid parameter response code for invalid parameter
token_id Header String Non-Hyph-uuid keystone authentication token required   Terminate 401
id Query String Hyph-uuid ID of the Virtual_Network_Appliance_Plan optional      
name Query String String(0-255) Name of the Virtual_Network_Appliance_Plan optional      
description Query String String(0-255) Description of the Virtual_Network_Appliance_Plan optional      
appliance_type Query String String(0-255) Type of appliance optional      
version Query String String(0-255) Version of the Virtual_Network_Appliance_Plan optional      
flavor Query String String(0-255) Nova flavor optional      
number_of_interfaces Query Integer Integer(0-255) Number of Interfaces optional      
enabled Query Boolean - Is user allowed to create new firewalls with this plan. optional      
max_number_of_aap Query Integer Integer(0-255) Max Number of allowed_address_pairs optional      
details Query Boolean - If details is false, availability_zones is not displayed. optional true    
availability_zone Query String - Availability_zones of the Virtual_Network_Appliance_Plan optional      
availability_zone.available Query Boolean - Display only the Virtual_Network_Appliance_Plan including available=X in the array of availability_zones and stores only the availability_zone including available=X in the array of availability_zones. optional      

Response

Response Header

Format

HTTP/1.1 <response_code> <message>       (ex. 200 OK)
  • <response_code>: see “HTTP Responses” section
  • <message>: message based on the response code

Response Code

Response Codes
response code condition
200 OK
401 unauthorized
500 Internal Server Error

Response Body

Format

{
  "virtual_network_appliance_plans": [
    {
      "id": "<id>",
      "name": "<name>",
      "description": "<description>",
      "appliance_type": "<appliance_type>",
      "version": "<version>",
      "flavor": "<flavor>",
      "number_of_interfaces" : "<number_of_interfaces>",
      "enabled": "<enabled>",
      "max_number_of_aap": "<max_number_of_aap>",
      "licenses": [
        {
          "license_type": "<license_type>"
        }
      ],
      "availability_zones": [
        {
          "availability_zone": "<availability_zone>",
          "available": "<available>",
          "rank": "<rank>"
        }
      ]
    }
  ]
}

Parameters

Response Parameters
item datatype format description
virtual_network_appliance_plans Array<Object> -  
id String Hyph-uuid It identifies Virtual_Network_Appliance_Plan uniquely.
name String String(0-255) Name of the Virtual_Network_Appliance_Plan
description String String(0-255) Description of the Virtual_Network_Appliance_Plan
appliance_type String String(0-255) Type of appliance
version String String(0-255) Version of the Virtual_Network_Appliance_Plan
flavor String String(0-255) Nova flavor
number_of_interfaces Integer Integer(0-255) Number of Interfaces
enabled Boolean - Is user allowed to create new firewalls with this plan.
max_number_of_aap Integer Integer(0-255) Max Number of allowed_address_pairs
licenses Array<Object> -  
license_type String String(0-255) Type of license
availability_zones Array<Object> -  
availability_zone String String(0-255) Availability_zones of the Virtual_Network_Appliance_Plan
available Boolean - Availability_zones availability
rank Integer Integer(0-255) The rank is displayed in the order of decreasing the quantity of Virtual_Network_Appliance resources.

Sample Request and Response

Sample API Request

Request URI

https://{api_endpoint}/v1.0/virtual_network_appliance_plans

Request Header

Content-Type: application/json
Accept: application/json
X-Auth-Token: 69105c889f824efdafb56af224208ad4

Request Body

This operation does not send a request body.

Sample API Response

Response Header

HTTP/1.1 200 OK

Response Body

{
  "virtual_network_appliance_plans": [
    {
      "id": "37556569-87f2-4699-b5ff-bf38e7cbf8a7",
      "name": "virtual_network_appliance_plans_name",
      "description": "virtual_network_appliance_plans_description",
      "appliance_type": "ECL::VirtualNetworkAppliance::VSRX",
      "version": "",
      "flavor": "2CPU-8GB",
      "number_of_interfaces": 8,
      "enabled": true,
      "max_number_of_aap": 1,
      "licenses": [
        {
          "license_type": "STD"
        }
      ],
      "availability_zones": [
        {
          "availability_zone": "zone1_groupa",
          "available": true,
          "rank": 1
        },
        {
          "availability_zone": "zone1_groupb",
          "available": false,
          "rank": 2
        }
      ]
    }
  ]
}

Example Error Message

HTTP Request

GET /v1.0/virtual_network_appliance_plans HTTP/1.1
User-Agent: curl/7.51.0
Host: 10.1.131.140
Accept:application/json
X-Auth-Token:4e54395a12b740d585d74190ba4eb14b
Content-Type: application/json

HTTP Response

HTTP/1.1 500 Internal Server Error
Server: nginx
Date: Wed, 07 Feb 2018 06:49:20 GMT
Content-Type: application/json
Content-Length: 40
Connection: keep-alive

{
  "cause": "Internal Server Error"
}