GetGwpBenchmarkList - Energy Expert - Alibaba Cloud Documentation Center

Retrieves a ranked list of active carbon reduction initiatives.

Operation description

This operation returns a paginated list of active carbon reduction amounts for a specified product. You can use this operation to understand the active carbon reduction amounts at each product level.

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

none

*All Resource

*

None

Request syntax

POST /api/v1/carbon/footprint/result/gwp/benchmark/list HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request parameters.
code	string	Yes	The enterprise code.	C-20080808-1
productId	integer	Yes	The product ID.	1024
productType	integer	Yes	The product type. A value of 1 indicates a product carbon footprint request. A value of 5 indicates a supply chain carbon footprint request.	1

Response elements

Element	Type	Description	Example
	object	Response schema
requestId	string	The request ID. Each request has a unique ID. Use this ID to troubleshoot issues.	A8AEC6D9-A359-5169-BD1A-BD848BA60D65
data	object	The returned data.
unit	string	The unit of emissions. The default value is kgCO₂e/productUnit, where `productUnit` is the unit selected for the product. The unit automatically adjusts to tCO₂e/productUnit or gCO₂e/productUnit based on the emission quantity.	kgCO₂e/kg
items	array<object>	The ranking list of active carbon reduction initiatives.
	object	The details of the carbon reduction project.
name	string	The name of the inventory item.	PVC废料回收
carbonEmission	number	The emissions of the inventory item. The value is accurate to four decimal places. The unit is specified by the `unit` parameter at the parent level.	-0.2061
percent	string	This parameter is not in use.	暂为null
benchmarkName	string	The name of the baseline.	PVC废料焚烧
benchmarkEmission	number	The baseline emissions associated with the inventory item. The value is accurate to four decimal places. The unit is specified by the `unit` parameter at the parent level.	0.0108
activeReduction	number	The active carbon reduction amount. This value is calculated by subtracting the inventory item's emissions from the baseline emissions. Typically, the baseline emissions are greater than the inventory item's emissions. The value is accurate to four decimal places. The unit is specified by the `unit` parameter at the parent level.	0.2169

Examples

Success response

JSON format

{
  "requestId": "A8AEC6D9-A359-5169-BD1A-BD848BA60D65",
  "data": {
    "unit": "kgCO₂e/kg",
    "items": [
      {
        "name": "PVC废料回收",
        "carbonEmission": -0.2061,
        "percent": "暂为null",
        "benchmarkName": "PVC废料焚烧",
        "benchmarkEmission": 0.0108,
        "activeReduction": 0.2169
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.