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

none

*All Resource

*

None

Request syntax

POST /api/v1/carbon/emission/analysis/gas/constitute HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
code	string	Yes	The enterprise code.	C-20240115-3
year	integer	Yes	The year.	2024
moduleType	integer	Yes	The module type.	3
moduleCode	string	No	The module code.	carbonInventory.check.scope_1_direct_ghg_emissions

Response elements

Element	Type	Description	Example
	object	The response struct.
requestId	string	The request ID.	83A5A7DD-8974-5769-952E-590A97BEA34E
data	array<object>	The response data.
	object	The response data structure.
type	integer	The gas type.	1
name	string	The gas name.	CO₂
gasEmissionData	number	The amount of gas emissions.	3.14
carbonEmissionData	number	The carbon emission equivalent.	3.14
ratio	number	The carbon emission ratio. For example, a value of 0.5 indicates 50%.	0.5

Examples

Success response

JSON format

{
  "requestId": "83A5A7DD-8974-5769-952E-590A97BEA34E\n",
  "data": [
    {
      "type": 1,
      "name": "CO₂",
      "gasEmissionData": 3.14,
      "carbonEmissionData": 3.14,
      "ratio": 0.5
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.