Skip to main content

Get

Returns the specified dashboard.

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

const GetDashboardRequest =
  cloudApi.monitoring.dashboard_service.GetDashboardRequest;

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

  const result = await client.get(
    GetDashboardRequest.fromPartial({
      dashboardId: "dashboardId",
    })
  );
  console.log(result);
})();

GetDashboardRequest​

dashboardId : string​

Required. Dashboard ID.

Dashboard​

Dashboard resource.

id : string​

Dashboard ID.

One of container​

Container id

  • folderId : string​

    Folder ID.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

modifiedAt : google.protobuf.Timestamp​

Modification timestamp.

createdBy : string​

ID of the user who created the dashboard.

modifiedBy : string​

ID of the user who modified the dashboard.

name : string​

Dashboard name.

description : string​

Dashboard description.

labels : string​

Resource labels as key:value pairs.

title : string​

Dashboard title.

widgets : Widget​

List of dashboard widgets.

parametrization : Parametrization​

Dashboard parametrization.

etag : string​

Dashboard etag.

managedBy : string​

Entity that controls dashboard Must match the regular expression "[\w -][1]{1,100}"

Information about entity that controls dashboard Must be valid URI

Widget​

Widget.

LayoutPosition​

Layout item for widget item positioning.

x : int64​

Required. X-axis top-left corner coordinate.

y : int64​

Required. Y-axis top-left corner coordinate.

w : int64​

Required. Weight.

h : int64​

Required. Height.

position : LayoutPosition​

Required. Widget layout position.

One of widget​

Required. Widget data.

  • text : TextWidget​

    Text widget.

  • title : TitleWidget​

    Title widget.

  • chart : ChartWidget​

    Chart widget.

Parametrization​

Parametrization.

parameters : Parameter​

Parameters.

selectors : string​

Predefined selectors.

LayoutPosition​

Layout item for widget item positioning.

x : int64​

Required. X-axis top-left corner coordinate.

y : int64​

Required. Y-axis top-left corner coordinate.

w : int64​

Required. Weight.

h : int64​

Required. Height.

TextWidget​

Text widget.

text : string​

Text.

TitleWidget​

Title widget.

TitleSize​

Title size.

  • TITLE_SIZE_UNSPECIFIED

    Title size.

  • TITLE_SIZE_XS

    Extra small size.

  • TITLE_SIZE_S

    Small size.

  • TITLE_SIZE_M

    Middle size.

  • TITLE_SIZE_L

    Large size.

text : string​

Title text.

size : TitleSize​

Title size.

ChartWidget​

Chart widget.

Queries​

Query settings.

Target​

Query target.

query : string​

Required. Query.

textMode : bool​

Text mode.

hidden : bool​

Checks that target is visible or invisible.

name : string​

Name of the query.

targets : Target​

Required. List of targets.

downsampling : Downsampling​

Required. Downsampling settings.

VisualizationSettings​

Visualization settings.

VisualizationType​

Chart visualization type.

  • VISUALIZATION_TYPE_UNSPECIFIED

    Not specified (line by default).

  • VISUALIZATION_TYPE_LINE

    Line chart.

  • VISUALIZATION_TYPE_STACK

    Stack chart.

  • VISUALIZATION_TYPE_COLUMN

    Points as columns chart.

  • VISUALIZATION_TYPE_POINTS

    Points.

  • VISUALIZATION_TYPE_PIE

    Pie aggregation chart.

  • VISUALIZATION_TYPE_BARS

    Bars aggregation chart.

  • VISUALIZATION_TYPE_DISTRIBUTION

    Distribution aggregation chart.

  • VISUALIZATION_TYPE_HEATMAP

    Heatmap aggregation chart.

Interpolate​
  • INTERPOLATE_UNSPECIFIED

    Not specified (linear by default).

  • INTERPOLATE_LINEAR

    Linear.

  • INTERPOLATE_LEFT

    Left.

  • INTERPOLATE_RIGHT

    Right.

