GetGatewayBySubDevice - IoT Platform - Centre de documentation Alibaba Cloud

Récupère les informations d'une passerelle à partir des informations d'un sous-dispositif.

Limites

Chaque compte Alibaba Cloud peut effectuer jusqu'à 50 requêtes par seconde (QPS).

Remarque

Les utilisateurs RAM d'un compte Alibaba Cloud partagent le quota de ce compte.

Débogage

Alibaba Cloud met à votre disposition OpenAPI Explorer pour simplifier l'utilisation des API. OpenAPI Explorer calcule automatiquement la valeur de la signature. Nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. L'outil génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	GetGatewayBySubDevice	Opération à effectuer. Définissez la valeur sur GetGatewayBySubDevice.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	ID de l'instance. Vous pouvez consulter l'ID de l'instance sur la page Overview de la console IoT Platform. Important Si votre instance possède un ID, vous devez configurer ce paramètre. À défaut, l'appel échoue. Si votre instance ne possède pas de page Overview ou d'ID, il n'est pas nécessaire de définir ce paramètre. Pour plus d'informations, consultez la rubrique Overview.
ProductKey	String	No	a1BwAGV****	ProductKey du produit auquel appartient le dispositif. Remarque Si vous spécifiez ce paramètre, vous devez également spécifier le paramètre DeviceName.
DeviceName	String	No	light	DeviceName du sous-dispositif. Remarque Si vous spécifiez ce paramètre, vous devez également spécifier le paramètre ProductKey.
IotId	String	No	Q7uOhVRdZRRlDnTLv****00100	ID du sous-dispositif. Il s'agit de l'identifiant unique attribué par IoT Platform au sous-dispositif. Remarque Si vous spécifiez ce paramètre, il n'est pas nécessaire de spécifier les paramètres ProductKey ni DeviceName. Le paramètre IotId correspond à l'identifiant global unique (GUID) du dispositif, qui équivaut à la combinaison des paramètres ProductKey et DeviceName. Si vous spécifiez à la fois le paramètre IotId et la combinaison des paramètres ProductKey et DeviceName, le paramètre IotId est prioritaire.

Outre les paramètres de requête spécifiques à l'opération mentionnés ci-dessus, vous devez spécifier les paramètres de requête communs lors de l'appel à cette opération. Pour plus d'informations, consultez la rubrique Common request parameters.

Paramètres de réponse

Parameter	Type	Example	Description
Code	String	iot.system.SystemException	Code d'erreur renvoyé en cas d'échec de l'appel. Pour plus d'informations, consultez la rubrique Error codes.
Data	Struct		Détails de la passerelle renvoyés en cas de succès de l'appel.
DeviceName	String	gateway	DeviceName de la passerelle.
DeviceSecret	String	dCYdTU3gw5Z77bsHjPk6lPHPVnBT****	DeviceSecret de la passerelle.
FirmwareVersion	String	V1.0.1	Numéro de version du firmware du dispositif.
GmtActive	String	2019-12-18 23:25:30	Heure d'activation de la passerelle. L'heure est affichée au format GMT. Il s'agit de l'heure locale de la région où réside la passerelle.
GmtCreate	String	2019-12-18 16:58:33	Heure de création de la passerelle. L'heure est affichée au format GMT. Il s'agit de l'heure locale de la région où réside la passerelle.
GmtOnline	String	2020-01-20 17:41:04	Dernière heure de connexion de la passerelle. L'heure est affichée au format GMT. Il s'agit de l'heure locale de la région où réside la passerelle.
IpAddress	String	106..1.**	Adresse IP de la passerelle.
NodeType	String	1	Type de nœud. La valeur 1 indique que le dispositif est une passerelle.
ProductKey	String	a1BwAGV****	ProductKey du produit auquel appartient la passerelle.
ProductName	String	LinkIoT	Nom du produit auquel appartient la passerelle.
Status	String	online	État du dispositif de passerelle. Valeurs valides : online : Le dispositif est en ligne. offline : Le dispositif est hors ligne. unactive : Le dispositif n'est pas activé. disable : Le dispositif est désactivé.
UtcActive	String	2019-12-18T15:25:30.176Z	Heure d'activation de la passerelle. L'heure est affichée au format UTC. L'heure réelle de la région où réside la passerelle est calculée en fonction du fuseau horaire de la région.
UtcCreate	String	2019-12-18T08:58:33.000Z	Heure de création de la passerelle. L'heure est affichée au format UTC. L'heure réelle de la région où réside la passerelle est calculée en fonction du fuseau horaire de la région.
UtcOnline	String	2020-01-20T09:41:04.879Z	Dernière heure de connexion de la passerelle. L'heure est affichée au format UTC. L'heure réelle de la région où réside la passerelle est calculée en fonction du fuseau horaire de la région.
iotId	String	WuyjPSDQE1L22z1d****000100	ID du dispositif de passerelle. Il s'agit de l'identifiant unique attribué par IoT Platform au dispositif.
region	String	cn-shanghai	Région où réside la passerelle. Cette région correspond à celle affichée dans la console IoT Platform.
ErrorMessage	String	A system exception occurred.	Message d'erreur renvoyé en cas d'échec de l'appel.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	ID de la requête.
Success	Boolean	true	Indique si l'appel a abouti. true : L'appel a abouti. false : L'appel a échoué.

Exemples

Exemple de requête

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

Exemple de réponse réussie

Format 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>

Format 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
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez le Centre d'erreurs API.