Find virtual machines by searching criteria
GET/projects/:projectId/zones/:zoneName/virtualmachines
Return virtual machines that match all searching criteria. Criteria are project identifier, virtual machine name, image identifier, virtual machine state.
Request
Path Parameters
Project Identifier
Zone name
Query Parameters
Name of the resource.
image name of the searched virtual machines
Possible values: [creating, updating, deleting, active, error]
state of the searched virtual machines
Default value: 0
Requested pagination of response. The parameter offset is the index of the first element to retrieve. Zero is the first element of the collection.
Possible values: >= 1
Default value: 100
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).
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
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
Response Headers
X-Total-Count
integer
Returns Pagination of response. The total number of items in the collection, after application of filters if any.
X-Result-Count
integer
The actual number of items contained in the response body. Note that it can be less than the requested "limit".
- application/json
- Schema
- Example (from schema)
Schema
Array [
- 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
- ignore : the modifications are recorded but no taken into account by the VNF
- replace : the modifications are taken into account by the VNF through a rebuild
Array [
]
Array [
Array [
- "true": the IP address cannot be routed outside the local network (NB: not compatible with BGPaaS)
- "false": the IP address can be routed outside the local network
]
Array [
]
Array [
]
Array [
]
Array [
Array [
- "true": the IP address cannot be routed outside the local network (NB: not compatible with BGPaaS)
- "false": the IP address can be routed outside the local network
]
Array [
]
Array [
]
]
]
]
Possible values: <= 40 characters, Value must match regular expression [A-Za-z0-9-]
Unique resource name. This attribute can not be updated.
Resource description
tags
object
Tags associated with the resource
Resource identifier.
Hypertext reference of the resource.
Creation date of the resource.
Date of the last modification of the resource.
Identifier of the user of the last create/update/delete operation requested on the resource.
Possible values: [creating, updating, deleting, active, error]
Provisioning state of the resource. Possible state:
Possible values: [active, suspended]
Operational state of the Virtual Machine.
Virtual machine image. Name to be selected from the result of GET images. If not provided, a bootable volume ref must be provided.
bootVolumeRef
object
The class represents a reference to a unique resource in API. Such reference refers to an resource either by its identifier, or by its name, or by both.
Identifier of the referred resource. If not provided, either name or hRef must be filled. This parameter can not be updated.
Possible values: non-empty and <= 40 characters
Name of the referred resource. If not provided, either hRef or identifier must be filled. This parameter can not be updated.
hRef of the referred resource. If not provided, either name or identifier must be filled. This parameter can not be updated.
Possible values: [virtio, ide, scsi, usb]
Type of the disk driver to use to boot on the Volume. Default value: virtio. To be used for exceptions. This attribute can not be updated.
Virtual machine flavor name. Name to be selected from the result of GET flavors. This attribute can not be updated.
serverGroupRef
object
The class represents a reference to a unique resource in API. Such reference refers to an resource either by its identifier, or by its name, or by both.
Identifier of the referred resource. If not provided, either name or hRef must be filled. This parameter can not be updated.
Possible values: non-empty and <= 40 characters
Name of the referred resource. If not provided, either hRef or identifier must be filled. This parameter can not be updated.
hRef of the referred resource. If not provided, either name or identifier must be filled. This parameter can not be updated.
Use configuration drive at VM boot. Configuration drives are special drives that are attached to a VM instance when it boots.
metaData
object
Map of key/value that can be passed to the VM without reboot. The maximum size of the metadata key and value is 255 bytes each. The total size limit is 65535 bytes.
VM boot configuration data encoded in Base64. Max length of decoded data = 65535 characters.
Possible values: [ignore, replace]
Update policy for the parameter userData :
keyPairRef
object
The class represents a reference to a unique resource in API. Such reference refers to an resource either by its identifier, or by its name, or by both.
Identifier of the referred resource. If not provided, either name or hRef must be filled. This parameter can not be updated.
Possible values: non-empty and <= 40 characters
Name of the referred resource. If not provided, either hRef or identifier must be filled. This parameter can not be updated.
hRef of the referred resource. If not provided, either name or identifier must be filled. This parameter can not be updated.
volumeRefs
object[]
List of Volumes to attach to the VM. Each Volume can be referenced by its identifier, its name, or its Hypertext reference.
Identifier of the referred resource. If not provided, either name or hRef must be filled. This parameter can not be updated.
Possible values: non-empty and <= 40 characters
Name of the referred resource. If not provided, either hRef or identifier must be filled. This parameter can not be updated.
hRef of the referred resource. If not provided, either name or identifier must be filled. This parameter can not be updated.
interfaces
object[]
required
Possible values: >= 1
List of interfaces of the virtual machine.
Possible values: non-empty and <= 40 characters
Name of the interface.
Interface description
Hypertext reference to the Interface details.
Default value: true
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.
virtualNetworkRef
object
required
The class represents a reference to a unique resource in API. Such reference refers to an resource either by its identifier, or by its name, or by both.
Identifier of the referred resource. If not provided, either name or hRef must be filled. This parameter can not be updated.
Possible values: non-empty and <= 40 characters
Name of the referred resource. If not provided, either hRef or identifier must be filled. This parameter can not be updated.
hRef of the referred resource. If not provided, either name or identifier must be filled. This parameter can not be updated.
ipAddresses
object[]
required
Possible values: >= 1
List of the IP addresses of the interface.
Possible values: Value must match regular expression ^(?:(?:(?:1\d{2}|[1-9]?\d|2[0-4]\d|25[0-5])(?:\.(?!$)|$)){4})|(?:(?:(?:[a-f1-9A-F][a-fA-F\d]{1,3}|[a-fA-F\d])(?::(?!$)|$)){8})$
IP address.
Possible values: [ipv4, ipv6]
IP Family Enum (ipv6 not available yet).
Scope of the IP address:
Floating IP address reserved with Orange associated with the interface. Ipv4 only available for the moment.
Fixed IP address mapped to the public IP address used as floating IP
securityGroupRefs
object[]
List of the Security Groups to apply on the interface.
Identifier of the referred resource. If not provided, either name or hRef must be filled. This parameter can not be updated.
Possible values: non-empty and <= 40 characters
Name of the referred resource. If not provided, either hRef or identifier must be filled. This parameter can not be updated.
hRef of the referred resource. If not provided, either name or identifier must be filled. This parameter can not be updated.
allowedIpAddressPairs
object[]
VRRP feature to define VIP IP
Virtual IP address.
Possible values: [active-active, active-standby]
VRRP mode.
Possible values: Value must match regular expression ^[\da-fA-F]{2}(?:-[\da-fA-F]{2}){5}$
MAC address associated to the Virtual IP address. If not provided, the MAC address of the active interface will be used.
Possible values: Value must match regular expression ^[\da-fA-F][02468aACEce](?:-[\da-fA-F]{2}){5}$
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.
interfaceRoutes
object[]
Interface loopback prefixe(s) and attributes to advertise.
Subnet in CIDR format.
Community Tags.
subInterfaces
object[]
Subinterfaces supported on the interface.
Possible values: <= 40 characters, Value must match regular expression [A-Za-z0-9-]
Name of the subinterface. Must be unique for the interface. This attribute can not be updated.
Possible values: <= 100 characters, Value must match regular expression ^[ -Za-zà-ë_]
Subinterface description.
Default value: true
Enable the subinterface. The interface can be disabled/enabled by updating this parameter.
virtualNetworkRef
object
required
The class represents a reference to a unique resource in API. Such reference refers to an resource either by its identifier, or by its name, or by both.
Identifier of the referred resource. If not provided, either name or hRef must be filled. This parameter can not be updated.
Possible values: non-empty and <= 40 characters
Name of the referred resource. If not provided, either hRef or identifier must be filled. This parameter can not be updated.
hRef of the referred resource. If not provided, either name or identifier must be filled. This parameter can not be updated.
802.1Q VLAN tag (range [100-199] recommended). This attribute can not be updated.
ipAddresses
object[]
required
List of the IP addresses of the subinterface.
Possible values: Value must match regular expression ^(?:(?:(?:1\d{2}|[1-9]?\d|2[0-4]\d|25[0-5])(?:\.(?!$)|$)){4})|(?:(?:(?:[a-f1-9A-F][a-fA-F\d]{1,3}|[a-fA-F\d])(?::(?!$)|$)){8})$
IP address.
Possible values: [ipv4, ipv6]
IP Family Enum (ipv6 not available yet).
Scope of the IP address:
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. This attribute can not be updated.
The floating IP is used to configure 1-to-1 NAT on the subinterface. This parameter specifies the Private IP address to use for NAT in case multiple IP addresses have been configured (this is recommended in this case, otherwise the private IP address will be selected randomly).
securityGroupRefs
object
The class represents a reference to a unique resource in API. Such reference refers to an resource either by its identifier, or by its name, or by both.
Identifier of the referred resource. If not provided, either name or hRef must be filled. This parameter can not be updated.
Possible values: non-empty and <= 40 characters
Name of the referred resource. If not provided, either hRef or identifier must be filled. This parameter can not be updated.
hRef of the referred resource. If not provided, either name or identifier must be filled. This parameter can not be updated.
allowedIpAddressPairs
object[]
List of Virtual IP addresses (VRRP protocol).
Virtual IP address.
Possible values: [active-active, active-standby]
VRRP mode.
Possible values: Value must match regular expression ^[\da-fA-F]{2}(?:-[\da-fA-F]{2}){5}$
MAC address associated to the Virtual IP address. If not provided, the MAC address of the active interface will be used.
Possible values: Value must match regular expression ^[\da-fA-F][02468aACEce](?:-[\da-fA-F]{2}){5}$
Mac address of the subinterface. Only Unicast MAC addresses are accepted. If not provided, the MAC address will be calculated automatically from a md5 hash of the subinterface name.
interfaceRoutes
object[]
Subinterface loopback prefixe(s) and attributes to advertise.
Subnet in CIDR format.
Community Tags.
bgpaas
object
BGPAAS option
Peer Autonomous System (2 or 4 bytes). Modifying it will cause a BGP flap.
Possible values: [up, down]
Bgpaas session admin state.
AS override replaces all occurrences of the peer ASN in the AS-path with the system AS. NB: This is a tricky option, do not use without prior knowledge.
Local Autonomous System used for this particular session. If configured, this overrides the backbone Autonomous System. Modifying it will cause a BGP flap.
Possible values: [inet, inet6]
List of BGP address families supported on this session (v6 is implemented according to RFC 2545). By default, this list contains only "inet"
Default value: 10000
Maximum number of BGP routes allowed by the BGPaaS session. This attribute can not be updated.
Possible values: <= 3
Default value: 0
Allows the vRouter to accept its own AS system in the AS path, a certain number of times defined by the loop count.
Possible values: >= 45 and <= 65535
Default value: 60
BGP hold time (standard BGP) (seconds). Max time to detect liveliness of peer.
bgpaas
object
BGPAAS option
Peer Autonomous System (2 or 4 bytes). Modifying it will cause a BGP flap.
Possible values: [up, down]
Bgpaas session admin state.
AS override replaces all occurrences of the peer ASN in the AS-path with the system AS. NB: This is a tricky option, do not use without prior knowledge.
Local Autonomous System used for this particular session. If configured, this overrides the backbone Autonomous System. Modifying it will cause a BGP flap.
Possible values: [inet, inet6]
List of BGP address families supported on this session (v6 is implemented according to RFC 2545). By default, this list contains only "inet"
Default value: 10000
Maximum number of BGP routes allowed by the BGPaaS session. This attribute can not be updated.
Possible values: <= 3
Default value: 0
Allows the vRouter to accept its own AS system in the AS path, a certain number of times defined by the loop count.
Possible values: >= 45 and <= 65535
Default value: 60
BGP hold time (standard BGP) (seconds). Max time to detect liveliness of peer.
[
{
"name": "string",
"description": "string",
"tags": {},
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"hRef": "string",
"createdDate": "2024-10-02T15:25:04.287Z",
"lastModifiedDate": "2024-10-02T15:25:04.287Z",
"lastRequesterId": "string",
"provisioningState": "creating",
"virtualMachineState": "active",
"image": "string",
"bootVolumeRef": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"hRef": "string"
},
"bootVolumeDiskBus": "virtio",
"flavor": "string",
"serverGroupRef": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"hRef": "string"
},
"configurationDrive": false,
"metaData": {},
"userData": "string",
"userDataUpdatePolicy": "ignore",
"keyPairRef": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"hRef": "string"
},
"volumeRefs": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"hRef": "string"
}
],
"interfaces": [
{
"name": "string",
"description": "string",
"hRef": "string",
"enabled": true,
"virtualNetworkRef": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"hRef": "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"
},
"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 (from schema)
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 (from schema)
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 (from schema)
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 (from schema)
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 (from schema)
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 (from schema)
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 (from schema)
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"
}