GetFootprintList - Energy Expert - Alibaba Cloud Documentation Center

Retrieves a list of product carbon footprints.

Operation description

This operation returns a list of product or supply chain carbon footprints that match the specified criteria. You can specify parameters such as the enterprise code, page number, and page size. The returned list includes information such as the product name and product ID. The product ID is used as an input parameter in other API operations to retrieve the results for the corresponding product.

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

none

*All Resource

*

None

Request syntax

POST /api/v1/carbon/footprint/product/list 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
currentPage	integer	Yes	The paging parameter. This is the page number. The value starts from 1.	1
pageSize	integer	Yes	The page size.	10
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
requestId	string	The request ID. Each request has a unique ID. This helps with troubleshooting.	06DA2909-7736-5738-AA31-ACD617D828F1
data	object	The returned data.
currentPage	integer	The current page number.	1
pageSize	integer	The page size.	10
records	array<object>	A list of product details.
	object	The product information struct.
id	integer	The product ID.	1024
name	string	The product name.	演示产品
authStatus	integer	The enumeration value for the certification status. For more information, see the appendix.	1
amount	number	The product quantity.	100.0000000000000000000000000
checkStartTime	string	The start time of the calculation.	2024/01/01
checkEndTime	string	The end time of the calculation.	2024/01/31
createdBy	string	The creator.	Energy Expert
code	string	The code of the enterprise to which the product belongs.	C-20080808-1
isDemoModel	integer	Indicates whether the model is a demo model. A value of 1 means yes. A value of 0 means no. A true value indicates a system-built demo model.	1
lifeCycle	string	The text description that corresponds to the lifeCycleType. The value can be `cradle-to-gate` or `cradle-to-grave`.	从摇篮到大门
lifeCycleType	integer	A value of 1 indicates cradle-to-gate. A value of 2 indicates cradle-to-grave.	1
type	string	The enumeration value for the product category. For more information, see the appendix.	158-159
unit	string	The enumeration value for the unit. For more information, see the appendix.	1-4
total	integer	The total number of records.	21
totalPage	integer	The total number of pages.	3

Examples

Success response

JSON format

{
  "requestId": "06DA2909-7736-5738-AA31-ACD617D828F1",
  "data": {
    "currentPage": 1,
    "pageSize": 10,
    "records": [
      {
        "id": 1024,
        "name": "演示产品",
        "authStatus": 1,
        "amount": 100,
        "checkStartTime": "2024/01/01",
        "checkEndTime": "2024/01/31",
        "createdBy": "Energy Expert",
        "code": "C-20080808-1",
        "isDemoModel": 1,
        "lifeCycle": "从摇篮到大门",
        "lifeCycleType": 1,
        "type": "158-159",
        "unit": "1-4"
      }
    ],
    "total": 21,
    "totalPage": 3
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.