Learn the supported API versions, authentication identities, and invocation methods for the Energy Expert OpenAPI.
Alibaba Cloud OpenAPI basics are covered in Use the OpenAPI.
Basic information
Version guide
|
Version number |
Description |
|
Recommended |
Endpoint description
API endpoints are listed in Endpoints. If an API specifies a different endpoint, use that one.
User identity
|
User identity |
Support |
|
Supported |
|
|
RAM user (Recommended) |
Supported |
|
RAM role (Recommended) |
Supported |
API style
Energy Expert API uses the ROA style, one of the OpenAPI styles.
Supported invocation methods
|
Invocation method |
Supported |
Notes |
|
Alibaba Cloud SDK (Recommended) |
Supported |
|
|
Cloud Assistant CLI |
Not supported |
For usage details, see Cloud Assistant CLI. |
|
Resource Orchestration Service |
Not supported |
For usage details, see Resource Orchestration Service. |
|
Terraform |
Not supported |
For usage details, see Terraform. |
For custom integrations, use Custom HTTP encapsulation to build your own requests.
Obtain parameters
Code - Organization code
Log on to Energy Expert. In the left navigation pane, choose Organization, then click a node. The organization code appears in the red box on the right.
API data identifier
Energy Expert uses data items to record activity data from carbon emission sources. Before submitting data through the API, create a data item and configure an API data identifier. The following figure shows this procedure:
Step 1: Click Carbon Emission in the left navigation pane (①).
Step 2: Click Data Management (②).
Step 3: Click the gear icon (③) in the upper-right corner of the Data Management page. In the Data Item Configuration dialog box, find the API Data Identifier column. For example, "electricity" in the preceding figure.
If a data item has no API Data Identifier, click the edit icon in the Actions column (④). In the Edit Data Item dialog box, set Data Ingestion Method to API Entry and enter a custom identifier, as shown below:
To add a new data item, click Add Data Item at the bottom of the dialog box (⑤).
Notes
Use the Alibaba Cloud SDK to integrate the Energy Expert OpenAPI.