SetRunningPlan - Energy Expert - Alibaba Cloud Documentation Center

Sets an execution plan.

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

none

*All Resource

*

None

Request syntax

POST /api/v1/carbon/hvac/setRunningPlan HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body parameters.
factoryId	string	Yes	The factory ID.	***
systemId	string	Yes	The system ID.	system1
pKey	string	No	The source of the call.	ib
seasonMode	integer	No	The season mode. For example, summer or winter.	0
dateType	integer	No	The date type. For example, weekday or holiday.	0
startTime	string	No	The start time of the plan.	2024-07-20
endTime	string	No	The end time of the plan.	2024-07-21
statisticsTime	string	No	The date for which to set the single-day execution plan.	2024-07-31
workingStartTime	string	No	The start time of the target period.	05:00:00
workingEndTime	string	No	The end time of the target period.	05:30:00
earliestStartupTime	string	No	The earliest startup time.	05:00:00
latestShutdownTime	string	No	The latest shutdown time.	05:30:00
minTem	number	No	The minimum target temperature.	2.1
maxTem	number	No	The maximum target temperature.	3.1
maxCarbonDioxide	number	No	The maximum carbon dioxide concentration.	2.1
controlType	integer	No	The control mode. For example, automatic or manual.	0

Response elements

Element	Type	Description	Example
	object	Schema of Response
requestId	string	Id of the request	83A5A7DD-8974-5769-952E-590A97BEA34E
data	boolean	The returned data.	true

Examples

Success response

JSON format

{
  "requestId": "83A5A7DD-8974-5769-952E-590A97BEA34E",
  "data": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.