Crée une tâche de distribution de périphériques. Par défaut, le produit auquel les périphériques appartiennent est distribué.
Remarques sur l'utilisation
Pour distribuer des périphériques, suivez la procédure ci-dessous :
1. Appelez cette opération de manière asynchrone pour créer une tâche de distribution de périphériques et obtenir le paramètre JobId.
2. Utilisez le paramètre JobId comme paramètre de requête et appelez l'opération QueryDeviceDistributeJob à plusieurs reprises pour obtenir le paramètre Status.
Contrôlez la fréquence des appels en fonction de la limite QPS de l'opération QueryDeviceDistributeJob.
La tâche de distribution se termine lorsque le paramètre Status renvoie l'une des valeurs suivantes :
2 : La tâche est terminée. Cette valeur n'indique pas que les périphériques sont distribués. Pour obtenir le résultat de distribution de chaque périphérique, passez à l'étape suivante.
3 : La distribution a été interrompue de manière inattendue. Une fois l'erreur résolue, vous pouvez lancer à nouveau une tâche de distribution de périphériques.
3. Utilisez le paramètre JobId renvoyé à l'étape 1 comme paramètre de requête et appelez l'opération QueryDeviceDistributeDetail pour obtenir le paramètre File, qui contient l'URL du fichier de résultats de distribution.
L'URL du fichier est valide pendant 10 minutes.
4. Téléchargez le résultat de distribution depuis l'URL du fichier. Le paramètre Code indique si un périphérique est distribué. Une valeur de 200 pour le paramètre Code indique une réussite.
En cas d'échec de la distribution, répétez les étapes précédentes pour redistribuer les périphériques.
Limites
Cette opération ne peut être appelée qu'à partir de l'endpoint suivant :
iot.cn-shanghai.aliyuncs.com.La distribution de périphériques entre comptes n'est pas prise en charge.
Chaque compte Alibaba Cloud peut créer au maximum 10 tâches de distribution de produits ou de périphériques. Pour plus d'informations sur la création d'une tâche de distribution de produits, consultez CreateProductDistributeJob.
-
Chaque compte Alibaba Cloud peut effectuer au maximum 2 requêtes par seconde (QPS).
RemarqueLes utilisateurs RAM d'un compte Alibaba Cloud partagent le quota du compte.
Débogage
OpenAPI Explorer calcule automatiquement la valeur de signature. 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 | CreateDeviceDistributeJob |
Opération à effectuer. Définissez la valeur sur CreateDeviceDistributeJob. |
| DeviceName.N | RepeatList | Yes | RepeatList |
Noms des périphériques à distribuer. Vous pouvez spécifier jusqu'à 10 000 noms de périphériques. |
| ProductKey | String | Yes | a1BwAGV**** |
ProductKey du produit auquel le périphérique appartient. |
| SourceInstanceId | String | Yes | iot-060*** |
ID de l'instance source à laquelle le périphérique appartient.
|
| Strategy | Integer | Yes | 0 |
Politique de distribution. Valeur par défaut : 0.
|
| TargetInstanceConfig.N.TargetInstanceId | String | Yes | iot-cn-6ja*** |
Configuration de l'instance de destination vers laquelle le périphérique est distribué. Pour plus d'informations sur les IDs d'instances, consultez la description du paramètre SourceInstanceId.
|
| TargetUid | String | No | 198*** |
ID du compte Alibaba Cloud auquel le périphérique appartient. Pour afficher l'ID du compte, connectez-vous à la console IoT Platform, cliquez sur l'image de profil et accédez à la page Security Settings. Vous devez spécifier au moins l'un des paramètres TargetUid et TargetAliyunId. |
| TargetAliyunId | String | No | io****@example.com |
Compte Alibaba Cloud auquel le périphérique appartient. Pour afficher le compte, connectez-vous à la console IoT Platform, cliquez sur l'image de profil et accédez à la page Security Settings. Vous devez spécifier au moins l'un des paramètres TargetUid et TargetAliyunId. |
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, consultez 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 Codes d'erreur. |
| ErrorMessage | String | A system exception occurred. |
Message d'erreur renvoyé en cas d'échec de l'appel. |
| JobId | String | UbmsMHmkqv0PiAG****010001 |
ID de tâche globalement unique renvoyé en cas de réussite 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.
|
Exemples
Exemples de requêtes
http(s)://iot.cn-shanghai.aliyuncs.com/?Action=CreateDeviceDistributeJob
&DeviceName.1=RepeatList
&ProductKey=a1BwAGV****
&SourceInstanceId=iot-060***
&Strategy=0
&TargetInstanceConfig.1.TargetInstanceId=iot-cn-6ja***
&TargetAliyunId=io****@example.com
&<Common request parameters>Exemples de réponses réussies
Format XML
<CreateDeviceDistributeJobResponse>
<RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
<JobId>UbmsMHmkqv0PiAG****010001</JobId>
<Success>true</Success>
</CreateDeviceDistributeJobResponse>Format JSON
{
"RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
"JobId": "UbmsMHmkqv0PiAG****010001",
"Success": true
}Codes d'erreur
Pour obtenir la liste des codes d'erreur, visitez le Centre d'erreurs API.