This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

CreateDashboard

1 - 1.2

scpcli servicewatch dashboard create
--name <value>
[--widgets <value>]

Description

Create dashboard

State ACTIVE (CURRENT)

VersionNot Before
1.2-

Parameters

NameTypeDescriptionExample
name
required
stringDashboard's nameNew-Monitoring-Dashboard
widgets
optional
arrayList of widgets included in the dashboard```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “InstanceId”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server

Responses

NameDescriptionExample
idWidget’s unique ID75da70a1a4fb486ab0282cf90693ec3c
dashboard_idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
heightWidget’s height1
orderWidget’s order in the dashboard1
propertiesWidget’s detailed properties
typeWidget typemetric
widthWidget’s width1

2 - 1.1

scpcli servicewatch dashboard create
--name <value>
[--widgets <value>]

Description

Create dashboard

State ACTIVE (SUPPORTED)

VersionNot Before
1.120260831

Parameters

NameTypeDescriptionExample
name
required
stringDashboard's nameNew-Monitoring-Dashboard
widgets
optional
arrayList of widgets included in the dashboard```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “InstanceId”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server

Responses

NameDescriptionExample
idWidget’s unique ID75da70a1a4fb486ab0282cf90693ec3c
dashboard_idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
heightWidget’s height1
orderWidget’s order in the dashboard1
propertiesWidget’s detailed properties
typeWidget typemetric
widthWidget’s width1

3 - 1.0

scpcli servicewatch dashboard create
--name <value>
[--widgets <value>]

Description

Create dashboard

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020260630

Parameters

NameTypeDescriptionExample
name
required
stringDashboard's nameNew-Monitoring-Dashboard
widgets
optional
arrayList of widgets included in the dashboard```’{“height”: 1, “order”: 1, “properties”: {“metrics”: [{“color”: “#ff7f0e”, “dimensions”: [{“key”: “InstanceId”, “value”: “10bf5d24-0f20-4066-bb0b-de2b1d6ff502”}], “display_name”: “EC2-Prod-CPU”, “individual_items”: [{“key”: “BucketId”, “value”: “b-1234567890abcdef0”}], “name”: “CPUUtilization”, “namespace_name”: “Virtual Server”, “period”: 300, “statistic_type”: “AVG”}], “period”: 300, “stacked”: false, “statistic_type”: “AVG”, “title”: “Virtual Server

Responses

NameDescriptionExample
idWidget’s unique ID75da70a1a4fb486ab0282cf90693ec3c
dashboard_idDashboard’s unique IDb48e730a70e74f6aa3d2555000b5c22b
heightWidget’s height1
orderWidget’s order in the dashboard1
propertiesWidget’s detailed properties
typeWidget typemetric
widthWidget’s width1