dashboards
Creates, updates, deletes, gets or lists a dashboards resource.
Overview
| Name | dashboards |
| Type | Resource |
| Id | linode.monitor.dashboards |
Fields
The following fields are returned by SELECT queries:
- get
- list_by_service_type
- list
Returns a dashboard.
| Name | Datatype | Description |
|---|---|---|
id | integer | The unique identifier for the dashboard. |
created | string (date-time) | When the dashboard was created. (example: 2024-10-10T05:01:58Z) |
label | string | The name of the dashboard. This is used for display purposes in Akamai Cloud Manager. (example: Resource Usage) |
service_type | string | The Akamai Cloud Computing service used by this dashboard. (example: dbaas) |
type | string | The type of dashboard. Currently, this can only be standard for a dashboard that uses default formatting. (standard) (example: standard) |
updated | string (date-time) | When the dashboard was last updated. (example: 2024-10-12T08:15:37Z) |
widgets | array | The widgets used in the dashboard. |
Returns a paginated list of dashboards.
| Name | Datatype | Description |
|---|---|---|
id | integer | The unique ID assigned to the dashboard. |
created | string (date-time) | When the dashboard was created. (example: 2024-10-10T05:01:58Z) |
label | string | The name of the dashboard. This is used for display purposes in Akamai Cloud Manager. (example: Resource Usage) |
service_type | string | The Akamai Cloud Computing service used by this dashboard. (example: dbaas) |
type | string | The type of dashboard. Currently, this can only be standard for a dashboard, which uses default formatting. (standard) (example: standard) |
updated | string (date-time) | When the dashboard was last updated. (example: 2024-10-12T08:15:37Z) |
widgets | array | The widgets used in the dashboard. |
Returns a paginated list of dashboards.
| Name | Datatype | Description |
|---|---|---|
id | integer | The unique identifier for the dashboard. |
created | string (date-time) | When the dashboard was created. (example: 2024-10-10T05:01:58Z) |
label | string | The name of the dashboard. This is used for display purposes in Akamai Cloud Manager. (example: Resource Usage) |
service_type | string | The Akamai Cloud Computing service used by this dashboard. (example: dbaas) |
type | string | The type of dashboard. Currently, this can only be standard for a dashboard that uses default formatting. (standard) (example: standard) |
updated | string (date-time) | When the dashboard was last updated. (example: 2024-10-12T08:15:37Z) |
widgets | array | The widgets used in the dashboard. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | dashboardId | Beta Returns a specific dashboard, based on its unique identifier. > 📘 > > This operation is beta. Call it using the v4beta path in its URL.Learn more... Learn more... | |
list_by_service_type | select | serviceType | Beta Returns all available dashboards for a given service type. > 📘 > > This operation is beta. Call it using the v4beta path in its URL.Learn more... Learn more... | |
list | select | Beta Returns all available dashboards. > 📘 > > This operation is beta. Call it using the v4beta path in its URL.Learn more... Learn more... |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
dashboardId | string | The unique identifier of the dashboard. |
serviceType | string | The Akamai Cloud Computing service being monitored. To see your currently supported services, run the List supported service types operation and store the appropriate service_type. |
SELECT examples
- get
- list_by_service_type
- list
Beta Returns a specific dashboard, based on its unique identifier.
> 📘
>
> This operation is beta. Call it using the v4beta path in its URL.
Learn more...
Learn more...
SELECT
id,
created,
label,
service_type,
type,
updated,
widgets
FROM linode.monitor.dashboards
WHERE dashboardId = '{{ dashboardId }}' -- required
;
Beta Returns all available dashboards for a given service type.
> 📘
>
> This operation is beta. Call it using the v4beta path in its URL.
Learn more...
Learn more...
SELECT
id,
created,
label,
service_type,
type,
updated,
widgets
FROM linode.monitor.dashboards
WHERE serviceType = '{{ serviceType }}' -- required
;
Beta Returns all available dashboards.
> 📘
>
> This operation is beta. Call it using the v4beta path in its URL.
Learn more...
Learn more...
SELECT
id,
created,
label,
service_type,
type,
updated,
widgets
FROM linode.monitor.dashboards
;