slo_report_job
Creates, updates, deletes, gets or lists a slo_report_job
resource.
Overview
Name | slo_report_job |
Type | Resource |
Id | datadog.service_management.slo_report_job |
Fields
The following fields are returned by SELECT
queries:
- get_sloreport_job_status
Name | Datatype | Description |
---|---|---|
id | string | The ID of the report job. (example: dc8d92aa-e0af-11ee-af21-1feeaccaa3a3) |
attributes | object | The attributes portion of the SLO report status response. |
type | string | The type of ID. (example: report_id) |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get_sloreport_job_status | select | report_id , region | Get the status of the SLO report job. | |
create_sloreport_job | insert | region , data__data | Create a job to generate an SLO report. The report job is processed asynchronously and eventually results in a CSV report being available for download. Check the status of the job and download the CSV report using the returned report_id . | |
get_sloreport | exec | report_id , region | Download an SLO report. This can only be performed after the report job has completed. Reports are not guaranteed to exist indefinitely. Datadog recommends that you download the report as soon as it is available. |
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 |
---|---|---|
region | string | (default: datadoghq.com) |
report_id | string | The ID of the report job. |
SELECT
examples
- get_sloreport_job_status
Get the status of the SLO report job.
SELECT
id,
attributes,
type
FROM datadog.service_management.slo_report_job
WHERE report_id = '{{ report_id }}' -- required
AND region = '{{ region }}' -- required
;
INSERT
examples
- create_sloreport_job
- Manifest
Create a job to generate an SLO report. The report job is processed asynchronously and eventually results in a CSV report being available for download.
Check the status of the job and download the CSV report using the returned report_id
.
INSERT INTO datadog.service_management.slo_report_job (
data__data,
region
)
SELECT
'{{ data }}' /* required */,
'{{ region }}'
RETURNING
data
;
# Description fields are for documentation purposes
- name: slo_report_job
props:
- name: region
value: string
description: Required parameter for the slo_report_job resource.
- name: data
value: object
description: |
The data portion of the SLO report request.
Lifecycle Methods
- get_sloreport
Download an SLO report. This can only be performed after the report job has completed.
Reports are not guaranteed to exist indefinitely. Datadog recommends that you download the report as soon as it is available.
EXEC datadog.service_management.slo_report_job.get_sloreport
@report_id='{{ report_id }}' --required,
@region='{{ region }}' --required
;