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

Consulta o status de processamento e o resultado do registro de dispositivos para múltiplos dispositivos.

Limites de QPS

É possível chamar esta operação de API até 30 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. 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	QueryBatchRegisterDeviceStatus	A operação que você deseja executar. Defina o valor como QueryBatchRegisterDeviceStatus.
ApplyId	Long	Sim	1295006	O ID da solicitação. Se a chamada para a operação BatchRegisterDeviceWithApplyId ou BatchRegisterDevice for bem-sucedida, o ID da solicitação será retornado.
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 Caso sua instância possua um ID, especifique-o neste parâmetro. Caso contrário, a chamada falhará. Se nenhuma página Overview ou ID for gerada para sua instância, não é necessário configurar este parâmetro. Para mais informações, consulte Visão geral.

Além dos parâmetros de solicitação específicos da operação anteriores, configure os parâmetros de solicitação comuns ao chamar esta operação. Para obter mais detalhes sobre os parâmetros de solicitação comuns, 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. Nota Os certificados X.509 estão disponíveis apenas para dispositivos na região China (Shanghai). Se seus dispositivos não estiverem na região China (Shanghai), não será possível gerar certificados X.509 para eles e o código de erro iot.device.RegionNotSupportX509 será retornado.
Data	Struct		As informações de status retornadas se a chamada for bem-sucedida.
InvalidDetailList	Array of invalidDetailList		Quando o valor retornado do parâmetro Status for CHECK_FAILED ou CREATE_FAILED, significa que alguns dispositivos não foram criados. O parâmetro InvalidDetailList retorna os detalhes desses dispositivos com falha na criação. Se o valor retornado do parâmetro Status for CHECK_SUCCESS ou CREATE_SUCCESS, todos os dispositivos foram criados. Nesse caso, não há detalhes de dispositivos com falha a serem retornados, e o valor do parâmetro InvalidDetailList será um array vazio.
invalidDetailList
DeviceName	String	light	O DeviceName do dispositivo.
ErrorMsg	String	The nick name is illegal.	A mensagem de erro retornada quando alguns dispositivos não são criados. Nota Múltiplas mensagens de erro são separadas por barras verticais (\|).
NickName	String	Campus light-1	O alias do dispositivo.
InvalidList	List	{ "Name": ["Elec_instrument"] }	Caso o valor retornado do parâmetro Status seja CHECK_FAILED ou CREATE_FAILED, indica que houve falha na criação de alguns dispositivos. O parâmetro InvalidList retorna os DeviceNames desses dispositivos. Quando o valor retornado do parâmetro Status for CHECK_SUCCESS ou CREATE_SUCCESS, todos os dispositivos foram criados com sucesso. Nesta situação, nenhum DeviceName precisa ser retornado e o valor do parâmetro InvalidList será um array vazio.
Status	String	CREATE_SUCCESS	O status e o resultado do processamento. Valores válidos: CHECK: O sistema está verificando os nomes dos dispositivos. CHECK_SUCCESS: Todos os dispositivos no formulário de solicitação foram verificados. CHECK_FAILED: A verificação falhou para todos os dispositivos no formulário de solicitação. CREATE: O sistema está criando os dispositivos. CREATE_SUCCESS: Todos os dispositivos no formulário de solicitação foram criados. Nota Se o tipo de autenticação do produto ao qual os dispositivos pertencem for X.509, todos os dispositivos e os certificados X.509 relacionados serão criados. CREATE_FAILED: Houve falha na criação de alguns dispositivos no formulário de solicitação. Nota Se a criação de um dispositivo ou de um certificado X.509 falhar no lote atual, e o tipo de autenticação for X.509, todos os dispositivos do lote falharão na criação.
ValidList	List	{ "Name": ["light3"] }	Se o valor do Status parâmetro for CHECK_FAILED ou CREATE_FAILED, alguns dispositivos não foram criados. O parâmetro ValidList retorna os DeviceNames dos dispositivos que foram criados com sucesso. Quando o valor do parâmetro Status for CHECK_SUCCESS ou CREATE_SUCCESS, todos os dispositivos foram criados. Nesse cenário, não é necessário retornar DeviceNames, e o valor do parâmetro ValidList será um array vazio.
ErrorMessage	String	A system exception occurred.	A mensagem de erro retornada se a chamada falhar.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	O 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.

Exemplos

Exemplos de solicitações

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

Exemplos de respostas de sucesso

Formato XML

<QueryBatchCheckDeviceNamesStatusResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <Status>CREATE_SUCCESS</Status>
        <InvalidDetailList>
              <invalidDetailList>
                    <ErrorMsg>The nick name is illegal. | The nick name is illegal.</ErrorMsg>
                    <NickName>Campus light-1</NickName>
                    <DeviceName>Elec_instrument</DeviceName>
              </invalidDetailList>
        </InvalidDetailList>
        <ValidList>
              <Name>light3</Name>
        </ValidList>
        <InvalidList>
              <Name>Elec_instrument</Name>
        </InvalidList>
  </Data>
  <Code></Code>
  <Success>true</Success>
</QueryBatchCheckDeviceNamesStatusResponse>

Formato JSON

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "Status": "CREATE_SUCCESS",
        "InvalidDetailList": {
            "invalidDetailList": [{
                "ErrorMsg": "The nick name is illegal. | The nick name is illegal.",
                "NickName": "Campus light-1",
                "DeviceName": "Elec_instrument"
            }]
        },
        "ValidList": {
            "Name": ["light3"]
        },
        "InvalidList": {
            "Name": ["Elec_instrument"]
        }
    },
    "Code": "",
    "Success": true
}

Códigos de erro

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