Compute Cloud API, gRPC: InstanceService.AttachNetworkInterface

Written by

Updated at October 17, 2024

gRPC request
AttachInstanceNetworkInterfaceRequest
PrimaryAddressSpec
OneToOneNatSpec
DnsRecordSpec
operation.Operation
AttachInstanceNetworkInterfaceMetadata
Instance
Resources
MetadataOptions
AttachedDisk
AttachedLocalDisk
AttachedFilesystem
NetworkInterface
PrimaryAddress
OneToOneNat
DnsRecord
SerialPortSettings
GpuSettings
SchedulingPolicy
NetworkSettings
PlacementPolicy
HostAffinityRule
HardwareGeneration
LegacyHardwareFeatures
Generation2HardwareFeatures

Attaches the network-interface to the instance.

To attach a network-interface, the instance must have a STOPPED status (Instance.status).
To check the instance status, make a InstanceService.Get request.
To stop the running instance, make a InstanceService.Stop request.

gRPC request

rpc AttachNetworkInterface (AttachInstanceNetworkInterfaceRequest) returns (operation.Operation)

AttachInstanceNetworkInterfaceRequest

{
  "instanceId": "string",
  "networkInterfaceIndex": "string",
  "subnetId": "string",
  "primaryV4AddressSpec": {
    "address": "string",
    "oneToOneNatSpec": {
      "ipVersion": "IpVersion",
      "address": "string",
      "dnsRecordSpecs": [
        {
          "fqdn": "string",
          "dnsZoneId": "string",
          "ttl": "int64",
          "ptr": "bool"
        }
      ]
    },
    "dnsRecordSpecs": [
      {
        "fqdn": "string",
        "dnsZoneId": "string",
        "ttl": "int64",
        "ptr": "bool"
      }
    ]
  },
  "securityGroupIds": [
    "string"
  ]
}

Field	Description
instanceId	string Required field. ID of the instance that in which network interface is being attached to.
networkInterfaceIndex	string Required field. The index of the network interface
subnetId	string Required field. ID of the subnet.
primaryV4AddressSpec	PrimaryAddressSpec Primary IPv4 address that will be assigned to the instance for this network interface.
securityGroupIds[]	string Required field. ID's of security groups attached to the interface.

PrimaryAddressSpec

Field	Description
address	string An IPv4 internal network address that is assigned to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
oneToOneNatSpec	OneToOneNatSpec An external IP address configuration. If not specified, then this instance will have no external internet access.
dnsRecordSpecs[]	DnsRecordSpec Internal DNS configuration

OneToOneNatSpec

Field	Description
ipVersion	enum IpVersion External IP address version. `IP_VERSION_UNSPECIFIED` `IPV4`: IPv4 address, for example 192.0.2.235. `IPV6`: IPv6 address. Not available yet.
address	string set static IP by value
dnsRecordSpecs[]	DnsRecordSpec External DNS configuration

DnsRecordSpec

Field	Description
fqdn	string Required field. FQDN (required)
dnsZoneId	string DNS zone id (optional, if not set, private zone used)
ttl	int64 DNS record ttl, values in 0-86400 (optional)
ptr	bool When set to true, also create PTR DNS record (optional)

operation.Operation

