Load Testing API, REST: Test methods
A set of methods for managing tests.
JSON Representation
{
"id": "string",
"configurations": [
{
"configId": "string",
"agentSelector": {
// `configurations[].agentSelector` includes only one of the fields `agentId`, `matchByFilter`, `anonymousAgent`
"agentId": "string",
"matchByFilter": "string",
"anonymousAgent": true,
// end of the list of possible fields`configurations[].agentSelector`
},
"files": "object"
}
],
"details": {
"name": "string",
"description": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"loggingLogGroupId": "string",
"artifactSettings": {
"isArchive": true,
"filterInclude": [
"string"
],
"filterExclude": [
"string"
],
"objectStorageBucket": "string"
}
},
"summary": {
"status": "string",
"createdAt": "string",
"createdBy": "string",
"startedAt": "string",
"finishedAt": "string",
"isFinished": true,
"error": "string",
"imbalancePoint": {
"at": "string",
"rps": "string",
"comment": "string"
},
"assignedAgentId": "string",
"artifacts": {
"objectStorage": {
"bucket": "string",
"name": "string"
}
}
},
"folderId": "string"
}
Field | Description |
---|---|
id | string ID of the test. Generated at creation time. |
configurations[] | object Configuration of the test. A test can have multiple configurations if it can be executed on multiple agents simultaneously. For more information, see Load testing using multiple agents. |
configurations[]. configId |
string ID of the config. |
configurations[]. agentSelector |
object Agent selection criterion. Agent selection criterion. The structure is used by service to determine on which agents a specific test should be executed. |
configurations[]. agentSelector. agentId |
string configurations[].agentSelector includes only one of the fields agentId , matchByFilter , anonymousAgent Selection by agent ID. |
configurations[]. agentSelector. matchByFilter |
string configurations[].agentSelector includes only one of the fields agentId , matchByFilter , anonymousAgent Selection by filter string. |
configurations[]. agentSelector. anonymousAgent |
boolean (boolean) configurations[].agentSelector includes only one of the fields agentId , matchByFilter , anonymousAgent Select anonymoud (i.e. not registered) agents. |
configurations[]. files |
object Additional files to be used during test execution, represented as
Use cases include:
|
details | object Test meta information. Name, description, etc. Test meta information. |
details. name |
string Name of the test. Value must match the regular expression |
details. description |
string Description of the test. The maximum string length in characters is 256. |
details. tags[] |
object Tags assigned to the test. |
details. tags[]. key |
string Key of the tag. |
details. tags[]. value |
string Value of the tag. |
details. loggingLogGroupId |
string ID of the logging group to which test artifacts are uploaded. |
details. artifactSettings |
object Settings which define where to upload test artifacts and which files should be included. Artifact upload settings. Defines where to upload test artifacts and which files should be included. |
details. artifactSettings. isArchive |
boolean (boolean) Setting which defines whether artifact files should be archived prior to uploading. |
details. artifactSettings. filterInclude[] |
string Filter strings defining which files should be included to artifacts. GLOB format. Example:
|
details. artifactSettings. filterExclude[] |
string Filter strings defining which files should be excluded from artifacts. GLOB format. Example:
|
details. artifactSettings. objectStorageBucket |
string Name of output object storage bucket in test's folder. |
summary | object Test execution information. Process of test and some results |
summary. status |
string Status of the test.
|
summary. createdAt |
string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
summary. createdBy |
string UA or SA that created the test. |
summary. startedAt |
string (date-time) Test start timestamp. Empty if the test has not been started yet. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
summary. finishedAt |
string (date-time) Test finish timestamp. Empty if the test has not been finished yet. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
summary. isFinished |
boolean (boolean) Indicates whether the test is finished. |
summary. error |
string Error message. |
summary. imbalancePoint |
object Detected imbalance point. Contains information about a state at the moment it has been auto-stopped. Empty if no auto-stop occured. Test imbalance point. |
summary. imbalancePoint. at |
string (date-time) Imbalance moment timestamp. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
summary. imbalancePoint. rps |
string (int64) Imbalance moment RPS. |
summary. imbalancePoint. comment |
string Imbalance reason comment. |
summary. assignedAgentId |
string ID of the agent that executed the test. |
summary. artifacts |
object Test output artifacts. Link to the artifacts output target containing Variant-like structure for referencing files in different sources. |
summary. artifacts. objectStorage |
object Reference to a file in Object Storage. |
summary. artifacts. objectStorage. bucket |
string Bucket name. |
summary. artifacts. objectStorage. name |
string File name. |
folderId | string ID of the folder that the test belongs to. |
Methods
Method | Description |
---|---|
create | Creates (runs) a test in the specified folder. |
delete | Deletes specified tests. |
get | Returns the specified test. |
list | Retrieves the list of test in the specified folder. |
stop | Stops the specified test. |