QueryJob - IoT Platform - Centre de documentation Alibaba Cloud

Limites QPS

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

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

Parameter	Type	Required	Example	Description
Action	String	Yes	QueryJob	Opération à effectuer. Définissez la valeur sur QueryJob.
JobId	String	Yes	450407b***	ID de la tâche. Cet ID est globalement unique.
IotInstanceId	String	No	iot-cn-0pp1n8t****	ID de l'instance. Vous pouvez consulter l'ID dans l'onglet Overview de la console IoT Platform. Important Si votre instance possède un ID, vous devez le spécifier. Sinon, l'appel échouera. Si aucun onglet Overview ou ID n'est généré pour votre instance, vous n'avez pas besoin de spécifier ce paramètre. Pour plus d'informations sur les instances, consultez la rubrique Overview.

En plus des paramètres de requête spécifiques à l'opération ci-dessus, vous devez spécifier les paramètres de requête communs lors de l'appel à cette opération. Pour plus d'informations, consultez la rubrique 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 la rubrique Error codes.
Data	Struct		Détails de la tâche renvoyés en cas de succès de l'appel. Pour plus d'informations, consultez les paramètres suivants.
Description	String	jobDescription	Description de la tâche.
JobDocument	String	{ "serviceIdentifier": "test_service", "params": { "key1": "value1", "key2": "value2" } }	Fichier de règles à distribuer aux appareils.
JobFile	Struct		Informations de téléchargement du fichier.
FileUrl	String	https://iotx-*.oss-cn-shanghai.aliyuncs.com/job/7u.sh?Expires=16&OSSAccessKeyId=LTA&Signature=TTTejn*	URL de téléchargement du fichier. Valide pendant 30 minutes.
Sign	String	TTTejn***	Signature. Pour les fichiers téléchargés via une URL, la signature est générée selon la méthode de signature spécifiée.
SignMethod	String	SHA256	Méthode de signature. Valeurs possibles : MD5 et SHA256.
JobId	String	450407b***	ID de la tâche. Cet ID est globalement unique.
JobName	String	tes	Nom de la tâche.
RolloutConfig	Struct		Taux de déploiement des sous-tâches dans la tâche.
MaximumPerMinute	Integer	10	Nombre maximal de sous-tâches déployées par minute.
MessageQoS	String	Qos1	Niveau de qualité de service (QoS) des messages. Ce paramètre est disponible uniquement pour les tâches personnalisées et les tâches de distribution de messages par lot. Valeurs possibles : QoS0 : Le système envoie le message une seule fois. QoS1 : Le système envoie le message au moins une fois. Si aucune réponse PUBACK n'est renvoyée après l'envoi d'un message QoS 1, le message est de nouveau envoyé à l'appareil lorsque celui-ci se reconnecte à IoT Platform.
ScheduledTime	Long	1557062301656	Heure de planification de la tâche. Unité : millisecondes.
Status	String	CANCELLED	État de la tâche. Valeurs possibles : INITIALIZING : La tâche est en cours d'initialisation. WAITING : La tâche est en attente de planification. IN_PROGRESS : La tâche est en cours. COMPLETE : La tâche est terminée. CANCELLING: La tâche est en cours d'annulation. CANCELLED : La tâche est annulée. REMOVING : La tâche est en cours de suppression. TIMED_OUT : La tâche a expiré.
TargetConfig	Struct		Configurations d'appareil pour la tâche.
TargetDevices	Array of targetDevices		Appareils.
targetDevices
DeviceName	String	a1Ix***	DeviceName de l'appareil.
ProductKey	String	nCwfSBzc***	ProductKey du produit auquel appartient l'appareil.
TargetGroup	String	1234	ID du groupe d'appareils auquel appartient l'appareil.
TargetProduct	String	nCwfSBzc***	ProductKey du produit auquel appartient l'appareil.
TargetType	String	DEVICE_LIST	Type de configuration d'appareil. Valeurs possibles : DEVICE_LIST : liste des appareils GROUP_ID : ID du groupe d'appareils PRODUCT_KEY : ProductKey du produit
TimeoutConfig	Struct		Configurations de délai d'expiration des sous-tâches dans la tâche.
InProgressTimeoutInMinutes	Integer	5	Délai d'expiration de la sous-tâche. Unité : minutes.
Type	String	SET_PROPERTY	Type de la tâche. Valeurs possibles : INVOKE_SERVICE : tâche d'appel de service par lot. SET_PROPERTY : tâche de configuration de propriété par lot. PUB : tâche de distribution de messages par lot. CUSTOM_JOB : tâche personnalisée.
UtcCreate	String	2020-12-13T04:09:51.000Z	Heure de création de la tâche.
UtcModified	String	2020-12-13T04:10:00.000Z	Heure de la dernière modification de la tâche.
ErrorMessage	String	A system exception occurred.	Message d'erreur renvoyé en cas d'échec de l'appel.
RequestId	String	A6BEAB33-03E6-4CE0-A94F-9E24C5512BAD	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

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryJob
&JobId=XUbmsMHmkqv0PiAG****010001
&<Common request parameters>

