List

Retrieves the list of regression dashboards in the specified folder.

TypeScript

import { cloudApi, serviceClients, Session } from "@yandex-cloud/nodejs-sdk";

const ListRegressionDashboardsRequest =
  cloudApi.loadtesting.api_regression_dashboard_service
    .ListRegressionDashboardsRequest;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(
    serviceClients.RegressionDashboardServiceClient
  );

  const result = await client.list(
    ListRegressionDashboardsRequest.fromPartial({
      folderId: "folderId",
      // pageSize: 0,
      // pageToken: "pageToken",
      // filter: "filter"
    })
  );
  console.log(result);
})();

Python

import os
import grpc
import yandexcloud

from yandex.cloud.loadtesting.api.v1.regression_dashboard_service_pb2 import (
    ListRegressionDashboardsRequest,
)
from yandex.cloud.loadtesting.api.v1.regression_dashboard_service_pb2_grpc import (
    RegressionDashboardServiceStub,
)

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(RegressionDashboardServiceStub)
response = service.List(
    ListRegressionDashboardsRequest(
        folder_id="folderId",
        # page_size = 0,
        # page_token = "pageToken",
        # filter = "filter"
    )
)
print(response)

ListRegressionDashboardsRequest

folderId : string

ID of the folder to list dashboards in.

pageSize : 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.next_page_token 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.next_page_token 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:

1. The field name.
2. An operator:

• =, !=, CONTAINS, for single values.
• IN or NOT IN for lists of values.

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

ListRegressionDashboardsResponse

dashboards : regression.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.page_size, use next_page_token as the value for the ListRegressionDashboardsRequest.page_token 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.

Content

Content of regression dashboard.

widgets : Widget

Widgets.

id : string

ID of the dashboard.

name : string

Name of the dashboard.

description : string

Description of the dashboard.

createdAt : google.protobuf.Timestamp

Creation timestamp.

updatedAt : google.protobuf.Timestamp

Last update timestamp.

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.

Widget

Regression dashboard widget.

LayoutPosition

Widget position.

x : int64

X.

y : int64

Y.

width : int64

Width.

height : int64

Height.

position : LayoutPosition

Widget position.

One of widget

• chart : ChartWidget

  Chart widget.

• text : TextWidget

  Text widget.

• title : TitleWidget

  Title widget.

Content

Content of regression dashboard.

widgets : Widget

Widgets.

LayoutPosition

Widget position.

x : int64

X.

y : int64

Y.

width : int64

Width.

height : int64

Height.

ChartWidget

Regression chart.

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 : report.Kpi

KPIs to show.

TextWidget

Text widget.

text : string

Text string.

TitleWidget

Title widget.

TitleSize

Title size.

• TITLE_SIZE_UNSPECIFIED

  Unspecified.

• TITLE_SIZE_XS

  Extra small.

• TITLE_SIZE_S

  Small.

• TITLE_SIZE_M

  Medium.

• TITLE_SIZE_L

  Large.

text : string

Title string.

size : TitleSize

Title size.

Kpi

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

selector : KpiSelector

Kind of KPI.

threshold : KpiThreshold

A condition that should be specified.

KpiSelector

KPI selector.

ResponseTime

Response time.

quantile : common.QuantileType

Cummulative quantile (percentile).

Instances

Aggregated number of instances.

agg : Aggregation

Aggregation function.

ImbalanceRps

Imbalance RPS.

ProtocolCodesAbsolute

codesPatterns : string

Protocol (HTTP, GRPC) code patterns to match.

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

ProtocolCodesRelative

codesPatterns : string

Protocol (HTTP, GRPC) code patterns to match.

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

NetworkCodesAbsolute

codesPatterns : string

Network code patterns to match.

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

NetworkCodesRelative

codesPatterns : string

Network code patterns to match.

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

One of kind

• responseTime : ResponseTime

  Response time cummulative quantile (percentile).

• instances : Instances

  A number of instances throughout the test.

• imbalanceRps : ImbalanceRps

  An RPS at the moment the test has been auto-stopped.

• protocolCodesAbsolute : ProtocolCodesAbsolute

  A total number of requests completed with certain protocol (HTTP, GRPC, etc.) codes.

• protocolCodesRelative : ProtocolCodesRelative

  A percentage of requests completed with certain protocol (HTTP, GRPC, etc.) codes.

• networkCodesAbsolute : NetworkCodesAbsolute

  A total number of requests completed with certain network codes.

• networkCodesRelative : NetworkCodesRelative

  A percentage of requests completed with certain network codes.

KpiThreshold

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

value : double

Value for comparison with an actual KPI value.

comparison : Comparison

Comparison operator for comparing actual with the threshold value.

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

ResponseTime

Response time.

quantile : common.QuantileType

Cummulative quantile (percentile).

Instances

Aggregated number of instances.

agg : Aggregation

Aggregation function.

ImbalanceRps

Imbalance RPS.

ProtocolCodesAbsolute

codesPatterns : string

Protocol (HTTP, GRPC) code patterns to match.

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

ProtocolCodesRelative

codesPatterns : string

Protocol (HTTP, GRPC) code patterns to match.

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

NetworkCodesAbsolute

codesPatterns : string

Network code patterns to match.

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

NetworkCodesRelative

codesPatterns : string

Network code patterns to match.

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

---

[8]: #protocolcodesrelative'0', '4xx', '5xx'

[10]: #protocolcodesrelative'0', '4xx', '5xx'

[16]: #protocolcodesrelative'0', '4xx', '5xx'

[18]: #protocolcodesrelative'0', '4xx', '5xx'