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

Consulta la información básica de un dispositivo específico. Esta información incluye el ID del dispositivo, el certificado del dispositivo y el alias.

Límites

Cada cuenta de Alibaba Cloud admite un máximo de 500 consultas por segundo (QPS).

Nota

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

Depuración

Alibaba Cloud ofrece OpenAPI Explorer para simplificar el uso de la API. OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, se recomienda llamar a esta operación desde OpenAPI Explorer. Esta herramienta 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í	QueryDeviceInfo	La operación que desea ejecutar. Establezca el valor en QueryDeviceInfo.
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, configure este parámetro. De lo contrario, la llamada fallará. Si su instancia no tiene página de Overview o ID, omita este parámetro. Para obtener más información, consulte Descripción general.
ProductKey	String	No	a1BwAGV****	La ProductKey del producto al que pertenece el dispositivo. Importante Si especifica este parámetro, también debe especificar el parámetro DeviceName.
DeviceName	String	No	light	El DeviceName del dispositivo. Importante Si especifica este parámetro, también debe especificar el parámetro ProductKey.
IotId	String	No	Q7uOhVRdZRRlDnTLv****00100	El ID del dispositivo. Importante Si especifica este parámetro, no necesita especificar ProductKey ni DeviceName. El parámetro IotId define un identificador único global (GUID) del dispositivo, que corresponde a una combinación de ProductKey y DeviceName. Si especifica tanto IotId como la combinación de ProductKey y DeviceName, IotId tendrá prioridad.

Además de los parámetros de solicitud específicos de la operación mencionados anteriormente, especifique los parámetros de solicitud comunes al llamar a esta operación. Para obtener más información, consulte Parámetros de solicitud comunes.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
Code	String	iot.system.SystemException	El código de error devuelto si la llamada falla. Para obtener más información, consulte Códigos de error.
Data	Struct		La información del dispositivo devuelta si la llamada es exitosa.
DeviceName	String	light	El DeviceName del dispositivo.
DeviceSecret	String	mz2Canp4GB7qRVf1OYPNtRqB2anu****	El DeviceSecret del dispositivo.
IotId	String	Q7uOhVRdZRRlDnTLv****00100	El ID del dispositivo. Este ID es el identificador único que IoT Platform asigna al dispositivo.
Nickname	String	detectors_in_beijing	El alias del dispositivo.
ProductKey	String	a1rYuVF****	La ProductKey del producto al que pertenece el dispositivo.
ErrorMessage	String	A system exception occurred.	El mensaje de error devuelto si la llamada falla.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	El ID de la solicitud.
Success	Boolean	true	Indica si la llamada fue exitosa. true: La llamada fue exitosa. false: La llamada falló.

Ejemplos

Solicitudes de ejemplo

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceInfo
&ProductKey=a1rYuVF****
&DeviceName=light
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<QueryDeviceInfoResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <IotId>Q7uOhVRdZRRlDnTLv****00100</IotId>
        <DeviceSecret>mz2Canp4GB7qRVf1OYPNtRqB2anu****</DeviceSecret>
        <ProductKey>a1rYuVF****</ProductKey>
        <Nickname>detectors_in_beijing</Nickname>
        <DeviceName>light</DeviceName>
  </Data>
  <Success>true</Success>
</QueryDeviceInfoResponse>

Formato JSON

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "IotId": "Q7uOhVRdZRRlDnTLv****00100",
        "DeviceSecret": "mz2Canp4GB7qRVf1OYPNtRqB2anu****",
        "ProductKey": "a1rYuVF****",
        "Nickname": "detectors_in_beijing",
        "DeviceName": "light"
    },
    "Success": true
}

Códigos de error

HttpCode	Código de error	Mensaje de error	Descripción
200	Iot.common.QueryDeviceActionError	An error occurred while querying the device.	El mensaje de error devuelto porque el sistema no pudo consultar la información del dispositivo.

Para obtener una lista de códigos de error, visite el Centro de errores de API.