GetGwpBenchmarkList - Energy Expert - Alibaba Cloud Documentation Center

obtain the active carbon reduction ranking list.

Operation description

This interface returns a list of proactive carbon reduction information given product ID. It's used to understand the carbon reduction efforts at various levels of the product.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	Request parameters.
code	string	Yes	The enterprise code.	C-20080808-1
productId	long	Yes	The product id.	1024
productType	long	Yes	Product type: 1 indicates that the carbon footprint of the product is requested, and 5 indicates that the carbon footprint of the supply chain is requested.	1

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
requestId	string	The ID of the request. The value is unique for each request. This facilitates subsequent troubleshooting.	A8AEC6D9-A359-5169-BD1A-BD848BA60D65
data	object	The response parameters.
unit	string	unit of emissions. The default value is `kgCO₂e/productUnit`. The `productUnit` is the unit selected for the product. The unit value is changed to `tCO₂e/productUnit` or `gCO₂e/productUnit`. For more information, see the remarks in the quantity column.	kgCO₂e/kg
items	array<object>	Active carbon reduction ranking list.
Item	object
name	string	name	new-energy
carbonEmission	double	Inventory emissions. Maintain four decimal places. Unit pertains to a higher-level unit.	-0.2061
percent	string	Unused temporarily.	null
benchmarkName	string	Benchmark name	old-energy
benchmarkEmission	double	Benchmark emissions. Maintain four decimal places. Unit pertains to a higher-level unit.	0.0108
activeReduction	double	`activeReduction=benchmarkEmission-carbonEmission` Generally, baseline emissions are greater than inventory emissions. Maintain four decimal places. Unit pertains to a higher-level unit.	0.2169

Examples

Sample success responses

JSONformat

{
  "requestId": "A8AEC6D9-A359-5169-BD1A-BD848BA60D65",
  "data": {
    "unit": "kgCO₂e/kg",
    "items": [
      {
        "name": "new-energy",
        "carbonEmission": -0.2061,
        "percent": "null",
        "benchmarkName": "old-energy ",
        "benchmarkEmission": 0.0108,
        "activeReduction": 0.2169
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.