API reference (Network)

Transcription

1 FUJITSU Cloud Service K5 IaaS API reference (Network) Version 1.5 FUJITSU LIMITED All Rights Reserved, Copyright Fujitsu Limited K5IA-DC-M E

2 Preface Structure of the manuals Manual Title IaaS API Reference Foundation Service Network (this document) Application Platform Service Management Administration Contract Management IaaS Features Handbook IaaS API User Guide IaaS Heat Template Specifications IaaS Service Portal User Guide K5 Portal User Guide Purposes and Methods of Use Detailed reference for using the REST API. Explains the features provided by this service. Explains how to use the REST API, how to build the API runtime environment, and sample scripts according to usage sequences, etc. This document explains the format of the Heat Orchestration Template (HOT) that you create in order to use the orchestration function. This document explains how to use the functions provided by this service via Service Portal (Web GUI). This document explains how to use the functions, including registration and user information management, provided by K5 Portal. Trademarks Adobe, the Adobe logo, Acrobat, and Adobe Reader are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries. Apache and Tomcat are either registered trademarks or trademarks of The Apache Software Foundation in the United States and/or other countries. Microsoft, Windows, and Windows Server are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. VMware, the VMware logo and VMotion are registered trademarks or trademarks of VMware, Inc. in the United States and other countries. The OpenStack Word Mark is either a registered trademark/service mark or trademark/service mark of the OpenStack Foundation, in the United States and other countries and is used with the OpenStack Foundation's permission. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Red Hat is a registered trademark of Red Hat, Inc. in the U.S. and other countries. UNIX is a registered trademark of The Open Group. Note that trademark symbols ( or ) are not appended to system names or product names used in this document. Export restrictions Exportation/release of this document may require necessary procedures in accordance with the regulations of your resident country and/or US export control laws. - i -

3 Notice Information in this document may be subject to change without prior notice. No part of the content of this document may be reproduced without the written permission of Fujitsu Limited. Information in this document is the latest information as of the date of revision. Fujitsu assumes no responsibility for infringement of any patent rights or other rights of third parties arising from the use of information in this document. - ii -

4 Contents Part 1: Network Global IP delivery service API list General requirements Common API items Common API error codes API options API options filter Column Selection APIs that do not support these options API details List floating IPs Create floating IP Show floating IP details Update floating IP Delete floating IP List subnets Create subnet Show subnet Update subnet Delete subnet Private network service API list General requirements Common API items Common API error codes API options API options filter Column Selection APIs that do not support these options API details List networks Create network Show network Update network Delete network Show Network Connector Pool List Network Connector Pools Create Network Connector Show Network Connector List Network Connectors Update Network Connector Deletes Network Connector Create Network Connector Endpoint Show Network Connector Endpoint List Network Connector Endpoints Update Network Connector Endpoint Deletes Network Connector Endpoint Connect Network Connector Endpoint iii -

5 Disconnect Network Connector Endpoint List Connected Interfaces of Network Connector Endpoint Network adapter API list General requirements Common API items Common API error codes API options API options filter Column Selection APIs that do not support these options API details List ports Create port Show port Update port Delete port Create security group Show security group Update security group Delete security group Create security group rule Delete security group rule List security groups List security group rules Show security group rule Network connector service API list General requirements Common API items Common API error codes API options API options filter Column Selection APIs that do not support these options API details Create router Show router details Delete router Update router Add interface to router Remove interface from router List routers Update extra route List IPSec policies Show IPSec policy details Create IPSec Policy Update IPSec Policy Delete IPSec policy List IPSec site connections Show IPSec site connection details Create IPSec site connection Update IPSec site connection Delete IPSec site connection List VPN services Show VPN service details iv -

6 Create VPN service Update VPN service Delete VPN service List IKE policies Show IKE policy details Create IKE policy Update IKE policy Delete IKE policy Firewall API list General requirements Common API items Common API error codes API options API options filter Column Selection APIs that do not support these options API details List firewall rules Show firewall rule details Create firewall rule Update firewall rule Delete firewall rule List firewall policies Shows firewall policy details Create firewall policy Update firewall policy Delete firewall policy Insert firewall rule in firewall policy Remove firewall rule from firewall policy List firewalls Shows firewall details Create firewall Update firewall Update firewall(connection reset) Delete firewall Load balancer API list General requirements API common information Query Requests and Response Requests Headers Common Parameters Common Errors API data types BackendServer HealthCheck ConnectionSettings Instance Instance LBCookieStickinessPolicy Listener Listener LoadBalancerAttributes LoadBalancer Policies SorryServerRedirectionPolicy v -

