ListDeviceDistributeJob - IoT Platform - Centre de documentation Alibaba Cloud

Notes d'utilisation

Si vous utilisez une instance Enterprise Edition, spécifiez le paramètre IotInstanceId lors de l'appel à cette opération. À défaut, l'appel échoue.

Limites de QPS

Vous pouvez appeler cette opération d'API jusqu'à cinq fois par seconde par compte.

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 requête

Parameter	Type	Required	Example	Description
Action	String	Yes	ListDeviceDistributeJob	Opération à effectuer. Définissez la valeur sur ListDeviceDistributeJob.
PageSize	Integer	Yes	10	Nombre d'entrées à renvoyer par page. Valeurs valides : 1 à 200.
TargetUid	String	No	198***	ID du compte Alibaba Cloud auquel les appareils sont distribués.
CurrentPage	Integer	No	1	Numéro de la page à renvoyer. Valeur par défaut : 1. Le paramètre NextToken ou CurrentPage spécifie une condition d'affichage des résultats. Spécifiez l'un des deux paramètres. Si vous spécifiez les deux paramètres simultanément, le paramètre NextToken est utilisé. Pour plus d'informations sur le paramètre NextToken, consultez sa description.
Status	Integer	No	1	Statut de la tâche de distribution d'appareils. 0 : La tâche est en cours d'initialisation. 1 : La tâche est en cours d'exécution. 2 : La tâche est terminée. Ce statut indique que la tâche de distribution est achevée, mais ne signifie pas que tous les produits et appareils ont été distribués. Pour obtenir les résultats de distribution, appelez l'opération QueryDeviceDistributeDetail. 3 : La tâche a été interrompue de manière inattendue.
JobId	String	No	UbmsMHmkqv0PiAG****010001	ID de la tâche de distribution. Cet ID est globalement unique.
NextToken	String	No	TGlzdFJlc291***	Jeton utilisé pour récupérer les pages suivantes des résultats de requête. Lors de la première exécution d'une opération de requête, il n'est pas nécessaire de spécifier ce paramètre. Le paramètre NextToken ou CurrentPage spécifie une condition d'affichage des résultats. Spécifiez l'un des deux paramètres. Si vous spécifiez les deux paramètres simultanément, le paramètre NextToken est utilisé. Important Le décalage dans le nombre de résultats est obtenu à l'aide de la formule suivante : PageSize × (CurrentPage - 1). Si le décalage est supérieur à 10 000, vous devez utiliser le jeton renvoyé dans la requête précédente comme valeur du paramètre NextToken pour obtenir la valeur du paramètre Data. À défaut, la requête actuelle est interrompue et la valeur du paramètre Data n'est pas renvoyée.
ProductKey	String	No	aw3zse****	ProductKey du produit auquel l'appareil appartient.

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 sur les paramètres de requête communs, consultez Common 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 Error codes.
Data	Struct		Tâches de distribution renvoyées en cas de succès de l'appel. Pour plus d'informations, consultez le paramètre JobInfo.
JobInfo	Array of items		Informations relatives à la tâche.
items
GmtCreate	Long	1581595942000	Heure de création de la tâche.
JobId	String	UbmsMHmkqv0PiAG****010001	ID de la tâche.
ProductKey	String	a1BwAGV****	ProductKey du produit auquel l'appareil appartient.
SourceInstanceId	String	iot-cn-6ja***	ID de l'instance source.
SourceInstanceName	String	Instance Debug 1	Nom de l'instance source.
SourceRegion	String	cn-shanghai	Région où réside l'instance source.
SourceUid	String	198***	ID du compte Alibaba Cloud source.
Status	Integer	1	Statut de la tâche. 0 : La tâche est en cours d'initialisation. 1 : La tâche est en cours d'exécution. 2 : La tâche est terminée. Ce statut indique que la tâche de distribution est achevée, mais ne signifie pas que tous les produits et appareils ont été distribués. Pour obtenir les résultats de distribution, appelez l'opération QueryDeviceDistributeDetail. 3 : La tâche a été interrompue de manière inattendue.
Strategy	Integer	0	Politique de distribution. 0 : distribue les appareils vers des instances spécifiées dans une région spécifiée. Il s'agit de la valeur par défaut. 1 : configure les ID d'instance dans plusieurs régions et distribue les appareils vers les régions les plus proches en fonction des adresses IP des appareils.
TargetInstanceConfigs	Array of targetInstanceConfigs		ID des instances de destination. Si la valeur du paramètre Strategy est 1, plusieurs ID d'instance existent. Si la valeur du paramètre Strategy est 0, un seul ID d'instance existe.
targetInstanceConfigs
TargetInstanceId	String	iot-cn-6ja***	ID de l'instance de destination.
TargetInstanceName	String	Instance Debug 2	Nom de l'instance de destination.
TargetRegion	String	cn-shanghai	Région où réside l'instance de destination.
TargetUid	String	198***	ID du compte Alibaba Cloud de destination.
Total	Integer	5	Nombre total d'appareils dans la tâche de distribution.
NextToken	String	TGlzdFJlc291***	Jeton utilisé pour récupérer les pages suivantes des résultats de requête. La valeur de ce paramètre peut être utilisée dans la requête suivante pour obtenir les pages de résultats suivantes. Si la valeur renvoyée est vide, aucune page suivante n'existe.
Total	Integer	10	Nombre total de tâches de distribution d'appareils.
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 valides : true : L'appel a réussi. false : L'appel a échoué.

