Load Test Run - List Test Runs

Служба:: Azure App Testing

Версия API:: 2022-11-01

Получите все тестовые запуски для заданных фильтров.

GET https://{endpoint}/test-runs?api-version=2022-11-01

С использованием необязательных параметров:

GET https://{endpoint}/test-runs?api-version=2022-11-01&orderby={orderby}&search={search}&testId={testId}&executionFrom={executionFrom}&executionTo={executionTo}&status={status}&maxpagesize={maxpagesize}

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (uri)
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.
executionFrom	query		string (date-time)	Start DateTime (формат литерала RFC 3339) диапазона фильтров времени выполнения тестового выполнения.
executionTo	query		string (date-time)	End DateTime (формат литерала RFC 3339) диапазона фильтров времени выполнения тестового выполнения.
maxpagesize	query		integer (int32)	Количество результатов в ответе.
orderby	query		string	Сортируйте поддерживаемые поля в формате (field asc/desc). например: создал DateTime asc. Поддерживаемые поля - createdDateTime, executedDateTime (legacy)
search	query		string	Префикс на основе префикса, поиска с учетом регистра в полях, доступных для поиска, — описание, исполняемыйUser. Например, чтобы выполнить поиск тестового запуска с описанием 500 виртуальных машин, параметр поиска может быть 500.
status	query		string	Разделенный запятыми список состояния тестового выполнения.
testId	query		string	Уникальное имя существующего нагрузочного теста.

Ответы

Имя	Тип	Описание
200 OK	PagedTestRun	Запрос выполнен успешно.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Непредвиденное сообщение об ошибке. Заголовки x-ms-error-code: string

Имя

Тип

Описание

200 OK

PagedTestRun

Запрос выполнен успешно.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Непредвиденное сообщение об ошибке.

Заголовки

x-ms-error-code: string

Безопасность

Oauth2

Поток OAuth 2.0 с идентификатором Microsoft Entra.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Области

Имя	Описание
https://cnt-prod.loadtesting.azure.com/.default

Примеры

List test runs.

Образец запроса

HTTP

GET https://{endpoint}/test-runs?api-version=2022-11-01&orderby=executedDateTime&search=Performance_LoadTest_Run1&testId=12345678-1234-1234-1234-123456789012&executionFrom=2021-12-05T16:43:48.805Z&executionTo=2021-12-05T16:43:48.805Z&status=DONE,EXECUTING&maxpagesize=30

Пример ответа

Код состояния:: 200

