IsCompleted - Energy Expert - Alibaba Cloud Documentation Center

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

none

*All Resource

*

None

Request syntax

POST /api/v1/carbon/footprint/result/completed 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. Set the value to `1` to request the carbon footprint of a product. Set the value to `5` to request the carbon footprint of a supply chain.	1

Response elements

Element	Type	Description	Example
	object
requestId	string	The ID of the request. Each request has a unique ID that you can use to troubleshoot issues.	83A5A7DD-8974-5769-952E-590A97BEA34E
data	object	The returned data.
modifiedTime	integer	The time when the status was last updated. This is a UNIX timestamp in milliseconds. Example: 1711438780000.	1711438780000
taskKey	string	The unique key of the generation task.	550c2b7b-f2e0-4176-ab0a-53ea4b355721
taskShortResult	string	This parameter is not in use. The value is empty.	null
taskStatus	string	The status of the report generation task. Valid values: `running` (the report is being generated), `success` (the report is generated), and `error` (the report failed to be generated). If the task fails, check and correct the model, and then generate the report again.	running

Examples

Success response

JSON format

{
  "requestId": "83A5A7DD-8974-5769-952E-590A97BEA34E",
  "data": {
    "modifiedTime": 1711438780000,
    "taskKey": "550c2b7b-f2e0-4176-ab0a-53ea4b355721",
    "taskShortResult": "null",
    "taskStatus": "running"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.