EditProhibitedDevices - Energy Expert - Alibaba Cloud Documentation Center

Edits the list of prohibited devices.

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

none

*All Resource

*

None

Request syntax

POST /api/v1/carbon/hvac/editProhibitedDevices 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	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 number, not the text before the colon.	1
isForbidden	integer	Yes	Specifies whether to disable the device. Valid values: 1 and 0.	1
isUnfavorableArea	integer	No	Specifies whether the device is in an unfavorable area. Valid values: 1 and 0.	1
buildingId	string	No	The building ID.	build_01
floorId	string	No	The floor ID.	floor_01
fenceId	string	No	The fence ID.	fence_01

The `deviceType` and `isForbidden` parameters are required. The `isUnfavorableArea` parameter is optional. Valid values for `deviceType` are `1` (water cooled chiller), `2` (cooling tower), `3` (water pump), `4` (indoor environment), `6` (air handling 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	Id of the request	9bc20a5a-b26b-4c28-922a-7cd10b61f96f
data	boolean	The returned data.	true

Examples

Success response

JSON format

{
  "requestId": "9bc20a5a-b26b-4c28-922a-7cd10b61f96f",
  "data": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.