Load Testing API, gRPC: AgentService.Get
Returns the specified agent.
To get the list of all available agents, make a List request.
gRPC request
rpc Get (GetAgentRequest) returns (agent.Agent)
GetAgentRequest
{
"agentId": "string"
}
Field |
Description |
agentId |
string ID of the agent to return. |
agent.Agent
{
"id": "string",
"folderId": "string",
"name": "string",
"description": "string",
"computeInstanceId": "string",
"status": "Status",
"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.
|
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 |
logSettings |
Agent log settings |
LogSettings
Field |
Description |
cloudLogGroupId |
string Id of Yandex Cloud log group to upload agent logs to |