{
  "value": [
    {
      "testRunId": "12316678-1234-1234-1234-122451189012",
      "displayName": "Performance_LoadTest_Run1",
      "testId": "12345678-1234-1234-1234-123456789012",
      "description": "sample description",
      "status": "DONE",
      "startDateTime": "2021-12-05T16:43:48.125Z",
      "endDateTime": "2021-12-05T16:43:48.125Z",
      "loadTestConfiguration": {
        "engineInstances": 6,
        "splitAllCSVs": true
      },
      "testResult": "PASSED",
      "passFailCriteria": {
        "passFailMetrics": {
          "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": {
            "clientMetric": "response_time_ms",
            "aggregate": "percentage",
            "condition": ">",
            "value": 10,
            "action": "continue",
            "actualValue": 10,
            "result": "passed"
          }
        }
      },
      "testArtifacts": {
        "inputArtifacts": {
          "configFileInfo": {
            "url": "https://dummyurl.com/configresource",
            "fileName": "config.yaml",
            "fileType": "ADDITIONAL_ARTIFACTS",
            "expireDateTime": "2021-12-05T16:43:46.072Z",
            "validationStatus": "VALIDATION_NOT_REQUIRED"
          },
          "testScriptFileInfo": {
            "url": "https://dummyurl.com/testscriptresource",
            "fileName": "sample.jmx",
            "fileType": "JMX_FILE",
            "expireDateTime": "2021-12-05T16:43:46.072Z",
            "validationStatus": "VALIDATION_SUCCESS"
          },
          "userPropFileInfo": {
            "url": "https://dummyurl.com/userpropresource",
            "fileName": "user.properties",
            "fileType": "USER_PROPERTIES",
            "expireDateTime": "2021-12-05T16:43:46.072Z",
            "validationStatus": "NOT_VALIDATED"
          },
          "inputArtifactsZipFileInfo": {
            "url": "https://dummyurl.com/inputartifactzipresource",
            "fileName": "inputartifacts.zip",
            "fileType": "ADDITIONAL_ARTIFACTS",
            "expireDateTime": "2021-12-05T16:43:46.072Z",
            "validationStatus": "VALIDATION_NOT_REQUIRED"
          },
          "additionalFileInfo": []
        },
        "outputArtifacts": {
          "resultFileInfo": {
            "url": "https://dummyurl.com/dummyresourceresult",
            "fileName": "sample.jmx",
            "fileType": "JMX_FILE",
            "expireDateTime": "2021-12-05T16:43:46.072Z",
            "validationStatus": "VALIDATION_SUCCESS"
          },
          "logsFileInfo": {
            "url": "https://dummyurl.com/logresource",
            "fileName": "worker.log",
            "fileType": "ADDITIONAL_ARTIFACTS",
            "expireDateTime": "2022-05-16T09:14:46.0411793+00:00",
            "validationStatus": "VALIDATION_NOT_REQUIRED"
          }
        }
      },
      "executedDateTime": "2021-12-05T16:43:48.125Z",
      "virtualUsers": 4,
      "testRunStatistics": {
        "Total": {
          "transaction": "Total",
          "sampleCount": 18,
          "errorCount": 19,
          "errorPct": 17,
          "meanResTime": 13,
          "medianResTime": 10,
          "maxResTime": 16,
          "minResTime": 18,
          "pct1ResTime": 27,
          "pct2ResTime": 20,
          "pct3ResTime": 3,
          "throughput": 5,
          "receivedKBytesPerSec": 13,
          "sentKBytesPerSec": 4
        }
      },
      "createdDateTime": "2021-12-05T16:43:46.072Z",
      "createdBy": "user@contoso.com",
      "lastModifiedDateTime": "2021-12-05T16:43:46.072Z",
      "lastModifiedBy": "user@contoso.com",
      "portalUrl": "https://portal.azure.com/dummyresource",
      "secrets": {
        "secret1": {
          "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827",
          "type": "AKV_SECRET_URI"
        }
      },
      "environmentVariables": {
        "envvar1": "sampletext"
      },
      "duration": 18,
      "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0"
    }
  ],
  "nextLink": "https://00000000-0000-0000-aaaa-00aa00aa00aa.westus2.cnt-prod.loadtesting.azure.com/test-runs?orderby=executedDateTime%20desc&continuationToken=some-value&search=&testId=&executionFrom=&executionTo=&status=&maxpagesize=50&api-version=2022-11-01"
}

Определения

Имя	Описание
Azure.Core.Foundations.Error	Объект ошибки.
Azure.Core.Foundations.ErrorResponse	Ответ, содержащий сведения об ошибке.
Azure.Core.Foundations.InnerError	Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по Azure REST API — https://aka.ms/AzureRestApiGuidelines#handling-errors.
CertificateMetadata	Метаданные сертификатов
CertificateType	Поддерживаемые типы сертификатов.
ErrorDetails	Сведения об ошибке при возникновении сбоя при выполнении нагрузочного теста
FileType	Поддерживаемые типы файлов.
FileValidationStatus	Состояние файла.
LoadTestConfiguration	Конфигурации для нагрузочного теста.
OptionalLoadTestConfiguration	Настройка для быстрого нагрузочного теста
PagedTestRun	Коллекция страниц элементов TestRun
PassFailAction	Действия, выполненные после выполнения порогового значения. Значение по умолчанию — "продолжить".
PassFailAggregationFunction	Функции агрегирования для условий передачи или сбоя.
PassFailCriteria	Передайте критерии сбоя для теста.
PassFailMetric	Передача метрики сбоя
PassFailResult	Результат условий передачи или сбоя.
PassFailTestResult	Результат теста на основе условий передачи или сбоя.
PFMetrics	Метрики для условий передачи или сбоя.
Secret	Секрет
SecretType	Поддерживаемые типы секретов.
TestRun	Модель запуска нагрузочного теста
TestRunArtifacts	Коллекция артефактов тестового запуска
TestRunFileInfo	Сведения о тестовом запуске файла.
TestRunInputArtifacts	Входные артефакты для тестового выполнения.
TestRunOutputArtifacts	Выходные артефакты для тестового выполнения.
TestRunStatistics	Статистика тестового запуска.
TestRunStatus	Состояние тестового запуска.

Azure.Core.Foundations.Error

Объект

Объект ошибки.

Имя	Тип	Описание
code	string	Один из определяемых сервером кодов ошибок.
details	Azure.Core.Foundations.Error[]	Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
innererror	Azure.Core.Foundations.InnerError	Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.
message	string	Читаемое пользователем представление ошибки.
target	string	Целевой объект ошибки.

Azure.Core.Foundations.ErrorResponse