7 SourceSecurityGroup API details ApplySecurityGroupsToLoadBalancer AttachLoadBalancerToSubnets ConfigureHealthCheck CreateLBCookieStickinessPolicy CreateLoadBalancer CreateLoadBalancerListeners CreateSorryServerRedirectionPolicy DeleteLoadBalancer DeleteLoadBalancerListeners DeregisterInstancesFromLoadBalancer DescribeLoadBalancerAttributes DescribeLoadBalancers DetachLoadBalancerFromSubnets ModifyLoadBalancerAttributes RegisterInstancesWithLoadBalancer SetLoadBalancerListenerSSLCertificate SetLoadBalancerPoliciesOfListener SSL-VPN connection API list General requirements Common API items Common API error codes Notes API details List SSL VPN Connections Shows details for a specified SSL VPN Connection Create SSL VPN Connection Update SSL VPN Connection Delete SSL VPN Connection DNS service API list General requirements Common API request headers Common API response headers Common API errors API details Create zone (POST /v1.0/hostedzone) Retrieve zone information (GET /v1.0/hostedzone/zoneid ) List zone information (GET /v1.0/hostedzone) Delete zone (DELETE /v1.0/hostedzone/zoneid ) Create/delete record (POST v1.0/hostedzone/zoneid/rrset) List record information (GET /v1.0/hostedzone/zoneid/rrset) Retrieve update request information (GET /v1.0/change/updaterequestid ) Network connector expansion API list General requirements Common API items Common API error codes API details Add interface to router (Create connection interface) Remove interface from router (Delete connection interface) Update router (Update routing information) vi -

8 - vii -

9 Part 1: Network Network Topics: Global IP delivery service Private network service Network adapter Network connector service Firewall Load balancer SSL-VPN connection DNS service Network connector expansion - 1 -

10 1.1 Global IP delivery service API list Layer-3 networking (floatingips) Item API 1 GET /v2.0/floatingips List floating IPs 2 POST /v2.0/floatingips Create floating IP 3 GET /v2.0/floatingips/floatingip_id Show floating IP details 4 PUT /v2.0/floatingips/floatingip_id Update floating IP 5 DELETE /v2.0/floatingips/floatingip_id Delete floating IP Lists floating IPs. Creates a floating IP. When port information is specified, associates the floating IP with the specified port. Shows details of the specified floating IP. Updates the specified floating IP and its association with an internal port. Deletes a floating IP and, if present, its associated port. subnets Item API 1 GET /v2.0/subnets List subnets 2 POST /v2.0/subnets Create subnet 3 GET /v2.0/subnets/subnet_id Show subnet 4 PUT /v2.0/subnets/subnet_id Update subnet 5 DELETE /v2.0/subnets/subnet_id Delete subnet Lists subnets to which the specified tenant has access. Creates a subnet on the specified network Shows information on the specified subnet. Updates the specified subnet. Deletes the specified subnet General requirements This section describes general requirements to use this API. Specify the name and description input parameters using up to 255 characters

11 Set the version of the IP address to be specified in the request parameter to "4" ("ip_version": 4), and specify the IP address (XXX_ip_address) in IPv4 format. When executing the API that lists the resources, only some of the availability zone information may be returned. If this happens, it is assumed that infrastructure maintenance is in progress, so wait for a few moments (at least one minute) and then execute the API again Common API items Request header Parameter Remarks Content-Type application/json - Accept application/json - X-Auth-Token authentication token Common API error codes Examples of common API error codes Response codes Status code 500,400,other codes possible computefault 501 notimplemented 503 servercapacityunavailable 503 serviceunavailable 400 badrequest 401 unauthorized 403 forbidden 403 resizenotallowed 404 itemnotfound 405 badmethod 409 backuporresizeinprogress 409 buildinprogress 409 conflictingrequest 413 overlimit 413 badmediatype - 3 -

12 If the user has insufficient privileges to issue the target API when issuing the API for Caution showing (Show), updating (Update), or deleting (Delete) resources, the status code 404 may be returned. If the user has insufficient privileges to issue the target API when issuing the API for listing (List) resources, the status code 200 will be returned and a null array will be set in the body. If there are resources with the shared attribute set to "True", information on the target resources only will be returned API options API options Two options are available for APIs that retrieve resource information (List, Show) filter Filters can be specified to retrieve only resources matching the specified attributes from the list of resource information to be retrieved. Multiple attributes can be specified using AND as a condition. This option can only be used for the List API. Execution example: Retrieve the network with the name "private" GET /v2.0/networks?name=private To filter using multiple attributes with AND. Retrieve the network with the name "private" and that belongs to the AZ1 availability zone. GET /v2.0/networks?name=private?availability_zone=az Column Selection The attributes that are retrieved from the resource information can be restricted. This option can only be used for the List and Show APIs. Execution example: List only the id attribute of networks GET /v2.0/networks?fields=id To retrieve multiple attributes (id and name) GET /v2.0/networks?fields=id&fields=name APIs that do not support these options These options are not supported by the following APIs. Show Network Connector Pool on page 31 List Network Connector Pools on page 32 Show Network Connector on page 35 List Network Connectors on page

