Compute Cloud API, gRPC: InstanceService.AttachNetworkInterface

Written by

Improved by

Updated at June 1, 2026

gRPC request
AttachInstanceNetworkInterfaceRequest
PrimaryAddressSpec
OneToOneNatSpec
DnsRecordSpec
operation.Operation

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

{
  "instance_id": "string",
  "network_interface_index": "string",
  "subnet_id": "string",
  "primary_v4_address_spec": {
    "address": "string",
    "one_to_one_nat_spec": {
      "ip_version": "IpVersion",
      "address": "string",
      "dns_record_specs": [
        {
          "fqdn": "string",
          "dns_zone_id": "string",
          "ttl": "int64",
          "ptr": "bool"
        }
      ]
    },
    "dns_record_specs": [
      {
        "fqdn": "string",
        "dns_zone_id": "string",
        "ttl": "int64",
        "ptr": "bool"
      }
    ]
  },
  "security_group_ids": [
    "string"
  ]
}

Field	Description
instance_id	string ID of the instance that in which network interface is being attached to. This field is required.
network_interface_index	string The index of the network interface This field is required.
subnet_id	string ID of the subnet. This field is required.
primary_v4_address_spec	PrimaryAddressSpec Primary IPv4 address that will be assigned to the instance for this network interface.
security_group_ids[]	string ID's of security groups attached to the interface. This field is required.

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.
one_to_one_nat_spec	OneToOneNatSpec An external IP address configuration. If not specified, then this instance will have no external internet access.
dns_record_specs[]	DnsRecordSpec Internal DNS configuration

OneToOneNatSpec

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

DnsRecordSpec

Field	Description
fqdn	string FQDN (required) This field is required.
dns_zone_id	string DNS zone id (optional, if not set, private zone used)
ttl	int64 DNS record ttl, values in 0-86400 (optional) The value must be between 0 and 86400.
ptr	bool When set to true, also create PTR DNS record (optional)

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": "google.protobuf.Any",
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": "google.protobuf.Any"
  // 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.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	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	google.protobuf.Any 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	google.protobuf.Any 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.

Compute Cloud API, gRPC: InstanceService.AttachNetworkInterface

gRPC requestgRPC request

AttachInstanceNetworkInterfaceRequestAttachInstanceNetworkInterfaceRequest

PrimaryAddressSpecPrimaryAddressSpec

OneToOneNatSpecOneToOneNatSpec

DnsRecordSpecDnsRecordSpec

operation.Operationoperation.Operation