Call this operation to query the processing status and results of registration of multiple devices.
Request Parameters
Parameter | Type | Required | Description |
---|---|---|---|
Action | String | Yes | The operation that you want to perform. Set the value to QueryBatchRegisterDeviceStatus. |
ProductKey | String | Yes | The key of the product that the devices belongs to. |
ApplyId | Long | Yes | The application ID of device registration. Application IDs are in the responses of BatchRegisterDeviceWithApplyId or BatchRegisterDevice requests. |
Response parameters
Parameter | Type | Description |
---|---|---|
RequestId | String | The globally unique ID generated by Alibaba Cloud for the request. |
Success | Boolean | Indicates whether the call is successful. A value of true indicates that the call is successful. A value of false indicates that the call has failed. |
ErrorMessage | String | The error message returned when the call fails. |
Code | String | The error code returned when the call fails. For more information about error codes, see Error codes. |
Data | DeviceApplyStatusInfo | The device registration status and results returned when the call is successful. See the following table DeviceApplyStatusInfo. |
Parameter | Type | Description |
---|---|---|
Status | String | The processing status and result. Values include: CHECK: Verifying the information . CHECK_SUCCESS: The information has been verified. CHECK_FAILED: The formation verification has failed. CREATE: Creating devices. CREATE_SUCCESS: Device registration is successful. CREATE_FAILED: Failed to register any device. |
ValidList | List | A collection of devices that have been successfully registered. The DeviceName of the devices are listed. |
InvalidList | List | A collection of devices that were failed to be registered. |
Examples
Request example
https://iot.cn-shanghai.aliyuncs.com/?Action=QueryBatchRegisterDeviceStatus
&ProductKey=al*********
&ApplyId=4416
&Public Request Parameters
Response sample
-
JSON format
{ "RequestId":"57b144cf-09fc-4916-a272-a62902d5b207", "Success": true, "Data": { "Status": "CREATE_SUCCESS", "ValidList": { "Name": [ ] }, "InvalidList": { "Name": [ ] } } }
-
XML format
<? xml version='1.0' encoding='utf-8'? > <QueryBatchCheckDeviceNamesStatusResponse> <RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId> <Success>true</Success> <Data> <Status>CREATE_SUCCESS</Status> <ValidList/> <InvalidList/> </Data> </QueryBatchCheckDeviceNamesStatusResponse>