13 Show Network Connector Endpoint on page 43 List Network Connector Endpoints on page 44 List Connected Interfaces of Network Connector Endpoint on page API details List floating IPs Lists floating IPs that are accessible to the tenant who submits the request. URI /v2.0/floatingips HTTP method GET Response codes Status code 200 Normal response codes unauthorized (401) Error response codes Response body (normal status) "floatingips": [ "router_id": "d23abc8d a55-ba98-2aaea84cc72f", "tenant_id": "4969c491a3c74ee4af974e6d800c62de", "floating_network_id": "376da547-b977-4cfe-9cba-275c80debf57", "fixed_ip_address": " ", "floating_ip_address": " ", "port_id": "ce705c24-c1ef-408a-bda3-7bbd946164ab", "id": "2f245a7b-796b-4f26-9cf9-9e82d248fda7", "status": "ACTIVE", "availability_zone": "AZ1", "router_id": null, "tenant_id": "4969c491a3c74ee4af974e6d800c62de", "floating_network_id": "376da547-b977-4cfe-9cba-275c80debf57", "fixed_ip_address": null, "floating_ip_address": " ", "port_id": null, "id": "61cea855-49cb d-801b70c71bdd", "status": "DOWN", "availability_zone": "AZ1" ] - 5 -

14 of response body (normal status) Item floatingip tenant_id router_id status floating_network_id fixed_ip_address floating_ip_address port_id id availability_zone A floatingip object. The tenant ID. The router ID. The floatingip status. The ID of the network associated with the floating IP. The fixed IP address associated with the floating IP. The floating IP address. The port ID. The floating IP ID. The Availability Zone name Create floating IP Creates a floating IP, and, if you specify port information, associates the floating IP with an internal port. URI /v2.0/floatingips HTTP method POST Request parameter Key Type Required/ optional floatingip A floatingip object. xsd:string Required tenant_id The tenant ID. xsd:string Optional floating_network_id fixed_ip_address The ID of the network associated with the floating IP. The fixed IP address associated with the floating IP. csapi:uuid xsd:string Required Optional port_id The port ID. csapi:uuid Optional availability_zone The Availability Zone name. If you don't specify, the resource will be created in default AZ. xsd:string Optional Example request "floatingip": - 6 -

15 , "floating_network_id": "376da547-b977-4cfe-9cba-275c80debf57", "port_id": "ce705c24-c1ef-408a-bda3-7bbd946164ab", "availability_zone": "AZ1" Response codes Status code 201 Normal response codes badrequest (400) Error response codes unauthorized (401) Error response codes conflict (409) Error response codes Response body (normal status) "floatingip": "router_id": "d23abc8d a55-ba98-2aaea84cc72f", "status": "DOWN", "tenant_id": "4969c491a3c74ee4af974e6d800c62de", "floating_network_id": "376da547-b977-4cfe-9cba-275c80debf57", "fixed_ip_address": " ", "floating_ip_address": " ", "port_id": "ce705c24-c1ef-408a-bda3-7bbd946164ab", "id": "2f245a7b-796b-4f26-9cf9-9e82d248fda7", "availability_zone": "AZ1" of response body (normal status) Item floatingip router_id status tenant_id floating_network_id fixed_ip_address floating_ip_address port_id id availability_zone A floatingip object. The router ID. The floatingip status. The tenant ID. The ID of the network associated with the floating IP. The fixed IP address associated with the floating IP. The floating IP address. The port ID. The floating IP ID. The Availability Zone name Show floating IP details Shows details for a specified floating IP

16 URI /v2.0/floatingips/floatingip_id of the URI: floatingip_id UUID The UUID of the floating IP. HTTP method GET Response codes Status code 200 Normal response codes unauthorized (401) Error response codes forbidden (403) Error response codes itemnotfound (404) Error response codes Response body (normal status) "floatingip": "fixed_ip_address": " ", "floating_ip_address": " ", "availability_zone": "AZ1" of response body (normal status) Item floatingip tenant_id router_id status floating_network_id fixed_ip_address floating_ip_address port_id id availability_zone A floatingip object. The tenant ID. The router ID. The floatingip status. The ID of the network associated with the floating IP. The fixed IP address associated with the floating IP. The floating IP address. The port ID. The floating IP ID. The Availability Zone name Update floating IP Updates a floating IP and its association with an internal port

17 URI /v2.0/floatingips/floatingip_id of the URI: floatingip_id UUID The UUID of the floating IP. HTTP method PUT Request parameter Key Type Required/optional port_id The port ID. csapi:uuid Required fixed_ip_address The fixed IP address associated with the floating IP. xsd:string Optional Example request "floatingip": "port_id": "fc e6c-4842-a0ed-e2363f9bc3a8" Response codes Status code 200 Normal response codes badrequest (400) Error response codes unauthorized (401) Error response codes itemnotfound (404) Error response codes Confirm the following two points when floating IP exists. Caution1. Subnet that the specified port belongs must be attached to router. 2. External network must be attached to same router described in 1. conflict (409) Error response codes Response body (normal status) "floatingip": "router_id": "d23abc8d a55-ba98-2aaea84cc72f", "tenant_id": "4969c491a3c74ee4af974e6d800c62de", "floating_network_id": "376da547-b977-4cfe-9cba-275c80debf57", "fixed_ip_address": " ", - 9 -

