Skip to main content

AttachNetworkInterface

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.

import {
  cloudApi,
  decodeMessage,
  serviceClients,
  Session,
  waitForOperation,
} from "@yandex-cloud/nodejs-sdk";

const AttachInstanceNetworkInterfaceRequest =
  cloudApi.compute.instance_service.AttachInstanceNetworkInterfaceRequest;
const Instance = cloudApi.compute.instance.Instance;
const IpVersion = cloudApi.compute.instance.IpVersion;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.InstanceServiceClient);

  const operation = await client.attachNetworkInterface(
    AttachInstanceNetworkInterfaceRequest.fromPartial({
      instanceId: "instanceId",
      networkInterfaceIndex: "networkInterfaceIndex",
      subnetId: "subnetId",
      // primaryV4AddressSpec: {
      // address: "address",
      // oneToOneNatSpec: {
      // ipVersion: IpVersion.IPV4,
      // address: "address",
      // dnsRecordSpecs: [{
      // fqdn: "fqdn",
      // dnsZoneId: "dnsZoneId",
      // ttl: 0,
      // ptr: true
      // }]
      // },
      // dnsRecordSpecs: [{
      // fqdn: "fqdn",
      // dnsZoneId: "dnsZoneId",
      // ttl: 0,
      // ptr: true
      // }]
      // },
      securityGroupIds: ["securityGroupIds"],
    })
  );
  const finishedOp = await waitForOperation(operation, session);

  if (finishedOp.response) {
    const result = decodeMessage<typeof Instance>(finishedOp.response);
    console.log(result);
  }
})();

AttachInstanceNetworkInterfaceRequest​

instanceId : string​

ID of the instance that in which network interface is being attached to.

networkInterfaceIndex : string​

The index of the network interface

subnetId : string​

ID of the subnet.

primaryV4AddressSpec : PrimaryAddressSpec​

Primary IPv4 address that will be assigned to the instance for this network interface.

securityGroupIds : string​

ID's of security groups attached to the interface.

PrimaryAddressSpec​

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​

ipVersion : IpVersion​

External IP address version.

address : string​
dnsRecordSpecs : DnsRecordSpec​

External DNS configuration

DnsRecordSpec​

fqdn : string​

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​

An Operation resource. For more information, see Operation.

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

One of result​

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.

  • error : google.rpc.Status​

    The error result of the operation in case of failure or cancellation.

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