GetThingTopo - IoT Platform - Centre de documentation Alibaba Cloud

Limites

Chaque compte Alibaba Cloud peut initier un maximum de 500 requêtes par seconde (QPS).

Remarque

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

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de la requête

Parameter	Type	Required	Example	Description
Action	String	Yes	GetThingTopo	L'opération que vous souhaitez exécuter. Définissez la valeur sur GetThingTopo.
PageNo	Integer	Yes	1	Le numéro de la page à renvoyer.
PageSize	Integer	Yes	10	Le nombre d'entrées à renvoyer sur chaque page. Valeur maximale : 50.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	L'ID de l'instance de service Internet des objets (IoT). Ce paramètre n'est pas requis pour les instances publiques. En revanche, ce paramètre est obligatoire pour les instances Enterprise Edition.
ProductKey	String	No	a1BwAGV****	Le ProductKey du produit auquel appartient l'appareil passerelle. Remarque Si vous spécifiez ce paramètre, vous devez également spécifier le paramètre DeviceName.
DeviceName	String	No	light	Le nom de l'appareil passerelle. Remarque Si vous spécifiez ce paramètre, vous devez également spécifier le paramètre ProductKey.
IotId	String	No	Q7uOhVRdZRRlDnTLv****00100	L'ID de l'appareil passerelle. L'ID est l'identifiant unique émis par IoT Platform pour l'appareil passerelle. Remarque Si vous spécifiez ce paramètre, il n'est pas nécessaire de spécifier les paramètres ProductKey ou DeviceName. Le paramètre IotId spécifie un identifiant unique pour l'appareil et correspond à une combinaison des paramètres ProductKey et DeviceName. Si vous spécifiez le paramètre IotId ainsi qu'une combinaison des paramètres ProductKey et DeviceName simultanément, le paramètre IotId est prioritaire.

Outre les paramètres de requête spécifiques à l'opération précédents, vous devez spécifier les paramètres de requête communs lorsque vous appelez cette opération API. Pour plus d'informations, consultez Paramètres de requête communs.

Paramètres de réponse

Parameter	Type	Example	Description
Code	String	iot.system.SystemException	Le code d'erreur renvoyé en cas d'échec de l'appel. Pour plus d'informations, consultez Codes d'erreur.
Data	Struct		Les données renvoyées en cas de succès de l'appel. Pour plus d'informations, consultez les paramètres suivants.
CurrentPage	Integer	1	Le numéro de la page renvoyée.
List	Array of deviceInfo		Les détails du sous-appareil. Les détails du sous-appareil sont inclus dans le paramètre deviceInfo.
deviceInfo
DeviceName	String	light	Le DeviceName du sous-appareil.
IotId	String	Q7uOhVRdZRRlDnTLv****00100	L'ID du sous-appareil. L'ID est l'identifiant unique émis par IoT Platform pour le sous-appareil.
ProductKey	String	a1BwAGV****	Le ProductKey du produit auquel appartient le sous-appareil.
PageCount	Long	1	Le nombre total de pages renvoyées.
PageSize	Integer	10	Le nombre d'entrées renvoyées sur chaque page.
Total	Long	1	Le nombre total d'entrées renvoyées.
ErrorMessage	String	A system exception occurred.	Le message d'erreur renvoyé en cas d'échec de l'appel.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	L'ID de la requête.
Success	Boolean	true	Indique si l'appel aboutit. true : L'appel aboutit. false : L'appel échoue.

Exemples

Exemples de requêtes

https://iot.cn-shanghai.aliyuncs.com/?Action=GetThingTopo
&ProductKey=a1BwAGV****
&DeviceName=device1
&PageSize=10
&PageNo=1
&<Common request parameters>

Exemples de réponses réussies

XML format

<GetThingTopoResponse>
  <Data>
        <PageCount>1</PageCount>
        <PageSize>2</PageSize>
        <CurrentPage>1</CurrentPage>
        <List>
              <deviceInfo>
                    <DeviceName>APItest</DeviceName>
                    <ProductKey>a1T27vz****</ProductKey>
                    <IotId>vWxNur6BUApsqjv****000100</IotId>
              </deviceInfo>
        </List>
        <Total>1</Total>
  </Data>
  <RequestId>93F05C63-9FD1-4CC8-B0FF-6D6C1A6632D1</RequestId>
  <Success>true</Success>
</GetThingTopoResponse>

JSON format

{
	"Data": {
		"PageCount": 1,
		"PageSize": 2,
		"CurrentPage": 1,
		"List": {
			"deviceInfo": [
				{
					"DeviceName": "APItest",
					"ProductKey": "a1T27vz****",
					"IotId": "vWxNur6BUApsqjv****000100"
				}
			]
		},
		"Total": 1
	},
	"RequestId": "93F05C63-9FD1-4CC8-B0FF-6D6C1A6632D1",
	"Success": true
}

Codes d'erreur

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