ColorSchemeSettings​

####### AutomaticColorScheme {#colorschemesettings_automaticcolorscheme}

####### StandardColorScheme {#colorschemesettings_standardcolorscheme}

####### GradientColorScheme {#colorschemesettings_gradientcolorscheme}

greenValue : string​

Gradient green value.

yellowValue : string​

Gradient yellow value.

redValue : string​

Gradient red value.

violetValue : string​

Gradient violet_value.

####### HashColorScheme {#colorschemesettings_hashcolorscheme}

One of scheme​

  • automatic : AutomaticColorScheme​

    Automatic color scheme.

  • standard : StandardColorScheme​

    Standard color scheme.

  • gradient : GradientColorScheme​

    Gradient color scheme.

  • hash : HashColorScheme​

    Hash color scheme. Based on line name or value.

HeatmapSettings​
greenValue : string​

Heatmap green value.

yellowValue : string​

Heatmap yellow value.

redValue : string​

Heatmap red value.

violetValue : string​

Heatmap violet_value.

YaxisType​

Y axis type. N.B. _TYPE prefix is necessary to expect name clash with Interpolate LINEAR value.

  • YAXIS_TYPE_UNSPECIFIED

    Not specified (linear by default).

  • YAXIS_TYPE_LINEAR

    Linear.

  • YAXIS_TYPE_LOGARITHMIC

    Logarithmic.

Yaxis​

Y axis settings.

type : YaxisType​

Type.

title : string​

Title or empty.

min : string​

Min value in extended number format or empty.

max : string​

Max value in extended number format or empty.

unitFormat : UnitFormat​

Unit format.

precision : google.protobuf.Int64Value​

Tick value precision (null as default, 0-7 in other cases).

YaxisSettings​
left : Yaxis​

Left Y axis settings.

right : Yaxis​

Right Y axis settings.

SeriesAggregation​
  • SERIES_AGGREGATION_UNSPECIFIED

    Not specified (avg by default).

  • SERIES_AGGREGATION_AVG

    Average.

  • SERIES_AGGREGATION_MIN

    Minimum.

  • SERIES_AGGREGATION_MAX

    Maximum.

  • SERIES_AGGREGATION_LAST

    Last non-NaN value.

  • SERIES_AGGREGATION_SUM

    Sum.

type : VisualizationType​

Visualization type.

normalize : bool​

Normalize.

interpolate : Interpolate​

Interpolate.

aggregation : SeriesAggregation​

Aggregation.

colorSchemeSettings : ColorSchemeSettings​

Color scheme settings.

heatmapSettings : HeatmapSettings​

Heatmap settings.

yaxisSettings : YaxisSettings​

Y axis settings.

title : string​

Inside chart title.

showLabels : bool​

Show chart labels.

SeriesOverrides​

Series override settings.

YaxisPosition​
  • YAXIS_POSITION_UNSPECIFIED

    Not specified (left by default).

  • YAXIS_POSITION_LEFT

    Left.

  • YAXIS_POSITION_RIGHT

    Right.

SeriesVisualizationType​
  • SERIES_VISUALIZATION_TYPE_UNSPECIFIED

    Not specified (line by default).

  • SERIES_VISUALIZATION_TYPE_LINE

    Line chart.

  • SERIES_VISUALIZATION_TYPE_STACK

    Stack chart.

  • SERIES_VISUALIZATION_TYPE_COLUMN

    Points as columns chart.

  • SERIES_VISUALIZATION_TYPE_POINTS

    Points.

SeriesOverrideSettings​
name : string​

Series name or empty.

color : string​

Series color or empty.

type : SeriesVisualizationType​

Type.

stackName : string​

Stack name or empty.

growDown : bool​

Stack grow down.

yaxisPosition : YaxisPosition​

Yaxis position.

One of type​

