Load Testing API, REST: Agent.Get
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": "object",
"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.
|
|
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 (map<string, string>) Agent labels as |
|
logSettings |
Agent log settings |
LogSettings
|
Field |
Description |
|
cloudLogGroupId |
string Id of Yandex Cloud log group to upload agent logs to |