Contact UsGet started
© 2024 Direct Cursus Technology L.L.C.

Load Testing API, REST: Test.Get

Written by
Updated at December 17, 2024

Returns the specified test.

To get the list of all available tests, make a List request.

HTTP request

GET https://loadtesting.api.cloud.yandex.net/loadtesting/api/v1/tests/{testId}

Path parameters

Field

Description

testId

string

Required field. ID of the test to return.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "configurations": [
    {
      "configId": "string",
      "agentSelector": {
        // Includes only one of the fields `agentId`, `matchByFilter`, `anonymousAgent`
        "agentId": "string",
        "matchByFilter": "string",
        "anonymousAgent": "boolean"
        // end of the list of possible fields
      },
      "files": "object"
    }
  ],
  "details": {
    "name": "string",
    "description": "string",
    "tags": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "loggingLogGroupId": "string",
    "artifactSettings": {
      // Includes only one of the fields `objectStorageBucket`
      "objectStorageBucket": "string",
      // end of the list of possible fields
      "isArchive": "boolean",
      "filterInclude": [
        "string"
      ],
      "filterExclude": [
        "string"
      ]
    }
  },
  "summary": {
    "status": "string",
    "createdAt": "string",
    "createdBy": "string",
    "startedAt": "string",
    "finishedAt": "string",
    "isFinished": "boolean",
    "error": "string",
    "imbalancePoint": {
      "at": "string",
      "rps": "string",
      "comment": "string"
    },
    "assignedAgentId": "string",
    "artifacts": {
      // Includes only one of the fields `objectStorage`
      "objectStorage": {
        "bucket": "string",
        "name": "string"
      }
      // end of the list of possible fields
    }
  },
  "folderId": "string"
}

Load Test.

In context of the service, Test represents a single testing task/job.

Field

Description

id

string

ID of the test. Generated at creation time.

configurations[]

SingleAgentConfiguration

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.

details

Details

Test meta information. Name, description, etc.

summary

Summary

Test execution information.

folderId

string

ID of the folder that the test belongs to.

SingleAgentConfiguration

Configuration of a test.

Field

Description

configId

string

ID of the config.

agentSelector

AgentSelector

Agent selection criterion.

files

object (map<string, FilePointer>)

Additional files to be used during test execution, represented as rel_path:file pairs.

rel_path can be either a simple file name, a relative path, or absolute path. Files are
downloaded by the agent to appropriate location.

Use cases include:

  • Test Data files.
  • Custom Pandora executable.
  • JMeter executable or ".jmx" scenario.
  • etc.

AgentSelector

Agent selection criterion.

The structure is used by service to determine on which agents a specific test should be executed.

Field

Description

agentId

string

Selection by agent ID.

Includes only one of the fields agentId, matchByFilter, anonymousAgent.

matchByFilter

string

Selection by filter string.

Includes only one of the fields agentId, matchByFilter, anonymousAgent.

anonymousAgent

boolean

Select anonymoud (i.e. not registered) agents.

Includes only one of the fields agentId, matchByFilter, anonymousAgent.

FilePointer

Variant-like structure for referencing files in different sources.

Field

Description

objectStorage

ObjectStorage

Reference to a file in Object Storage.

Includes only one of the fields objectStorage.

ObjectStorage

Reference to a file stored in Object Storage.

Field

Description

bucket

string

Bucket name.

name

string

File name.

Details

Test meta information.

Field

Description

name

string

Name of the test.

description

string

Description of the test.

tags[]

Tag

Tags assigned to the test.

loggingLogGroupId

string

ID of the logging group to which test artifacts are uploaded.

artifactSettings

ArtifactSettings

Settings which define where to upload test artifacts and which files should be included.

Tag

Tag attached to some entity.

Field

Description

key

string

Key of the tag.

value

string

Value of the tag.

ArtifactSettings

Artifact upload settings.

Defines where to upload test artifacts and which files should be included.

Field

Description

objectStorageBucket

string

Name of output object storage bucket in test's folder.

Includes only one of the fields objectStorageBucket.

isArchive

boolean

Setting which defines whether artifact files should be archived prior to uploading.

filterInclude[]

string

Filter strings defining which files should be included to artifacts. GLOB format.

Example:

  • ['*'] - all files will be uploaded.
  • ['.log', '.yaml] - all .log and .yaml files will be uploaded.

filterExclude[]

string

Filter strings defining which files should be excluded from artifacts. GLOB format.

Example:

  • filter_include=['*'], filter_exclude=['phout.log'] - upload all .log files excluding phout.log.

Summary

Process of test and some results

Field

Description

status

enum (Status)

Status of the test.

  • STATUS_UNSPECIFIED: Status is unspecified.

  • CREATED: Test has been created, but not started by any agent.

  • INITIATED: Execution stage: initialization.

  • PREPARING: Execution stage: data preparation and warm-up.

  • RUNNING: Execution stage: load generation.

  • FINISHING: Execution stage: termination.

  • DONE: Test is done.

  • POST_PROCESSING: Execution stage: results post-processing.

  • FAILED: Test has failed due to some error.

  • STOPPING: Test is being stopped.

  • STOPPED: Test has been stopped.

  • AUTOSTOPPED: Test has been stopped automatically by satisfying autostop condition.

  • WAITING: Execution stage: waiting for a trigger to start.

  • DELETING: Test is being deleted.

  • LOST: Test status has not been reported in a while during execution stage.

    Means that either an agent is too busy to send it, got offline, or failed without
    reporting a final status.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

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

UA or SA that created the test.

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
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

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).

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
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

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).

isFinished

boolean

Indicates whether the test is finished.

error

string

Error message.

imbalancePoint

ImbalancePoint

Detected imbalance point.

Contains information about a state at the moment it has been
auto-stopped.

Empty if no auto-stop occured.

assignedAgentId

string

ID of the agent that executed the test.

artifacts

FilePointer

Test output artifacts.

Link to the artifacts output target containing .log and other files collected
during test execution.

ImbalancePoint

Test imbalance point.

Field

Description

at

string (date-time)

Imbalance moment timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

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).

rps

string (int64)

Imbalance moment RPS.

comment

string

Imbalance reason comment.
Previous
Create
Next
Stop