IoTIoT

Compute
Elastic Cloud Server
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
Domain Name Service
VPC Endpoint
Cloud Connect
Enterprise Switch
Security & Compliance
Anti-DDoS
Web Application Firewall
Host Security Service
Data Encryption Workshop
Database Security Service
Advanced Anti-DDoS
Data Security Center
Container Guard Service
Situation Awareness
Managed Threat Detection
Compass
Cloud Certificate Manager
Anti-DDoS Service
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GaussDB NoSQL
GaussDB(for MySQL)
Distributed Database Middleware
GaussDB(for openGauss)
Developer Services
ServiceStage
Distributed Cache Service
Simple Message Notification
Application Performance Management
Application Operations Management
Blockchain Service
API Gateway
Cloud Performance Test Service
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
DevCloud
ProjectMan
CodeHub
CloudRelease
CloudPipeline
CloudBuild
CloudDeploy
Cloud Communications
Message & SMS
Cloud Ecosystem
Marketplace
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP License Service
Support Plans
Customer Operation Capabilities
Partner Support Plans
Professional Services
enterprise-collaboration
Meeting
IoT
IoT
Intelligent EdgeFabric
DeveloperTools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Updated at: Feb 24, 2022 GMT+08:00

Querying a Device Information List

Typical Scenario

If an NA needs to view detailed information (such as the manufacturer, model, version, status, and service attributes) of multiple devices that have been registered with the IoT platform, the NA can call this API to obtain the information.

API Function

This API is used by an NA to query detailed information (such as configuration, status and service attributes) of multiple devices based on specified conditions on the IoT platform.

API Description

1
public function queryBatchDevicesInfo($qbdiInDTO, $accessToken)

Parameter Description

Parameter

Mandatory or Optional

Location

Description

$qbdiInDTO

Mandatory

query

For details, see PostDeviceCommandInDTO structure.

$accessToken

Mandatory

header

This parameter is set to the value of the access token obtained by calling the Authentication API.

PostDeviceCommandInDTO

Parameter

Mandatory or Optional

Location

Description

$appId

Mandatory

query

If the device belongs to the current application, set this parameter to null. Otherwise, set this parameter to the ID of the authorized application.

$gatewayId

Optional

query

Identifies a gateway.

$nodeType

Optional

query

Indicates the node type. The value options are ENDPOINT, GATEWAY, and UNKNOW.

$deviceType

Optional

query

Indicates the device type.

$pageNo

Optional

query

Indicates the page number.

  • If the value is null, pagination query is not performed.
  • If the value is an integer greater than or equal to 0, pagination query is performed.
  • If the value is 0, the first page is queried.

$pageSize

Optional

query

Indicates the number of records on each page. The default value is 1.

$status

Optional

query

Indicates the device status.

  • ONLINE: The device is online.
  • OFFLINE: The device is offline.
  • ABNORMAL: The device is abnormal.

$startTime

Optional

query

Indicates the start time. Records with the device registration time later than the specified start time are queried. The value is in the format of yyyyMMdd'T'HHmmss'Z'. An example value is 20151212T121212Z.

$endTime

Optional

query

Indicates the end time. Records with the device registration time earlier than the specified end time are queried. The value is in the format of yyyyMMdd'T'HHmmss'Z'. An example value is 20151212T121212Z.

$sort

Optional

query

Indicates the sorting mode of queried records.

  • ASC: Records are sorted in ascending order of device registration time.
  • DESC: Records are sorted in descending order of device registration time.

The default value is DESC.

$select

Optional

query

Indicates the record to be returned. The value can be IMSI.

Response Parameters

QueryBatchDevicesInfoOutDTO

Parameter

Description

$totalCount

Indicates the number of queried records.

$pageNo

Indicates the page number.

$pageSize

Indicates the number of records on each page.

$devices

Indicates the device pagination information list. For details, see QuerySingleDeviceInfoOutDTO structure.

QuerySingleDeviceInfoOutDTO structure

Parameter

Description

$deviceId

Identifies a device.

$gatewayId

Identifies a gateway.

$nodeType

Indicates the node type. The value options are ENDPOINT, GATEWAY, and UNKNOW.

$createTime

Indicates the time when the device is created. The value is in the format of yyyyMMdd'T'HHmmss'Z'. An example value is 20151212T121212Z.

$lastModifiedTime

Indicates the last time when the device is modified.

$deviceInfo

Indicates information about the device. For details, see DeviceInfo structure.

$services

Indicates the device service list. For details, see DeviceService structure.

DeviceInfo structure

Parameter

Description

$nodeId

Identifies a device.

$name

Indicates the device name.

$description

Indicates the device description.

$manufacturerId