18 "floating_ip_address": " ", "port_id": "fc e6c-4842-a0ed-e2363f9bc3a8", "id": "2f245a7b-796b-4f26-9cf9-9e82d248fda7", "availability_zone": "AZ1" of response body (normal status) Item floatingip tenant_id router_id status floating_network_id fixed_ip_address floating_ip_address port_id id availability_zone A floatingip object. The tenant ID. The router ID. The floatingip status. The ID of the network associated with the floating IP. The fixed IP address associated with the floating IP. The floating IP address. The port ID. The floating IP ID. The Availability Zone name Delete floating IP Deletes a floating IP. URI /v2.0/floatingips/floatingip_id of the URI: floatingip_id UUID The UUID of the floating IP. HTTP method DELETE Response codes Status code 204 Normal response codes unauthorized (401) Error response codes itemnotfound (404) Error response codes List subnets Lists subnets to which the specified tenant has access

19 URI /v2.0/subnets HTTP method GET Response codes Status code 200 Normal response codes unauthorized (401) Error response codes Response body (normal status) "subnets": [ "name": "private-subnet", "enable_dhcp": true, "network_id": "db193ab3-96e3-4cb3-8fc5-05f4296d0324", "tenant_id": "26a d0414dbc1fc1f88cdb7e6e", "dns_nameservers": [], "allocation_pools": [ "start": " ", "end": " " ], "host_routes": [], "ip_version": 4, "gateway_ip": " ", "cidr": " /24", "id": "08eae a-923c-34f7cfe39c1b", "availability_zone": "AZ1", "name": "my_subnet", "enable_dhcp": true, "network_id": "d32019d3-bc6e c1d-6722fc136a22", "tenant_id": "4fd44f e481c7b8a0c ", "dns_nameservers": [], "allocation_pools": [ "start": " ", "end": " " ], "host_routes": [], "ip_version": 4, "gateway_ip": " ", "cidr": " /8", "id": "54d6f61d-db07-451c-9ab3-b9609b6b6f0b", "availability_zone": "AZ1" ]

20 of response body (normal status) Item name enable_dhcp network_id tenant_id dns_nameservers allocation_pools host_routes The subnet name. Set to true if DHCP is enabled and false if DHCP is disabled. The ID of the attached network. The ID of the tenant who owns the network. A list of DNS name servers for the subnet. For example [" ", " "]. specified IP addresses are displayed in sorted order in ascending order. lowest IP address will be primary DNS address. The start and end addresses for the allocation pools. A list of host route dictionaries for the subnet. For example: "host_routes":[ "destination":" /0", "nexthop":" ", "destination":" /24", "nexthop":" " ] ip_version The IP version, which is 4. gateway_ip cidr id availability_zone The gateway IP address. The CIDR. The ID of the subnet. The Availability Zone name Create subnet Creates a subnet on the specified network. URI /v2.0/subnets HTTP method POST Request parameter Key Type Required/ optional name The subnet name. xsd:string Optional

21 Key Type Required/ optional network_id The ID of the attached network. csapi:uuid required allocation_pools The start and end addresses for the allocation pools. xsd:dict Optional dns_nameservers A list of DNS name servers for the subnet. xsd:string Optional Specify each name server as an IP address enclosed by double quotation marks and separate multiple entries with commas. For example [" ", " "]. Specify the IP addresses in ascending order. The lowest IP address will be primary DNS address. host_routes A list of host route dictionaries for the subnet. For example: xsd:list Optional "host_routes":[ "destination":" /0", "nexthop":" ", "destination":" /24", "nexthop":" " ] gateway_ip The gateway IP address. xsd:string Optional ip_version The IP version, which can be 4 or 6. xsd:string Required cidr The CIDR. xsd:bool required enable_dhcp Set to "true" if DHCP is enabled, or "false" otherwise. xsd:boolean Optional availability_zone The Availability Zone name. xsd:string Optional If you don't specify, the resource will be created in default AZ. Do not specify an ISP shared address ( /10 or a subnet address of that Caution subnet when divided). One subnet is associated with one network. Note the following when creating a subnet that uses the Windows virtual server for SAP Cautionservice or physical server for SAP HANA service. Create a subnet with the following string assigned to the beginning of the name parameter

22 Windows virtual server for SAP service: Physical server for SAP HANA service: fcx_subnet-w: fcx_subnet-b: The mask value that you can specify using CIDR is 16 to 29. Other than the IP address specified for allocation_pools and gateway_ip, is the IP address assigned to the server (VM) that was created using the Windows virtual server for SAP service or physical server for SAP HANA service. For allocation_pools, specify an IP address outside of the IP address range used by the Windows virtual server for SAP service or physical server for SAP HANA service. For ip_version, specify 4. The information specified for host_routes, enable_dhcp, and dns_nameservers is not set for the server (VM) created using the Windows virtual server for SAP service or physical server for SAP HANA service. Example request "subnet": "network_id": "d32019d3-bc6e c1d-6722fc136a22", "ip_version": 4, "cidr": " /24", "availability_zone": "AZ1" Response codes Status code 201 Normal response codes badrequest (400) Error response codes unauthorized (401) Error response codes forbidden (403) Error response codes itemnotfound (404) Error response codes conflict (409) Error response codes Response body (normal status) "subnet": "name": "", "enable_dhcp": true, "network_id": "d32019d3-bc6e c1d-6722fc136a22", "tenant_id": "4fd44f e481c7b8a0c ", "dns_nameservers": [], "allocation_pools": [ "start": " ", "end": " " ], "host_routes": [], "ip_version": 4,

