UpdateNetworkInterface

Updates the specified instance network interface.

TypeScript

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

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

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

  const operation = await client.updateNetworkInterface(
    UpdateInstanceNetworkInterfaceRequest.fromPartial({
      instanceId: "instanceId",
      networkInterfaceIndex: "networkInterfaceIndex",
      // updateMask: {
      // paths: ["paths"]
      // },
      // 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
      // }]
      // },
      // primaryV6AddressSpec: {
      // 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);
  }
})();

Python

import os
import grpc
import yandexcloud

from yandex.cloud.compute.v1.instance_service_pb2 import DnsRecordSpec
from yandex.cloud.compute.v1.instance_pb2 import Instance
from yandex.cloud.compute.v1.instance_service_pb2_grpc import InstanceServiceStub
from yandex.cloud.compute.v1.instance_pb2 import IpVersion
from yandex.cloud.compute.v1.instance_service_pb2 import OneToOneNatSpec
from yandex.cloud.compute.v1.instance_service_pb2 import PrimaryAddressSpec
from yandex.cloud.compute.v1.instance_service_pb2 import UpdateInstanceNetworkInterfaceMetadata
from yandex.cloud.compute.v1.instance_service_pb2 import UpdateInstanceNetworkInterfaceRequest

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(InstanceServiceStub)
operation = service.UpdateNetworkInterface(
    UpdateInstanceNetworkInterfaceRequest(
        instance_id="instanceId",
        network_interface_index="networkInterfaceIndex",
        # update_mask = FieldMask.FromJsonString("field1,field2"),
        # subnet_id = "subnetId",
        # primary_v_4_address_spec = PrimaryAddressSpec(
        # address = "address",
        # one_to_one_nat_spec = OneToOneNatSpec(
        # ip_version = IpVersion.IPV4,
        # address = "address",
        # dns_record_specs = [DnsRecordSpec(
        # fqdn = "fqdn",
        # dns_zone_id = "dnsZoneId",
        # ttl = 0,
        # ptr = true
        # )]
        # ),
        # dns_record_specs = [DnsRecordSpec(
        # fqdn = "fqdn",
        # dns_zone_id = "dnsZoneId",
        # ttl = 0,
        # ptr = true
        # )]
        # ),
        # primary_v_6_address_spec = PrimaryAddressSpec(
        # address = "address",
        # one_to_one_nat_spec = OneToOneNatSpec(
        # ip_version = IpVersion.IPV4,
        # address = "address",
        # dns_record_specs = [DnsRecordSpec(
        # fqdn = "fqdn",
        # dns_zone_id = "dnsZoneId",
        # ttl = 0,
        # ptr = true
        # )]
        # ),
        # dns_record_specs = [DnsRecordSpec(
        # fqdn = "fqdn",
        # dns_zone_id = "dnsZoneId",
        # ttl = 0,
        # ptr = true
        # )]
        # ),
        # security_group_ids = ["securityGroupIds"]
    )
)
operation_result = sdk.wait_operation_and_get_result(
    operation,
    response_type=Instance,
    meta_type=UpdateInstanceNetworkInterfaceMetadata,
)
print(operation_result)

UpdateInstanceNetworkInterfaceRequest

instanceId : string

ID of the instance that is being updated.

networkInterfaceIndex : string

The index of the network interface to be updated.

updateMask : google.protobuf.FieldMask

Field mask that specifies which attributes of the instance should be updated.

subnetId : string

ID of the subnet.

primaryV4AddressSpec : PrimaryAddressSpec

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

primaryV6AddressSpec : PrimaryAddressSpec

Primary IPv6 address that will be assigned to the instance for this network interface. IPv6 not available yet.

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.

---