Load Testing API, gRPC: AgentService.List
Retrieves the list of agents in the specified folder.
gRPC request
rpc List (ListAgentsRequest) returns (ListAgentsResponse)
ListAgentsRequest
{
"folderId": "string",
"pageSize": "int64",
"pageToken": "string",
"filter": "string"
}
Field |
Description |
folderId |
string Required field. ID of the folder to list agents in. |
pageSize |
int64 The maximum number of results per page to return. If the number of available |
pageToken |
string Page token. To get the next page of results, set |
filter |
string A filter expression that filters agents listed in the response. The filter expression may contain multiple field expressions joined by
Currently supported fields:
Examples:
|
ListAgentsResponse
{
"agents": [
{
"id": "string",
"folderId": "string",
"name": "string",
"description": "string",
"computeInstanceId": "string",
"status": "Status",
"errors": [
"string"
],
"currentJobId": "string",
"agentVersionId": "string",
"labels": "string",
"logSettings": {
"cloudLogGroupId": "string"
}
}
],
"nextPageToken": "string"
}
Field |
Description |
agents[] |
List of agents in the specified folder. |
nextPageToken |
string Token for getting the next page of the list. If the number of results is greater than Each subsequent page will have its own |
Agent
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 |