Load Testing API, REST: RegressionDashboard.List

Статья создана

Обновлена 17 октября 2024 г.

HTTP request
Query parameters
Response
Dashboard
Content
Widget
LayoutPosition
ChartWidget
Kpi
KpiSelector
ResponseTime
Instances
ProtocolCodesAbsolute
ProtocolCodesRelative
NetworkCodesAbsolute
NetworkCodesRelative
KpiThreshold
TextWidget
TitleWidget

Retrieves the list of regression dashboards in the specified folder.

HTTP request

GET https://loadtesting.api.cloud.yandex.net/loadtesting/api/v1/regressionDashboards

Query parameters

Field	Description
folderId	string Required field. ID of the folder to list dashboards in.
pageSize	string (int64) The maximum number of results per page to return. If the number of available results is larger than `page_size`, the service returns a ListRegressionDashboardsResponse.nextPageToken that can be used to get the next page of results in subsequent list requests. Default value: 100.
pageToken	string Page token. To get the next page of results, set `page_token` to the ListRegressionDashboardsResponse.nextPageToken returned by a previous list request.
filter	string A filter expression that filters dashboards listed in the response. The filter expression may contain multiple field expressions joined by `AND`. The field expression must specify: The field name. An operator: `=`, `!=`, `CONTAINS`, for single values. `IN` or `NOT IN` for lists of values. The value. String values must be encosed in `"`, boolean values are {`true`, `false`}, timestamp values in ISO-8601. Currently supported fields: `id` yandex.cloud.loadtesting.api.v1.regression.Dashboard.id operators: `=`, `!=`, `IN`, `NOT IN` `name` yandex.cloud.loadtesting.api.v1.regression.Dashboard.name operators: `=`, `!=`, `IN`, `NOT IN`, `CONTAINS` Examples: `id IN ("1", "2", "3")` `name CONTAINS "my-dashboard" AND id NOT IN ("4", "5")`

Response

HTTP Code: 200 - OK

{
  "dashboards": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "createdBy": "string",
      "updatedBy": "string",
      "etag": "string",
      "content": {
        "widgets": [
          {
            "position": {
              "x": "string",
              "y": "string",
              "width": "string",
              "height": "string"
            },
            // Includes only one of the fields `chart`, `text`, `title`
            "chart": {
              "id": "string",
              "name": "string",
              "description": "string",
              "filterStr": "string",
              "testCase": "string",
              "kpis": [
                {
                  "selector": {
                    // Includes only one of the fields `responseTime`, `instances`, `imbalanceRps`, `protocolCodesAbsolute`, `protocolCodesRelative`, `networkCodesAbsolute`, `networkCodesRelative`
                    "responseTime": {
                      "quantile": "string"
                    },
                    "instances": {
                      "agg": "string"
                    },
                    "imbalanceRps": "object",
                    "protocolCodesAbsolute": {
                      "codesPatterns": [
                        "string"
                      ]
                    },
                    "protocolCodesRelative": {
                      "codesPatterns": [
                        "string"
                      ]
                    },
                    "networkCodesAbsolute": {
                      "codesPatterns": [
                        "string"
                      ]
                    },
                    "networkCodesRelative": {
                      "codesPatterns": [
                        "string"
                      ]
                    }
                    // end of the list of possible fields
                  },
                  "threshold": {
                    "value": "string",
                    "comparison": "string"
                  }
                }
              ]
            },
            "text": {
              "text": "string"
            },
            "title": {
              "text": "string",
              "size": "string"
            }
            // end of the list of possible fields
          }
        ]
      }
    }
  ],
  "nextPageToken": "string"
}

Field

Description

dashboards[]

Dashboard

List of dashboards in the specified folder.

nextPageToken

string

Token for getting the next page of the list. If the number of results is greater than
the specified ListRegressionDashboardsRequest.pageSize, use next_page_token as the value
for the ListRegressionDashboardsRequest.pageToken parameter in the next list request.

