metrics
Creates, updates, deletes, gets or lists a metrics resource.
Overview
| Name | metrics |
| Type | Resource |
| Id | linode.monitor.metrics |
Fields
The following fields are returned by SELECT queries:
- get_monitor_information
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_monitor_information | select | X-Filter | Beta Returns metrics for a specific service type. Include the appropriate service_type as a path parameter.> 📘 > > - This operation is beta. Call it using the v4beta path in its URL.> > - Currently, only the Managed Databases ( dbaas) service type is supported.Learn more... Learn more... | |
post_read_metric | exec | Beta Returns metrics information for the individual entities within a specific service type. Include the appropriate service_type as a path parameter. Requires an authorization: Bearer token you've created for this service_type.> 📘 > > - Currently, only the Managed Databases ( dbaas) service type is supported.> > - This operation uses a different URL and version from standard Linode API operations. Verify you're using the URL with the monitor-api.linode.com hostname and include v2beta as the version in the URL. | ||
post_get_token | exec | entity_ids | Beta Returns a token that authenticates requests for the entities within a specific service type. Include the appropriate service_type as a path parameter. The token has a lifetime of six hours after you create it. For an example of the token generation process, see Monitor API operation authentication.> 📘 > > - This operation is beta. Call it using the v4beta path in its URL.> > - Currently, only the Managed Databases ( dbaas) service type is supported.> > - You also need read_only access to the scope for the selected service_type.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 |
|---|---|---|
X-Filter | object | Specifies a JSON object to filter down the results. See Filtering and sorting for details. (example: {{X-Filter}}) |
SELECT examples
- get_monitor_information
Beta Returns metrics for a specific service type. Include the appropriate service_type as a path parameter.
> 📘
>
> - This operation is beta. Call it using the v4beta path in its URL.
>
> - Currently, only the Managed Databases (dbaas) service type is supported.
Learn more...
Learn more...
SELECT
data,
page,
pages,
results
FROM linode.monitor.metrics
WHERE X-Filter = '{{ X-Filter }}';
Lifecycle Methods
- post_read_metric
- post_get_token
Beta Returns metrics information for the individual entities within a specific service type. Include the appropriate service_type as a path parameter. Requires an authorization: Bearer token you've created for this service_type.
> 📘
>
> - Currently, only the Managed Databases (dbaas) service type is supported.
>
> - This operation uses a different URL and version from standard Linode API operations. Verify you're using the URL with the monitor-api.linode.com hostname and include v2beta as the version in the URL.
EXEC linode.monitor.metrics.post_read_metric
;
Beta Returns a token that authenticates requests for the entities within a specific service type. Include the appropriate service_type as a path parameter. The token has a lifetime of six hours after you create it. For an example of the token generation process, see Monitor API operation authentication.
> 📘
>
> - This operation is beta. Call it using the v4beta path in its URL.
>
> - Currently, only the Managed Databases (dbaas) service type is supported.
>
> - You also need read_only access to the scope for the selected service_type.
Learn more...
Learn more...
EXEC linode.monitor.metrics.post_get_token
@@json=
'{
"entity_ids": "{{ entity_ids }}"
}';