Uniquely identifies a manufacturer.

$manufacturerName

Indicates the manufacturer name.

$mac

Indicates the MAC address of the device.

$location

Indicates the device location.

$deviceType

Indicates the device type. The upper camel case is used, for example, MultiSensor, ContactSensor, and CameraGateway.

$model

Indicates the device model.

In Z-Wave, the format is productType + productId. The value is a hexadecimal value in the format of XXXX-XXXX. Zeros are added if required, for example, 001A-0A12. The format in other protocols is still to be determined.

$swVersion

Indicates the software version of the device.

In Z-Wave, the format is major version.minor version, for example, 1.1.

$fwVersion

Indicates the firmware version of the device.

$hwVersion

Indicates the hardware version of the device.

$protocolType

Indicates the protocol type used by the device. The value options are CoAP, huaweiM2M, Z-Wave, ONVIF, WPS, Hue, WiFi, J808, Gateway, ZigBee, and LWM2M.

$bridgeId

Identifies the bridge through which the device accesses the IoT platform.

$status

Indicates whether the device is online. The value options are ONLINE, OFFLINE, INBOX, and ABNORMAL.

$statusDetail

Indicates the device status. The specific value is determined by the value of status. For details, see status and statusDetail.

$mute

Indicates whether the device is in the frozen state. Based on the value of this parameter, the IoT platform determines whether to manage and store data reported by the device.

  • TRUE: The device is in the frozen state.
  • FALSE: The device is not in the frozen state.

$supportedSecurity

Indicates whether the security mode is supported.

  • TRUE: The security mode is supported.
  • FALSE: The security mode is not supported.

$isSecurity

Indicates whether the security mode is enabled.

  • TRUE: The security mode is enabled.
  • FALSE: The security mode is disabled.

$signalStrength

Indicates the signal strength of the device.

$sigVersion

Indicates the SIG version of the device.

$serialNumber

Indicates the serial number of the device.

$batteryLevel

Indicates the battery level of the device.

status and statusDetail

$status

$statusDetail

OFFLINE

NONE CONFIGURATION_PENDING

ONLINE

NONE COMMUNICATION_ERROR CONFIGURATION_ERROR BRIDGE_OFFLINE FIRMWARE_UPDATING DUTY_CYCLE NOT_ACTIVE

NOTE:

When the device status information is reported to the IoT platform, status and statusDetail must be included. It is recommended that statusDetail be used only for display but not for logical judgment.

DeviceService structure

Parameter

Description

$serviceId

Identifies a service.

$serviceType

Indicates the service type.

$serviceInfo

Indicates service information of the device. For details, see ServiceInfo structure.

$data

Indicates an attribute value pair.

$eventTime

The value is in the format of yyyyMMdd'T'HHmmss'Z'. An example value is 20151212T121212Z.

ServiceInfo structure

Parameter

Description

$muteCmds

Indicates the device command list.

Error Codes

HTTP Status Code

Error Code

Error Description

Remarks

400

100216

The application input is invalid.

The application input is invalid.

Recommended handling: Check whether parameters in the API request are correct by referring to the request parameter description.

400

100218

The gatewayId and pageNo cannot be both null.

The gatewayId and pageNo parameters cannot be null at the same time.

Recommended handling: Check whether gatewayId or pageNo is set.

400

100405

The request parameter is invalid.

The request message contains invalid parameters.

Recommended handling: Check whether parameters in the API request are correct by referring to the request parameter description.

403

100203

The application is not existed.

The application does not exist.

Recommended handling:

  • Check whether appId carried in the HTTP request header is correct.
  • Check whether appId in the request path (URL) is correct.

403

100217

The application hasn't been authorized.

The application has not been authorized.

Recommended handling: In scenarios where applications are not authorized, ensure that request parameter appId is null.

403

1010009

app throttle exceed.

The NA calls the API at a frequency that exceeds the flow control threshold (100 calls per minute by default).

Recommended handling: Contact IoT platform maintenance personnel to adjust the flow control threshold or control the API call frequency.

403

1010005

App_key or access_token is invalid.

The access token is invalid.

Recommended handling: Check whether accessToken carried in the API request is correct.

500

100203

The application is not existed.

The application does not exist.

Recommended handling:

  • Check whether appId carried in the HTTP request header is correct.
  • Check whether appId in the request path (URL) is correct.

500

50252

Internal server error.

An internal server error occurs.

Recommended handling: An internal error occurs on the IoT platform. Contact IoT platform maintenance personnel.

Did you find this page helpful?

Failed to submit the feedback. Please try again later.

Which of the following issues have you encountered?







Please complete at least one feedback item.

Content most length 200 character

Content is empty.

OK Cancel