Each subsequent page will have its own next_page_token to continue paging through the results.

Dashboard

Regression dashboard.

Field	Description
id	string ID of the dashboard.
name	string Name of the dashboard.
description	string Description of the dashboard.
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).
updatedAt	string (date-time) Last update 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 dashboard.
updatedBy	string UA or SA that updated the dashboard last time.
etag	string Etag of the dashboard.
content	Content Dashboard content.

Content

Content of regression dashboard.

Field

Description

widgets[]

Widget

Widgets.

Regression dashboard widget.

Field	Description
position	LayoutPosition Widget position.
chart	ChartWidget Chart widget. Includes only one of the fields `chart`, `text`, `title`.
text	TextWidget Text widget. Includes only one of the fields `chart`, `text`, `title`.
title	TitleWidget Title widget. Includes only one of the fields `chart`, `text`, `title`.

Widget position.

Field	Description
x	string (int64) X.
y	string (int64) Y.
width	string (int64) Width.
height	string (int64) Height.

ChartWidget

Regression chart.

Field	Description
id	string ID of the chart.
name	string Name of the chart.
description	string Description of the chart.
filterStr	string Test filter selector to show KPI values for.
testCase	string Test case to show KPI values for.
kpis[]	Kpi KPIs to show.

Kpi

KPI (Key Performance Indicator) represents some integral indicator measured during test.

Field

Description

selector

KpiSelector

Kind of KPI.

threshold

KpiThreshold

A condition that should be specified.

KpiSelector

KPI selector.

Field	Description
responseTime	ResponseTime Response time cummulative quantile (percentile). Includes only one of the fields `responseTime`, `instances`, `imbalanceRps`, `protocolCodesAbsolute`, `protocolCodesRelative`, `networkCodesAbsolute`, `networkCodesRelative`.
instances	Instances A number of instances throughout the test. Includes only one of the fields `responseTime`, `instances`, `imbalanceRps`, `protocolCodesAbsolute`, `protocolCodesRelative`, `networkCodesAbsolute`, `networkCodesRelative`.
imbalanceRps	object An RPS at the moment the test has been auto-stopped. Includes only one of the fields `responseTime`, `instances`, `imbalanceRps`, `protocolCodesAbsolute`, `protocolCodesRelative`, `networkCodesAbsolute`, `networkCodesRelative`.
protocolCodesAbsolute	ProtocolCodesAbsolute A total number of requests completed with certain protocol (HTTP, GRPC, etc.) codes. Includes only one of the fields `responseTime`, `instances`, `imbalanceRps`, `protocolCodesAbsolute`, `protocolCodesRelative`, `networkCodesAbsolute`, `networkCodesRelative`.
protocolCodesRelative	ProtocolCodesRelative A percentage of requests completed with certain protocol (HTTP, GRPC, etc.) codes. Includes only one of the fields `responseTime`, `instances`, `imbalanceRps`, `protocolCodesAbsolute`, `protocolCodesRelative`, `networkCodesAbsolute`, `networkCodesRelative`.
networkCodesAbsolute	NetworkCodesAbsolute A total number of requests completed with certain network codes. Includes only one of the fields `responseTime`, `instances`, `imbalanceRps`, `protocolCodesAbsolute`, `protocolCodesRelative`, `networkCodesAbsolute`, `networkCodesRelative`.
networkCodesRelative	NetworkCodesRelative A percentage of requests completed with certain network codes. Includes only one of the fields `responseTime`, `instances`, `imbalanceRps`, `protocolCodesAbsolute`, `protocolCodesRelative`, `networkCodesAbsolute`, `networkCodesRelative`.

ResponseTime

Response time.

Field

Description

quantile

enum (QuantileType)

Cummulative quantile (percentile).