Exemples

Exemples de requêtes

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

Exemples de réponses réussies

XML format

<ListDeviceDistributeJobResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <NextToken>TGlzdFJlc291***</NextToken>
        <Total>10</Total>
        <JobInfo>
              <items>
                    <Status>1</Status>
                    <SourceInstanceName> Instance Debug 1</SourceInstanceName>
                    <GmtCreate>1581595942000</GmtCreate>
                    <SourceUid>198***</SourceUid>
                    <Total>5</Total>
                    <Strategy>0</Strategy>
                    <TargetUid>198***</TargetUid>
                    <SourceRegion>cn-shanghai</SourceRegion>
                    <SourceInstanceId>iot-cn-6ja***</SourceInstanceId>
                    <ProductKey>a1BwAGV****</ProductKey>
                    <JobId>UbmsMHmkqv0PiAG****010001</JobId>
                    <TargetInstanceConfigs>
                          <targetInstanceConfigs>
                                <TargetRegion>cn-shanghai</TargetRegion>
                                <TargetInstanceName> Instance Debug 2</TargetInstanceName>
                                <TargetInstanceId>iot-cn-6ja***</TargetInstanceId>
                          </targetInstanceConfigs>
                    </TargetInstanceConfigs>
              </items>
        </JobInfo>
  </Data>
  <Success>true</Success>
</ListDeviceDistributeJobResponse>

JSON format

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "NextToken":"TGlzdFJlc291***",
        "Total": 10,
        "JobInfo": {
            "items": {
                "Status": 1,
                "SourceInstanceName": "Instance Debug 1",
                "GmtCreate": 1581595942000,
                "SourceUid": "198***",
                "Total": 5,
                "Strategy": 0,
                "TargetUid": "198***",
                "SourceRegion": "cn-shanghai",
                "SourceInstanceId": "iot-cn-6ja***",
                "ProductKey": "a1BwAGV****",
                "JobId": "UbmsMHmkqv0PiAG****010001",
                "TargetInstanceConfigs": {
                    "targetInstanceConfigs": {
                        "TargetRegion": "cn-shanghai",
                        "TargetInstanceName": "Instance Debug 2",
                        "TargetInstanceId": "iot-cn-6ja***"
                    }
                }
            }
        }
    },
    "Success": true
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez Codes d'erreur de service.