Load Testing API, REST: Agent.list
Retrieves the list of agents in the specified folder.
HTTP request
GET https://loadtesting.api.cloud.yandex.net/loadtesting/api/v1/agent
Query parameters
Parameter | Description |
---|---|
folderId | Required. ID of the folder to list agents in. The maximum string length in characters is 50. |
pageSize | The maximum number of results per page to return. If the number of available results is larger than The maximum value is 1000. |
pageToken | Page token. To get the next page of results, set The maximum string length in characters is 100. |
filter | A filter expression that filters agents listed in the response. The filter expression may contain multiple field expressions joined by
Currently supported fields:
Examples:
The maximum string length in characters is 1000. |
Response
HTTP Code: 200 - OK
{
"agents": [
{
"id": "string",
"folderId": "string",
"name": "string",
"description": "string",
"computeInstanceId": "string",
"status": "string",
"errors": [
"string"
],
"currentJobId": "string",
"agentVersionId": "string",
"labels": "object",
"logSettings": {
"cloudLogGroupId": "string"
}
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
agents[] | object List of agents in the specified folder. |
agents[]. id |
string ID of the agent. Generated at creation time. |
agents[]. folderId |
string ID of the folder that the agent belongs to. |
agents[]. name |
string Name of the agent. |
agents[]. description |
string Description of the agent. |
agents[]. 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). |
agents[]. status |
string Status of the agent. Agent status.
|
agents[]. errors[] |
string List of errors reported by the agent. |
agents[]. currentJobId |
string ID of the test that is currently being executed by the agent. |
agents[]. agentVersionId |
string Version of the agent. |
agents[]. labels |
object Agent labels as |
agents[]. logSettings |
object Agent log settings |
agents[]. logSettings. cloudLogGroupId |
string Id of Yandex Cloud log group to upload agent logs to The maximum string length in characters is 50. |
nextPageToken | string Token for getting the next page of the list. If the number of results is greater than the specified pageSize, use Each subsequent page will have its own The maximum string length in characters is 100. |