Skip to main content

types

Agent​

Load testing agent on which tests are executed.

id : string​

ID of the agent. Generated at creation time.

folderId : string​

ID of the folder that the agent belongs to.

name : string​

Name of the agent.

description : string​

Description of the agent.

computeInstanceId : string​

ID of the compute instance managed by the agent.

Empty if there is no such instance (i.e. the case of external agent).

status : Status​

Status of the agent.

errors : string​

List of errors reported by the agent.

currentJobId : string​

ID of the test that is currently being executed by the agent.

agentVersionId : string​

Version of the agent.

labels : string​

Agent labels as key:value pairs.

logSettings : agent.LogSettings​

Agent log settings

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"

LogSettings​

cloudLogGroupId : string​

Id of Yandex Cloud log group to upload agent logs to