Contact UsGet started

Load Testing API, REST: Agent.Get

Written by
Updated at October 17, 2024

Returns the specified agent.

To get the list of all available agents, make a List request.

HTTP request

GET https://loadtesting.api.cloud.yandex.net/loadtesting/api/v1/agent/{agentId}

Path parameters

Field

Description

agentId

string

Required field. ID of the agent to return.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "folderId": "string",
  "name": "string",
  "description": "string",
  "computeInstanceId": "string",
  "status": "string",
  "errors": [
    "string"
  ],
  "currentJobId": "string",
  "agentVersionId": "string",
  "labels": "string",
  "logSettings": {
    "cloudLogGroupId": "string"
  }
}

Load testing agent on which tests are executed.

Field

Description

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

enum (Status)

Status of the agent.

  • STATUS_UNSPECIFIED: Status is not specified.
  • PREPARING_TEST: Agent is preparing a test to be executed.
  • READY_FOR_TEST: Agent is ready to take a test.
  • TESTING: Agent is executing a test.
  • TANK_FAILED: Agent application encountered an error and cannot operate normally.
  • PROVISIONING: Agent is waiting for resources to be allocated.
  • STOPPING: Agent is being stopped.
  • STOPPED: Agent is stopped.
  • STARTING: Agent is being started.
  • RESTARTING: Agent is being restarted.
  • UPDATING: Agent is being updated.
  • ERROR: Agent encountered an error and cannot operate.
  • CRASHED: Agent is crashed and will be restarted automatically.
  • DELETING: Agent is being deleted.
  • INITIALIZING_CONNECTION: Service is waiting for connection with agent to be established.
  • LOST_CONNECTION_WITH_AGENT: Service has lost connection with agent.
  • UPLOADING_ARTIFACTS: Agent is uploading test artifacts.

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

LogSettings

Agent log settings

LogSettings

Field

Description

cloudLogGroupId

string

Id of Yandex Cloud log group to upload agent logs to
Previous
Create
Next
List