Registers multiple devices by using an application ID.

Usage notes

You can use one of the following methods to register multiple devices:

  • Call the BatchRegisterDevice operation to generate random device names.
  • Call the BatchRegisterDeviceWithApplyId and BatchCheckDeviceNames operations to specify custom device names.

Procedure:

1. Call the BatchCheckDeviceNames operation and specify the names of devices that you want to register. If these device names are valid, IoT Platform returns an application ID. The ApplyId parameter includes the application ID. You can query the results of device name settings, registration results of devices, and details of devices by application ID.

2. Call the QueryBatchRegisterDeviceStatus operation to view the results of device name settings.

3. Call the BatchRegisterDeviceWithApplyId operation to register multiple devices. The successful result that is returned by this operation indicates that only the batch registration request is submitted. In practice, the registration process takes a few minutes.

4. Optional. Call the QueryBatchRegisterDeviceStatus operation to view the registration results of devices.

5. Call the QueryPageByApplyId operation to view the details of devices that are registered in batches.

Limits

Each Alibaba Cloud account can run a maximum of 500 queries per second (QPS).

Note Resource Access Management (RAM) users of an Alibaba Cloud account share the quota of the account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes BatchRegisterDeviceWithApplyId

The operation that you want to perform. Set the value to BatchRegisterDeviceWithApplyId.

ApplyId Long Yes 1295006

The application ID for devices to be registered. The application ID is returned by calling the BatchCheckDeviceNames operation.

ProductKey String Yes a1BwAGV****

The key of the product to which the devices belongs.

IotInstanceId String No iot_instc_pu****_c*-v64********

The instance ID. This parameter is not required for public instances. However, the parameter is required for the instances that you have purchased.

In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this API operation. For more information, see Common request parameters.

Response parameters

Parameter Type Example Description
Code String iot.system.SystemException

The error code returned if the call fails. For more information, see Error codes.

Data Struct

The data returned if the call succeeds. For more information, see the following parameters.

ApplyId Long 1295006

The application ID.

ErrorMessage String A system exception occurred.

The error message returned if the call fails.

RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

The ID of the request.

Success Boolean true

Indicates whether the call succeeds.

  • true: The call succeeded.
  • false: The call failed.

Examples

Sample requests

https://iot.cn-shanghai.aliyuncs.com/?Action=BatchRegisterDeviceWithApplyId
&ProductKey=alNdd3i****
&ApplyId=1234567
&<Common request parameters>

Sample success responses

XML format

<BatchRegisterDeviceWithApplyIdResponse>
  <Data>
        <ApplyId>1234567</ApplyId>
  </Data>
  <RequestId>82C16DC1-41B5-45F8-9AFD-1FB42448D405</RequestId>
  <Success>true</Success>
</BatchRegisterDeviceWithApplyIdResponse>

JSON format

{
	"Data": {
		"ApplyId": 1234567
	},
	"RequestId": "82C16DC1-41B5-45F8-9AFD-1FB42448D405",
	"Success": true
}

Error codes

For a list of error codes, visit the API Error Center.