QueryPageByApplyId - IoT Platform - Centre de documentation Alibaba Cloud

Interroge les informations relatives à plusieurs appareils enregistrés.

Limites

Chaque compte Alibaba Cloud peut exécuter un maximum de 50 requêtes par seconde (QPS).

Remarque

Les utilisateurs RAM d'un compte Alibaba Cloud partagent le quota de ce compte.

Débogage

Alibaba Cloud met à votre disposition OpenAPI Explorer pour simplifier l'utilisation des API. OpenAPI Explorer calcule automatiquement la valeur de la signature. Pour plus de commodité, 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	QueryPageByApplyId	L'opération que vous souhaitez effectuer. Définissez la valeur sur QueryPageByApplyId.
ApplyId	Long	Yes	1295006	L'ID de la demande. Vous pouvez consulter l'ID de la demande dans la réponse de l'opération BatchRegisterDeviceWithApplyId ou BatchRegisterDevice.
IotInstanceId	String	No	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 configurer ce paramètre. Si vous ne le définissez pas, l'appel échouera. Si votre instance ne possède pas de page Overview ou d'ID, il n'est pas nécessaire de définir ce paramètre. Pour plus d'informations, consultez la rubrique Overview.
PageSize	Integer	No	10	Le nombre d'entrées à renvoyer par page. Valeur maximale : 50. Valeur par défaut : 10.
CurrentPage	Integer	No	1	Le numéro de la page à renvoyer. Valeur par défaut : 1.

Outre les paramètres de requête spécifiques à l'opération mentionnés précédemment, 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 Paramètres de requête communs.

Paramètres de réponse

Parameter	Type	Example	Description
ApplyDeviceList	Array of ApplyDeviceInfo		La liste des informations sur les appareils enregistrés renvoyée en cas de succès de l'appel. Le paramètre ApplyDeviceInfo inclut les détails des appareils enregistrés.
ApplyDeviceInfo
DeviceId	String	gQG2GJ2y10m6hIk8****	L'ID de l'appareil (obsolète). Remarque Ce paramètre n'est plus utilisé. Ne l'utilisez pas pour identifier un appareil. Vous pouvez utiliser le paramètre IotId ou une combinaison des paramètres ProductKey et DeviceName pour identifier un appareil.
DeviceName	String	light	Le DeviceName de l'appareil.
DeviceSecret	String	SkfeXXKrTgp1DbDxYr74mfJ5cnui****	Le DeviceSecret de l'appareil.
IotId	String	vWxNur6BUApsqjv9****000100	L'ID de l'appareil. Il s'agit de l'identifiant unique attribué par IoT Platform à l'appareil.
Code	String	iot.system.SystemException	Le code d'erreur renvoyé en cas d'échec de l'appel. Pour plus d'informations, consultez la rubrique Codes d'erreur.
ErrorMessage	String	A system exception occurred.	Le message d'erreur renvoyé en cas d'échec de l'appel.
Page	Integer	1	Le numéro de la page renvoyée.
PageCount	Integer	1	Le nombre total de pages.
PageSize	Integer	10	Le nombre d'entrées renvoyées par page.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	L'ID de la requête.
Success	Boolean	true	Indique si l'appel a réussi. true : L'appel a réussi. false : L'appel a échoué.
Total	Integer	2	Le nombre total d'appareils.

Exemples

Exemple de requête

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryPageByApplyId
&ApplyId=1234567
&PageSize=10
&CurrentPage=1
&<Common request parameters>

Exemple de réponse en cas de succès

Format XML

<QueryPageByApplyIdResponse>
  <PageCount>1</PageCount>
  <ApplyDeviceList>
        <ApplyDeviceInfo>
              <DeviceId>vWxNur6BUApsqjv9****</DeviceId>
              <DeviceName>APItest</DeviceName>
              <DeviceSecret>tXXEtily4XuV7WS1fosJoDkhRIIU****</DeviceSecret>
              <IotId>vWxNur6BUApsqjv****4000100</IotId>
        </ApplyDeviceInfo>
        <ApplyDeviceInfo>
              <DeviceId>hoiwszKPYmHk074H****</DeviceId>
              <DeviceName>awfg</DeviceName>
              <DeviceSecret>BYpg1b2nmuq21BO7fxOogYQQZd9z****</DeviceSecret>
              <IotId>hoiwszKPYmHk074HA****000100</IotId>
        </ApplyDeviceInfo>
  </ApplyDeviceList>
  <Page>1</Page>
  <PageSize>10</PageSize>
  <RequestId>762F7AAD-8B87-4C65-BBF3-4575B002B384</RequestId>
  <Success>true</Success>
  <Total>2</Total>
</QueryPageByApplyIdResponse>

Format JSON

{
    "PageCount": 1,
    "ApplyDeviceList": {
        "ApplyDeviceInfo": [
            {
                "DeviceId": "vWxNur6BUApsqjv9****",
                "DeviceName": "APItest",
                "DeviceSecret": "tXXEtily4XuV7WS1fosJoDkhRIIU****",
                "IotId": "vWxNur6BUApsqjv****4000100"
            },
            {
                "DeviceId": "hoiwszKPYmHk074H****",
                "DeviceName": "awfg",
                "DeviceSecret": "BYpg1b2nmuq21BO7fxOogYQQZd9z****",
                "IotId": "hoiwszKPYmHk074HA****000100"
            }
        ]
    },
    "Page": 1,
    "PageSize": 10,
    "RequestId": "762F7AAD-8B87-4C65-BBF3-4575B002B384",
    "Success": true,
    "Total": 2
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, rendez-vous sur le Centre d'erreurs de l'API.