GetGwpInventorySummary - Energy Expert - Alibaba Cloud Documentation Center

Operation description

This operation retrieves the total carbon footprint for a specified product ID. It also provides details about the top four contributors to the carbon footprint. You can use this operation to understand the total carbon footprint of a product and identify 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:GetGwpInventorySummary

none

*All Resource

*

None

Request syntax

POST /api/v1/carbon/footprint/result/gwp/inventory/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`: product carbon footprint. `5`: supply chain carbon footprint.	1

Response elements

Element	Type	Description	Example
	object	Schema of Response
requestId	string	The unique ID of the request. Use this ID to troubleshoot issues.	83A5A7DD-8974-5769-952E-590A97BEA34E
data	object	The returned data.
unit	string	The unit of emissions.	tCO₂e/Piece(s)
quantity	number	The quantity.	1.0100
resultGenerateTime	integer	The time when the result was generated. The value is a UNIX timestamp in milliseconds.	1709108026000
items	array<object>	Details of the top four contributors to the carbon footprint.
	object
name	string	The name of the inventory type.	电力清单
unit	string	The unit.	kgCO₂e/Piece(s)
quantity	number	The quantity.	9.9763
percent	string	The percentage.	99.01

Examples

Success response

JSON format

{
  "requestId": "83A5A7DD-8974-5769-952E-590A97BEA34E",
  "data": {
    "unit": "tCO₂e/Piece(s)",
    "quantity": 1.01,
    "resultGenerateTime": 1709108026000,
    "items": [
      {
        "name": "电力清单",
        "unit": "kgCO₂e/Piece(s)",
        "quantity": 9.9763,
        "percent": "99.01"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.