GetAreaElecConstitute - Energy Expert - Alibaba Cloud Documentation Center

Retrieves analytical data for power stations.

Operation description

Retrieves the lowest-level electricity analysis data.
The code parameter specifies the enterprise level for analysis. The analysis is performed on all enterprises at the specified level.

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

none

*All Resource

*

None

Request syntax

POST /api/v1/carbon/emission/analysis/elec/area HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
code	string	Yes	The enterprise code.	Z-20240115-2
year	integer	Yes	The year.	2024

Response elements

Element	Type	Description	Example
	object	The response data structure.
requestId	string	The request ID.	83A5A7DD-8974-5769-952E-590A97BEA34E
data	object	The returned data.
water	array	Data about hydropower consumption and carbon emissions for each enterprise.
	CarbonEmissionElecSummaryItem	The data structure for hydropower consumption and carbon emissions for each enterprise.
light	array	Data about photovoltaic power consumption and carbon emissions for each enterprise.
	CarbonEmissionElecSummaryItem	The data structure for photovoltaic power consumption and carbon emissions for each enterprise.
urban	array	Data about grid power consumption and carbon emissions for each enterprise.
	CarbonEmissionElecSummaryItem	The data structure for grid power consumption and carbon emissions for each enterprise.
wind	array	Data about wind power consumption and carbon emissions for each enterprise.
	CarbonEmissionElecSummaryItem	The data structure for wind power consumption and carbon emissions for each enterprise.
nuclear	array	Data about nuclear power consumption and carbon emissions for each enterprise.
	CarbonEmissionElecSummaryItem	The data structure for nuclear power consumption and carbon emissions for each enterprise.
renewing	array	Data about renewable electricity consumption and carbon emissions for each enterprise.
	CarbonEmissionElecSummaryItem	The data structure for renewable electricity consumption and carbon emissions for each enterprise.
zero	array	Data about zero-carbon electricity consumption and carbon emissions for each enterprise.
	CarbonEmissionElecSummaryItem	The data structure for zero-carbon electricity consumption and carbon emissions for each enterprise.
code	string	The response code. A value of 200 indicates that the request was successful. Other values indicate that the request failed. For more information about an error, see the msg parameter.	200

Examples

Success response

JSON format

{
  "requestId": "83A5A7DD-8974-5769-952E-590A97BEA34E",
  "data": {
    "water": [
      {
        "carbonEmissionData": 1.22,
        "rawData": 1.2,
        "ratio": 0.22,
        "dataUnit": "kg",
        "name": "xxx"
      }
    ],
    "light": [
      {
        "carbonEmissionData": 1.22,
        "rawData": 1.2,
        "ratio": 0.22,
        "dataUnit": "kg",
        "name": "xxx"
      }
    ],
    "urban": [
      {
        "carbonEmissionData": 1.22,
        "rawData": 1.2,
        "ratio": 0.22,
        "dataUnit": "kg",
        "name": "xxx"
      }
    ],
    "wind": [],
    "nuclear": [],
    "renewing": [],
    "zero": []
  },
  "code": "200"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.