Find virtual networks by searching criteria

GET 
/v1/projects/:projectId/zones/:zoneName/virtualnetworks

Return virtual networks that match all searching criteria. Criteria are project identifier and virtual network name.

Request

Path Parameters

projectId stringrequired

Project Identifier

zoneName stringrequired

Zone name

Query Parameters

name string

Name of the resource.

provisioningState BasicStateEnum

Possible values: [creating, updating, deleting, active, error]

State of the searched virtual networks.

offset int32
Requested pagination of response. The parameter offset is the index of the first element to retrieve. Zero is the first element of the collection.
Default value: 0
limit int32
Possible values: >= 1
Requested pagination of response. The parameter limit is the maximum number of elements to retrieve (it can be greater than the actual available number of items).
Default value: 100
sort string

Possible values: <= 100 characters, Value must match regular expression -?[A-Za-z0-9]+(?:,[A-Za-z0-9]+)*

The list of field names to sort the result. Prefixing a field name with a "-" sign will indicate a descending order.

Header Parameters

X-API-KEY string

Your SIU token if you use this API through Orange Developer.

Authorization string

Bearer access token authentication if you use this API through Orange Developer or Orange Developer Inside.

X-Requester-Id string

Your SIU Id if you use this API through Orange Developer Inside.

Responses

200

Ok

Response Headers

X-Total-Count

Returns Pagination of response. The total number of items in the collection, after application of filters if any.

X-Result-Count

The actual number of items contained in the response body. Note that it can be less than the requested "limit".

application/json

Schema

Schema

Array [
idstringrequired
Id of the Virtual Network.
hRefstringrequired
HREF of the Virtual Network.
namestringrequired
Name of the Virtual Network. Must be unique within the project for a zone. Cannot be updated.
Possible values: <= 40 characters, Value must match regular expression [A-Za-z0-9-]
descriptionstring
Description of the Virtual Network
tags object
Tags associated with the virtual network.
property name*string
createdDatestring
Date when the Virtual Network was created.
lastModifiedDatestring
Date when the Virtual Network was last modified.
lastRequesterIdstring
User name (CUID or SIUID) associated with the last modification request (creation, update or deletion).
provisioningStateBasicStateEnum (string)
Provisioning state of the resource. Possible state:
• creating: resource creation in progress
• updating: resource update in progress
• deleting: resource deletion in progress
• active: resource created/updated successfully
• error: resource in error because the last creation/update/deletion failed
Possible values: [creating, updating, deleting, active, error]
vpns object[]
List of VPNs attached to the VN. Impact if VPN are modified or removed.
Possible values: <= 99
Array [
vpnNamestringrequired
VPN name. This attribute can not be updated.
vnRoleVPNRoleEnum (string)required
VN role in the VPN.
Possible values: [any-to-any, client, server]
]
subnets object[]required
List of subnets. It is not possible to remove a subnet from this list once an IP has been allocated from this subnet.
Array [
subnetstringrequired
Subnet in CIDR format. Cannot be updated. IPv6 not available yet.
enableDhcpboolean
Enable DHCP on subnet. This attribute can not be updated.
Default value: true
allocateIpAddressFromStartboolean
Subnet IP allocation rule for DHCP process:
• true: from first address of subnet
• false: from last address of subnet
Default value: true
dnsPrimarystring
IP address of the primary DNS server (applicable to IPV4 subnets only).
dnsSecondarystring
IP address of the secondary DNS server (applicable to IPV4 subnets only).
allocationPools object[]
List of pools of IP addresses belonging to the subnet that can be used by DHCP allocation process. If not defined, the entire subnet is used. After addition of the subnet, it is only possible to add pools.
Array [
startstringrequired
First IP address of the pool.
endstringrequired
Last IP address of the pool.
]
hostRoutes object[]
Host routes, configured for the subnet, that are sent to the VM by DHCP. Changes are not taken into account until a new DHCP request is sent. NB: this option is usually used in combination with IRT (Interface Route Table) or NRT (Network Route Table).
Array [
prefixstringrequired
Prefix of the route in CIDR format. This attribute can not be updated.
nextHopstringrequired
Next hop IP address of the route. This attribute can not be updated.
]
gatewayIpAddressstring
IP address of the Contrail vRouter to be used for its "gateway" role. If not defined, Contrail uses the first usable address of the subnet (from start or from end depending on the value of the parameter allocateIpAddressFromStart). This attribute can not be updated. Ipv6 not available yet.
serviceIpAddressstring
IP address that the vRouter must use to configure its service interface on this VN. If not defined, Contrail uses the second usable address of the subnet (from start or from end depending on the value of the parameter allocateIpAddressFromStart). Ipv6 not available yet.
]
hostRoutes object[]
Host routes, configured for the subnet, that are sent to the VM by DHCP. Changes are not taken into account until a new DHCP request is sent. NB: this option is usually used in combination with IRT (Interface Route Table) or NRT (Network Route Table).
Array [
prefixstringrequired
Prefix of the route in CIDR format. This attribute can not be updated.
nextHopstringrequired
Next hop IP address of the route. This attribute can not be updated.
]
networkRoutesobject[]
Network routes that are pushed on the vrouter. In a general case, this option is used in combination with host routes. NB: impact service if routes are removed.
routingPolicyRefs object[]
List of routing policies applied on the VN, identified either by their name or their resource id. NB: the order in the list is the order in which the routing policies will be applied.
Array [
iduuid
Identifier of the referred resource. If not provided, either name or hRef must be filled. This parameter can not be updated.
namestring
Name of the referred resource. If not provided, either hRef or identifier must be filled. This parameter can not be updated.
Possible values: non-empty and <= 40 characters
hRefuri
hRef of the referred resource. If not provided, either name or identifier must be filled. This parameter can not be updated.
]
]