QUANTILE_TYPE_UNSPECIFIED: Unspecified percentile.
QUANTILE_TYPE_50: 50 percentile (median).
QUANTILE_TYPE_75: 75 percentile.
QUANTILE_TYPE_80: 80 percentile.
QUANTILE_TYPE_85: 85 percentile.
QUANTILE_TYPE_90: 90 percentile.
QUANTILE_TYPE_95: 95 percentile.
QUANTILE_TYPE_98: 98 percentile.
QUANTILE_TYPE_99: 99 percentile.
QUANTILE_TYPE_100: 100 percentile (maximum or minimum).

Instances

Aggregated number of instances.

Field

Description

agg

enum (Aggregation)

Aggregation function.

AGGREGATION_UNSPECIFIED: Unspecified.
AGGREGATION_MIN: Minimum.
AGGREGATION_MAX: Maximum.
AGGREGATION_AVG: Average.
AGGREGATION_MEDIAN: Median.
AGGREGATION_STD_DEV: Standard deviation.

ProtocolCodesAbsolute

Field

Description

codesPatterns[]

string

Protocol (HTTP, GRPC) code patterns to match.

All successful HTTP responses: ['2xx', '3xx'].
All failed HTTP responses: ['0', '4xx', '5xx'].

ProtocolCodesRelative

Field

Description

codesPatterns[]

string

Protocol (HTTP, GRPC) code patterns to match.

All successful HTTP responses: ['2xx', '3xx'].
All failed HTTP responses: ['0', '4xx', '5xx'].

NetworkCodesAbsolute

Field

Description

codesPatterns[]

string

Network code patterns to match.

All successful network responses: ['0'].
All failed network responses: ['xx', 'xxx'].

NetworkCodesRelative

Field

Description

codesPatterns[]

string

Network code patterns to match.

All successful network responses: ['0'].
All failed network responses: ['xx', 'xxx'].

KpiThreshold

KPI threshold represents a condition that an actual value of test's KPI should satisfy.

Field

Description

value

string

Value for comparison with an actual KPI value.

comparison

enum (Comparison)

Comparison operator for comparing actual with the threshold value.

Rule: actual (</<=/>/>=) reference

COMPARISON_UNSPECIFIED: Unspecified.
COMPARISON_LT: Less than the specified value.
COMPARISON_LTE: Less than or equal to the specified value.
COMPARISON_GT: Greater than the specified value.
COMPARISON_GTE: Greater than or equal to the specified value.

TextWidget

Text widget.

Field

Description

text

string

Text string.

TitleWidget

Title widget.

Field

Description

text

string

Title string.

size

enum (TitleSize)

Title size.

TITLE_SIZE_UNSPECIFIED: Unspecified.
TITLE_SIZE_XS: Extra small.
TITLE_SIZE_S: Small.
TITLE_SIZE_M: Medium.
TITLE_SIZE_L: Large.

Load Testing API, REST: RegressionDashboard.List

HTTP requestHTTP request

Query parametersQuery parameters

ResponseResponse

DashboardDashboard

ContentContent

WidgetWidget

LayoutPositionLayoutPosition

ChartWidgetChartWidget

KpiKpi

KpiSelectorKpiSelector

ResponseTimeResponseTime

InstancesInstances

ProtocolCodesAbsoluteProtocolCodesAbsolute

ProtocolCodesRelativeProtocolCodesRelative

NetworkCodesAbsoluteNetworkCodesAbsolute

NetworkCodesRelativeNetworkCodesRelative

KpiThresholdKpiThreshold

TextWidgetTextWidget

TitleWidgetTitleWidget

Была ли статья полезна?

HTTP request

Query parameters

Response

Dashboard

Content

Widget

LayoutPosition

ChartWidget

Kpi

KpiSelector

ResponseTime

Instances

ProtocolCodesAbsolute

ProtocolCodesRelative

NetworkCodesAbsolute

NetworkCodesRelative

KpiThreshold

TextWidget

TitleWidget