Объект

Ответ, содержащий сведения об ошибке.

Имя	Тип	Описание
error	Azure.Core.Foundations.Error	Объект ошибки.

Azure.Core.Foundations.InnerError

Объект

Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по Azure REST API — https://aka.ms/AzureRestApiGuidelines#handling-errors.

Имя	Тип	Описание
code	string	Один из определяемых сервером кодов ошибок.
innererror	Azure.Core.Foundations.InnerError	Внутренняя ошибка.

CertificateMetadata

Объект

Метаданные сертификатов

Имя	Тип	Описание
name	string	Имя сертификата.
type	CertificateType	Тип сертификата
value	string	Значение сертификата для соответствующего типа

CertificateType

Перечисление

Поддерживаемые типы сертификатов.

Значение	Описание
AKV_CERT_URI	Если сертификат хранится в Azure Key Vault.

ErrorDetails

Объект

Сведения об ошибке при возникновении сбоя при выполнении нагрузочного теста

Имя	Тип	Описание
message	string	Сведения об ошибке при тестовом выполнении не удалось выполнить.

FileType

Перечисление

Поддерживаемые типы файлов.

Значение	Описание
JMX_FILE	Если файл является скриптом JMX.
USER_PROPERTIES	Если файл является файлом свойств пользователя.
ADDITIONAL_ARTIFACTS	Если файл не является одним из других поддерживаемых типов файлов.

FileValidationStatus

Перечисление

Состояние файла.

Значение	Описание
NOT_VALIDATED	Файл не проверяется.
VALIDATION_SUCCESS	Проверяется файл.
VALIDATION_FAILURE	Проверка файла завершается ошибкой.
VALIDATION_INITIATED	Выполняется проверка файлов.
VALIDATION_NOT_REQUIRED	Проверка не требуется.

LoadTestConfiguration

Объект

Конфигурации для нагрузочного теста.

Имя	Тип	Default value	Описание
engineInstances	integer (int32)		Количество экземпляров подсистемы для выполнения нагрузочного теста. Поддерживаемые значения находятся в диапазоне от 1 до 400. Требуется для создания нового теста.
optionalLoadTestConfig	OptionalLoadTestConfiguration		Настройка для быстрого нагрузочного теста
quickStartTest	boolean	False	Если задано значение true, необязательный атрибутLoadTestConfig является обязательным, а для нагрузочного теста не требуется выполнить скрипт JMX.
splitAllCSVs	boolean	False	Если значение false, нагрузочное тестирование Azure копирует и обрабатывает входные файлы, не измененные во всех экземплярах тестового модуля. Если значение true, нагрузочное тестирование Azure распределяет входные данные CSV по всем экземплярам ядра. Если вы предоставляете несколько CSV-файлов, каждый файл будет разделен равномерно.

OptionalLoadTestConfiguration

Объект

Настройка для быстрого нагрузочного теста

Имя	Тип	Описание
duration	integer (int32)	Длительность тестового выполнения в секундах.
endpointUrl	string	Тестовый URL-адрес. Укажите полный URL-адрес HTTP. Например, `https://contoso-app.azurewebsites.net/login`
rampUpTime	integer (int32)	Увеличение времени в секундах.
virtualUsers	integer (int32)	Нет одновременных виртуальных пользователей.

PagedTestRun

Объект

Коллекция страниц элементов TestRun

Имя	Тип	Описание
nextLink	string (uri)	Ссылка на следующую страницу элементов
value	TestRun[]	Элементы TestRun на этой странице

PassFailAction

Перечисление

Действия, выполненные после выполнения порогового значения. Значение по умолчанию — "продолжить".

Значение	Описание
continue	Тест будет продолжать выполняться, даже если метрика критериев метрики неудачной передачи не пройдена.
stop	Тестовый запуск остановится, если не передается метрика условий сбоя.

PassFailAggregationFunction

Перечисление

Функции агрегирования для условий передачи или сбоя.

Значение	Описание
count	Критерии применяются для значения счетчика.
percentage	Критерии применяются для заданного процентного значения.
avg	Критерии применяются к значению avg.
p50	Критерии применяются для 50-го процентильного значения.
p90	Критерии применяются для 90-го процентильного значения.
p95	Критерии применяются для 95-го процентильного значения.
p99	Критерии применяются для 99-го процентильного значения.
min	Критерии применяются к минимальному значению.
max	Критерии применяются к максимальному значению.

PassFailCriteria

Объект

Передайте критерии сбоя для теста.

