usage_carbon_emissions
Creates, updates, deletes, gets or lists a usage_carbon_emissions resource.
Overview​
| Name | usage_carbon_emissions |
| Type | Resource |
| Id | oci.usage.usage_carbon_emissions |
Fields​
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
request_usage_carbon_emissions | exec | region, tenantId, timeUsageStarted, timeUsageEnded | opc-request-id, page, limit | Returns carbon emission usage for the given account.<br /> |
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 | OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION) |
limit | integer | The maximum number of items to return. |
opc-request-id | string | Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
page | string | The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. |
Lifecycle Methods​
- request_usage_carbon_emissions
Returns carbon emission usage for the given account.<br />
EXEC oci.usage.usage_carbon_emissions.request_usage_carbon_emissions
@region='{{ region }}' --required,
@opc-request-id='{{ opc-request-id }}',
@page='{{ page }}',
@limit='{{ limit }}'
@@json=
'{
"compartmentDepth": {{ compartmentDepth }},
"emissionCalculationMethod": "{{ emissionCalculationMethod }}",
"emissionType": "{{ emissionType }}",
"filter": "{{ filter }}",
"granularity": "{{ granularity }}",
"groupBy": "{{ groupBy }}",
"groupByTag": "{{ groupByTag }}",
"isAggregateByTime": {{ isAggregateByTime }},
"tenantId": "{{ tenantId }}",
"timeUsageEnded": "{{ timeUsageEnded }}",
"timeUsageStarted": "{{ timeUsageStarted }}"
}'
;