Get Machine Network Interface

Get Machine Network Interface

Get network interface with a given id for specific machine

Request
URI
GET
https://{api_host}/iaas/api/machines/{id}/network-interfaces/{id1}
COPY
Path Parameters
string
id
Required

The ID of the machine.

string
id1
Required

The ID of the network interface.

Query Parameters
string
apiVersion
Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /iaas/api/about

Responses
200

successful operation

Returns NetworkInterface of type(s) */* 
{
    "owner": "[email protected]",
    "addresses": [
        "string"
    ],
    "externalRegionId": "ap-northeast-2",
    "description": "my-description",
    "externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
    "deviceIndex": 1,
    "orgId": "9e49",
    "tags": [
        {
            "value": "string",
            "key": "string"
        }
    ],
    "organizationId": "deprecated",
    "createdAt": "2012-09-27",
    "cloudAccountIds": [
        "string"
    ],
    "name": "my-name",
    "id": "9e49",
    "updatedAt": "2012-09-27"
}
string
owner
Optional

Email of the user that owns the entity.

array of string
addresses
Optional

A list of IP addresses allocated or in use by this network interface.

object
_links
Required

HATEOAS of the entity

string
externalRegionId
Required

The external regionId of the network interface.

string
description
Optional

A human-friendly description.

string
externalId
Optional

External entity Id on the provider side.

integer As int32 As int32
deviceIndex
Optional

The device index of this network interface.

string
orgId
Optional

The id of the organization this entity belongs to.

array of Tag
tags
Optional

A set of tag keys and optional values that were set on this network interface.

string
organizationId
Optional

This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.

string
createdAt
Optional

Date when the entity was created. The date is in ISO 6801 and UTC.

array of string
cloudAccountIds
Optional

Set of ids of the cloud accounts this entity belongs to.

object
customProperties
Optional

Additional properties that may be used to extend the base type.

string
name
Optional

A human-friendly name used as an identifier in APIs that support this option.

string
id
Required

The id of this resource instance

string
updatedAt
Optional

Date when the entity was last updated. The date is ISO 8601 and UTC.


403

Forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

On This Page
Network Operations
GET
Get Machine Network Interface