Update

Updates the specified agent.

TypeScript

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

const AttachedDiskSpec_Mode =
  cloudApi.compute.instance_service.AttachedDiskSpec_Mode;
const IpVersion = cloudApi.compute.instance.IpVersion;
const UpdateAgentRequest =
  cloudApi.loadtesting.api_agent_service.UpdateAgentRequest;

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

  const operation = await client.update(
    UpdateAgentRequest.fromPartial({
      agentId: "agentId",
      updateMask: {
        // paths: ["paths"]
      },
      // name: "name",
      // description: "description",
      // computeInstanceParams: {
      // labels: {"key": "labels"},
      // zoneId: "zoneId",
      // resourcesSpec: {
      // memory: 0,
      // cores: 0,
      // coreFraction: 0,
      // gpus: 0
      // },
      // metadata: {"key": "metadata"},
      // bootDiskSpec: {
      // mode: AttachedDiskSpec_Mode.READ_ONLY,
      // deviceName: "deviceName",
      // autoDelete: true,
      // diskSpec: {
      // name: "name",
      // description: "description",
      // typeId: "typeId",
      // size: 0,
      // imageId: "imageId",
      // snapshotId: "snapshotId",
      // diskPlacementPolicy: {
      // placementGroupId: "placementGroupId",
      // placementGroupPartition: 0
      // },
      // blockSize: 0,
      // kmsKeyId: "kmsKeyId"
      // },
      // diskId: "diskId"
      // },
      // networkInterfaceSpecs: [{
      // 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"],
      // index: "index"
      // }],
      // serviceAccountId: "serviceAccountId",
      // platformId: "platformId"
      // },
      // labels: {"key": "labels"}
    })
  );
  await waitForOperation(operation, session);
})();

Python

import os
import grpc
import yandexcloud

from yandex.cloud.loadtesting.agent.v1.agent_service_pb2_grpc import AgentServiceStub
from yandex.cloud.compute.v1.instance_service_pb2 import AttachedDiskSpec
from yandex.cloud.loadtesting.api.v1.agent.create_compute_instance_pb2 import CreateComputeInstance
from yandex.cloud.compute.v1.disk_pb2 import DiskPlacementPolicy
from yandex.cloud.compute.v1.instance_service_pb2 import DnsRecordSpec
from yandex.cloud.compute.v1.instance_pb2 import IpVersion
from yandex.cloud.compute.v1.instance_service_pb2 import NetworkInterfaceSpec
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 ResourcesSpec
from yandex.cloud.loadtesting.api.v1.agent_service_pb2 import UpdateAgentRequest

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(AgentServiceStub)
operation = service.Update()
operation_result = sdk.wait_operation_and_get_result(
    operation,
    meta_type=UpdateAgentMetadata,
)

UpdateAgentRequest

agentId : string

ID of the agent to update.

updateMask : google.protobuf.FieldMask

Field mask that specifies which attributes of the agent are going to be updated.

name : string

New name of the agent.

description : string

New description of the agent.

computeInstanceParams : agent.CreateComputeInstance

New parameters of compute instance managed by the agent.

labels : string

New labels of the agent.

CreateComputeInstance

labels : string

Resource labels as key:value pairs.

zoneId : string

ID of the availability zone where the instance resides. To get a list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request

resourcesSpec : compute.v1.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.

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.

bootDiskSpec : compute.v1.AttachedDiskSpec

Boot disk to attach to the instance.

networkInterfaceSpecs : compute.v1.NetworkInterfaceSpec

Network configuration for the instance. Specifies how the network interface is configured to interact with other services on the internal network and on the internet. Currently only one network interface is supported per instance.

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.

platformId : string

ID of the Compute VM platform on which the agent will be created. Default value: "standard-v2"

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.

AttachedDiskSpec

Mode

• MODE_UNSPECIFIED

• READ_ONLY

  Read-only access.

• READ_WRITE

  Read/Write access. Default value.

DiskSpec

name : string

Name of the disk.

description : string

Description of the disk.

typeId : string

ID of the disk type. To get a list of available disk types, use the yandex.cloud.compute.v1.DiskTypeService.List request.

size : int64

Size of the disk, specified in bytes.

One of source

• imageId : string

  ID of the image to create the disk from.

• snapshotId : string

  ID of the snapshot to restore the disk from.

diskPlacementPolicy : DiskPlacementPolicy

Placement policy configuration.

blockSize : int64

Block size of the disk, specified in bytes. The default is 4096.

kmsKeyId : string

ID of KMS key for disk encryption

mode : Mode

The mode in which to attach this disk.

deviceName : string

Specifies a unique serial number of your choice 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. If not specified, a random value will be generated.

autoDelete : bool

Specifies whether the disk will be auto-deleted when the instance is deleted.

One of disk

• diskSpec : DiskSpec

  Disk specification.

• diskId : string

  ID of the disk that should be attached.

NetworkInterfaceSpec

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

index : string

The index of the network interface, will be generated by the server, 0,1,2... etc if not specified.

DiskPlacementPolicy

placementGroupId : string

Placement group ID.

placementGroupPartition : int64

DiskSpec

name : string

Name of the disk.

description : string

Description of the disk.

typeId : string

ID of the disk type. To get a list of available disk types, use the yandex.cloud.compute.v1.DiskTypeService.List request.

size : int64

Size of the disk, specified in bytes.

• imageId : string

  ID of the image to create the disk from.

• snapshotId : string

  ID of the snapshot to restore the disk from.

diskPlacementPolicy : DiskPlacementPolicy

Placement policy configuration.

blockSize : int64

Block size of the disk, specified in bytes. The default is 4096.

kmsKeyId : string

ID of KMS key for disk encryption

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.

---