23 "gateway_ip": " ", "cidr": " /24", "id": "3b80198d-4f7b-4f77-9ef5-774d54e17126", "availability_zone": "AZ1" of response body (normal status) Item name network_id tenant_id dns_nameservers allocation_pools host_routes The subnet name. The ID of the attached network. The ID of the tenant who owns the network. A list of DNS name servers for the subnet. Specify each name server as an IP address enclosed by double quotation marks and separate multiple entries with commas. For example [" ", " "]. The start and end addresses for the allocation pools. A list of host route dictionaries for the subnet. For example: "host_routes":[ "destination":" /0", "nexthop":" ", "destination":" /24", "nexthop":" " ] gateway_ip The gateway IP address. ip_version The IP version, which is 4. cidr The CIDR. id The ID of the subnet. enable_dhcp Set to true if DHCP is enabled and false if DHCP is disabled. availability_zone The Availability Zone name Show subnet Shows information for a specified subnet. URI /v2.0/subnets/subnet_id of the URI: subnet_id UUID The UUID for the subnet of interest to you

24 HTTP method GET Response codes Status code 200 Normal response codes unauthorized (401) Error response codes itemnotfound (404) Error response codes Response body (normal status) "subnet": "name": "my_subnet", "enable_dhcp": true, "network_id": "d32019d3-bc6e c1d-6722fc136a22", "tenant_id": "4fd44f e481c7b8a0c ", "dns_nameservers": [], "allocation_pools": [ "start": " ", "end": " " ], "host_routes": [], "ip_version": 4, "gateway_ip": " ", "cidr": " /8", "id": "54d6f61d-db07-451c-9ab3-b9609b6b6f0b", "availability_zone": "AZ1" of response body (normal status) Item name network_id tenant_id dns_nameservers allocation_pools host_routes The subnet name. The ID of the attached network. The ID of the tenant who owns the network. A list of DNS name servers for the subnet. Specify each name server as an IP address enclosed by double quotation marks and separate multiple entries with commas. For example [" ", " "]. specified IP addresses are displayed in sorted order in ascending order. lowest IP address will be primary DNS address. The start and end addresses for the allocation pools. A list of host route dictionaries for the subnet. For example: "host_routes":[

25 Item "destination":" /0", "nexthop":" ", "destination":" /24", "nexthop":" " ] gateway_ip The gateway IP address. ip_version The IP version, which is 4 or 6. cidr The CIDR. id The ID of the subnet. enable_dhcp Set to true if DHCP is enabled and false if DHCP is disabled. availability_zone The Availability Zone name Update subnet Updates the specified subnet. URI /v2.0/subnets/subnet_id of the URI: subnet_id: The UUID of the subnet. HTTP method PUT Request parameter Key Type Required/ optional name The subnet name. xsd:string Optional gateway_ip The gateway IP address. xsd:string Optional enable_dhcp Set to true if DHCP is enabled and false if DHCP is disabled. xsd:boolean Optional dns_nameservers A list of DNS name servers for the subnet. xsd:string Optional Specify each name server as an IP address enclosed by double quotation marks and separate multiple entries with commas. For example [" ", " "]. host_routes A list of host route dictionaries for the subnet. For example: xsd:list Optional "host_routes":[

26 Key Type Required/ optional "destination":" /0", "nexthop":" ", "destination":" /24", "nexthop":" " ] Note the following when updating a subnet that uses the Windows virtual server for SAP Cautionservice or physical server for SAP HANA service. The "fcx_subnet-w:" or "fcx_subnet-b:" string at the beginning of the name parameter cannot be changed. gateway_ip cannot be changed. The information specified for host_routes, enable_dhcp, and dns_nameservers is not set for the server (VM) created using the Windows virtual server for SAP service or physical server for SAP HANA service. Example request "subnet": "name": "my_subnet" Response codes Status code 200 Normal response codes badrequest (400) Error response codes unauthorized (401) Error response codes forbidden (403) Error response codes itemnotfound (404) Error response codes Response body (normal status) "subnet": "name": "private-subnet", "enable_dhcp": true, "network_id": "db193ab3-96e3-4cb3-8fc5-05f4296d0324", "tenant_id": "26a d0414dbc1fc1f88cdb7e6e", "dns_nameservers": [], "allocation_pools": [ "start": " ", "end": " "

27 ], "host_routes": [], "ip_version": 4, "gateway_ip": " ", "cidr": " /24", "id": "08eae a-923c-34f7cfe39c1b", "availability_zone": "AZ1" of response body (normal status) Item name enable_dhcp network_id tenant_id dns_nameservers allocation_pools host_routes The subnet name. Set to true if DHCP is enabled and false if DHCP is disabled. The ID of the attached network. The ID of the tenant who owns the network. A list of DNS name servers for the subnet. Specify each name server as an IP address enclosed by double quotation marks and separate multiple entries with commas. For example [" ", " "]. The start and end addresses for the allocation pools. A list of host route dictionaries for the subnet. For example: "host_routes":[ "destination":" /0", "nexthop":" ", "destination":" /24", "nexthop":" " ] ip_version The IP version, which is 4 or 6. gateway_ip cidr id availability_zone The gateway IP address. The CIDR. The ID of the subnet. The Availability Zone name Delete subnet Deletes the specified subnet. URI /v2.0/subnets/subnet_id of the URI:

