GetDeviceList - Energy Expert - Alibaba Cloud Documentation Center

Retrieves the list of devices for an activated site.

Operation description

Queries the data collection devices at a site. If the request is successful, the operation returns device information. Otherwise, the operation returns an empty value.
Excludes virtual meters from the results.
Currently, only the energyexpertexternal.cn-hangzhou.aliyuncs.com endpoint is supported.
To call this operation, your service must be added to the whitelist. To add your service to the whitelist, contact us.

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

list

*All Resource

*

None

Request syntax

GET /api/external/getDeviceList HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
factoryId	string	Yes	The site ID.	pn_95

Response elements

Element	Type	Description	Example
	object	The response schema.
requestId	string	The request ID.	83A5A7DD-8974-5769-952E-590A97BEA34E
data	object	The returned data.
factoryId	string	The site ID.	pn_95
deviceList	array<object>	The list of devices.
	array<object>	The list of devices.
deviceId	string	The device ID.	pn_69873
deviceName	string	The device name.	主变4#
firstTypeName	string	The primary meter type.	电表
secondTypeName	string	The secondary meter type.	关口表
parentDevice	string	The parent device.	pn_6987
info	object	The device information.
magnification	integer	The magnification ratio.	80
pressure	integer	Indicates high or low voltage.	0
pt	integer	The voltage transformation ratio.	80
ct	integer	The current transformation ratio.	1
constKva	integer	The rated capacity, in kVA.	100
httpCode	integer	The HTTP status code.	200
code	string	The status code.	Success
success	boolean	Indicates whether the request was successful.	true
httpCode	integer	The HTTP status code.	200
code	string	The status code.	Success
success	boolean	Indicates whether the request was successful.	true

Examples

Success response

JSON format

{
  "requestId": "83A5A7DD-8974-5769-952E-590A97BEA34E",
  "data": {
    "factoryId": "pn_95",
    "deviceList": [
      {
        "deviceId": "pn_69873",
        "deviceName": "主变4#",
        "firstTypeName": "电表",
        "secondTypeName": "关口表",
        "parentDevice": "pn_6987",
        "info": {
          "magnification": 80,
          "pressure": 0,
          "pt": 80,
          "ct": 1,
          "constKva": 100
        }
      }
    ],
    "httpCode": 200,
    "code": "Success",
    "success": true
  },
  "httpCode": 200,
  "code": "Success",
  "success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	invalidParameter	Invalid parameter values.	Request parameters are incorrect. Please check method entry parameters.
401	notAuthorized	No permissions to call API operations.	No permissions to call API operations.
500	systemError	System error.	System error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.