ListDistributedDevice - IoT Platform - Centre de documentation Alibaba Cloud

Notes d'utilisation

Cette opération prend uniquement en charge l'endpoint suivant :iot.cn-shanghai.aliyuncs.com.
Chaque compte Alibaba Cloud est limité à 5 requêtes par seconde (QPS).

Remarque
Les utilisateurs RAM d'un compte Alibaba Cloud partagent le quota de ce compte.
La limite cumulée pour tous les comptes Alibaba Cloud est de 200 QPS.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. Il 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	ListDistributedDevice	Opération à effectuer. Définissez la valeur sur ListDistributedDevice.
CurrentPage	Integer	Yes	1	Numéro de la page à renvoyer. Valeur par défaut : 1.
PageSize	Integer	Yes	5	Nombre d'entrées à renvoyer par page. Valeur maximale : 200.
ProductKey	String	No	a1BwAGV****	ProductKey du produit auquel l'appareil appartient.
DeviceName	String	No	mydevice	DeviceName de l'appareil.
TargetUid	String	No	198***	ID du compte Alibaba Cloud. Pour trouver votre ID de compte, connectez-vous à la console IoT Platform, cliquez sur votre photo de profil et consultez l'Account ID sur la page Security Settings.
SourceInstanceId	String	No	iot-060***	ID de l'instance source à laquelle l'appareil appartient. IDs des instances publiques dans différentes régions : Chine (Shanghai) : iotx-oxssharez200. Japon (Tokyo) : iotx-oxssharez300. Singapour (Singapour) : iotx-oxssharez400. États-Unis (Silicon Valley) : iotx-oxssharez500. États-Unis (Virginie) : iotx-oxssharez600. Allemagne (Francfort) : iotx-oxssharez700. IDs des instances Enterprise Edition : 1. Connectez-vous à la console IoT Platform. Sélectionnez une région dans la liste déroulante en haut à gauche de la barre de navigation supérieure. 2. Sur la page Overview, cliquez sur le nom de l'instance. Sur la page Instance Details, consultez l'ID de l'instance dans la section Basic Information.

Vous devez également spécifier les paramètres de requête communs lors de l'appel à cette opération. Pour plus d'informations, consultez la rubrique sur les paramètres de requête communs.

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 les codes d'erreur.
Data	Struct		Produits renvoyés si l'appel aboutit. Pour plus d'informations, consultez la section Info.
Info	Array of items		Informations relatives à l'appareil.
items
DeviceName	String	mydevice	DeviceName de l'appareil.
GmtCreate	Long	1581595942000	Date de création de la tâche de distribution.
GmtModified	Long	1581595942222	Date de modification de la tâche de distribution.
ProductKey	String	a1BwAGV***	ProductKey du produit auquel l'appareil appartient.
SourceInstanceId	String	iot-cn-6ja***	ID de l'instance source.
SourceInstanceName	String	myproInstance	Nom de l'instance source.
SourceRegion	String	cn-shanghai	Région source de l'appareil.
SourceUid	String	198***	ID du compte Alibaba Cloud qui distribue l'appareil. La distribution d'appareils n'est prise en charge qu'au sein du même compte Alibaba Cloud, entre différentes régions et instances. La valeur de ce paramètre est identique à celle du paramètre TargetUid.
TargetAliyunId	String	io****@example.com	Compte Alibaba Cloud vers lequel l'appareil est distribué.
TargetInstanceId	String	iot-cn-09k***	ID de l'instance de destination.
TargetInstanceName	String	newinstance	Nom de l'instance de destination.
TargetRegion	String	cn-shenzhen	Région de destination vers laquelle l'appareil est distribué.
TargetUid	String	198***	Compte Alibaba Cloud vers lequel l'appareil est distribué. La distribution d'appareils n'est prise en charge qu'au sein du même compte Alibaba Cloud, entre différentes régions et instances. La valeur de ce paramètre est identique à celle du paramètre TargetUid.
Total	Integer	10	Nombre total d'appareils renvoyés.
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 réussi. true : L'appel a réussi. false : L'appel a échoué.

Exemples

Exemple de requête

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=ListDistributedDevice
&CurrentPage=1
&PageSize=5
&TargetUid=198***
&<Common request parameters>

Exemple de réponse réussie

Format XML

<ListDistributedDeviceResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <Total>10</Total>
        <Info>
              <items>
                    <TargetRegion>cn-shenzhen</TargetRegion>
                    <SourceInstanceName>myproInstance</SourceInstanceName>
                    <TargetAliyunId>io****@example.com</TargetAliyunId>
                    <SourceUid>198***</SourceUid>
                    <GmtModified>1581595942222</GmtModified>
                    <TargetInstanceId>iot-cn-09k***</TargetInstanceId>
                    <TargetUid>198***</TargetUid>
                    <SourceRegion>cn-shanghai</SourceRegion>
                    <SourceInstanceId>iot-cn-6ja***</SourceInstanceId>
                    <GmtCreate>1581595942000</GmtCreate>
                    <TargetInstanceName>newinstance</TargetInstanceName>
                    <ProductKey>a1BwAGV***</ProductKey>
                    <DeviceName>mydevice</DeviceName>
              </items>
        </Info>
  </Data>
  <Success>true</Success>
</ListDistributedDeviceResponse>

Format JSON

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "Total": 10,
        "Info": {
            "items": [{
                "TargetRegion": "cn-shenzhen",
                "SourceInstanceName": "myproInstance",
                "TargetAliyunId": "io****@example.com",
                "SourceUid": "198***",
                "GmtModified": 1581595942222,
                "TargetInstanceId": "iot-cn-09k***",
                "TargetUid": "198***",
                "SourceRegion": "cn-shanghai",
                "SourceInstanceId": "iot-cn-6ja***",
                "GmtCreate": 1581595942000,
                "TargetInstanceName": "newinstance",
                "ProductKey": "a1BwAGV***",
                "DeviceName": "mydevice"
            }]
        }
    },
    "Success": true
}

Codes d'erreur

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