Crée plusieurs DeviceNames personnalisés pour un produit. IoT Platform vérifie la validité des DeviceNames.
Notes d'utilisation
Utilisez cette opération conjointement avec l'opération BatchRegisterDeviceWithApplyId pour enregistrer plusieurs appareils dotés de noms uniques sous un produit.
Procédure :
1. Appelez l'opération BatchCheckDeviceNames pour spécifier les noms des appareils à enregistrer. IoT Platform renvoie l'ID d'application indiqué par le paramètre ApplyId. Si l'appel aboutit, une demande de vérification des DeviceNames est soumise. La vérification proprement dite s'effectue de manière asynchrone.
2. Appelez l'opération QueryBatchRegisterDeviceStatus pour consulter le résultat de la définition des noms.
3. Appelez l'opération BatchRegisterDeviceWithApplyId pour enregistrer les appareils.
4. (Facultatif) Appelez l'opération QueryBatchRegisterDeviceStatus pour consulter le résultat de l'enregistrement des appareils.
5. Appelez l'opération QueryPageByApplyId pour afficher les détails des appareils enregistrés simultanément.
Limites
Vous pouvez spécifier jusqu'à 10 000 DeviceNames dans un seul appel.
Limites de QPS
Vous pouvez appeler cette API jusqu'à 10 fois par seconde par compte.
Les utilisateurs RAM d'un compte Alibaba Cloud partagent le quota du compte.
Débogage
Paramètres de requête
Parameter | Type | Required | Example | Description |
Action | String | Yes | BatchCheckDeviceNames | Opération à effectuer. Définissez la valeur sur BatchCheckDeviceNames. |
ProductKey | String | Yes | a1BwAGV**** | Clé ProductKey du produit auquel appartient l'appareil. |
IotInstanceId | String | No | iot-cn-0pp1n8t**** | ID de l'instance IoT. Vous pouvez afficher l'ID de l'instance sur la page Overview de la console IoT Platform. Important
Pour plus d'informations, consultez la rubrique Overview des instances IoT. |
DeviceName.N | RepeatList | No | light | Nom de l'appareil. Le DeviceName doit être unique au sein du produit. Il doit comporter entre 4 et 32 caractères et peut contenir des lettres, des chiffres, des traits d'union (-), des traits de soulignement (_), des signes at (@), des points (.) et des deux-points (:). Spécifiez ce paramètre ou le paramètre DeviceNameList.N.DeviceName. Si vous spécifiez les deux paramètres simultanément, la valeur du paramètre DeviceNameList.N.DeviceName est prioritaire. Remarque Vous pouvez spécifier jusqu'à 10 000 DeviceNames dans un seul appel. Si le nombre de DeviceNames dépasse la limite, les DeviceNames excédentaires sont ignorés. |
DeviceNameList.N.DeviceName | String | No | light1 | Nom de l'appareil. Le DeviceName doit être unique au sein du produit. Il doit comporter entre 4 et 32 caractères et peut contenir des lettres, des chiffres, des traits d'union (-), des traits de soulignement (_), des signes at (@), des points (.) et des deux-points (:). Spécifiez ce paramètre ou le paramètre DeviceName.N. Si vous spécifiez les deux paramètres simultanément, la valeur de ce paramètre est prioritaire. Remarque Vous pouvez spécifier jusqu'à 10 000 DeviceNames dans un seul appel. Si le nombre de DeviceNames dépasse la limite, les DeviceNames excédentaires sont ignorés. |
DeviceNameList.N.DeviceNickname | String | No | Smart light 1 | Alias de l'appareil. L'alias doit comporter entre 4 et 64 caractères et peut contenir des lettres, des chiffres et des traits de soulignement (_). Important Si vous spécifiez ce paramètre, vous devez également spécifier le paramètre DeviceNameList.N.DeviceName. |
Outre les paramètres de requête spécifiques à l'opération précédents, 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 Paramètres 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. |
Data | Struct | Données renvoyées en cas de réussite de l'appel. | |
ApplyId | Long | 1295006 | ID d'application (ApplyId) renvoyé en cas de réussite de l'appel. Lorsque vous appelez l'opération BatchRegisterDeviceWithApplyId pour enregistrer des appareils, vous devez spécifier le paramètre ApplyId. |
InvalidDetailList | Array of InvalidDetailList | Détails des DeviceNames invalides des appareils dont l'enregistrement a échoué. | |
InvalidDetailList | |||
DeviceName | String | light | DeviceName. |
ErrorMsg | String | The device name is illegal. | Messages d'erreur renvoyés lorsque l'enregistrement des appareils échoue. Remarque Plusieurs messages d'erreur sont séparés par des barres verticales (|). |
NickName | String | Smart Light 1 | Alias de l'appareil. |
InvalidDeviceNameList | List | { "InvalidDeviceName": [ "APT$", "aw" ] } | DeviceNames invalides dont l'enregistrement a échoué. |
InvalidDeviceNicknameList | List | { "InvalidDeviceNickname": [ "APT$", "aw" ] } | Alias d'appareil invalides dont l'enregistrement a échoué. |
RepeatedDeviceNameList | List | { "RepeatedDeviceName": [ "APT$", "aw" ] } | DeviceNames en double dont l'enregistrement a échoué. |
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 la requête a abouti. Valeurs possibles :
|
Exemples
Exemples de requêtes
https://iot.cn-shanghai.aliyuncs.com/?Action=BatchCheckDeviceNames
&productKey=a1BwAGV****
&DeviceNameList.1.DeviceName=light1
&DeviceNameList.2.DeviceName=light2
&DeviceNameList.3.DeviceName=light3
&DeviceNameList.3.DeviceNickname=Smart light 3
&<Common request parameters>Exemples de réponses réussies
Format XML
<BatchCheckDeviceNamesResponse>
<Data>
<ApplyId>1234567</ApplyId>
</Data>
<RequestId>E976E36B-6874-4FA4-8BC0-55F9BEC5E2EF</RequestId>
<Success>true</Success>
</BatchCheckDeviceNamesResponse>Format JSON
{
"Data": {
"ApplyId": 1234567
},
"RequestId": "E976E36B-6874-4FA4-8BC0-55F9BEC5E2EF",
"Success": true
}Codes d'erreur
Pour obtenir la liste des codes d'erreur, consultez Codes d'erreur de service .