GetGwpInventoryConstitute - Energy Expert - Alibaba Cloud Documentation Center

Operation description

Retrieves the carbon emission composition analysis for a specified product. The analysis provides a breakdown across two dimensions: by checklist and by type. The results are rendered as a hierarchical list and a pie chart.

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

none

*All Resource

*

None

Request syntax

POST /api/v1/carbon/footprint/result/gwp/inventory/constitute 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	integer	Yes	The product ID.	1024
productType	integer	Yes	The product type. A value of 1 indicates a request for a product carbon footprint. A value of 5 indicates a request for a supply chain carbon footprint.	1

Response elements

Element	Type	Description	Example
	object	Schema of Response
requestId	string	The request ID. Each request has a unique value. You can use this ID to troubleshoot issues.	06DA2909-7736-5738-AA31-ACD617D828F1
data	object	The returned data.
name	string	The meaning of the current hierarchical structure.	总碳排放量
unit	string	The emissions unit.	kgCO₂e/t
carbonEmission	number	The amount of emissions. The value can be positive, negative, or 0. To ensure calculation accuracy, the calculation process retains 24 decimal places. For ease of display and use, truncate the value as needed.	1009.976265540000000000000000000000
byResourceType	array	Aggregated by type. This includes the emission details for each type.
	GwpInventoryConstitute	Used for the 'by type' analysis. This is a two-level nested structure. The top level is Total Carbon Emissions, which is then sorted by checklist type. The byResourceType parameter at the lowest level is empty.
items	array	Organized in a hierarchical structure from the highest level to the lowest level: stage, procedure, and then checklist.
	GwpInventoryConstitute	Used for the 'by checklist' analysis. This is a nested structure organized by stage, procedure, and checklist level. The items parameter at the lowest level is empty.

Examples

Success response

JSON format

{
  "requestId": "06DA2909-7736-5738-AA31-ACD617D828F1",
  "data": {
    "name": "总碳排放量",
    "unit": "kgCO₂e/t",
    "carbonEmission": 1009.97626554,
    "byResourceType": [
      {
        "percent": 100,
        "resourceType": 1,
        "unit": "kgCO₂e/kg",
        "carbonEmission": 1009.97626554,
        "name": "Acquisition of Raw Materials",
        "byResourceType": [
          {
            "name": "Energy",
            "unit": "kgCO₂e/Piece(s)",
            "resourceType": 1,
            "carbonEmission": 1009.97626554,
            "percent": "98.76"
          }
        ],
        "items": [
          {
            "percent": 100,
            "resourceType": 1,
            "unit": "kgCO₂e/kg",
            "carbonEmission": 1009.97626554,
            "name": "Acquisition of Raw Materials",
            "byResourceType": [
              {
                "name": "Energy",
                "unit": "kgCO₂e/Piece(s)",
                "resourceType": 1,
                "carbonEmission": 1009.97626554,
                "percent": "98.76"
              }
            ],
            "items": [
              {
                "percent": 100,
                "resourceType": 1,
                "unit": "kgCO₂e/kg",
                "carbonEmission": 1009.97626554,
                "name": "Acquisition of Raw Materials",
                "byResourceType": [
                  {
                    "name": "Energy",
                    "unit": "kgCO₂e/Piece(s)",
                    "resourceType": 1,
                    "carbonEmission": 1009.97626554,
                    "percent": "98.76"
                  }
                ],
                "items": []
              }
            ]
          }
        ]
      }
    ],
    "items": []
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.