28 subnet_id UUID The UUID for the subnet of interest to you. HTTP method DELETE Request parameter When a subnet is deleted, DHCP can no longer be used in the network where it was it was created. If using DHCP, the subnet alone cannot be deleted- the network must be deleted Caution as well. Before deleting a subnet that uses the Windows virtual server for SAP service or physical server for SAP HANA service, it is necessary to delete the network resources using it. Caution Response codes Status code 204 Normal response codes unauthorized (401) Error response codes itemnotfound (404) Error response codes conflict (409) Error response codes

29 1.2 Private network service API list networks Item API 1 GET /v2.0/networks List networks 2 POST /v2.0/networks Create network 3 GET /v2.0/networks/network_id Show network 4 PUT /v2.0/networks/network_id Update network 5 DELETE /v2.0/networks/network_id Delete network Lists networks to which the tenant has access Creates a network Shows details of the specified network Updates the specified network Deletes the specified network and its associated resources Network Connector Item API 1 GET /v2.0/network_connector_pools/ network_connector_pool_id Show network connector pool 2 GET /v2.0/network_connector_pools List network connector pools 3 POST /v2.0/network_connectors Create Network Connector 4 GET /v2.0/network_connectors/ network_connector_id Show network connector 5 GET /v2.0/network_connectors List Network Connectors 6 PUT /v2.0/network_connectors/network connector id Update Network Connector 7 DELETE /v2.0/network_connector/network connector id Shows the specified network connector pool Lists network connector pools Creates a network connector Shows information about the specified network connector Lists network connectors Updates the specified network connector Deletes the specified network connector

30 Item API Deletes Network Connector 8 POST /v2.0/network_connector_endpoints Create Network Connector Endpoint 9 GET /v2.0/network_connector_endpoints/ network_connector_endpoint_id Show Network Connector Endpoint 10 GET /v2.0/network_connector_endpoints List Network Connector Endpoints 11 PUT /v2.0/network_connector_endpoints/ network connector endpoint id Update Network Connector Endpoint 12 DELETE /v2.0/ network_connector_endpoints/network connector endpoint id Deletes Network Connector Endpoint 13 PUT /v2.0/network_connector_endpoints/ network connector endpoint id/connect Connect Network Connector Endpoint 14 PUT /v2.0/network_connector_endpoints/ network connector endpoint id/ disconnect Disconnect Network Connector Endpoint 15 GET /v2.0/network_connector_endpoints/ network connector endpoint id/ interfaces List Connected Interfaces of Network Connector Endpoint Creates a network connector endpoint Shows information about the specified network connector endpoint Lists network connector endpoints Updates the specified network connector endpoint Deletes the specified network connector endpoint Connects interface to the specified network connector endpoint Disconnects interface from the specified network connector endpoint Lists the interfaces connected to the specified network connector endpoint General requirements This section describes general requirements to use this API. Specify the name and description input parameters using up to 255 characters. Set the version of the IP address to be specified in the request parameter to "4" ("ip_version": 4), and specify the IP address (XXX_ip_address) in IPv4 format. When executing the API that lists the resources, only some of the availability zone information may be returned. If this happens, it is assumed that infrastructure maintenance is in progress, so wait for a few moments (at least one minute) and then execute the API again

31 1.2.3 Common API items Request header Parameter Remarks Content-Type application/json - Accept application/json - X-Auth-Token authentication token Common API error codes Examples of common API error codes Response codes Status code 500,400,other codes possible computefault 501 notimplemented 503 servercapacityunavailable 503 serviceunavailable 400 badrequest 401 unauthorized 403 forbidden 403 resizenotallowed 404 itemnotfound 405 badmethod 409 backuporresizeinprogress 409 buildinprogress 409 conflictingrequest 413 overlimit 413 badmediatype Caution If the user has insufficient privileges to issue the target API when issuing the API for showing (Show), updating (Update), or deleting (Delete) resources, the status code 404 may be returned. If the user has insufficient privileges to issue the target API when issuing the retrieve resource list (List) API, the status code 200 may be returned. If this happen, a null

32 array will be returned in the body section. Also, if there are resources with the shared attribute set to "True", information on the target resources only will be returned API options API options Two options are available for APIs that retrieve resource information (List, Show) filter Filters can be specified to retrieve only resources matching the specified attributes from the list of resource information to be retrieved. Multiple attributes can be specified using AND as a condition. This option can only be used for the List API. Execution example: Retrieve the network with the name "private" GET /v2.0/networks?name=private To filter using multiple attributes with AND. Retrieve the network with the name "private" and that belongs to the AZ1 availability zone. GET /v2.0/networks?name=private?availability_zone=az Column Selection The attributes that are retrieved from the resource information can be restricted. This option can only be used for the List and Show APIs. Execution example: List only the id attribute of networks GET /v2.0/networks?fields=id To retrieve multiple attributes (id and name) GET /v2.0/networks?fields=id&fields=name APIs that do not support these options These options are not supported by the following APIs. Show Network Connector Pool on page 31 List Network Connector Pools on page 32 Show Network Connector on page 35 List Network Connectors on page 36 Show Network Connector Endpoint on page 43 List Network Connector Endpoints on page 44 List Connected Interfaces of Network Connector Endpoint on page

