Aller au contenu principal

Cette page est disponible uniquement en anglais (This page is only available in English).

Get a virtual machine by its identifier

GET 

/v1/projects/:projectId/zones/:zoneName/virtualmachines/:virtualMachineId

Get a virtual machine by its identifier

Request

Path Parameters

    projectId stringrequired

    Project Identifier

    zoneName stringrequired

    Zone name

    virtualMachineId stringrequired

    Virtual machine Identifier

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

Ok

Schema
    namestringrequired

    Unique resource name. This attribute can not be updated.

    Possible values: Value must match regular expression [A-Za-z0-9-]

    descriptionstring

    Resource description

    tags object

    Tags associated with the resource

    property name*string
    iduuidrequired

    Resource identifier.

    hRefurirequired

    Hypertext reference of the resource.

    createdDatedate-timerequired

    Creation date of the resource.

    lastModifiedDatedate-timerequired

    Date of the last modification of the resource.

    lastRequesterIdstringrequired

    Identifier of the user of the last create/update/delete operation requested on the resource.

    provisioningStateBasicStateEnum (string)required

    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]

    virtualMachineStateVirtualMachineStateEnum (string)required

    Operational state of the Virtual Machine.

    Possible values: [active, suspended]

    imagestring

    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.

    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.

    bootVolumeDiskBusbootVolumeDiskBusEnum (string)

    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.

    Possible values: [virtio, ide, scsi, usb]

    flavorstringrequired

    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.

    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.

    configurationDriveboolean

    Use configuration drive at VM boot. Configuration drives are special drives that are attached to a VM instance when it boots.

    Default value: false
    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.

    property name*string
    userDatastring

    VM boot configuration data encoded in Base64. Max length of decoded data = 65535 characters.

    userDataUpdatePolicyUserDataUpdatePolicyEnum (string)

    Update policy for the parameter userData :

    • 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

    Possible values: [ignore, replace]

    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.

    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.

    volumeRefs object[]

    List of Volumes to attach to the VM. Each Volume can be referenced by its identifier, its name, or its Hypertext reference.

  • 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.

  • ]
  • interfaces object[]required

    List of interfaces of the virtual machine.

    Possible values: >= 1

  • Array [
  • namestringrequired

    Name of the interface.

    Possible values: non-empty and <= 40 characters

    descriptionstring

    Interface description

    hRefstringrequired

    Hypertext reference to the Interface details.

    enabledboolean

    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.

    Default value: true
    virtualNetworkRef 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.

    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.

    sharedVirtualNetworkNamestring

    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

    List of the IP addresses of the interface.

    Possible values: >= 1

  • Array [
  • ipAddressstringrequired

    IP address.

    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})$

    familyIpFamilyEnum (string)

    IP Family Enum (ipv6 not available yet).

    Possible values: [ipv4, ipv6]

    isIpLocalboolean

    Scope of the IP address:

    • "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
    Default value: false
  • ]
  • floatingIpAddressstring

    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.

    floatingPrivateIpAddressstring

    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.

  • 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.

  • ]
  • allowedIpAddressPairs object[]

    VRRP feature to define VIP IP

  • Array [
  • ipAddressstringrequired

    Virtual IP address.

    modeAddressPairModeEnum (string)

    VRRP mode.

    Possible values: [active-active, active-standby]

    macAddressstring

    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]{2}(?:-[\da-fA-F]{2}){5}$

  • ]
  • macAddressstring

    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[]

    Interface loopback prefixe(s) and attributes to advertise.

  • Array [
  • prefixstringrequired

    Subnet in CIDR format.

    communityTagsstring[]

    Community Tags. Possible values: community tag or 'no-export', 'no-advertise'

    Possible values: <= 10

  • ]
  • subInterfaces object[]

    Subinterfaces supported on the interface.

  • Array [
  • namestringrequired

    Name of the subinterface. Must be unique for the interface. This attribute can not be updated.

    Possible values: <= 40 characters, Value must match regular expression [A-Za-z0-9-]

    descriptionstring

    Subinterface description.

    Possible values: <= 100 characters, Value must match regular expression ^[ -Za-zà-ë_]

    enabledboolean

    Enable the subinterface. The interface can be disabled/enabled by updating this parameter.

    Default value: true
    virtualNetworkRef 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.

    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.

    sharedVirtualNetworkNamestring

    Name of the shared Virtual Network connected to the sub-interface. If not provided, a virtual network ref must be provided. This attribute can not be updated.

    Possible values: non-empty and <= 50 characters, Value must match regular expression [a-zA-Z0-9-_ ]

    vlanIdint32required

    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.

  • Array [
  • ipAddressstringrequired

    IP address.

    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})$

    familyIpFamilyEnum (string)

    IP Family Enum (ipv6 not available yet).

    Possible values: [ipv4, ipv6]

    isIpLocalboolean

    Scope of the IP address:

    • "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
    Default value: false
  • ]
  • floatingIpAddressstring

    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. IpV6 not available yet.

    floatingPrivateIpAddressstring

    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). IpV6 not available yet.

    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.

    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.

    allowedIpAddressPairs object[]

    List of Virtual IP addresses (VRRP protocol).

  • Array [
  • ipAddressstringrequired

    Virtual IP address.

    modeAddressPairModeEnum (string)

    VRRP mode.

    Possible values: [active-active, active-standby]

    macAddressstring

    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]{2}(?:-[\da-fA-F]{2}){5}$

  • ]
  • macAddressstring

    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.

    Possible values: Value must match regular expression ^[\da-fA-F][02468aACEce](?:-[\da-fA-F]{2}){5}$

    interfaceRoutes object[]

    Subinterface loopback prefixe(s) and attributes to advertise.

  • Array [
  • prefixstringrequired

    Subnet in CIDR format.

    communityTagsstring[]

    Community Tags. Possible values: community tag or 'no-export', 'no-advertise'

    Possible values: <= 10

  • ]
  • bgpaas object

    BGPAAS option

    autonomousSystemint32required

    Peer Autonomous System (2 or 4 bytes). Modifying it will cause a BGP flap.

    adminSessionStateAdminSessionStateEnum (string)

    Bgpaas session admin state.

    Possible values: [up, down]

    asOverrideboolean

    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.

    localAutonomousSystemint32

    Local Autonomous System used for this particular session. If configured, this overrides the backbone Autonomous System. Modifying it will cause a BGP flap.

    bgpAddressFamiliesBGPAddressFamilyEnum (string)[]

    List of BGP address families supported on this session (v6 is implemented according to RFC 2545). By default, this list contains only "inet"

    Possible values: [inet, inet6]

    maxRoutesint32

    Maximum number of BGP routes allowed by the BGPaaS session. This attribute can not be updated.

    Default value: 10000
    loopCountint32

    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: <= 3

    Default value: 0
    holdTimeint32

    BGP hold time (standard BGP) (seconds). Max time to detect liveliness of peer.

    Possible values: >= 45 and <= 65535

    Default value: 60
  • ]
  • bgpaas object

    BGPAAS option

    autonomousSystemint32required

    Peer Autonomous System (2 or 4 bytes). Modifying it will cause a BGP flap.

    adminSessionStateAdminSessionStateEnum (string)

    Bgpaas session admin state.

    Possible values: [up, down]

    asOverrideboolean

    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.

    localAutonomousSystemint32

    Local Autonomous System used for this particular session. If configured, this overrides the backbone Autonomous System. Modifying it will cause a BGP flap.

    bgpAddressFamiliesBGPAddressFamilyEnum (string)[]

    List of BGP address families supported on this session (v6 is implemented according to RFC 2545). By default, this list contains only "inet"

    Possible values: [inet, inet6]

    maxRoutesint32

    Maximum number of BGP routes allowed by the BGPaaS session. This attribute can not be updated.

    Default value: 10000
    loopCountint32

    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: <= 3

    Default value: 0
    holdTimeint32

    BGP hold time (standard BGP) (seconds). Max time to detect liveliness of peer.

    Possible values: >= 45 and <= 65535

    Default value: 60
  • ]
curl -L '/v1/projects/:projectId/zones/:zoneName/virtualmachines/:virtualMachineId' \
-H 'Accept: application/json'
Request Collapse all
Base URL
/v1
Parameters
— pathrequired
— pathrequired
— pathrequired
— header
— header
— header