GetEpdSummary - Energy Expert - Alibaba Cloud Documentation Center

Operation description

This operation retrieves the total emissions for a product across various environmental impact categories. The product is identified by its ID. The operation returns the totals from the generated results page.

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

none

*All Resource

*

None

Request syntax

POST /api/v1/carbon/footprint/result/epd/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. `1` indicates a product carbon footprint request. `5` indicates a supply chain carbon footprint request.	1

Response elements

Element	Type	Description	Example
	object
requestId	string	The ID of the request. This value is unique for each request. Use this ID to troubleshoot issues.	B91B5559-065A-55C3-8D75-DA218EBFD1DC
data	array<object>	The returned data.
	object
carbonEmission	number	The emission amount. The result is returned with 31 decimal places to ensure calculation accuracy. Truncate this value for display. Use the emission amount with its corresponding unit.	1009.976265540000000000000000000000
indicator	string	The evaluation indicator for the environmental impact.	GWP100a
key	string	The category key for the environmental impact category. Up to 19 categories are supported. For more information, see the appendix.	gwp
method	string	The standard for the calculation method.	CML v4.8 2016
name	string	The name of the category.	气候变化
num	integer	The category number. This is the unique ordinal number for the environmental impact category. Up to 19 categories are supported. For more information, see the appendix.	1
preUnit	string	The unit of the environmental impact result.	kg CO2-Eq
state	integer	The status of the data. `1` indicates an accurate calculation. `2` indicates that default data was used. `3` indicates that a factor was missing and a value of 0 was used.	1

Examples

Success response

JSON format

{
  "requestId": "B91B5559-065A-55C3-8D75-DA218EBFD1DC",
  "data": [
    {
      "carbonEmission": 1009.97626554,
      "indicator": "GWP100a",
      "key": "gwp",
      "method": "CML v4.8 2016",
      "name": "气候变化",
      "num": 1,
      "preUnit": "kg CO2-Eq",
      "state": 1
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.