ListDistributedProduct - 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.

Limites QPS

Chaque compte Alibaba Cloud peut appeler cette opération jusqu'à cinq fois par seconde.

Remarque

Les utilisateurs RAM partagent le quota du compte Alibaba Cloud.

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 des exemples de code pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	ListDistributedProduct	Opération à effectuer. Définissez la valeur sur ListDistributedProduct.
CurrentPage	Integer	Oui	1	Numéro de la page à renvoyer. Valeur par défaut : 1.
PageSize	Integer	Oui	5	Nombre d'entrées à renvoyer par page. Valeur maximale : 200.
SourceInstanceId	String	Non	iot-060***	ID de l'instance source à laquelle le produit appartient. ID 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. Pour afficher l'ID d'une instance Enterprise Edition, procédez comme suit : 1. Connectez-vous à la console IoT Platform. Dans la barre de navigation supérieure, sélectionnez la région de l'instance dans la liste déroulante. 2. Sur la page Overview, affichez l'ID de l'instance.
ProductKey	String	Non	a1BwAGV****	ProductKey du produit.
TargetInstanceId	String	Non	iot-cn-6ja***	ID de l'instance de destination vers laquelle le produit est distribué. Pour plus d'informations sur les ID d'instance, consultez la description du paramètre SourceInstanceId.
TargetUid	String	Non	198***	ID du compte Alibaba Cloud propriétaire du produit. Pour obtenir cet ID, connectez-vous à la console IoT Platform, cliquez sur l'image de profil, puis affichez l'account ID sur la page Security Settings.

En plus des paramètres spécifiques à l'opération répertoriés ci-dessus, vous devez également spécifier les paramètres de requête communs. Pour plus d'informations, consultez les Paramètres communs.

Paramètres de réponse

Paramètre	Type	Exemple	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		Liste des produits renvoyée lorsque l'appel réussit. Pour plus d'informations, consultez la section « Info » de cette rubrique.
Info	Array of items		Détails de la distribution du produit.
items
GmtCreate	Long	1581595942	Heure de création de la tâche de distribution.
ProductKey	String	a1BwAGV****	ProductKey du produit.
SourceInstanceId	String	iot-cn-6ja***	ID de l'instance source à laquelle le produit appartient.
SourceInstanceName	String	myproInstance	Nom de l'instance source à laquelle le produit appartient.
SourceRegion	String	cn-shanghai	Région source à laquelle le produit appartient.
SourceUid	String	198***	ID du compte Alibaba Cloud utilisé pour distribuer le produit. La distribution interrégionale et inter-instances n'est prise en charge qu'au sein d'un même compte. La valeur est identique à celle de TargetUid.
TargetAliyunId	String	io****@example.com	Nom du compte Alibaba Cloud vers lequel le produit est distribué.
TargetInstanceId	String	iot-cn-09k***	ID de l'instance de destination vers laquelle le produit est distribué.
TargetInstanceName	String	newinstance	Nom de l'instance de destination vers laquelle le produit est distribué.
TargetRegion	String	cn-shenzhen	Région de destination vers laquelle le produit est distribué.
TargetUid	String	198***	ID du compte Alibaba Cloud vers lequel le produit est distribué. La distribution interrégionale et inter-instances n'est prise en charge qu'au sein d'un même compte. La valeur est identique à celle de TargetUid.
Total	Integer	10	Nombre total de produits 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. Valeurs possibles : true : L'appel a réussi. false : L'appel a échoué.

Exemples

Exemple de requête

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

Exemple de réponse réussie

Format XML

<ListDistributedProductResponse>
  <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>
                    <GmtCreate>1581595942</GmtCreate>
                    <SourceUid>198***</SourceUid>
                    <TargetInstanceName>newinstance</TargetInstanceName>
                    <TargetInstanceId>iot-cn-09k***</TargetInstanceId>
                    <TargetUid>198***</TargetUid>
                    <SourceRegion>cn-shanghai</SourceRegion>
                    <SourceInstanceId>iot-cn-6ja***</SourceInstanceId>
                    <ProductKey>a1BwAGV****</ProductKey>
              </items>
        </Info>
  </Data>
  <Success>true</Success>
</ListDistributedProductResponse>

Format JSON

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

Codes d'erreur

Pour une liste des codes d'erreur, consultez les Codes d'erreur de service.