QueryBatchRegisterDeviceStatus - IoT Platform - Centre de documentation Alibaba Cloud

Interroge le statut de traitement et le résultat de l'enregistrement de plusieurs appareils.

Limites de QPS

Vous pouvez appeler cette opération d'API jusqu'à 30 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. Nous vous recommandons d'appeler cette opération dans OpenAPI Explorer pour plus de commodité. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	QueryBatchRegisterDeviceStatus	L'opération à effectuer. Définissez la valeur sur QueryBatchRegisterDeviceStatus.
ApplyId	Long	Oui	1295006	L'ID de la demande. Si l'appel de l'opération BatchRegisterDeviceWithApplyId ou BatchRegisterDevice aboutit, l'ID de la demande est renvoyé.
ProductKey	String	Oui	a1BwAGV****	La ProductKey du produit auquel appartient l'appareil.
IotInstanceId	String	Non	iot_instc_pu***_c-v64********	L'ID de l'instance. Vous pouvez consulter l'ID de l'instance sur la page Overview de la console IoT Platform. Important Si votre instance possède un ID, vous devez spécifier cet ID pour ce paramètre. Sinon, l'appel échoue. Si aucune page Overview ou aucun ID n'est généré pour votre instance, vous n'avez pas besoin de configurer ce paramètre. Pour plus d'informations, consultez Overview.

Outre les paramètres de requête spécifiques à l'opération, vous devez configurer 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

Paramètre	Type	Exemple	Description
Code	String	iot.system.SystemException	Le code d'erreur renvoyé en cas d'échec de l'appel. Pour plus d'informations, consultez Codes d'erreur. Remarque Les certificats X.509 sont disponibles uniquement pour les appareils de la région Chine (Shanghai). Si vos appareils ne se trouvent pas dans la région Chine (Shanghai), vous ne pouvez pas générer de certificats X.509 pour ces appareils et le code d'erreur iot.device.RegionNotSupportX509 est renvoyé.
Data	Struct		Les informations de statut renvoyées en cas de réussite de l'appel.
InvalidDetailList	Array of invalidDetailList		Si la valeur de retour du paramètre Status est CHECK_FAILED ou CREATE_FAILED, la création de certains appareils a échoué. Le paramètre InvalidDetailList renvoie les détails des appareils dont la création a échoué. Si la valeur de retour du paramètre Status est CHECK_SUCCESS ou CREATE_SUCCESS, tous les appareils sont créés. Dans ce cas, aucun détail concernant les appareils ayant échoué n'est renvoyé et la valeur de retour du paramètre InvalidDetailList est un tableau vide.
invalidDetailList
DeviceName	String	light	Le DeviceName de l'appareil.
ErrorMsg	String	The nick name is illegal.	Le message d'erreur renvoyé si la création de certains appareils a échoué. Remarque Plusieurs messages d'erreur sont séparés par des barres verticales (\|).
NickName	String	Campus light-1	L'alias de l'appareil.
InvalidList	List	{ "Name": ["Elec_instrument"] }	Si la valeur de retour du paramètre Status est CHECK_FAILED ou CREATE_FAILED, la création de certains appareils a échoué. Le paramètre InvalidList renvoie les DeviceNames des appareils dont la création a échoué. Si la valeur de retour du paramètre Status est CHECK_SUCCESS ou CREATE_SUCCESS, tous les appareils sont créés. Dans ce cas, aucun DeviceName n'est renvoyé et la valeur de retour du paramètre InvalidList est un tableau vide.
Status	String	CREATE_SUCCESS	Le statut de traitement et le résultat. Valeurs possibles : CHECK : Le système vérifie les noms des appareils. CHECK_SUCCESS : Tous les appareils du formulaire de demande sont vérifiés. CHECK_FAILED : La vérification de tous les appareils du formulaire de demande a échoué. CREATE : Le système crée les appareils. CREATE_SUCCESS : Tous les appareils du formulaire de demande sont créés. Remarque Si le type d'authentification du produit auquel appartiennent les appareils est X.509, tous les appareils et les certificats X.509 associés sont créés. CREATE_FAILED : La création de certains appareils du formulaire de demande a échoué. Remarque Si un appareil ou un certificat X.509 n'a pas pu être créé dans le lot actuel lorsque le type d'authentification est X.509, la création de tous les appareils échoue.
ValidList	List	{ "Name": ["light3"] }	Si la valeur du paramètre Status est CHECK_FAILED ou CREATE_FAILED, la création de certains appareils a échoué. Le paramètre ValidList renvoie les DeviceNames des appareils qui ont été créés. Si la valeur du paramètre Status est CHECK_SUCCESS ou CREATE_SUCCESS, tous les appareils sont créés. Dans ce cas, aucun DeviceName n'est renvoyé et la valeur de retour du paramètre ValidList est un tableau vide.
ErrorMessage	String	A system exception occurred.	Le message d'erreur renvoyé en cas d'échec de l'appel.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	L'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

Exemples de requêtes

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryBatchRegisterDeviceStatus
&ProductKey=a1BwAGV****
&ApplyId=1234567
&<Common request parameters>

Exemples de réponses réussies

XML format

<QueryBatchCheckDeviceNamesStatusResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <Status>CREATE_SUCCESS</Status>
        <InvalidDetailList>
              <invalidDetailList>
                    <ErrorMsg>The nick name is illegal. | The nick name is illegal.</ErrorMsg>
                    <NickName>Campus light-1</NickName>
                    <DeviceName>Elec_instrument</DeviceName>
              </invalidDetailList>
        </InvalidDetailList>
        <ValidList>
              <Name>light3</Name>
        </ValidList>
        <InvalidList>
              <Name>Elec_instrument</Name>
        </InvalidList>
  </Data>
  <Code></Code>
  <Success>true</Success>
</QueryBatchCheckDeviceNamesStatusResponse>

JSON format

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "Status": "CREATE_SUCCESS",
        "InvalidDetailList": {
            "invalidDetailList": [{
                "ErrorMsg": "The nick name is illegal. | The nick name is illegal.",
                "NickName": "Campus light-1",
                "DeviceName": "Elec_instrument"
            }]
        },
        "ValidList": {
            "Name": ["light3"]
        },
        "InvalidList": {
            "Name": ["Elec_instrument"]
        }
    },
    "Code": "",
    "Success": true
}

Codes d'erreur

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