Имя	Тип	Описание
passFailMetrics	<string, PassFailMetric>	Сопоставление идентификаторов и передачи метрик сбоя { id: pass fail metrics }.

PassFailMetric

Объект

Передача метрики сбоя

Имя	Тип	Default value	Описание
action	PassFailAction	continue	Действия, выполненные после выполнения порогового значения. Значение по умолчанию — "продолжить".
actualValue	number (double)		Фактическое значение метрики клиента для тестового выполнения.
aggregate	PassFailAggregationFunction		Функция агрегирования, применяемая к метрикам клиента. Разрешенные функции "процент" — для метрик ошибок , "avg", процентилей, таких как "p50", "p90", & так далее, "min", "max" - для response_time_ms и метрики задержки, "avg" - для requests_per_sec, "count" - для запросов
clientMetric	PFMetrics		Метрика клиента, к которой должны применяться критерии.
condition	string		Оператор сравнения. Поддерживаемые типы ">", "<"
requestName	string		Имя запроса, для которого необходимо применить критерии сбоя Pass
result	PassFailResult		Результат тестового выполнения.
value	number (double)		Значение для сравнения с метрикой клиента. Допустимые значения : "error: [0.0, 100.0] единица - %', response_time_ms и задержка: любая целочисленная единица значения мс.

PassFailResult

Перечисление

Результат условий передачи или сбоя.

Значение	Описание
passed	Метрика условий сбоя пройдена.
undetermined	Не удалось определить метрики условий сбоя при передаче.
failed	Метрика условий сбоя пройдена сбоем.

PassFailTestResult

Перечисление

Результат теста на основе условий передачи или сбоя.

Значение	Описание
PASSED	Критерии передачи и сбоя прошли.
NOT_APPLICABLE	Критерии передачи и сбоя не применимы.
FAILED	Сбой условий передачи или сбоя.

PFMetrics

Перечисление

Метрики для условий передачи или сбоя.

Значение	Описание
response_time_ms	Передайте критерии сбоя для метрик времени отклика в миллисекундах.
latency	Передайте критерии сбоя для метрик задержки в миллисекундах.
error	Передайте критерии сбоя для метрики ошибок.
requests	Передайте критерии сбоя для общих запросов.
requests_per_sec	Передайте критерии сбоя для запроса в секунду.

Secret

Объект

Секрет

Имя	Тип	Описание
type	SecretType	Тип секрета
value	string	Значение секрета для соответствующего типа

SecretType

Перечисление

Поддерживаемые типы секретов.

Значение	Описание
AKV_SECRET_URI	Если секрет хранится в Azure Key Vault.
SECRET_VALUE	Значение секрета, предоставленное как обычный текст.

TestRun

Объект

Модель запуска нагрузочного теста

Имя	Тип	Описание
certificate	CertificateMetadata	Метаданные сертификатов
createdBy	string	Созданный пользователь.
createdDateTime	string (date-time)	Дата и время создания (формат литерала RFC 3339).
description	string maxLength: 100	Описание тестового запуска.
displayName	string minLength: 2 maxLength: 50	Отображаемое имя testRun.
duration	integer (int64)	Длительность тестового выполнения в миллисекундах.
endDateTime	string (date-time)	Тестовый формат dateTime(RFC 3339 литерала).
environmentVariables	object	Переменные среды, определенные как набор пар <имени, значения>.
errorDetails	ErrorDetails[]	Сведения об ошибке при возникновении сбоя при выполнении нагрузочного теста
executedDateTime	string (date-time)	Время, инициированное тестом. Это наследие, новые разработки должны использовать createdDateTime.
lastModifiedBy	string	Пользователь, который последний раз изменился.
lastModifiedDateTime	string (date-time)	Последний измененный формат даты и времени (RFC 3339 литерала).
loadTestConfiguration	LoadTestConfiguration	Конфигурация нагрузочного теста.
passFailCriteria	PassFailCriteria	Передайте критерии сбоя для теста.
portalUrl	string	URL-адрес портала.
secrets	<string, Secret>	Секреты можно хранить в Azure Key Vault или любом другом хранилище секретов. Если секрет хранится в Azure Key Vault, значение должно быть идентификатором секрета, а тип должен быть AKV_SECRET_URI. Если секрет хранится в другом месте, значение секрета должно быть предоставлено напрямую, а тип должен быть SECRET_VALUE.
startDateTime	string (date-time)	Тестовый формат запуска dateTime(RFC 3339 литерал).
status	TestRunStatus	Состояние тестового запуска.
subnetId	string	Идентификатор подсети, на котором должны выполняться экземпляры нагрузочного теста.
testArtifacts	TestRunArtifacts	Коллекция артефактов тестового запуска
testId	string minLength: 2 maxLength: 50	Связанный идентификатор теста.
testResult	PassFailTestResult	Результат теста для условий прохождения или сбоя, используемых во время тестового выполнения.
testRunId	string minLength: 2 maxLength: 50 pattern: ^[a-z0-9_-]*$	Уникальный идентификатор тестового запуска для выполнения нагрузочного теста должен содержать только буквы нижнего регистра, числовые, символы подчеркивания или дефиса.
testRunStatistics	<string, TestRunStatistics>	Статистика тестового запуска. Ключом является имя и значение примера является набор статистики для метрик производительности, таких как время отклика, пропускная способность и т. д. из запуска нагрузочного теста. Имя образца совпадает с именем, упомянутым в тестовом скрипте. Имя sampler "Total" представляет агрегированную статистику всех примеров.
virtualUsers	integer (int32)	Количество виртуальных пользователей, для которых был запущен тест.

