EditUnfavorableAreaDevices - Energy Expert - Alibaba Cloud Documentation Center

Edits devices in unfavorable areas.

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

none

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
factoryId	string	Yes	The factory ID.	***
systemId	string	Yes	The site ID.	system1
hvacDeviceConfigVOList	array<object>	Yes	The list of device configurations.
	object	No	The device configuration object.
deviceName	string	No	The device name.	name1
deviceId	string	No	The device ID.	id1
deviceType	string	Yes	The device type. Enter the enumeration value. Valid values: 空调机组 : 6 锅炉 : 7 冷机 : 1 冷却塔 : 2 水泵 : 3 室内环境 : 4	1
isForbidden	integer	No	Specifies whether the device is disabled. Valid values: 1 and 0. Valid values: 不是禁用设备 : 0 是禁用设备 : 1	1
isUnfavorableArea	integer	Yes	Specifies whether the device is in an unfavorable area. Valid values: 1 and 0. Valid values: 是不利区 : 1 不是不利区 : 0	1
buildingId	string	No	The building ID.	buildingId1
floorId	string	No	The floor ID.	floorId2
fenceId	string	No	The fence ID.	fenceId1

The deviceType and isUnfavorableArea parameters are required. Do not specify the isForbidden parameter. Valid values for deviceType are 1 (water cooled chiller), 2 (cooling tower), 3 (water pump), 4 (indoor environment), 6 (air conditioning unit), and 7 (boiler). If deviceType is 1, 2, 3, 6, or 7, the deviceId parameter is required. Do not specify the buildingId, floorId, or fenceId parameters. If deviceType is 4, the buildingId, floorId, and fenceId parameters are required. Do not specify the deviceId or deviceName parameters.

Response elements

Element	Type	Description	Example
	object	Schema of Response
requestId	string	The ID of the request.	83A5A7DD-8974-5769-952E-590A97BEA34E
data	boolean	The returned data. Valid values: 成功 : true 失败 : false	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.