Load Testing API, REST: Test.create
Creates (runs) a test in the specified folder.
HTTP request
POST https://loadtesting.api.cloud.yandex.net/loadtesting/api/v1/tests
Body parameters
{
"folderId": "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"
}
],
"testDetails": {
"name": "string",
"description": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"loggingLogGroupId": "string",
"artifactSettings": {
"isArchive": true,
"filterInclude": [
"string"
],
"filterExclude": [
"string"
],
"objectStorageBucket": "string"
}
}
}
Field | Description |
---|---|
folderId | string Required. ID of the folder to create a test in. The maximum string length in characters is 50. |
configurations[] | object Test configuration associated with agents on which they will be executed. In case of multiple configurations, a multitest will be created. |
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:
|
testDetails | object Test details. Name, tags etc. Test meta information. |
testDetails. name |
string Name of the test. Value must match the regular expression |
testDetails. description |
string Description of the test. The maximum string length in characters is 256. |
testDetails. tags[] |
object Tags assigned to the test. |
testDetails. tags[]. key |
string Key of the tag. |
testDetails. tags[]. value |
string Value of the tag. |
testDetails. loggingLogGroupId |
string ID of the logging group to which test artifacts are uploaded. |
testDetails. 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. |
testDetails. artifactSettings. isArchive |
boolean (boolean) Setting which defines whether artifact files should be archived prior to uploading. |
testDetails. artifactSettings. filterInclude[] |
string Filter strings defining which files should be included to artifacts. GLOB format. Example:
|
testDetails. artifactSettings. filterExclude[] |
string Filter strings defining which files should be excluded from artifacts. GLOB format. Example:
|
testDetails. artifactSettings. objectStorageBucket |
string Name of output object storage bucket in test's folder. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": true,
"metadata": "object",
// includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": "object",
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
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). |
createdBy | string ID of the user or service account who initiated the operation. |
modifiedAt | string (date-time) The time when the Operation resource was last modified. 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). |
done | boolean (boolean) If the value is |
metadata | object Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
error | object The error result of the operation in case of failure or cancellation. includes only one of the fields error , response |
error. code |
integer (int32) Error code. An enum value of google.rpc.Code. |
error. message |
string An error message. |
error. details[] |
object A list of messages that carry the error details. |
response | object includes only one of the fields error , response The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. |