TestRunArtifacts

Объект

Коллекция артефактов тестового запуска

Имя	Тип	Описание
inputArtifacts	TestRunInputArtifacts	Входные артефакты для тестового выполнения.
outputArtifacts	TestRunOutputArtifacts	Выходные артефакты для тестового выполнения.

TestRunFileInfo

Объект

Сведения о тестовом запуске файла.

Имя	Тип	Описание
expireDateTime	string (date-time)	Срок действия файла (формат литерала RFC 3339)
fileName	string	Имя файла.
fileType	FileType	Тип файла
url	string (uri)	URL-адрес файла.
validationFailureDetails	string	Сведения об ошибке проверки
validationStatus	FileValidationStatus	Состояние проверки файла

TestRunInputArtifacts

Объект

Входные артефакты для тестового выполнения.

Имя	Тип	Описание
additionalFileInfo	TestRunFileInfo[]	Дополнительные поддерживаемые файлы для тестового запуска
configFileInfo	TestRunFileInfo	Нагрузочный файл YAML, содержащий конфигурацию теста
inputArtifactsZipFileInfo	TestRunFileInfo	ZIP-файл для всех входных артефактов
testScriptFileInfo	TestRunFileInfo	Файл тестового скрипта для тестового запуска
userPropFileInfo	TestRunFileInfo	Файл свойств пользователя

TestRunOutputArtifacts

Объект

Выходные артефакты для тестового выполнения.

Имя	Тип	Описание
logsFileInfo	TestRunFileInfo	Тестовый отчет о выполнении с метриками
resultFileInfo	TestRunFileInfo	Файл результатов тестового выполнения

TestRunStatistics

Объект

Статистика тестового запуска.

Имя	Тип	Описание
errorCount	number (double)	Число ошибок.
errorPct	number (double)	Процент ошибок.
maxResTime	number (double)	Максимальное время отклика.
meanResTime	number (double)	Среднее время отклика.
medianResTime	number (double)	Время отклика медиана.
minResTime	number (double)	Минимальное время отклика.
pct1ResTime	number (double)	Время отклика на 90 процентилей.
pct2ResTime	number (double)	Время отклика на 95 процентов.
pct3ResTime	number (double)	Время отклика на 99 процентилей.
receivedKBytesPerSec	number (double)	Полученные сетевые байты.
sampleCount	number (double)	Число примеров.
sentKBytesPerSec	number (double)	Отправка сетевых байтов.
throughput	number (double)	Производительность.
transaction	string	Имя транзакции.

TestRunStatus

Перечисление

Состояние тестового запуска.

Значение	Описание
ACCEPTED	Тестовый запрос запуска принимается.
NOTSTARTED	Тестовый запуск еще не запущен.
PROVISIONING	Тестовый запуск — подготовка.
PROVISIONED	Тестовый запуск подготовлен.
CONFIGURING	Тестовый запуск настраивается.
CONFIGURED	Настройка тестового запуска выполняется.
EXECUTING	Тестовый запуск начал выполняться.
EXECUTED	Выполнение тестового запуска завершено.
DEPROVISIONING	Тестовый запуск становится устаревшим.
DEPROVISIONED	Тестовое выполнение отключено.
DONE	Тестовое выполнение завершено.
CANCELLING	Тестовое выполнение отменено.
CANCELLED	Запрос тестового запуска отменен.
FAILED	Сбой тестового запроса запуска.
VALIDATION_SUCCESS	Тестовый запуск JMX-файла проверяется.
VALIDATION_FAILURE	Проверка тестового запуска JMX-файла завершается ошибкой.