Verifica em lote os dispositivos importados para uma instância do Standard Enterprise Edition ou para um produto de gateway de nuvem MQTT.
Limites de QPS
Você pode chamar esta operação até 100 vezes por segundo por conta.
Depuração
Parâmetros de solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Exemplo |
Detalhes |
| Action | String | Sim | BatchCheckImportDevice |
A operação que você deseja executar. Defina o valor como BatchCheckImportDevice. |
| ProductKey | String | Sim | a1BwAGV**** |
A ProductKey do produto ao qual os dispositivos pertencem. |
| DeviceList.N.DeviceName | String | Sim | light |
O DeviceName do dispositivo. O DeviceName deve ter entre 4 e 32 caracteres e pode conter letras, dígitos, hifens (-), sublinhados (_), arroba (@), pontos (.) e dois-pontos (:). O DeviceName deve ser único no produto. Nota Você pode especificar até 10.000 DeviceNames em uma única chamada. Se o número de DeviceNames exceder o limite, os DeviceNames excedentes serão descartados. |
| DeviceList.N.DeviceSecret | String | Sim | b4d43f7******10ba5e5 |
O DeviceSecret do dispositivo. O DeviceSecret deve ter entre 1 e 32 caracteres e pode conter letras, dígitos, hifens (-), sublinhados (_), arroba (@), pontos (.) e dois-pontos (:). Nota Você pode especificar até 10.000 DeviceSecrets em uma única chamada. Se o número de DeviceSecrets exceder o limite, os DeviceSecrets excedentes serão descartados. |
| DeviceList.N.Sn | String | Não | QC4******001 |
O número de série (SN) do dispositivo. O SN deve ter entre 1 e 64 caracteres e pode conter letras, dígitos e sublinhados (_). Nota Você pode especificar até 10.000 SNs em uma única chamada. Se o número de SNs exceder o limite, os SNs excedentes serão descartados. |
| IotInstanceId | String | Não | iot-1n8t**** |
O ID da instância. Você pode encontrar o ID na aba Overview no console do IoT Platform. Importante
Para mais informações, consulte Visão geral da instância. |
Além dos parâmetros de solicitação específicos da operação listados acima, você deve especificar parâmetros de solicitação comuns ao chamar esta operação. Para mais informações, consulte Parâmetros comuns.
Parâmetros de resposta
|
Parâmetro |
Tipo |
Exemplo |
Detalhes |
| Code | String | iot.system.SystemException |
O código de erro retornado se a chamada falhar. Para mais informações, consulte Códigos de erro. |
| Data | Struct |
Os dados retornados se a chamada for bem-sucedida, incluindo informações sobre os dispositivos que falharam na verificação. |
|
| InvalidDetailList | Array of InvalidDetailList |
Os dispositivos inválidos. |
|
| DeviceName | String | light% |
O DeviceName do dispositivo. |
| DeviceSecret | String | ^67$ |
O segredo do dispositivo. |
| ErrorMsg | String | The device name is illegal. |
A mensagem de erro retornada se a chamada falhar. |
| Sn | String | QC4001# |
O SN do dispositivo. |
| InvalidDeviceNameList | List | { "InvalidDeviceNameList": [ "APT$", "aw" ] } |
Os DeviceNames inválidos. |
| InvalidDeviceSecretList | List | { "InvalidDeviceSecretList": [ "^67$", "1" ] } |
Os DeviceSecrets inválidos. |
| InvalidSnList | List | { "InvalidSnList": [ "" ] } |
Os SNs de dispositivos inválidos. |
| RepeatedDeviceNameList | List | { "RepeatedDeviceNameList": [ "abcd", "asdf" ] } |
Os DeviceNames duplicados. |
| ErrorMessage | String | A system exception occurred. |
A mensagem de erro retornada se a chamada falhar. |
| RequestId | String | E4C0FF92-2A86-41DB-92D3-73B60310D25E |
O ID da solicitação. |
| Success | Boolean | true |
Indica se a chamada foi bem-sucedida. Valores válidos:
|
Exemplos
Solicitações de exemplo
http(s)://iot.cn-shanghai.aliyuncs.com/?Action=BatchCheckImportDevice
&DeviceList.1.DeviceName=device1
&DeviceList.2.DeviceName=device2
&DeviceList.1.DeviceSecret=b4d43f7******10ba5e5
&DeviceList.2.DeviceSecret=912179******700210b4
&ProductKey=a1BwAGV****
&IotInstanceId=iot-1n8t****
&<Common request parameters>
Exemplos de respostas bem-sucedidas
XML formato
<BatchCheckImportDeviceResponse>
<RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
<Success>true</Success>
</BatchCheckImportDeviceResponse>
JSON formato
{
"RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
"Success": true
}
Códigos de erro
|
HttpCode |
Código de erro |
Mensagem de erro |
Descrição |
| 400 | iot.device.TooManyDeviceNamesPerRequest | The devices you query exceed the maximum number. | O número de DeviceNames especificados na solicitação excede o limite. |
| 400 | iot.device.NoneDeviceNameElement | The DeviceName list is empty. | Nenhum DeviceName foi especificado. |
| 400 | iot.device.InvalidDeviceParams | The request parameters are invalid. | O valor do parâmetro de solicitação é inválido. |
Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.