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

Consulta la información de un gateway a partir de los datos de un subdispositivo.

Límites

Cada cuenta de Alibaba Cloud admite un máximo de 50 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 mayor 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í	GetGatewayBySubDevice	La operación que desea ejecutar. Establezca el valor en GetGatewayBySubDevice.
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 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. Nota Si especifica este parámetro, también debe especificar el parámetro DeviceName.
DeviceName	String	No	light	El DeviceName del subdispositivo. Nota Si especifica este parámetro, también debe especificar el parámetro ProductKey.
IotId	String	No	Q7uOhVRdZRRlDnTLv****00100	El ID del subdispositivo. Este ID es un identificador único asignado por IoT Platform al subdispositivo. Nota Si especifica este parámetro, no necesita especificar ProductKey ni DeviceName. El parámetro IotId define un identificador único global (GUID) del dispositivo, equivalente a la 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 específicos de esta operación, debe especificar los parámetros de solicitud comunes. 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		Los detalles del gateway devueltos si la llamada es exitosa.
DeviceName	String	gateway	El DeviceName del gateway.
DeviceSecret	String	dCYdTU3gw5Z77bsHjPk6lPHPVnBT****	El DeviceSecret del gateway.
FirmwareVersion	String	V1.0.1	La versión del firmware del dispositivo.
GmtActive	String	2019-12-18 23:25:30	La hora de activación del gateway en formato GMT, correspondiente a la hora local de la región donde reside el gateway.
GmtCreate	String	2019-12-18 16:58:33	La hora de creación del gateway en formato GMT, correspondiente a la hora local de la región donde reside el gateway.
GmtOnline	String	2020-01-20 17:41:04	La última hora de conexión del gateway en formato GMT, correspondiente a la hora local de la región donde reside el gateway.
IpAddress	String	106..1.**	La dirección IP del gateway.
NodeType	String	1	El tipo de nodo. El valor 1 indica que el dispositivo es un gateway.
ProductKey	String	a1BwAGV****	La ProductKey del producto al que pertenece el gateway.
ProductName	String	LinkIoT	El nombre del producto al que pertenece el gateway.
Status	String	online	El estado del dispositivo gateway. Valores válidos: online: El dispositivo está en línea. offline: El dispositivo está fuera de línea. unactive: El dispositivo no está activado. disable: El dispositivo está deshabilitado.
UtcActive	String	2019-12-18T15:25:30.176Z	La hora de activación del gateway en formato UTC. La hora local se calcula según la zona horaria de la región donde reside el gateway.
UtcCreate	String	2019-12-18T08:58:33.000Z	La hora de creación del gateway en formato UTC. La hora local se calcula según la zona horaria de la región donde reside el gateway.
UtcOnline	String	2020-01-20T09:41:04.879Z	La última hora de conexión del gateway en formato UTC. La hora local se calcula según la zona horaria de la región donde reside el gateway.
iotId	String	WuyjPSDQE1L22z1d****000100	El ID del dispositivo gateway. Es el identificador único asignado por IoT Platform al dispositivo.
region	String	cn-shanghai	La región donde reside el gateway. Corresponde a la región mostrada en la consola de IoT Platform.
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

https://iot.cn-shanghai.aliyuncs.com/?Action=GetGatewayBySubDevice
&ProductKey=a1BwAGV****
&DeviceName=XTzosqEOgxFXKPRgd8zl
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

<GetGatewayBySubDeviceResponse>
  <Data>
        <region>cn-shanghai</region>
        <DeviceName>gateway_04</DeviceName>
        <GmtActive>2019-12-18 23:25:30</GmtActive>
        <ProductKey>a1vL7cp****</ProductKey>
        <IpAddress>106.**.1**.**</IpAddress>
        <GmtCreate>2019-12-18 16:58:33</GmtCreate>
        <UtcCreate>2019-12-18T08:58:33.000Z</UtcCreate>
        <UtcOnline>2020-01-20T09:41:04.879Z</UtcOnline>
        <UtcActive>2019-12-18T15:25:30.176Z</UtcActive>
        <Status>online</Status>
        <NodeType>1</NodeType>
        <GmtOnline>2020-01-20 17:41:04</GmtOnline>
        <ProductName>LinkIoTEdge_Gateway</ProductName>
        <iotId>WuyjPSDQE1L22z1****000100</iotId>
  </Data>
  <RequestId>0377D5A9-BDE1-48C2-96C9-BDC048899186</RequestId>
  <Success>true</Success>
</GetGatewayBySubDeviceResponse>

Formato JSON

{
    "Data": {
        "region": "cn-shanghai",
        "DeviceName": "gateway_04",
        "GmtActive": "2019-12-18 23:25:30",
        "ProductKey": "a1vL7cp****",
        "IpAddress": "106.**.1**.**",
        "GmtCreate": "2019-12-18 16:58:33",
        "UtcCreate": "2019-12-18T08:58:33.000Z",
        "UtcOnline": "2020-01-20T09:41:04.879Z",
        "UtcActive": "2019-12-18T15:25:30.176Z",
        "Status": "online",
        "NodeType": 1,
        "GmtOnline": "2020-01-20 17:41:04",
        "ProductName": "LinkIoTEdge_Gateway",
        "iotId": "WuyjPSDQE1L22z1****000100"
    },
    "RequestId": "0377D5A9-BDE1-48C2-96C9-BDC048899186",
    "Success": true
}

Códigos de error

Para consultar la lista de códigos de error, visite el Centro de errores de API.