Get an interface by its name for a given virtual machine
GET/v1/projects/:projectId/zones/:zoneName/virtualmachines/:virtualMachineId/interfaces/:interfaceName
Return an interface by its name (in path).
Request
Path Parameters
Project Identifier
Zone name
Virtual machine Identifier
Name of the interface.
Header Parameters
Your SIU token if you use this API through Orange Developer.
Bearer access token authentication if you use this API through Orange Developer or Orange Developer Inside.
Your SIU Id if you use this API through Orange Developer Inside.
Responses
- 200
- 400
- 401
- 403
- 404
- 405
- 500
- 503
Ok
- application/json
- Schema
- Example (auto)
Schema
Name of the interface.
Possible values: non-empty
and <= 40 characters
Interface description
Hypertext reference to the Interface details.
Enable the interface. The interface can be disabled/enabled by updating this parameter or by using the disable/enable actions. By default, the interface is enabled.
true
virtualNetworkRef object
Name of the shared Virtual Network connected to the interface.
Possible values: non-empty
and <= 50 characters
, Value must match regular expression [a-zA-Z0-9-_ ]
ipAddresses object[]required
The floating IP is used to configure 1-to-1 NAT on the subinterface. This parameter specifies the Public IP address to use for NAT. Ipv4 only available for the moment.
Fixed IP address mapped to the public IP address used as floating IP
securityGroupRefs object[]
allowedIpAddressPairs object[]
Mac address of the interface. Only Unicast MAC addresses are accepted. If not provided, the MAC address will be calculated automatically from a md5 hash of the interface name.
Possible values: Value must match regular expression ^[\da-fA-F][02468aACEce](?:-[\da-fA-F]{2}){5}$
interfaceRoutes object[]
subInterfaces object[]
bgpaas object
{
"name": "string",
"description": "string",
"hRef": "string",
"enabled": true,
"virtualNetworkRef": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"hRef": "string"
},
"sharedVirtualNetworkName": "string",
"ipAddresses": [
{
"ipAddress": "string",
"family": "ipv4",
"isIpLocal": false
}
],
"floatingIpAddress": "string",
"floatingPrivateIpAddress": "string",
"securityGroupRefs": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"hRef": "string"
}
],
"allowedIpAddressPairs": [
{
"ipAddress": "string",
"mode": "active-active",
"macAddress": "string"
}
],
"macAddress": "string",
"interfaceRoutes": [
{
"prefix": "string",
"communityTags": [
"string"
]
}
],
"subInterfaces": [
{
"name": "string",
"description": "string",
"enabled": true,
"virtualNetworkRef": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"hRef": "string"
},
"sharedVirtualNetworkName": "string",
"vlanId": 0,
"ipAddresses": [
{
"ipAddress": "string",
"family": "ipv4",
"isIpLocal": false
}
],
"floatingIpAddress": "string",
"floatingPrivateIpAddress": "string",
"securityGroupRefs": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"hRef": "string"
},
"allowedIpAddressPairs": [
{
"ipAddress": "string",
"mode": "active-active",
"macAddress": "string"
}
],
"macAddress": "string",
"interfaceRoutes": [
{
"prefix": "string",
"communityTags": [
"string"
]
}
],
"bgpaas": {
"autonomousSystem": 0,
"adminSessionState": "up",
"asOverride": true,
"localAutonomousSystem": 0,
"bgpAddressFamilies": [
"inet"
],
"maxRoutes": 10000,
"loopCount": 0,
"holdTime": 60
}
}
],
"bgpaas": {
"autonomousSystem": 0,
"adminSessionState": "up",
"asOverride": true,
"localAutonomousSystem": 0,
"bgpAddressFamilies": [
"inet"
],
"maxRoutes": 10000,
"loopCount": 0,
"holdTime": 60
}
}
Bad Request
Request is not valid
- application/json
- Schema
- Example (auto)
Schema
An integer coding the error type. This is given to caller so he can translate them if required.
A short localized string that describes the error.
(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.
{
"code": 0,
"message": "string",
"description": "string"
}
Unauthorized
Credentials are missing
- application/json
- Schema
- Example (auto)
Schema
An integer coding the error type. This is given to caller so he can translate them if required.
A short localized string that describes the error.
(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.
{
"code": 0,
"message": "string",
"description": "string"
}
Forbidden
Valid credentials but not enough privileges to perform the operation
- application/json
- Schema
- Example (auto)
Schema
An integer coding the error type. This is given to caller so he can translate them if required.
A short localized string that describes the error.
(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.
{
"code": 0,
"message": "string",
"description": "string"
}
Not Found
Unknown resource or service
- application/json
- Schema
- Example (auto)
Schema
An integer coding the error type. This is given to caller so he can translate them if required.
A short localized string that describes the error.
(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.
{
"code": 0,
"message": "string",
"description": "string"
}
Method Not Allowed
Operation is not valid according to the state of the resource
- application/json
- Schema
- Example (auto)
Schema
An integer coding the error type. This is given to caller so he can translate them if required.
A short localized string that describes the error.
(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.
{
"code": 0,
"message": "string",
"description": "string"
}
Internal Server Error
Unexpected error, please contact support
- application/json
- Schema
- Example (auto)
Schema
An integer coding the error type. This is given to caller so he can translate them if required.
A short localized string that describes the error.
(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.
{
"code": 0,
"message": "string",
"description": "string"
}
Service Unavailable
Service probably in maintenance. Please retry later.
- application/json
- Schema
- Example (auto)
Schema
An integer coding the error type. This is given to caller so he can translate them if required.
A short localized string that describes the error.
(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.
{
"code": 0,
"message": "string",
"description": "string"
}
- curl
- python
- go
- nodejs
- php
- java
- CURL
curl -L '/v1/projects/:projectId/zones/:zoneName/virtualmachines/:virtualMachineId/interfaces/:interfaceName' \
-H 'Accept: application/json'