QueryDeviceDistributeJob - Query device distribution task details - IoT Platform

Remarques sur l'utilisation

Appelez cette opération uniquement via l'endpoint suivant : iot.cn-shanghai.aliyuncs.com.
Chaque compte Alibaba Cloud peut exécuter un maximum de 10 requêtes par seconde (QPS).

Remarque
Les utilisateurs RAM partagent le quota du compte Alibaba Cloud.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'appeler cette opération dans OpenAPI Explorer, qui génère dynamiquement des exemples de code pour différents SDK.

Paramètres de la requête

Parameter

Type

Required

Example

Description

Action

String

Yes

QueryDeviceDistributeJob

Opération à effectuer. Définissez la valeur sur QueryDeviceDistributeJob.

JobId

String

Yes

UbmsMHmkqv0PiAG****010001

ID globalement unique de la tâche de distribution.

Cette opération nécessite également des paramètres communs.

Paramètres de la réponse

Parameter	Type	Example	Description
Code	String	iot.system.SystemException	Code d'erreur renvoyé en cas d'échec de l'appel. Codes d'erreur.
Data	Struct		Informations relatives à la tâche renvoyées en cas de succès.
GmtCreate	Long	1581595942000	Date de création de la tâche.
JobId	String	UbmsMHmkqv0PiAG****010001	ID de la tâche de distribution.
ProductKey	String	a1BwAGV****	ProductKey du produit auquel appartient le périphérique.
SourceInstanceId	String	iot-cn-6ja***	ID de l'instance source.
SourceUid	String	198***	ID du compte Alibaba Cloud.
Status	Integer	1	État de la tâche de distribution. 0 : Initialisation. 1 : En cours. 2 : Terminée. Cela ne garantit pas que tous les produits et périphériques ont été distribués. Pour vérifier les résultats de la distribution, appelez l'opération QueryDeviceDistributeDetail. 3 : Interruption inattendue.
Strategy	Integer	0	Stratégie de distribution. 0 : Distribue les périphériques vers des instances dans une région spécifiée. 1 : Configure les ID d'instance sur plusieurs régions et distribue les périphériques vers les régions les plus proches en fonction des adresses IP des périphériques.
TargetInstanceConfigs	Array of targetInstanceConfigs		ID des instances de destination. Si le paramètre Strategy est défini sur 1, plusieurs ID d'instance sont renvoyés. Si le paramètre Strategy est défini sur 0, un seul ID d'instance est renvoyé.
targetInstanceConfigs
TargetInstanceId	String	iot-cn-6ja***	ID de l'instance de destination.
TargetUid	String	198***	ID du compte Alibaba Cloud.
Total	Integer	5	Nombre total de périphériques dans la tâche.
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 : Réussite. false : Échec.

Exemples

Exemple de requête

http(s)://iot.cn-shanghai.aliyuncs.com/? Action=QueryDeviceDistributeJob
&JobId=UbmsMHmkqv0PiAG****010001
&<Common request parameters>

Exemple de réponse en cas de succès

Format XML

<QueryDeviceDistributeJobResponse>
  <RequestId> E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <Status>1</Status>
        <GmtCreate>1581595942000</GmtCreate>
        <SourceUid>198***</SourceUid>
        <Total>5</Total>
        <Strategy>0</Strategy>
        <TargetUid>198***</TargetUid>
        <SourceInstanceId>iot-cn-6ja***</SourceInstanceId>
        <TargetInstanceConfigs>
              <targetInstanceConfigs>
                    <TargetInstanceId>iot-cn-6ja***</TargetInstanceId>
              </targetInstanceConfigs>
        </TargetInstanceConfigs>
        <ProductKey>a1BwAGV****</ProductKey>
        <JobId>UbmsMHmkqv0PiAG****010001</JobId>
  </Data>
  <Success>true</Success>
</QueryDeviceDistributeJobResponse>

Format JSON

{
    "RequestId": " E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "Status": "1",
        "GmtCreate": "1581595942000",
        "SourceUid": "198***",
        "Total": "5",
        "Strategy": "0",
        "TargetUid": "198***",
        "SourceInstanceId": "iot-cn-6ja***",
        "TargetInstanceConfigs": {
            "targetInstanceConfigs": [{
                "TargetInstanceId": "iot-cn-6ja***"
            }]
        },
        "ProductKey": "a1BwAGV****",
        "JobId": "UbmsMHmkqv0PiAG****010001"
    },
    "Success": "true"
}

Codes d'erreur

Pour consulter les codes d'erreur, rendez-vous sur le Centre d'erreurs de l'API.