Load Testing API, REST: Agent methods
Written by
Updated at September 17, 2024
A set of methods for managing Load Testing agents.
JSON Representation
{
"id": "string",
"folderId": "string",
"name": "string",
"description": "string",
"computeInstanceId": "string",
"status": "string",
"errors": [
"string"
],
"currentJobId": "string",
"agentVersionId": "string",
"labels": "object",
"logSettings": {
"cloudLogGroupId": "string"
}
}
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 | string Status of the agent. Agent status.
|
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 | object Agent labels as |
logSettings | object Agent log settings |
logSettings. cloudLogGroupId |
string Id of Yandex Cloud log group to upload agent logs to The maximum string length in characters is 50. |
Methods
Method | Description |
---|---|
create | Creates an agent in the specified folder. |
delete | Deletes the specified agent. |
get | Returns the specified agent. |
list | Retrieves the list of agents in the specified folder. |
update | Updates the specified agent. |