{
  "id": "string",
  "description": "string",
  "createdAt": "google.protobuf.Timestamp",
  "createdBy": "string",
  "modifiedAt": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "instanceId": "string",
    "networkInterfaceIndex": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "folderId": "string",
    "createdAt": "google.protobuf.Timestamp",
    "name": "string",
    "description": "string",
    "labels": "string",
    "zoneId": "string",
    "platformId": "string",
    "resources": {
      "memory": "int64",
      "cores": "int64",
      "coreFraction": "int64",
      "gpus": "int64"
    },
    "status": "Status",
    "metadata": "string",
    "metadataOptions": {
      "gceHttpEndpoint": "MetadataOption",
      "awsV1HttpEndpoint": "MetadataOption",
      "gceHttpToken": "MetadataOption",
      "awsV1HttpToken": "MetadataOption"
    },
    "bootDisk": {
      "mode": "Mode",
      "deviceName": "string",
      "autoDelete": "bool",
      "diskId": "string"
    },
    "secondaryDisks": [
      {
        "mode": "Mode",
        "deviceName": "string",
        "autoDelete": "bool",
        "diskId": "string"
      }
    ],
    "localDisks": [
      {
        "size": "int64",
        "deviceName": "string"
      }
    ],
    "filesystems": [
      {
        "mode": "Mode",
        "deviceName": "string",
        "filesystemId": "string"
      }
    ],
    "networkInterfaces": [
      {
        "index": "string",
        "macAddress": "string",
        "subnetId": "string",
        "primaryV4Address": {
          "address": "string",
          "oneToOneNat": {
            "address": "string",
            "ipVersion": "IpVersion",
            "dnsRecords": [
              {
                "fqdn": "string",
                "dnsZoneId": "string",
                "ttl": "int64",
                "ptr": "bool"
              }
            ]
          },
          "dnsRecords": [
            {
              "fqdn": "string",
              "dnsZoneId": "string",
              "ttl": "int64",
              "ptr": "bool"
            }
          ]
        },
        "primaryV6Address": {
          "address": "string",
          "oneToOneNat": {
            "address": "string",
            "ipVersion": "IpVersion",
            "dnsRecords": [
              {
                "fqdn": "string",
                "dnsZoneId": "string",
                "ttl": "int64",
                "ptr": "bool"
              }
            ]
          },
          "dnsRecords": [
            {
              "fqdn": "string",
              "dnsZoneId": "string",
              "ttl": "int64",
              "ptr": "bool"
            }
          ]
        },
        "securityGroupIds": [
          "string"
        ]
      }
    ],
    "serialPortSettings": {
      "sshAuthorization": "SSHAuthorization"
    },
    "gpuSettings": {
      "gpuClusterId": "string"
    },
    "fqdn": "string",
    "schedulingPolicy": {
      "preemptible": "bool"
    },
    "serviceAccountId": "string",
    "networkSettings": {
      "type": "Type"
    },
    "placementPolicy": {
      "placementGroupId": "string",
      "hostAffinityRules": [
        {
          "key": "string",
          "op": "Operator",
          "values": [
            "string"
          ]
        }
      ],
      "placementGroupPartition": "int64"
    },
    "hostGroupId": "string",
    "hostId": "string",
    "maintenancePolicy": "MaintenancePolicy",
    "maintenanceGracePeriod": "google.protobuf.Duration",
    "hardwareGeneration": {
      // Includes only one of the fields `legacyFeatures`, `generation2Features`
      "legacyFeatures": {
        "pciTopology": "PCITopology"
      },
      "generation2Features": "Generation2HardwareFeatures"
      // end of the list of possible fields
    }
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
createdAt	google.protobuf.Timestamp Creation timestamp.
createdBy	string ID of the user or service account who initiated the operation.
modifiedAt	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
metadata	AttachInstanceNetworkInterfaceMetadata Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
error	google.rpc.Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
response	Instance The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.

AttachInstanceNetworkInterfaceMetadata

Field

Description

instanceId

string

ID of the instant network interface that is being updated.

networkInterfaceIndex

string

Instance

An Instance resource. For more information, see Instances.

Field	Description
id	string ID of the instance.
folderId	string ID of the folder that the instance belongs to.
createdAt	google.protobuf.Timestamp
name	string Name of the instance. 1-63 characters long.
description	string Description of the instance. 0-256 characters long.
labels	string Resource labels as `key:value` pairs. Maximum of 64 per resource.
zoneId	string ID of the availability zone where the instance resides.
platformId	string ID of the hardware platform configuration for the instance.
resources	Resources Computing resources of the instance such as the amount of memory and number of cores.
status	enum Status Status of the instance. `STATUS_UNSPECIFIED` `PROVISIONING`: Instance is waiting for resources to be allocated. `RUNNING`: Instance is running normally. `STOPPING`: Instance is being stopped. `STOPPED`: Instance stopped. `STARTING`: Instance is being started. `RESTARTING`: Instance is being restarted. `UPDATING`: Instance is being updated. `ERROR`: Instance encountered a problem and cannot operate. `CRASHED`: Instance crashed and will be restarted automatically. `DELETING`: Instance is being deleted.
metadata	string The metadata `key:value` pairs assigned to this instance. This includes custom metadata and predefined keys. For example, you may use the metadata in order to provide your public SSH key to the instance. For more information, see Metadata.
metadataOptions	MetadataOptions Options allow user to configure access to instance's metadata
bootDisk	AttachedDisk Boot disk that is attached to the instance.
secondaryDisks[]	AttachedDisk Array of secondary disks that are attached to the instance.
localDisks[]	AttachedLocalDisk Array of local disks that are attached to the instance.
filesystems[]	AttachedFilesystem Array of filesystems that are attached to the instance.
networkInterfaces[]	NetworkInterface Array of network interfaces that are attached to the instance.
serialPortSettings	SerialPortSettings Serial port settings
gpuSettings	GpuSettings GPU settings
fqdn	string A domain name of the instance. FQDN is defined by the server in the format `<hostname>.<region_id>.internal` when the instance is created. If the hostname were not specified when the instance was created, FQDN would be `<id>.auto.internal`.
schedulingPolicy	SchedulingPolicy Scheduling policy configuration.
serviceAccountId	string ID of the service account to use for authentication inside the instance. To get the service account ID, use a yandex.cloud.iam.v1.ServiceAccountService.List request.
networkSettings	NetworkSettings Network Settings
placementPolicy	PlacementPolicy Placement policy configuration.
hostGroupId	string ID of the dedicated host group that the instance belongs to.
hostId	string ID of the dedicated host that the instance belongs to.
maintenancePolicy	enum MaintenancePolicy Behaviour on maintenance events `MAINTENANCE_POLICY_UNSPECIFIED` `RESTART`: Restart instance to move it to another host during maintenance `MIGRATE`: Use live migration to move instance to another host during maintenance
maintenanceGracePeriod	google.protobuf.Duration Time between notification via metadata service and maintenance
hardwareGeneration	HardwareGeneration This feature set is inherited from the image/disk used as a boot one at the creation of the instance.

Resources

Field	Description
memory	int64 The amount of memory available to the instance, specified in bytes.
cores	int64 The number of cores available to the instance.
coreFraction	int64 Baseline level of CPU performance with the ability to burst performance above that baseline level. This field sets baseline performance for each core.
gpus	int64 The number of GPUs available to the instance.

MetadataOptions

Field	Description
gceHttpEndpoint	enum MetadataOption Enabled access to GCE flavored metadata `METADATA_OPTION_UNSPECIFIED` `ENABLED`: Option is enabled `DISABLED`: Option is disabled
awsV1HttpEndpoint	enum MetadataOption Enabled access to AWS flavored metadata (IMDSv1) `METADATA_OPTION_UNSPECIFIED` `ENABLED`: Option is enabled `DISABLED`: Option is disabled
gceHttpToken	enum MetadataOption Enabled access to IAM credentials with GCE flavored metadata `METADATA_OPTION_UNSPECIFIED` `ENABLED`: Option is enabled `DISABLED`: Option is disabled
awsV1HttpToken	enum MetadataOption Enabled access to IAM credentials with AWS flavored metadata (IMDSv1) `METADATA_OPTION_UNSPECIFIED` `ENABLED`: Option is enabled `DISABLED`: Option is disabled

AttachedDisk

Field	Description
mode	enum Mode Access mode to the Disk resource. `MODE_UNSPECIFIED` `READ_ONLY`: Read-only access. `READ_WRITE`: Read/Write access.
deviceName	string Serial number that is reflected into the /dev/disk/by-id/ tree of a Linux operating system running within the instance. This value can be used to reference the device for mounting, resizing, and so on, from within the instance.
autoDelete	bool Specifies whether the disk will be auto-deleted when the instance is deleted.
diskId	string ID of the disk that is attached to the instance.

AttachedLocalDisk

Field

Description

size

int64

Size of the disk, specified in bytes.

deviceName

string

Serial number that is reflected into the /dev/disk/by-id/ tree
of a Linux operating system running within the instance.

This value can be used to reference the device for mounting, resizing, and so on, from within the instance.

AttachedFilesystem

Field	Description
mode	enum Mode Access mode to the filesystem. `MODE_UNSPECIFIED` `READ_ONLY`: Read-only access. `READ_WRITE`: Read/Write access.
deviceName	string Name of the device representing the filesystem on the instance. The name should be used for referencing the filesystem from within the instance when it's being mounted, resized etc.
filesystemId	string ID of the filesystem that is attached to the instance.

NetworkInterface

Field	Description
index	string The index of the network interface, will be generated by the server, 0,1,2... etc if not specified.
macAddress	string MAC address that is assigned to the network interface.
subnetId	string ID of the subnet.
primaryV4Address	PrimaryAddress Primary IPv4 address that is assigned to the instance for this network interface.
primaryV6Address	PrimaryAddress Primary IPv6 address that is assigned to the instance for this network interface. IPv6 not available yet.
securityGroupIds[]	string ID's of security groups attached to the interface

PrimaryAddress

Field	Description
address	string An IPv4 internal network address that is assigned to the instance for this network interface.
oneToOneNat	OneToOneNat One-to-one NAT configuration. If missing, NAT has not been set up.
dnsRecords[]	DnsRecord Internal DNS configuration

OneToOneNat

Field	Description
address	string An external IP address associated with this instance.
ipVersion	enum IpVersion IP version for the external IP address. `IP_VERSION_UNSPECIFIED` `IPV4`: IPv4 address, for example 192.0.2.235. `IPV6`: IPv6 address. Not available yet.
dnsRecords[]	DnsRecord External DNS configuration

DnsRecord

Field	Description
fqdn	string Name of the A/AAAA record as specified when creating the instance. Note that if `fqdn' has no trailing '.', it is specified relative to the zone (@see dns_zone_id).
dnsZoneId	string DNS zone id for the record (optional, if not set, some private zone is used).
ttl	int64 DNS record ttl (optional, if not set, a reasonable default is used.)
ptr	bool When true, indicates there is a corresponding auto-created PTR DNS record.

SerialPortSettings

Field

Description

sshAuthorization

enum SSHAuthorization

Authentication and authorization in serial console when using SSH protocol

SSH_AUTHORIZATION_UNSPECIFIED
INSTANCE_METADATA: Authentication and authorization using SSH keys in instance metadata
OS_LOGIN: Authentication and authorization using Oslogin service

GpuSettings

Field

Description

gpuClusterId

string

Attach instance to specified GPU cluster.

SchedulingPolicy

Field

Description

preemptible

bool

True for short-lived compute instances. For more information, see Preemptible VMs.

NetworkSettings

Field

Description

type

enum Type

Network Type

TYPE_UNSPECIFIED
STANDARD: Standard network.
SOFTWARE_ACCELERATED: Software accelerated network.
HARDWARE_ACCELERATED: Hardware accelerated network (not available yet, reserved for future use).

PlacementPolicy

Field	Description
placementGroupId	string Placement group ID.
hostAffinityRules[]	HostAffinityRule List of affinity rules. Scheduler will attempt to allocate instances according to order of rules.
placementGroupPartition	int64 Placement group partition

HostAffinityRule

Affinity definition

Field	Description
key	string Affinity label or one of reserved values - 'yc.hostId', 'yc.hostGroupId'
op	enum Operator Include or exclude action `OPERATOR_UNSPECIFIED` `IN` `NOT_IN`
values[]	string Affinity value or host ID or host group ID

HardwareGeneration

A set of features, specific to a particular Compute hardware generation.
They are not necessary supported by every host OS or distro, thus they are fixed to an image
and are applied to all instances created with it as their boot disk image.
These features significantly determine how the instance is created, thus cannot be changed after the fact.

Field

Description

legacyFeatures

LegacyHardwareFeatures

Includes only one of the fields legacyFeatures, generation2Features.

generation2Features

Generation2HardwareFeatures

Includes only one of the fields legacyFeatures, generation2Features.

LegacyHardwareFeatures

A first hardware generation, by default compatible with all legacy images.
Allows switching to PCI_TOPOLOGY_V2 and back.

Field

Description

pciTopology

enum PCITopology

PCI_TOPOLOGY_UNSPECIFIED
PCI_TOPOLOGY_V1
PCI_TOPOLOGY_V2

Generation2HardwareFeatures

A second hardware generation, which by default assumes PCI_TOPOLOGY_V2
and UEFI boot (with UEFI related features).

Field	Description
Empty

Compute Cloud API, gRPC: InstanceService.AttachNetworkInterface

gRPC requestgRPC request

AttachInstanceNetworkInterfaceRequestAttachInstanceNetworkInterfaceRequest

PrimaryAddressSpecPrimaryAddressSpec

OneToOneNatSpecOneToOneNatSpec

DnsRecordSpecDnsRecordSpec

operation.Operationoperation.Operation

AttachInstanceNetworkInterfaceMetadataAttachInstanceNetworkInterfaceMetadata

InstanceInstance

ResourcesResources

MetadataOptionsMetadataOptions

AttachedDiskAttachedDisk

AttachedLocalDiskAttachedLocalDisk

AttachedFilesystemAttachedFilesystem

NetworkInterfaceNetworkInterface

PrimaryAddressPrimaryAddress

OneToOneNatOneToOneNat

DnsRecordDnsRecord

SerialPortSettingsSerialPortSettings

GpuSettingsGpuSettings

SchedulingPolicySchedulingPolicy

NetworkSettingsNetworkSettings

PlacementPolicyPlacementPolicy

HostAffinityRuleHostAffinityRule

HardwareGenerationHardwareGeneration

LegacyHardwareFeaturesLegacyHardwareFeatures

Generation2HardwareFeaturesGeneration2HardwareFeatures

Was the article helpful?

gRPC request

AttachInstanceNetworkInterfaceRequest

PrimaryAddressSpec

OneToOneNatSpec

DnsRecordSpec

operation.Operation

AttachInstanceNetworkInterfaceMetadata

Instance

Resources

MetadataOptions

AttachedDisk

AttachedLocalDisk

AttachedFilesystem

NetworkInterface

PrimaryAddress

OneToOneNat

DnsRecord

SerialPortSettings

GpuSettings

SchedulingPolicy

NetworkSettings

PlacementPolicy

HostAffinityRule

HardwareGeneration

LegacyHardwareFeatures

Generation2HardwareFeatures