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

Observações de uso

Para registrar múltiplos dispositivos de uma só vez, utilize um dos métodos abaixo:

Invoque a operação BatchRegisterDevice para gerar DeviceNames aleatórios.
Utilize as operações BatchRegisterDeviceWithApplyId e BatchCheckDeviceNames para definir DeviceNames personalizados. Siga este fluxo:

Execute a operação BatchCheckDeviceNames e especifique os nomes dos dispositivos que deseja registrar. Se os DeviceNames forem válidos, o IoT Platform retorna um ID de aplicação por meio do parâmetro ApplyId. Com esse ApplyId, é possível consultar os resultados da definição de DeviceName, o status do registro e os detalhes dos dispositivos.

Chame a operação QueryBatchRegisterDeviceStatus para verificar o resultado da definição dos nomes.

Envie a solicitação BatchRegisterDeviceWithApplyId para efetuar o registro em lote. Um retorno bem-sucedido indica apenas que a requisição foi aceita; o processamento real do registro leva alguns minutos.

Opcionalmente, invoque a operação QueryBatchRegisterDeviceStatus para checar o resultado final do registro dos dispositivos.

Por fim, utilize a operação QueryPageByApplyId para visualizar os detalhes dos dispositivos registrados em lote.

Limites de QPS

Cada conta Alibaba Cloud suporta até 500 consultas por segundo (QPS).

Nota

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

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	BatchRegisterDeviceWithApplyId	A operação que você deseja executar. Defina o valor como BatchRegisterDeviceWithApplyId.
ApplyId	Long	Sim	1295006	O ID da aplicação. Este ID é retornado pela operação BatchCheckDeviceNames.
ProductKey	String	Sim	a1BwAGV****	O ProductKey do produto ao qual o dispositivo pertence.
IotInstanceId	String	Não	iot_instc_pu***_c-v64********	O ID da instância. Visualize o ID da instância na página Overview no console do IoT Platform. Importante Se sua instância possuir um ID, especifique-o neste parâmetro. Caso contrário, a chamada falhará. Se não houver uma página Overview ou ID gerado para sua instância, não é necessário configurar este parâmetro. Para mais informações, consulte Overview.

Além dos parâmetros específicos descritos acima, é obrigatório especificar os parâmetros comuns de solicitação ao chamar esta operação. Para mais detalhes, consulte Parâmetros comuns de solicitação.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
Code	String	iot.system.SystemException	Código de erro retornado caso a chamada falhe. Para mais informações, consulte Códigos de erro.
Data	Struct		Dados retornados quando a chamada é bem-sucedida. Consulte os parâmetros a seguir para mais detalhes.
ApplyId	Long	1295006	O ID da aplicação.
ErrorMessage	String	A system exception occurred.	Mensagem de erro exibida se a solicitação falhar.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	O ID da solicitação.
Success	Boolean	true	Indica se a chamada foi bem-sucedida. true: A chamada teve sucesso. false: A chamada falhou.

Exemplos

Exemplo de solicitação

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

Exemplo de resposta de sucesso

Formato XML

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

Formato JSON

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

Códigos de erro

Para obter uma lista de códigos de erro, visite o API Error Center.