Carbon Footprint Report Job

Overview

This job can be used to generate the Carbon Footprint Report.

Job Template ID	Resource Type	Data
b0001d36-6490-48ac-93af-a87adfb997ed	compute-ops-mgmt/filter	`reportType*`

Data properties marked with a * are required.

Create Job

A job can be created by issuing a POST to the /compute-ops-mgmt/v1beta3/jobs endpoint with the correct payload for the job.

The following properties are used when creating a job:

Property	JSON Type	Description	Required?
`jobTemplateUri`	string (uri)	A job-template URI with the durable Template ID of the job	Yes
`resourceUri`	string (uri)	A resource URI that the job will operate on	Yes
`data`	object	Any additional data required by the job	No

If the job was created successfully, a 201 Created response is returned. The response includes the job resource which has a job resourceUri that you can use to track the progress of the job.

Data

This table summarizes the supported properties in data.

Property	JSON Type	Description	Required?
`reportType`	string (enum)	Type of report to be generated	Yes

Data properties

reportType : This required property defines the type of report generated. Today only CARBON_FOOTPRINT is supported.

Example

Here's an example request payload for creating this job.

Example 1

Copy

Copied

{
      "jobTemplateUri": "/compute/v1/job-templates/b0001d36-6490-48ac-93af-a87adfb997ed",
      "resourceUri": "/compute-ops-mgmt/v1beta1/filters/e7cef8e6-a3f6-4490-b669-136e3ca40617",
      "data": {"reportType": "CARBON_FOOTPRINT"}
}