Example (auto)

[
  {
    "id": "string",
    "hRef": "string",
    "name": "string",
    "description": "string",
    "tags": {},
    "createdDate": "string",
    "lastModifiedDate": "string",
    "lastRequesterId": "string",
    "provisioningState": "creating",
    "vpns": [
      {
        "vpnName": "string",
        "vnRole": "any-to-any"
      }
    ],
    "subnets": [
      {
        "subnet": "string",
        "enableDhcp": true,
        "allocateIpAddressFromStart": true,
        "dnsPrimary": "string",
        "dnsSecondary": "string",
        "allocationPools": [
          {
            "start": "string",
            "end": "string"
          }
        ],
        "hostRoutes": [
          {
            "prefix": "string",
            "nextHop": "string"
          }
        ],
        "gatewayIpAddress": "string",
        "serviceIpAddress": "string"
      }
    ],
    "hostRoutes": [
      {
        "prefix": "string",
        "nextHop": "string"
      }
    ],
    "networkRoutes": [
      {
        "prefix": "string",
        "nextHop": "string",
        "communityTags": [
          "string"
        ]
      }
    ],
    "routingPolicyRefs": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "hRef": "string"
      }
    ]
  }
]

400

Bad Request

Request is not valid

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

401

Unauthorized

Credentials are missing

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

403

Forbidden

Valid credentials but not enough privileges to perform the operation

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

404

Not Found

Unknown resource or service

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

405

Method Not Allowed

Operation is not valid according to the state of the resource

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

500

Internal Server Error

Unexpected error, please contact support

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

503

Service Unavailable

Service probably in maintenance. Please retry later.

application/json

Schema

Schema

codeint32required

An integer coding the error type. This is given to caller so he can translate them if required.

messagestringrequired

A short localized string that describes the error.

descriptionstring

(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.

Example (auto)

{
  "code": 0,
  "message": "string",
  "description": "string"
}

• curl
• python
• go
• nodejs
• php
• java

• CURL

curl -L '/v1/projects/:projectId/zones/:zoneName/virtualnetworks' \
-H 'Accept: application/json'

Request Collapse all

Base URL

/v1

Parameters

projectId — pathrequired

zoneName — pathrequired

name — query

provisioningState — query

---creatingupdatingdeletingactiveerror

offset — query

limit — query

sort — query

X-API-KEY — header

Authorization — header

X-Requester-Id — header