Show Virtual Network Appliance Plan

Summary

Show details for Virtual Network Appliance Plan.

Type

  • Show

Synchronous/Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{api_endpoint}/v1.0/virtual_network_appliance_plans/{virtual_network_appliance_plan_id}

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
virtual_network_appliance_plan_id URL String Hyph-uuid ID of the Virtual_Network_Appliance_Plan required   Terminate 404
details Query Boolean - If details is false, availability_zones is not displayed. optional true    

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
404 Not Found
500 Internal Server Error

Response Body

Format

{
  "virtual_network_appliance_plan": {
    "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 format description  
virtual_network_appliance_plan Object    
id String It identifies Virtual_Network_Appliance_Plan uniquely.  
name String Name of the Virtual_Network_Appliance_Plan  
description String Description of the Virtual_Network_Appliance_Plan  
appliance_type String Type of appliance  
version String Version of the Virtual_Network_Appliance_Plan  
flavor String Nova flavor  
number_of_interfaces Integer Number of Interfaces  
enabled Boolean Is user allowed to create new firewalls with this plan.  
max_number_of_aap Integer Max Number of allowed_address_pairs  
licenses Array<Object>    
license_type String 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/{virtual_network_appliance_plan_id}

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_plan": {
    "id": "37556569-87f2-4699-b5ff-bf38e7cbf8a7",
    "name": "vSRX_15.1X49-D100_2CPU_4GB_8IF_STD",
    "description": "vSRX_15.1X49-D100_2CPU_4GB_8IF_STD",
    "appliance_type": "ECL::VirtualNetworkAppliance::VSRX",
    "version": "15.1X49-D100",
    "flavor": "VSRX-2CPU-4GB",
    "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/{virtual_network_appliance_plan_id} 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"
}