Etiquetas de dispositivo - IoT Platform - Centro de documentación de Alibaba Cloud

Cierta información del dispositivo, como el proveedor y el modelo, se puede reportar a IoT Platform como etiquetas de dispositivo. También puede consultar y eliminar las etiquetas de un dispositivo. Este tema describe los temas y formatos de datos que se utilizan para enviar, consultar y eliminar etiquetas de dispositivo.

Enviar etiquetas

A continuación se muestran los temas que se utilizan cuando un dispositivo envía solicitudes a IoT Platform y cuando IoT Platform envía respuestas al dispositivo:

Tema de solicitud:/sys/${productKey}/${deviceName}/thing/deviceinfo/update
Tema de respuesta:/sys/${productKey}/${deviceName}/thing/deviceinfo/update_reply

Ejemplo de solicitud en formato Alink JSON:

{
    "id": "123",
    "version": "1.0",
    "sys":{
        "ack":0
    },
    "params":[
        {
            "attrKey": "Temperature",
            "attrValue": "36.8"
        }
    ],
    "method": "thing.deviceinfo.update"
}

Ejemplo de respuesta en formato Alink JSON:

{
    "id": "123",
    "code": 200,
    "data": {}
}

Parámetros

Parámetro	Tipo	Descripción
id	String	El ID del mensaje. Valores válidos: de 0 a 4294967295. Cada ID de mensaje debe ser único para el dispositivo.
version	String	El número de versión del protocolo. Establezca el valor en 1.0.
sys	Object	Parámetros de función extendida. Nota Si utiliza un SDK del lado del dispositivo sin configurar funciones extendidas, este parámetro se omite y se aplican los valores predeterminados.
ack	Integer	Indica si la nube devuelve una respuesta. Campo ubicado bajo sys. 1: Devuelve una respuesta. 0: No se devuelve ninguna respuesta. Importante Thing Specification Language model usage examples. Si no se configura, este parámetro se omite y se devuelve una respuesta de forma predeterminada.
params	Object	Los parámetros de la solicitud. El parámetro attrKey especifica la clave de la etiqueta, y el parámetro attrValue especifica el valor de la etiqueta. El parámetro params puede contener hasta 200 elementos en una matriz.
method	String	El método de la solicitud. Establezca el valor en `thing.deviceinfo.update`.
attrKey	String	La clave de la etiqueta. La clave debe tener entre 1 y 30 caracteres de longitud, y puede contener letras, dígitos, guiones bajos (_), guiones (-), signos de número (#), arrobas (@), signos de porcentaje (%), ampersands (&), asteriscos (*) y puntos (.).
attrValue	String	El valor de la etiqueta. El valor debe tener entre 1 y 128 caracteres de longitud, y puede contener caracteres chinos, letras, dígitos, caracteres japoneses, guiones bajos (_), guiones (-), signos de número (#), arrobas (@), signos de porcentaje (%), ampersands (&), dos puntos (:) y puntos (.). Cada carácter chino o japonés ocupa dos caracteres.
code	Integer	El código de estado HTTP en la respuesta. El valor 200 indica que la solicitud fue exitosa.

Códigos de error

Código de error	Mensaje de error	Descripción
460	request parameter error	Mensaje de error devuelto porque los parámetros de la solicitud no son válidos.
6100	device not found	Mensaje de error devuelto porque el dispositivo no existe.

Consultar etiquetas

Importante

Puede consultar hasta 10 etiquetas a la vez.
Solo puede consultar etiquetas personalizadas. No es posible consultar las etiquetas internas de IoT Platform.
Debe especificar la clave de la etiqueta que desea consultar. Si no especifica una clave de etiqueta, no se devolverán datos.

A continuación se muestran los temas que se utilizan cuando un dispositivo envía solicitudes a IoT Platform y cuando IoT Platform envía respuestas al dispositivo:

Tema de solicitud:/sys/${productKey}/${deviceName}/thing/deviceinfo/get
Tema de respuesta:/sys/${productKey}/${deviceName}/thing/deviceinfo/get_reply

Ejemplo de solicitud en formato Alink JSON:

{
    "id": "123",
    "version": "1.0",
    "params":{ 
        "attrKeys":["attrKey1", "attrKey2", "attrKey3"]
    },
    "method": "thing.deviceinfo.get"
}

Ejemplo de respuesta en formato Alink JSON:

{
    "id": "123",
    "code": 200,
    "data": [
        {
            "attrKey1":"v1"
        },
        {
            "attrKey2":"v2"
        },
        {
            "attrKey3":"v3"
        }
    ]
}

Parámetros

Parámetro	Tipo	Descripción
id	String	El ID del mensaje. Valores válidos: de 0 a 4294967295. Cada ID de mensaje debe ser único para el dispositivo.
version	String	El número de versión del protocolo. Establezca el valor en 1.0.
params	Object	Los parámetros de la solicitud. El parámetro attrKeys especifica las claves de las etiquetas que desea consultar.
attrKeys	JSONArray	Las claves de las etiquetas que desea consultar. Nota Si una clave de etiqueta no es válida, por ejemplo, si está duplicada, se devuelve una excepción. Si una clave de etiqueta no existe, no se devuelven datos. Para obtener más información sobre cómo especificar una etiqueta en formato clave-valor para un dispositivo, consulte Edit device tags.
method	String	El método de la solicitud. Establezca el valor en `thing.deviceinfo.get`.
data	JSONArray	La información devuelta sobre las etiquetas, incluidas sus claves y valores.
code	Integer	El código de estado HTTP en la respuesta. El valor 200 indica que la solicitud fue exitosa.

La siguiente tabla describe los códigos de error.

Código de error	Mensaje de error	Descripción
460	request parameter error	Mensaje de error devuelto porque los parámetros de la solicitud no son válidos. Por ejemplo, el valor del parámetro attrKeys no es una matriz JSON, no se especificaron claves de etiqueta, las claves especificadas están duplicadas o la cantidad de claves supera 10.
429	too many requests	Mensaje de error devuelto porque se activó la limitación debido a un número excesivo de consultas por segundo (QPS). Puede llamar a esta operación de API hasta 50 veces por segundo por cuenta. Nota Los usuarios RAM de una cuenta de Alibaba Cloud comparten la cuota de dicha cuenta.

Eliminar etiquetas

A continuación se muestran los temas que se utilizan cuando un dispositivo envía solicitudes a IoT Platform y cuando IoT Platform envía respuestas al dispositivo:

Tema de solicitud:/sys/${productKey}/${deviceName}/thing/deviceinfo/delete
Tema de respuesta:/sys/${productKey}/${deviceName}/thing/deviceinfo/delete_reply

Ejemplo de solicitud en formato Alink JSON:

{
    "id": "123",
    "version": "1.0",
    "sys":{
        "ack":0
    },
    "params": [
        {
            "attrKey": "Temperature"
        }
    ],
    "method": "thing.deviceinfo.delete"
}

Ejemplo de respuesta en formato Alink JSON:

{
    "id": "123",
    "code": 200,
    "data": {}
}

Parámetros

Parámetro	Tipo	Descripción
id	String	El ID del mensaje. Valores válidos: de 0 a 4294967295. Cada ID de mensaje debe ser único para el dispositivo.
version	String	El número de versión del protocolo. Establezca el valor en 1.0.
sys	Object	Parámetros de función extendida. Nota Si utiliza un SDK del lado del dispositivo sin configurar funciones extendidas, este parámetro se omite y se aplican los valores predeterminados.
ack	Integer	Indica si la nube devuelve una respuesta. Campo ubicado bajo sys. 1: Devuelve una respuesta. 0: No se devuelve ninguna respuesta. Importante Thing Specification Language model usage examples. Si no se configura, este parámetro se omite y se devuelve una respuesta de forma predeterminada.
params	Object	Los parámetros de la solicitud. El parámetro attrKey especifica las claves de las etiquetas que desea eliminar.
method	String	El método de la solicitud. Establezca el valor en `thing.deviceinfo.delete`.
attrKey	String	Las claves de las etiquetas que desea eliminar.
code	Integer	El código de estado HTTP en la respuesta. El valor 200 indica que la solicitud fue exitosa.

Códigos de error

Código de error	Mensaje de error	Descripción
460	request parameter error	Mensaje de error devuelto porque los parámetros de la solicitud no son válidos.
6100	device not found	Mensaje de error devuelto porque el dispositivo no existe.