BatchImportDevice - IoT Platform: Central de Documentação do Alibaba Cloud

Observações de uso

Antes de adicionar dispositivos a um produto de gateway MQTT, crie o gateway MQTT e o produto associado e obtenha a ProductKey. Para mais informações, consulte Criar um gateway MQTT.

Limites de QPS

Você pode chamar esta operação de API até 10 vezes por segundo por conta.

Nota

Os usuários RAM de uma conta Alibaba Cloud compartilham a cota da conta.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos usar o OpenAPI Explorer para chamar esta operação. A ferramenta gera dinamicamente códigos de exemplo para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	BatchImportDevice	Operação a ser executada. Defina o valor como BatchImportDevice.
ProductKey	String	Sim	a1BwAGV****	ProductKey do produto ao qual o dispositivo pertence. A ProductKey é o identificador exclusivo do produto no IoT Platform. Visualize os produtos no console do IoT Platform ou chame a operação QueryProductList.
DeviceList.N.DeviceName	String	Sim	device1	DeviceName do dispositivo. O DeviceName deve ter de 4 a 32 caracteres e pode conter letras, dígitos, hifens (-), sublinhados (_), arrobas (@), pontos (.) e dois-pontos (:). O DeviceName deve ser exclusivo no produto. Nota Especifique até 10.000 DeviceNames em uma única chamada. Se a quantidade exceder o limite, os nomes adicionais serão descartados.
DeviceList.N.DeviceSecret	String	Sim	b4d43f7******10ba5e5	DeviceSecret do dispositivo. O DeviceSecret deve ter de 1 a 32 caracteres e pode conter letras, dígitos, hifens (-), sublinhados (_), arrobas (@), pontos (.) e dois-pontos (:). Nota Especifique até 10.000 DeviceSecrets em uma única chamada. Se a quantidade exceder o limite, os valores adicionais serão descartados.
DeviceList.N.Sn	String	Não	QC4******001	Número de série (SN) do dispositivo. O SN deve ter de 1 a 64 caracteres e pode conter letras, dígitos e sublinhados (_). Nota Especifique até 10.000 SNs em uma única chamada. Se a quantidade exceder o limite, os valores adicionais serão descartados.
IotInstanceId	String	Não	iot-1n8t****	ID da instância. Encontre o ID na página Overview do console do IoT Platform. Importante Se a instância tiver um ID, especifique-o neste parâmetro. Caso contrário, a chamada falhará. Se não houver página Overview ou ID gerado para a instância, não configure este parâmetro. Para mais informações, consulte Visão geral.

Além dos parâmetros específicos listados acima, especifique também os parâmetros comuns de solicitação ao chamar esta operação. Para mais informações, consulte Parâmetros comuns.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
Code	String	iot.system.SystemException	Código de erro retornado se a chamada falhar. Para mais informações, consulte Códigos de erro.
Data	Struct		Dados retornados quando a chamada é bem-sucedida.
ApplyId	Long	1295006	ID da aplicação (ApplyId) gerado para uma solicitação bem-sucedida.
InvalidDetailList	Array of InvalidDetailList		Detalhes dos dispositivos inválidos retornados caso a chamada falhe.
InvalidDetailList
DeviceName	String	light%	DeviceName do dispositivo.
DeviceSecret	String	^67$	DeviceSecret do dispositivo.
ErrorMsg	String	The device name is illegal.	Mensagem de erro retornada se a chamada falhar.
Sn	String	QC4001#	SN do dispositivo.
InvalidDeviceNameList	List	{ "InvalidDeviceNameList": [ "APT$", "aw" ] }	DeviceNames inválidos retornados em caso de falha na chamada.
InvalidDeviceSecretList	List	{ "InvalidDeviceSecretList": [ "^67$", "1" ] }	DeviceSecrets inválidos retornados em caso de falha na chamada.
InvalidSnList	List	{ "InvalidSnList": [ "" ] }	SNs inválidos retornados em caso de falha na chamada.
RepeatedDeviceNameList	List	{ "RepeatedDeviceNameList": [ "abcd", "asdf" ] }	DeviceNames duplicados retornados se a chamada falhar.
ErrorMessage	String	A system exception occurred.	Mensagem de erro retornada se a chamada falhar.
RequestId	String	E4C0FF92-2A86-41DB-92D3-73B60310D25E	ID da solicitação.
Success	Boolean	true	Indica se a chamada foi bem-sucedida. Valores válidos: true: A chamada foi bem-sucedida. false: A chamada falhou.

Descrição

Exemplos de solicitações

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=BatchImportDevice
&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 de sucesso

Formato XML

<BatchImportDeviceResponse>
  <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
  <Data>
        <ApplyId>1295006</ApplyId>
  </Data>
  <Success>true</Success>
</BatchImportDeviceResponse>

Formato JSON

{
    "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
    "Data": {
        "ApplyId": 1295006
    },
    "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.	A quantidade de DeviceNames especificada na solicitação excede o limite permitido.
400	iot.device.ApplyManyDevicesFailed	An error occurred while creating multiple devices.	Falha ao criar múltiplos dispositivos simultaneamente.
400	iot.device.DeviceNumerExceedTenant	The device total number beyond limit.	O número total de dispositivos ultrapassou o limite.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.