GetGwpBenchmarkSummary - Energy Expert - Alibaba Cloud Documentation Center

Retrieves the total proactive carbon reduction.

Operation description

This operation returns the proactive carbon reduction data from the generated results page for a specific product ID. It also provides details about the top four contributors to carbon reduction. You can use this operation to understand the total proactive carbon reduction for a product and its main sources.

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

none

*All Resource

*

None

Request syntax

POST /api/v1/carbon/footprint/result/gwp/benchmark/summary 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
requestId	string	The request ID. Each request has a unique ID for troubleshooting.	83A5A7DD-8974-5769-952E-590A97BEA34E
data	object	The returned data.
items	array<object>	Details of the top four contributors to carbon reduction.
	object	Item details.
name	string	The name of the carbon reduction detail.	原材料
percent	string	The emission percentage. This is a string with two decimal places. For example, a value of `99.01` indicates that this category accounts for 99.01% of the total emissions. Note that the returned string does not include the percent sign (%).	99.01
quantity	integer	The emission quantity, with a precision of four decimal places. This value is typically not negative, but you can construct a negative value for proactive carbon reduction. The `quantity` and `unit` parameters are adaptive and together represent the emission amount. The unit automatically adjusts based on the quantity. If the emission amount is greater than 1000 kgCO₂e/productUnit, the unit is converted to tCO₂e/productUnit. If the amount is less than 1 kgCO₂e/productUnit, the unit is converted to gCO₂e/productUnit. Otherwise, the unit remains kgCO₂e/productUnit.	9.9763
unit	string	The emission unit. The default is kgCO₂e/productUnit, where `productUnit` is the unit selected for the product. The `unit` adaptively changes to tCO₂e/productUnit or gCO₂e/productUnit based on the `quantity`. For more information about the conversion rules, see the description of the `quantity` parameter.	kgCO₂e/kg
quantity	integer	The emission quantity, with a precision of four decimal places. This value is typically not negative, but you can construct a negative value for proactive carbon reduction. The `quantity` and `unit` parameters are adaptive and together represent the emission amount. The unit automatically adjusts based on the quantity. If the emission amount is greater than 1000 kgCO₂e/productUnit, the unit is converted to tCO₂e/productUnit. If the amount is less than 1 kgCO₂e/productUnit, the unit is converted to gCO₂e/productUnit. Otherwise, the unit remains kgCO₂e/productUnit.	1000.0000
unit	string	The emission unit. The default is kgCO₂e/productUnit, where `productUnit` is the unit selected for the product. The `unit` adaptively changes to tCO₂e/productUnit or gCO₂e/productUnit based on the `quantity`. For more information about the conversion rules, see the description of the `quantity` parameter.	kgCO₂e/t

Examples

Success response

JSON format

{
  "requestId": "83A5A7DD-8974-5769-952E-590A97BEA34E",
  "data": {
    "items": [
      {
        "name": "原材料",
        "percent": "99.01",
        "quantity": 9.9763,
        "unit": "kgCO₂e/kg"
      }
    ],
    "quantity": 1000,
    "unit": "kgCO₂e/t"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.