33 1.2.6 API details List networks Lists networks to which the specified tenant has access. URI /v2.0/networks HTTP method GET Response codes Status code 200 Normal response codes unauthorized (401) Error response codes Response body (normal status) "networks": [ "status": "ACTIVE", "subnets": [ "54d6f61d-db07-451c-9ab3-b9609b6b6f0b" ], "name": "private-network", "admin_state_up": true, "tenant_id": "4fd44f e481c7b8a0c ", "router:external": true, "shared": true, "id": "d32019d3-bc6e c1d-6722fc136a22", "availability_zone": "AZ1", "status": "ACTIVE", "subnets": [ "08eae a-923c-34f7cfe39c1b" ], "name": "private", "admin_state_up": true, "tenant_id": "26a d0414dbc1fc1f88cdb7e6e", "router:external": true, "shared": true, "id": "db193ab3-96e3-4cb3-8fc5-05f4296d0324", "availability_zone": "AZ1" ]

34 of response body (normal status) Item admin_state_up id name shared status subnets tenant_id router:external availability_zone The administrative state of the network, which is up (true) or down (false). The network ID. The network name. Indicates whether this network is shared across all tenants. The network status. The associated subnets. The tenant ID. Specifies whether the network is an external network or not. The Availability Zone name Create network Creates a network. URI /v2.0/networks HTTP method POST Request parameter Key Type Required/optional admin_state_up The administrative state of the network, which is up (true) or down (false). xsd:bool Optional name The network name. A request body is optional: If you include it, it can specify this optional attribute. xsd:string Optional shared Indicates whether this network is shared across all tenants. By default, only administrative users can change this value. xsd:bool Optional availability_zone The Availability Zone name. xsd:string Optional If you don't specify, the resource will be created in default AZ. Example request "network":

35 "name": "sample_network", "admin_state_up": true, "availability_zone": "AZ1" Response codes Status code 201 Normal response codes badrequest (400) Error response codes unauthorized (401) Error response codes Response body (normal status) "network": "status": "ACTIVE", "subnets": [], "name": "net1", "admin_state_up": true, "tenant_id": "9bacb3c5d39d41a f338cf177", "segments": [ "provider:segmentation_id": 2, "provider:physical_network": "8bab8453-1bc9-45af-8c70- f83aa9b50453", "provider:network_type": "vlan", "provider:segmentation_id": null, "provider:physical_network": "8bab8453-1bc9-45af-8c70- f83aa9b50453", "provider:network_type": "stt" ], "shared": false, "port_security_enabled": true, "id": "4e8e f-477b-9e5b-f1f75b21c03c", "availability_zone": "AZ1" of response body (normal status) Item admin_state_up id name shared status subnets The administrative state of the network, which is up (true) or down (false). The network ID. The network name. Indicates whether this network is shared across all tenants. The network status. The associated subnets

36 Item tenant_id availability_zone The tenant ID. The Availability Zone name Show network Shows information for a specified network. URI /v2.0/networks/network_id of the URI: network_id UUID The UUID for the network of interest to you. HTTP method GET Response codes Status code 200 Normal response codes unauthorized (401) Error response codes itemnotfound (404) Error response codes Response body (normal status) "network": "status": "ACTIVE", "subnets": [ "54d6f61d-db07-451c-9ab3-b9609b6b6f0b" ], "name": "private-network", "admin_state_up": true, "tenant_id": "4fd44f e481c7b8a0c ", "router:external": true, "shared": true, "id": "d32019d3-bc6e c1d-6722fc136a22", "availability_zone": "AZ1" of response body (normal status) Item admin_state_up id name The administrative state of the network, which is up (true) or down (false). The network ID. The network name

37 Item shared status subnets tenant_id availability_zone router:external Indicates whether this network is shared across all tenants. The network status. The associated subnets. The tenant ID. The Availability Zone name Specifies whether the network is an external network or not Update network Updates a specified network. URI /v2.0/networks/network_id of the URI: network_id UUID The UUID for the network of interest to you. HTTP method PUT Request parameter Key Type Required/optional admin_state_up The administrative state of the network, which is up (true) or down (false). xsd:bool Optional name The network name. xsd:string Optional Example request "network": "name": "sample_network_5_updated" Response codes Status code 200 Normal response codes badrequest (400) Error response codes unauthorized (401) Error response codes forbidden (403) Error response codes itemnotfound (404) Error response codes

