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

Observações de uso

Antes de chamar esta operação, verifique se você já criou um gateway MQTT e o produto relacionado, e se obteve a ProductKey do produto.

Limites de QPS

Você pode chamar esta API até 50 vezes por segundo por conta.

Nota

Usuários RAM compartilham a cota da conta Alibaba Cloud.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos que você chame 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	ImportDevice	A operação a ser executada. Defina o valor como ImportDevice.
ProductKey	String	Sim	a1BwAGV****	A ProductKey do produto ao qual o dispositivo pertence.
DeviceName	String	Sim	light	O 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.
DeviceSecret	String	Sim	b4d43f7******10ba5e5	O 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 (:).
Nickname	String	Não	Campus light	O alias do dispositivo. O alias deve ter de 1 a 64 caracteres e pode conter letras, dígitos e sublinhados (_). Nota Se você não especificar este parâmetro, o IoT Platform não gerará um alias para o dispositivo.
Sn	String	Não	QC4******001	O 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 Se você não especificar este parâmetro, o IoT Platform não gerará um SN para o dispositivo.
IotInstanceId	String	Não	iot-1n8t****	O ID da instância. Você encontra o ID na página Overview no console do IoT Platform. Importante Se sua instância tiver um ID, especifique-o. 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 especificar este parâmetro. Para mais informações, consulte Visão geral.

Além dos parâmetros específicos da operação, especifique 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	O código de erro retornado se a chamada falhar. Para mais informações, consulte Códigos de erro.
Data	Struct		As informações do dispositivo retornadas em caso de sucesso na chamada.
DeviceName	String	light	O DeviceName do dispositivo. Importante Mantenha estas informações confidenciais.
DeviceSecret	String	b4d43f7******10ba5e5	O DeviceSecret do dispositivo. Importante Mantenha estas informações confidenciais.
IotId	String	1O4YPNtRqB2anumz2Canp4GB7*****	O ID exclusivo do dispositivo emitido pelo IoT Platform. Importante Mantenha estas informações confidenciais.
Nickname	String	Campus light	O alias do dispositivo. Nota Se você não especificar um alias para o dispositivo, este parâmetro estará vazio.
ProductKey	String	a1BwAGV****	A ProductKey do produto ao qual o dispositivo pertence.
Sn	String	QC4******001	O SN do dispositivo. Nota Se você não especificar um SN para o dispositivo, este parâmetro estará vazio.
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. true: A chamada foi bem-sucedida. false: A chamada falhou.

Exemplos

Exemplos de solicitações

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ImportDevice
&DeviceName=device1
&DeviceSecret=b4d43f7******10ba5e5
&ProductKey=a1BwAGV****
&IotInstanceId=iot-1n8t****
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

<ImportDeviceResponse>
  <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
  <Data>
        <IotId>1O4YPNtRqB2anumz2Canp4GB7*****</IotId>
        <DeviceSecret>b4d43f7******10ba5e5</DeviceSecret>
        <Sn>QC4******001</Sn>
        <ProductKey>a1BwAGV****</ProductKey>
        <Nickname>Campus light</Nickname>
        <DeviceName>light</DeviceName>
  </Data>
  <Success>true</Success>
</ImportDeviceResponse>

Formato JSON

{
    "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
    "Data": {
        "IotId": "1O4YPNtRqB2anumz2Canp4GB7*****",
        "DeviceSecret": "b4d43f7******10ba5e5",
        "Sn": "QC4******001",
        "ProductKey": "a1BwAGV****",
        "Nickname": "Campus light",
        "DeviceName": "light"
    },
    "Success": true
}

Códigos de erro

HttpCode	Código de erro	Mensagem de erro	Descrição
200	iot.device.CreateDeviceFailed	An error occurred while creating the device.	Falha ao criar o dispositivo.
200	iot.device.AlreadyExistedDeviceName	The DeviceName already exists.	O DeviceName especificado já existe no produto.

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