Required. Series selection type.

  • name : string​

    Series name.

  • targetIndex : string​

    Target index.

settings : SeriesOverrideSettings​

Required. Override settings.

NameHidingSettings​

Name hiding settings.

positive : bool​

True if we want to show concrete series names only, false if we want to hide concrete series names.

names : string​

Series names to show or hide.

FreezeDuration​
  • FREEZE_DURATION_UNSPECIFIED

  • FREEZE_DURATION_HOUR

    Last hour.

  • FREEZE_DURATION_DAY

    Last day = last 24 hours.

  • FREEZE_DURATION_WEEK

    Last 7 days.

  • FREEZE_DURATION_MONTH

    Last 31 days.

RepeatSettings​
repeatBy : string​

Parameters to repeat by.

maxChartsInRow : int64​

Max number of chart in one row.

id : string​

Required. Chart ID.

queries : Queries​

Queries.

visualizationSettings : VisualizationSettings​

Visualization settings.

seriesOverrides : SeriesOverrides​

Override settings.

nameHidingSettings : NameHidingSettings​

Name hiding settings.

description : string​

Chart description in dashboard (not enabled in UI).

title : string​

Chart widget title.

displayLegend : bool​

Enable legend under chart.

freeze : FreezeDuration​

Fixed time interval for chart.

repeat : RepeatSettings​

Setting for repeat panel / repeat row

Parameter​

Parameter.

name : string​

Parameter identifier.

title : string​

UI-visible title of the parameter.

One of data​

Parameter data.

  • labelValues : LabelValuesParameter​

    Label values parameter.

  • custom : CustomParameter​

    Custom parameter.

  • text : TextParameter​

    Text parameter.

  • integerParameter : IntegerParameter​

    Integer parameter.

  • doubleParameter : DoubleParameter​

    Double parameter.

  • textValues : TextValuesParameter​

    Integer parameter.

hidden : bool​

UI-visibility.

description : string​

Parameter description.

Target​

Query target.

query : string​

Required. Query.

textMode : bool​

Text mode.

hidden : bool​

Checks that target is visible or invisible.

name : string​

Name of the query.

Downsampling​

List of available aggregate functions for downsampling.

GridAggregation​

List of available aggregate functions for downsampling.

  • GRID_AGGREGATION_UNSPECIFIED

    List of available aggregate functions for downsampling.

  • GRID_AGGREGATION_MAX

    Max value.

  • GRID_AGGREGATION_MIN

    Min value.

  • GRID_AGGREGATION_SUM

    Sum of values.

  • GRID_AGGREGATION_AVG

    Average value.

  • GRID_AGGREGATION_LAST

    Last value.

  • GRID_AGGREGATION_COUNT

    Total count of points.

GapFilling​

List of available gap filling policy for downsampling.

  • GAP_FILLING_UNSPECIFIED

    List of available gap filling policy for downsampling.

  • GAP_FILLING_NULL

    Returns null as a metric value and timestamp as a time series value.

  • GAP_FILLING_NONE

    Returns no value and no timestamp.

  • GAP_FILLING_PREVIOUS

    Returns the value from the previous time interval.

One of mode​

  • maxPoints : int64​

    Maximum number of points to be returned.

  • gridInterval : int64​
    Time interval (grid) for downsampling in milliseconds.

    Points in the specified range are aggregated into one time point.

  • disabled : bool​

    Disable downsampling.

gridAggregation : GridAggregation​

Function that is used for downsampling.

gapFilling : GapFilling​

Parameters for filling gaps in data.

AutomaticColorScheme​

StandardColorScheme​

GradientColorScheme​

greenValue : string​

Gradient green value.

yellowValue : string​

Gradient yellow value.

redValue : string​

Gradient red value.

violetValue : string​

Gradient violet_value.

HashColorScheme​

Yaxis​

Y axis settings.

type : YaxisType​

Type.

title : string​

Title or empty.

min : string​

