GetCarbonEmissionTrend - Energy Expert - Alibaba Cloud Documentation Center

Queries the carbon emission trend.

Operation description

This operation queries the carbon emissions of an organization for each month within a specified year. The results are returned in a list that shows the carbon emission trend over time. The following parameters are required:

The unique identifier of the organization
The year for the carbon emission statistics
The type of the statistics module
The required trend type

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:GetCarbonEmissionTrend

none

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	Request parameters
code	string	Yes	The organization code.	C-20240119-1
yearList	array	Yes	The list of inventory years.
	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
trendType	integer	Yes	The trend type.	0

Response elements

Element	Type	Description	Example
	object	Schema of Response
requestId	string	Id of the request	9bc20a5a-b26b-4c28-922a-7cd10b61f96f
data	object	The returned data.
targetEmissionList	array<object>	The list of target emissions.
	array<object>	The target emission data.
year	string	The year.	2024
items	array<object>	The list of data items.
	object	The data item.
year	string	The year.	2024
month	integer	The month.	10
carbonEmissionData	number	The carbon emissions.	20.22
actualEmissionList	array<object>	The list of actual emissions.
	array<object>	The actual emission data.
year	string	The year.	2024
items	array<object>	The list of data items.
	object	The data item.
year	string	The year.	2024
month	integer	The month.	11
carbonEmissionData	number	The carbon emissions.	20.22

Examples

Success response

JSON format

{
  "requestId": "9bc20a5a-b26b-4c28-922a-7cd10b61f96f",
  "data": {
    "targetEmissionList": [
      {
        "year": "2024",
        "items": [
          {
            "year": "2024",
            "month": 10,
            "carbonEmissionData": 20.22
          }
        ]
      }
    ],
    "actualEmissionList": [
      {
        "year": "2024",
        "items": [
          {
            "year": "2024",
            "month": 11,
            "carbonEmissionData": 20.22
          }
        ]
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.