Load Testing API, REST: RegressionDashboard.create
Creates a regression dashboard in the specified folder.
HTTP request
POST https://loadtesting.api.cloud.yandex.net/loadtesting/api/v1/regressionDashboards
Body parameters
{
"folderId": "string",
"name": "string",
"description": "string",
"content": {
"widgets": [
{
"position": {
"x": "string",
"y": "string",
"width": "string",
"height": "string"
},
// `content.widgets[]` includes only one of the fields `chart`, `text`, `title`
"chart": {
"id": "string",
"name": "string",
"description": "string",
"filterStr": "string",
"testCase": "string",
"kpis": [
{
"selector": {
// `content.widgets[].chart.kpis[].selector` includes only one of the fields `responseTime`, `instances`, `imbalanceRps`, `protocolCodesAbsolute`, `protocolCodesRelative`, `networkCodesAbsolute`, `networkCodesRelative`
"responseTime": {
"quantile": "string"
},
"instances": {
"agg": "string"
},
"imbalanceRps": {},
"protocolCodesAbsolute": {
"codesPatterns": [
"string"
]
},
"protocolCodesRelative": {
"codesPatterns": [
"string"
]
},
"networkCodesAbsolute": {
"codesPatterns": [
"string"
]
},
"networkCodesRelative": {
"codesPatterns": [
"string"
]
},
// end of the list of possible fields`content.widgets[].chart.kpis[].selector`
},
"threshold": {
"value": "number",
"comparison": "string"
}
}
]
},
"text": {
"text": "string"
},
"title": {
"text": "string",
"size": "string"
},
// end of the list of possible fields`content.widgets[]`
}
]
}
}
Field | Description |
---|---|
folderId | string Required. ID of the folder to create a regression dashboard in. The maximum string length in characters is 50. |
name | string Name of the dashboard. Value must match the regular expression |
description | string Description of the dashboard. The maximum string length in characters is 1024. |
content | object Content of the dashboard. Content of regression dashboard. |
content. widgets[] |
object Widgets. |
content. widgets[]. position |
object Widget position. |
content. widgets[]. position. x |
string (int64) X. |
content. widgets[]. position. y |
string (int64) Y. |
content. widgets[]. position. width |
string (int64) Width. |
content. widgets[]. position. height |
string (int64) Height. |
content. widgets[]. chart |
object Chart widget. content.widgets[] includes only one of the fields chart , text , title |
content. widgets[]. chart. id |
string ID of the chart. |
content. widgets[]. chart. name |
string Name of the chart. |
content. widgets[]. chart. description |
string Description of the chart. |
content. widgets[]. chart. filterStr |
string Test filter selector to show KPI values for. |
content. widgets[]. chart. testCase |
string Test case to show KPI values for. |
content. widgets[]. chart. kpis[] |
object KPIs to show. |
content. widgets[]. chart. kpis[]. selector |
object Kind of KPI. KPI selector. |
content. widgets[]. chart. kpis[]. selector. responseTime |
object Response time cummulative quantile (percentile). content.widgets[].chart.kpis[].selector includes only one of the fields responseTime , instances , imbalanceRps , protocolCodesAbsolute , protocolCodesRelative , networkCodesAbsolute , networkCodesRelative |
content. widgets[]. chart. kpis[]. selector. responseTime. quantile |
string Cummulative quantile (percentile). Quantiles (percentiles).
|
content. widgets[]. chart. kpis[]. selector. instances |
object A number of instances throughout the test. content.widgets[].chart.kpis[].selector includes only one of the fields responseTime , instances , imbalanceRps , protocolCodesAbsolute , protocolCodesRelative , networkCodesAbsolute , networkCodesRelative |
content. widgets[]. chart. kpis[]. selector. instances. agg |
string Aggregation function. Aggregation function.
|
content. widgets[]. chart. kpis[]. selector. imbalanceRps |
object An RPS at the moment the test has been auto-stopped. content.widgets[].chart.kpis[].selector includes only one of the fields responseTime , instances , imbalanceRps , protocolCodesAbsolute , protocolCodesRelative , networkCodesAbsolute , networkCodesRelative |
content. widgets[]. chart. kpis[]. selector. protocolCodesAbsolute |
object A total number of requests completed with certain protocol (HTTP, GRPC, etc.) codes. content.widgets[].chart.kpis[].selector includes only one of the fields responseTime , instances , imbalanceRps , protocolCodesAbsolute , protocolCodesRelative , networkCodesAbsolute , networkCodesRelative |
content. widgets[]. chart. kpis[]. selector. protocolCodesAbsolute. codesPatterns[] |
string Protocol (HTTP, GRPC) code patterns to match. All successful HTTP responses: ['2xx', '3xx']. All failed HTTP responses: ['0', '4xx', '5xx']. |
content. widgets[]. chart. kpis[]. selector. protocolCodesRelative |
object A percentage of requests completed with certain protocol (HTTP, GRPC, etc.) codes. content.widgets[].chart.kpis[].selector includes only one of the fields responseTime , instances , imbalanceRps , protocolCodesAbsolute , protocolCodesRelative , networkCodesAbsolute , networkCodesRelative |
content. widgets[]. chart. kpis[]. selector. protocolCodesRelative. codesPatterns[] |
string Protocol (HTTP, GRPC) code patterns to match. All successful HTTP responses: ['2xx', '3xx']. All failed HTTP responses: ['0', '4xx', '5xx']. |
content. widgets[]. chart. kpis[]. selector. networkCodesAbsolute |
object A total number of requests completed with certain network codes. content.widgets[].chart.kpis[].selector includes only one of the fields responseTime , instances , imbalanceRps , protocolCodesAbsolute , protocolCodesRelative , networkCodesAbsolute , networkCodesRelative |
content. widgets[]. chart. kpis[]. selector. networkCodesAbsolute. codesPatterns[] |
string Network code patterns to match. All successful network responses: ['0']. All failed network responses: ['xx', 'xxx']. |
content. widgets[]. chart. kpis[]. selector. networkCodesRelative |
object A percentage of requests completed with certain network codes. content.widgets[].chart.kpis[].selector includes only one of the fields responseTime , instances , imbalanceRps , protocolCodesAbsolute , protocolCodesRelative , networkCodesAbsolute , networkCodesRelative |
content. widgets[]. chart. kpis[]. selector. networkCodesRelative. codesPatterns[] |
string Network code patterns to match. All successful network responses: ['0']. All failed network responses: ['xx', 'xxx']. |
content. widgets[]. chart. kpis[]. threshold |
object A condition that should be specified. KPI threshold represents a condition that an actual value of test's KPI should satisfy. |
content. widgets[]. chart. kpis[]. threshold. value |
number (double) Value for comparison with an actual KPI value. |
content. widgets[]. chart. kpis[]. threshold. comparison |
string Comparison operator for comparing actual with the threshold value. Rule: actual (</<=/>/>=) reference Comparison operator.
|
content. widgets[]. text |
object Text widget. content.widgets[] includes only one of the fields chart , text , title |
content. widgets[]. text. text |
string content.widgets[] includes only one of the fields chart , text , title Text string. |
content. widgets[]. title |
object Title widget. content.widgets[] includes only one of the fields chart , text , title |
content. widgets[]. title. text |
string content.widgets[] includes only one of the fields chart , text , title Title string. |
content. widgets[]. title. size |
string Title size. Title size.
|
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. |