Skip to main content

Update

Updates the specified instance.

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

const HostAffinityRule_Operator =
  cloudApi.compute.instance.HostAffinityRule_Operator;
const Instance = cloudApi.compute.instance.Instance;
const MaintenancePolicy = cloudApi.compute.maintenance.MaintenancePolicy;
const MetadataOption = cloudApi.compute.instance.MetadataOption;
const NetworkSettings_Type = cloudApi.compute.instance.NetworkSettings_Type;
const SerialPortSettings_SSHAuthorization =
  cloudApi.compute.instance.SerialPortSettings_SSHAuthorization;
const UpdateInstanceRequest =
  cloudApi.compute.instance_service.UpdateInstanceRequest;

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

  const operation = await client.update(
    UpdateInstanceRequest.fromPartial({
      instanceId: "instanceId",
      // updateMask: {
      // paths: ["paths"]
      // },
      // name: "name",
      // description: "description",
      // labels: {"key": "labels"},
      // platformId: "platformId",
      // resourcesSpec: {
      // memory: 0,
      // cores: 0,
      // coreFraction: 0,
      // gpus: 0
      // },
      // metadata: {"key": "metadata"},
      // metadataOptions: {
      // gceHttpEndpoint: MetadataOption.ENABLED,
      // awsV1HttpEndpoint: MetadataOption.ENABLED,
      // gceHttpToken: MetadataOption.ENABLED,
      // awsV1HttpToken: MetadataOption.ENABLED
      // },
      // serviceAccountId: "serviceAccountId",
      // networkSettings: {
      // type: NetworkSettings_Type.STANDARD
      // },
      // placementPolicy: {
      // placementGroupId: "placementGroupId",
      // hostAffinityRules: [{
      // key: "key",
      // op: HostAffinityRule_Operator.IN,
      // values: ["values"]
      // }],
      // placementGroupPartition: 0
      // },
      // schedulingPolicy: {
      // preemptible: true
      // },
      // maintenancePolicy: MaintenancePolicy.RESTART,
      // maintenanceGracePeriod: {
      // seconds: 0,
      // nanos: 0
      // },
      // serialPortSettings: {
      // sshAuthorization: SerialPortSettings_SSHAuthorization.INSTANCE_METADATA
      // }
    })
  );
  const finishedOp = await waitForOperation(operation, session);

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

UpdateInstanceRequest​

instanceId : string​

ID of the Instance resource to update. To get the instance ID, use a InstanceService.List request.

updateMask : google.protobuf.FieldMask​

Field mask that specifies which fields of the Instance resource are going to be updated.

name : string​

Name of the instance.

description : string​

Description of the instance.

labels : string​

Resource labels as key:value pairs.

Existing set of labels is completely replaced by the provided set.

platformId : string​

ID of the hardware platform configuration for the instance. This field affects the available values in resources_spec field.

Platforms allows you to create various types of instances: with a large amount of memory, with a large number of cores, with a burstable performance. For more information, see Platforms.

resourcesSpec : ResourcesSpec​

Computing resources of the instance, such as the amount of memory and number of cores. To get a list of available values, see Levels of core performance.

metadata : string​

The metadata key:value pairs that will be assigned to this instance. This includes custom metadata and predefined keys. The total size of all keys and values must be less than 512 KB.

Existing set of metadata is completely replaced by the provided set.

Values are free-form strings, and only have meaning as interpreted by the programs which configure the instance. The values must be 256 KB or less.

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

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.

schedulingPolicy : SchedulingPolicy​

Scheduling policy configuration.

maintenancePolicy : MaintenancePolicy​

Behaviour on maintenance events

maintenanceGracePeriod : google.protobuf.Duration​

Time between notification via metadata service and maintenance

serialPortSettings : SerialPortSettings​

Serial port settings

ResourcesSpec​

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.

For example, if you need only 5% of the CPU performance, you can set core_fraction=5. For more information, see Levels of core performance.

gpus : int64​

The number of GPUs available to the instance.

MetadataOptions​

gceHttpEndpoint : MetadataOption​

Enabled access to GCE flavored metadata

awsV1HttpEndpoint : MetadataOption​

Enabled access to AWS flavored metadata (IMDSv1)

gceHttpToken : MetadataOption​

Enabled access to IAM credentials with GCE flavored metadata

awsV1HttpToken : MetadataOption​

Enabled access to IAM credentials with AWS flavored metadata (IMDSv1)

NetworkSettings​

Type​
  • TYPE_UNSPECIFIED

  • STANDARD

    Standard network.

  • SOFTWARE_ACCELERATED

    Software accelerated network.

  • HARDWARE_ACCELERATED

    Hardware accelerated network (not available yet, reserved for future use).

type : Type​

Network Type

PlacementPolicy​

HostAffinityRule​

Affinity definition

Operator​
  • OPERATOR_UNSPECIFIED

  • IN

  • NOT_IN

key : string​

Affinity label or one of reserved values - 'yc.hostId', 'yc.hostGroupId'

op : Operator​

Include or exclude action

values : string​

Affinity value or host ID or host group ID

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

SchedulingPolicy​

preemptible : bool​

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

SerialPortSettings​

SSHAuthorization​
  • SSH_AUTHORIZATION_UNSPECIFIED

  • INSTANCE_METADATA

    Authentication and authorization using SSH keys in instance metadata

  • OS_LOGIN

    Authentication and authorization using Oslogin service

sshAuthorization : SSHAuthorization​

Authentication and authorization in serial console when using SSH protocol

HostAffinityRule​

Affinity definition

Operator​
  • OPERATOR_UNSPECIFIED

  • IN

  • NOT_IN

key : string​

Affinity label or one of reserved values - 'yc.hostId', 'yc.hostGroupId'

op : Operator​

Include or exclude action

values : string​

Affinity value or host ID or host group ID

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.