status_messages
Creates, updates, deletes, gets or lists a status_messages resource.
Overview
| Name | status_messages |
| Type | Resource |
| Id | digitalocean.kubernetes.status_messages |
Fields
The following fields are returned by SELECT queries:
- kubernetes_get_status_messages
The response is a JSON object which contains status messages for a Kubernetes cluster. Each message object contains a timestamp and an indication of what issue the cluster is experiencing at a given time.
| Name | Datatype | Description |
|---|---|---|
message | string | Status information about the cluster which impacts it's lifecycle. (example: Resource provisioning may be delayed while our team resolves an incident) |
timestamp | string (date-time) | A timestamp in ISO8601 format that represents when the status message was emitted. (example: 2018-11-15T16:00:11Z) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
kubernetes_get_status_messages | select | cluster_id | since | To retrieve status messages for a Kubernetes cluster, send a GET request to/v2/kubernetes/clusters/$K8S_CLUSTER_ID/status_messages. Status messages inform users of any issues that come up during the cluster lifecycle. |
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 |
|---|---|---|
cluster_id | string (uuid) | A unique ID that can be used to reference a Kubernetes cluster. (example: bd5f5959-5e1e-4205-a714-a914373942af) |
since | string (date-time) | A timestamp used to return status messages emitted since the specified time. The timestamp should be in ISO8601 format. (example: 2018-11-15T16:00:11Z) |
SELECT examples
- kubernetes_get_status_messages
To retrieve status messages for a Kubernetes cluster, send a GET request to/v2/kubernetes/clusters/$K8S_CLUSTER_ID/status_messages. Status messages inform users of any issues that come up during the cluster lifecycle.
SELECT
message,
timestamp
FROM digitalocean.kubernetes.status_messages
WHERE cluster_id = '{{ cluster_id }}' -- required
AND since = '{{ since }}';