QueryBatchRegisterDeviceStatus - IoT Platform - Centro de documentación de Alibaba Cloud

Consulta el estado de procesamiento y el resultado del registro de varios dispositivos.

Límites de QPS

Puede invocar esta operación de API hasta 30 veces por segundo por cuenta.

Nota

Los usuarios RAM de una cuenta de Alibaba Cloud comparten la cuota de dicha cuenta.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos invocar esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	QueryBatchRegisterDeviceStatus	La operación que desea ejecutar. Establezca el valor en QueryBatchRegisterDeviceStatus.
ApplyId	Long	Sí	1295006	El ID de la solicitud. Si la invocación de la operación BatchRegisterDeviceWithApplyId o BatchRegisterDevice es exitosa, se devuelve el ID de la solicitud.
ProductKey	String	Sí	a1BwAGV****	La ProductKey del producto al que pertenece el dispositivo.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	El ID de la instancia. Consulte el ID de la instancia en la página Overview de la consola de IoT Platform. Importante Si su instancia tiene un ID, debe especificarlo en este parámetro. De lo contrario, la invocación fallará. Si no se ha generado ninguna página de Overview o ID para su instancia, no necesita configurar este parámetro. Para más información, consulte Descripción general.

Además de los parámetros de solicitud específicos de la operación anteriores, debe configurar los parámetros de solicitud comunes al invocar esta operación. Para obtener más información sobre los parámetros de solicitud comunes, consulte Parámetros comunes.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.system.SystemException	El código de error devuelto si la invocación falla. Para más información, consulte Códigos de error. Nota Los certificados X.509 solo están disponibles para dispositivos en la región China (Shanghai). Si sus dispositivos no residen en la región China (Shanghai), no podrá generar certificados X.509 para ellos y se devolverá el código de error iot.device.RegionNotSupportX509.
Data	Struct		La información de estado devuelta si la invocación es exitosa.
InvalidDetailList	Array of invalidDetailList		Si el valor devuelto del parámetro Status es CHECK_FAILED o CREATE_FAILED, algunos dispositivos no se crearon. El parámetro InvalidDetailList devuelve los detalles de los dispositivos cuya creación falló. Si el valor devuelto del parámetro Status es CHECK_SUCCESS o CREATE_SUCCESS, todos los dispositivos se crearon correctamente. En este caso, no es necesario devolver detalles de dispositivos con errores, y el valor devuelto del parámetro InvalidDetailList es un arreglo vacío.
invalidDetailList
DeviceName	String	light	El DeviceName del dispositivo.
ErrorMsg	String	The nick name is illegal.	El mensaje de error devuelto si algunos dispositivos no se crearon. Nota Varios mensajes de error se separan mediante barras verticales (\|).
NickName	String	Campus light-1	El alias del dispositivo.
InvalidList	List	{ "Name": ["Elec_instrument"] }	Si el valor devuelto del parámetro Status es CHECK_FAILED o CREATE_FAILED, algunos dispositivos no se crearon. El parámetro InvalidList devuelve los DeviceName de los dispositivos cuya creación falló. Si el valor devuelto del parámetro Status es CHECK_SUCCESS o CREATE_SUCCESS, todos los dispositivos se crearon correctamente. En este caso, no es necesario devolver ningún DeviceName, y el valor devuelto del parámetro InvalidList es un arreglo vacío.
Status	String	CREATE_SUCCESS	El estado de procesamiento y el resultado. Valores válidos: CHECK: El sistema está verificando los nombres de los dispositivos. CHECK_SUCCESS: Se verificaron todos los dispositivos del formulario de solicitud. CHECK_FAILED: Falló la verificación de todos los dispositivos del formulario de solicitud. CREATE: El sistema está creando los dispositivos. CREATE_SUCCESS: Se crearon todos los dispositivos del formulario de solicitud. Nota Si el tipo de autenticación del producto al que pertenecen los dispositivos es X.509, se crean todos los dispositivos y los certificados X.509 relacionados. CREATE_FAILED: Falló la creación de algunos dispositivos del formulario de solicitud. Nota Si falla la creación de un dispositivo o de un certificado X.509 en el lote actual cuando el tipo de autenticación es X.509, fallará la creación de todos los dispositivos.
ValidList	List	{ "Name": ["light3"] }	Si el valor del parámetro Status es CHECK_FAILED o CREATE_FAILED, algunos dispositivos no se crearon. El parámetro ValidList devuelve los DeviceName de los dispositivos que sí se crearon. Si el valor del parámetro Status es CHECK_SUCCESS o CREATE_SUCCESS, todos los dispositivos se crearon correctamente. En este caso, no es necesario devolver ningún DeviceName, y el valor devuelto del parámetro ValidList es un arreglo vacío.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto si la invocación falla.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	El ID de la solicitud.
Success	Boolean	true	Indica si la invocación fue exitosa. Valores válidos: true: La invocación fue exitosa. false: La invocación falló.

Ejemplos

Solicitudes de ejemplo

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

Respuestas exitosas de ejemplo

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 error

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.