Exemple de réponse réussie

Format XML

<QueryJobResponse>
    <RequestId>A6BEAB33-03E6-4CE0-A94F-9E24C5512BAD</RequestId>
    <Data>
            <Status>CANCELLED</Status>
		    <ScheduledTime>1557062301656</ScheduledTime>
            <Type>SET_PROPERTY</Type>
            <TimeoutConfig>
                    <InProgressTimeoutInMinutes>5</InProgressTimeoutInMinutes>
            </TimeoutConfig>
            <Description>jobDescription</Description>
            <UtcCreate>2020-12-13T04:09:51.000Z</UtcCreate>
            <JobFile>
                    <FileUrl>https://iotx-***.oss-cn-shanghai.aliyuncs.com/job***/7u***.sh?Expires=16***&amp;OSSAccessKeyId=LTA***&amp;Signature=TTTejn***</FileUrl>
                    <Sign>1235</Sign>
                    <SignMethod>SHA256</SignMethod>
            </JobFile>
            <JobDocument>{}</JobDocument>
            <JobName>test</JobName>
            <UtcModified>2020-12-13T04:10:00.000Z</UtcModified>
            <JobId>450407b***</JobId>
            <TargetConfig>
                    <TargetDevices>
                            <targetDevices>
                                    <ProductKey>nCwf***</ProductKey>
                                    <DeviceName>a1IxS***</DeviceName>
                            </targetDevices>
                            <targetDevices>
                                    <ProductKey>24VI***</ProductKey>
                                    <DeviceName>a1***</DeviceName>
                            </targetDevices>
                            <targetDevices>
                                    <ProductKey>6NDWQ***</ProductKey>
                                    <DeviceName>a1I***</DeviceName>
                            </targetDevices>
                            <targetDevices>
                                    <ProductKey>EQtTJT***</ProductKey>
                                    <DeviceName>a1IxS***</DeviceName>
                            </targetDevices>
                            <targetDevices>
                                    <ProductKey>rUdc33Vr***</ProductKey>
                                    <DeviceName>a1IxS***</DeviceName>
                            </targetDevices>
                    </TargetDevices>
                    <TargetType>DEVICE_LIST</TargetType>
            </TargetConfig>
    </Data>
    <Success>true</Success>
</QueryJobResponse>

Format JSON

{
    "RequestId": "A6BEAB33-03E6-4CE0-A94F-9E24C5512BAD",
    "Data": {
        "Status": "CANCELLED",
        "ScheduledTime": 1557062301656,
        "Type": "SET_PROPERTY",
        "TimeoutConfig": {
            "InProgressTimeoutInMinutes": 5
        },
        "Description": "jobDescription",
        "UtcCreate": "2020-12-13T04:09:51.000Z",
        "JobFile": {
            "FileUrl": "https://iotx-***.oss-cn-shanghai.aliyuncs.com/job***/7u***.sh?Expires=16***&amp;OSSAccessKeyId=LTA***&amp;Signature=TTTejn***",
            "Sign": "1235",
            "SignMethod": "SHA256"
        },
        "JobDocument": "{}",
        "JobName": "test",
        "UtcModified": "2020-12-13T04:10:00.000Z",
        "JobId": "450407b***",
        "TargetConfig": {
            "TargetDevices": {
                "targetDevices": [
                    {
                        "ProductKey": "nCwf***",
                        "DeviceName": "a1IxS***"
                    },
                    {
                        "ProductKey": "24VI***",
                        "DeviceName": "a1***"
                    },
                    {
                        "ProductKey": "6NDWQ***",
                        "DeviceName": "a1I***"
                    },
                    {
                        "ProductKey": "EQtTJT***",
                        "DeviceName": "a1IxS***"
                    },
                    {
                        "ProductKey": "rUdc33Vr***",
                        "DeviceName": "a1IxS***"
                    }
                ]
            },
            "TargetType": "DEVICE_LIST"
        }
    },
    "Success": true
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez la rubrique Service error codes.