38 Response body (normal status) "network": "status": "ACTIVE", "subnets": [], "name": "sample_network_5_updated", "admin_state_up": true, "tenant_id": "4fd44f e481c7b8a0c ", "router:external": false, "shared": false, "id": "1f f be64-6d3d4a6adcc6", "availability_zone": "AZ1" of response body (normal status) Item status subnets name admin_state_up tenant_id router:external shared id provider:segmentation_id availability_zone The network status. The associated subnets. The network name. The administrative state of the network, which is up (true) or down (false). The tenant ID. Specifies whether the network is an external network or not. Indicates whether this network is shared across all tenants. By default, only administrative users can change this value. The network ID. The Availability Zone name Delete network Deletes the specified network and its associated resources. URI /v2.0/networks/network_id of the URI: network_id UUID The UUID for the network of interest to you. HTTP method DELETE Request parameter

39 Before deleting a network that is specified for subnets that use the Windows virtual server for SAP service or physical server for SAP HANA service, it is necessary to delete the Caution network resources using the subnet. Response codes Status code 204 Normal response codes unauthorized (401) Error response codes itemnotfound (404) Error response codes conflict (409) Error response codes Show Network Connector Pool Shows a specified network connector pool. Request URI GET <network service endpoint>/v2.0/network_connector_pools/<network connector pool id> Example: GET Headers X-Auth-Token: token delivered by identity service Response Status Code 200 Headers Content-Type: application/json Body "network_connector_pool" : "id" : " a-4c1a-a76d-43033c7fc9bf", "name" : "mpls-vpn-pool1"

40 Body Elements id: id for this network connector pool Type: String name: name for network connector pool Type: String Errors 401: Token is not specified or not authorized. 403: Token is not permitted to operate. 404: Specified Network Connector Pool not found List Network Connector Pools Lists network connector pools. Request URI GET <network service endpoint>/v2.0/network_connector_pools Example: GET Headers X-Auth-Token: token delivered by identity service Response Status Code 200 Headers Content-Type: application/json Body "network_connector_pools" : [ "id" : " a-4c1a-a76d-43033c7fc9bf", "name" : "mpls-vpn-pool1",, "id" : "ddd a-4c1a-a76d-43033c7fc9bf", "name" : "mpls-vpn-pool2"

41 ] Elements id: id for this network connector pool Type: String name: name for network connector pool Type: String Errors 401: Token is not specified or not authorized. 403: Token is not permitted to operate Create Network Connector Creates a network connector. Request URI POST <network service endpoint>/v2.0/network_connectors Example: POST Headers X-Auth-Token: token delivered by identity service Content-Type: application/json Body syntax "network_connector" : "name" : "connector1", "network_connector_pool_id" : " a-4c1a-a76d-43033c7fc9bf", "tenant_id" : "29320d5e-dd29-425c-b386-3cbb2754ad03" Parameters name: name for network connector Type: String

42 Constraints: Up to 255 characters in length Constraints: a-z, A-Z, 0-9, and _- Required: Yes network_connector_pool_id: A network connector pool id for this network connector. When this value not specified and only one pool exists, use it. Type: String Required: No tenant_id: The tenant's ID to which this network connector belongs. This parameter is restricted for tenant in which requester joins. Type: String Required: No Response Status code 201 Headers Content-Type: application/json Body Example: "network_connector" : "id" : "07993b1c-79e1-4cf6-a663-dc42b9ce37d4", "name" : "connector1", "network_connector_pool_id" : " a-4c1a-a76d-43033c7fc9bf", "network_connector_endpoints" : [], "tenant_id" : "29320d5e-dd29-425c-b386-3cbb2754ad03" Elements id: ID for this network connector Type: String name: name for network connector Type: String network_connector_pool_id: A network connector pool id for this network connector. Type: String network_connector_endpoints:

43 ID of network connector endpoints belonging to this network connector. Immediate after creation, this value must be empty array. Type: Array of String tenant_id: tenant's ID to which this network connector belongs Type: String Errors 400: Invalid parameter in request body 401: Token is not specified or not authorized. 403: Token is not permitted to operate. 404: Network Connector Pool not found. 409: Operation conflicts with another one. 503: No resource remains in the network connector pool Show Network Connector Shows information for a specified network connector. Request URI GET <network service endpoint>/v2.0/network_connectors/<network connector id> Example: GET dc42b9ce37d4 Headers X-Auth-Token: token delivered by identity service Response Status code 200 Headers Content-Type: application/json Body "network_connector" : "id" : "07993b1c-79e1-4cf6-a663-dc42b9ce37d4", "name" : "connector1", "network_connector_pool_id" : " a-4c1a-a76d-43033c7fc9bf", "network_connector_endpoints" : [

44 "0e521ed5-62d0-44c9-9c04-2e880b5add21" ], "tenant_id" : "29320d5e-dd29-425c-b386-3cbb2754ad03" Elements id: ID for this network connector Type: String name: name for network connector Type: String network_connector_pool_id: A network connector pool id for this network connector. Type: String network_connector_endpoints: ID of network connector endpoints belonging to this network connector. Immediate after creation, this value must be empty array. Type: Array of String tenant_id: Errors tenant's ID to which this network connector belongs Type: String 401: Token is not specified or not authorized. 403: Token is not permitted to operate. 404: Specified network connector not found List Network Connectors Lists network connectors. Request URI GET <network service endpoint>/v2.0/network_connectors Example: GET Headers X-Auth-Token: token delivered by identity service