Min value in extended number format or empty.

max : string​

Max value in extended number format or empty.

unitFormat : UnitFormat​

Unit format.

precision : google.protobuf.Int64Value​

Tick value precision (null as default, 0-7 in other cases).

ColorSchemeSettings​

AutomaticColorScheme​
StandardColorScheme​
GradientColorScheme​
greenValue : string​

Gradient green value.

yellowValue : string​

Gradient yellow value.

redValue : string​

Gradient red value.

violetValue : string​

Gradient violet_value.

HashColorScheme​
  • automatic : AutomaticColorScheme​

    Automatic color scheme.

  • standard : StandardColorScheme​

    Standard color scheme.

  • gradient : GradientColorScheme​

    Gradient color scheme.

  • hash : HashColorScheme​

    Hash color scheme. Based on line name or value.

HeatmapSettings​

greenValue : string​

Heatmap green value.

yellowValue : string​

Heatmap yellow value.

redValue : string​

Heatmap red value.

violetValue : string​

Heatmap violet_value.

YaxisSettings​

left : Yaxis​

Left Y axis settings.

right : Yaxis​

Right Y axis settings.

SeriesOverrideSettings​

name : string​

Series name or empty.

color : string​

Series color or empty.

type : SeriesVisualizationType​

Type.

stackName : string​

Stack name or empty.

growDown : bool​

Stack grow down.

yaxisPosition : YaxisPosition​

Yaxis position.

Queries​

Query settings.

Target​

Query target.

query : string​

Required. Query.

textMode : bool​

Text mode.

hidden : bool​

Checks that target is visible or invisible.

name : string​

Name of the query.

targets : Target​

Required. List of targets.

downsampling : Downsampling​

Required. Downsampling settings.

VisualizationSettings​

Visualization settings.

VisualizationType​

Chart visualization type.

  • VISUALIZATION_TYPE_UNSPECIFIED

    Not specified (line by default).

  • VISUALIZATION_TYPE_LINE

    Line chart.

  • VISUALIZATION_TYPE_STACK

    Stack chart.

  • VISUALIZATION_TYPE_COLUMN

    Points as columns chart.

  • VISUALIZATION_TYPE_POINTS

    Points.

  • VISUALIZATION_TYPE_PIE

    Pie aggregation chart.

  • VISUALIZATION_TYPE_BARS

    Bars aggregation chart.

  • VISUALIZATION_TYPE_DISTRIBUTION

    Distribution aggregation chart.

  • VISUALIZATION_TYPE_HEATMAP

    Heatmap aggregation chart.

Interpolate​
  • INTERPOLATE_UNSPECIFIED

    Not specified (linear by default).

  • INTERPOLATE_LINEAR

    Linear.

  • INTERPOLATE_LEFT

    Left.

  • INTERPOLATE_RIGHT

    Right.

ColorSchemeSettings​
AutomaticColorScheme​
StandardColorScheme​
GradientColorScheme​
greenValue : string​

Gradient green value.

yellowValue : string​

Gradient yellow value.

redValue : string​

Gradient red value.

violetValue : string​

Gradient violet_value.

HashColorScheme​
  • automatic : AutomaticColorScheme​

    Automatic color scheme.

  • standard : StandardColorScheme​

    Standard color scheme.

  • gradient : GradientColorScheme​

    Gradient color scheme.

  • hash : HashColorScheme​

    Hash color scheme. Based on line name or value.

HeatmapSettings​
greenValue : string​

Heatmap green value.

yellowValue : string​

Heatmap yellow value.

redValue : string​

Heatmap red value.

violetValue : string​

Heatmap violet_value.

YaxisType​

Y axis type. N.B. _TYPE prefix is necessary to expect name clash with Interpolate LINEAR value.

  • YAXIS_TYPE_UNSPECIFIED

    Not specified (linear by default).

  • YAXIS_TYPE_LINEAR

    Linear.

  • YAXIS_TYPE_LOGARITHMIC

    Logarithmic.

