GetEmissionSummary - Energy Expert - Alibaba Cloud Documentation Center

Retrieves a carbon emission summary.

Operation description

This operation returns the summary of carbon emission metrics for an organization. The following parameters are required:

The unique identifier of the organization
The year of the statistics
The type of the statistical module

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

energy:GetEmissionSummary

none

*All Resource

*

None

Request syntax

POST /api/v1/carbon/emission/analysis/summary HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request parameters.
code	string	Yes	The code of the enterprise.	C-20240119-1
year	integer	Yes	The inventory year.	2024
moduleType	integer	No	The module type.	3
moduleCode	string	No	The module code.	carbonInventory.check.scope_1_direct_ghg_emissions

Response elements

Element	Type	Description	Example
	object	The schema of the response.
data	object	The details of the summary.
currentPeriodCarbonEmissionData	number	The statistical metric for the current period.	276.4
lastPeriodCarbonEmissionData	number	The statistical metric for the previous period.	9.40100
totalCarbonEmissionData	number	The total emissions from energy consumption.	276.46
carbonSaveConversion	number	The reduced carbon emissions.	0.0
ratio	number	The year-over-year (YoY) change for the current period.	28.410
actualEmissionRatio	number	The percentage of recorded emissions.	2.7657
weightingCarbonEmissionData	number	The carbon emissions calculated based on the equity ratio.	248.81400
lastPeriodWeightingCarbonEmissionData	number	The carbon emissions of the previous period calculated based on the equity ratio.	8.4609
weightingRatio	number	The YoY change in carbon emissions based on the equity ratio.	28.4102
isWeighting	boolean	Indicates whether to show carbon emissions based on the equity ratio.	true
requestId	string	The ID of the request.	83A5A7DD-8974-5769-952E-590A97BEA34E

Examples

Success response

JSON format

{
  "data": {
    "currentPeriodCarbonEmissionData": 276.4,
    "lastPeriodCarbonEmissionData": 9.401,
    "totalCarbonEmissionData": 276.46,
    "carbonSaveConversion": 0,
    "ratio": 28.41,
    "actualEmissionRatio": 2.7657,
    "weightingCarbonEmissionData": 248.814,
    "lastPeriodWeightingCarbonEmissionData": 8.4609,
    "weightingRatio": 28.4102,
    "isWeighting": true
  },
  "requestId": "83A5A7DD-8974-5769-952E-590A97BEA34E"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.