Yaxis​

Y axis settings.

type : YaxisType​

Type.

title : string​

Title or empty.

min : string​

Min value in extended number format or empty.

max : string​

Max value in extended number format or empty.

unitFormat : UnitFormat​

Unit format.

precision : google.protobuf.Int64Value​

Tick value precision (null as default, 0-7 in other cases).

YaxisSettings​
left : Yaxis​

Left Y axis settings.

right : Yaxis​

Right Y axis settings.

SeriesAggregation​
  • SERIES_AGGREGATION_UNSPECIFIED

    Not specified (avg by default).

  • SERIES_AGGREGATION_AVG

    Average.

  • SERIES_AGGREGATION_MIN

    Minimum.

  • SERIES_AGGREGATION_MAX

    Maximum.

  • SERIES_AGGREGATION_LAST

    Last non-NaN value.

  • SERIES_AGGREGATION_SUM

    Sum.

type : VisualizationType​

Visualization type.

normalize : bool​

Normalize.

interpolate : Interpolate​

Interpolate.

aggregation : SeriesAggregation​

Aggregation.

colorSchemeSettings : ColorSchemeSettings​

Color scheme settings.

heatmapSettings : HeatmapSettings​

Heatmap settings.

yaxisSettings : YaxisSettings​

Y axis settings.

title : string​

Inside chart title.

showLabels : bool​

Show chart labels.

SeriesOverrides​

Series override settings.

YaxisPosition​
  • YAXIS_POSITION_UNSPECIFIED

    Not specified (left by default).

  • YAXIS_POSITION_LEFT

    Left.

  • YAXIS_POSITION_RIGHT

    Right.

SeriesVisualizationType​
  • SERIES_VISUALIZATION_TYPE_UNSPECIFIED

    Not specified (line by default).

  • SERIES_VISUALIZATION_TYPE_LINE

    Line chart.

  • SERIES_VISUALIZATION_TYPE_STACK

    Stack chart.

  • SERIES_VISUALIZATION_TYPE_COLUMN

    Points as columns chart.

  • SERIES_VISUALIZATION_TYPE_POINTS

    Points.

SeriesOverrideSettings​
name : string​

Series name or empty.

color : string​

Series color or empty.

type : SeriesVisualizationType​

Type.

stackName : string​

Stack name or empty.

growDown : bool​

Stack grow down.

yaxisPosition : YaxisPosition​

Yaxis position.

  • name : string​

    Series name.

  • targetIndex : string​

    Target index.

settings : SeriesOverrideSettings​

Required. Override settings.

NameHidingSettings​

Name hiding settings.

positive : bool​

True if we want to show concrete series names only, false if we want to hide concrete series names.

names : string​

Series names to show or hide.

RepeatSettings​

repeatBy : string​

Parameters to repeat by.

maxChartsInRow : int64​

Max number of chart in one row.

LabelValuesParameter​

Label values parameter.

  • folderId : string​

    Required. Folder ID.

selectors : string​

Required. Selectors to select metric label values.

labelKey : string​

Required. Label key to list label values.

multiselectable : bool​

Specifies the multiselectable values of parameter.

defaultValues : string​

Default values.

CustomParameter​

Custom parameter.

values : string​

Required. List of parameter values.

multiselectable : bool​

Specifies the multiselectable values of parameter.

defaultValues : string​

Default values.

TextParameter​

Text parameter.

defaultValue : string​

Default value.

IntegerParameter​

Integer parameter.

defaultValue : int64​

Default value.

unitFormat : UnitFormat​

Parameter unit.

DoubleParameter​

Double parameter.

defaultValue : double​

Default value.

unitFormat : UnitFormat​

Parameter unit.

TextValuesParameter​

Text multiple values parameter.

defaultValues : string​

Default value.

[1]: #dashboard\w -