IoT Platform:QueryDeviceBySQL

Description

• L'interrogation des appareils sur les instances Enterprise Edition est uniquement disponible dans les régions Chine (Shanghai),Japon (Tokyo)

  , Chine du Nord 2 (Pékin) et Chine du Sud 1 (Shenzhen).

• L'opération QueryDeviceBySQL renvoie jusqu'à 10 000 appareils par appel. Pour plus d'informations, consultez la section « Syntax of LIMIT clauses » de cette rubrique.

Limites de QPS

Vous pouvez appeler cette opération API jusqu'à 10 fois par seconde par compte.

Paramètres de requête

Pour appeler l'opération QueryDeviceBySQL afin d'interroger des appareils, vous devez spécifier une instruction de type SQL. Cette instruction doit contenir une clause SELECT et une clause WHERE. Elle peut également inclure une clause ORDER BY et une clause LIMIT. La longueur de chaque instruction ne doit pas dépasser 400 caractères.

Exemples :

SELECT FROM device WHERE product_key = "a1****" order by active_time limit 0,10

|

Clauses SELECT

| SELECT [field]/[count(*)] FROM device

Le paramètre field spécifie les champs à obtenir. Le tableau suivant décrit ces champs. Pour obtenir tous les champs, spécifiez un astérisque (*).

Pour obtenir le nombre de lignes correspondant aux conditions spécifiées, indiquez count(*).

|

|

Clauses WHERE

| WHERE [condition1] AND [condition2]

Vous pouvez spécifier jusqu'à cinq conditions. L'imbrication n'est pas prise en charge. Le tableau suivant décrit les champs et les opérateurs.

Utilisez l'opérateur logique AND ou OR pour connecter les conditions. Vous pouvez utiliser jusqu'à cinq opérateurs logiques.

|

|

Clauses ORDER BY (facultatif)

|

La clause ORDER BY permet de trier les champs. Les champs suivants peuvent être triés : gmt_create, gmt_modified et active_time.

Cette clause est facultative. Si vous ne la spécifiez pas, les résultats sont triés de manière aléatoire.

|

|

Clauses LIMIT (facultatif)

|

La clause LIMIT spécifie le nombre maximal de lignes à renvoyer par page et le nombre total de lignes à renvoyer. Pour plus d'informations, consultez la section « Syntax of LIMIT clauses » de cette rubrique.

Si vous ne spécifiez pas de clause LIMIT, la valeur limit 20 est appliquée par défaut.

|

Syntaxe des clauses LIMIT

|

limit k

|

La valeur de k doit être inférieure ou égale à 50, ce qui signifie que le nombre de lignes renvoyées par page ne peut pas dépasser 50. Exemples :

SELECT * FROM device WHERE product_key = "a1*****" limit 10 |

|

limit n,k

|

La somme des valeurs de n et de k doit être inférieure ou égale à 10 000, et la valeur de k doit être inférieure ou égale à 50. Cela signifie que le nombre total de lignes renvoyées ne peut pas dépasser 10 000 et que le nombre maximal de lignes renvoyées par page ne peut pas dépasser 50. Exemples :

SELECT * FROM device WHERE product_key = "a1*****" limit 40,10 |

Champs

Opérateurs

|

=

|

number, date et text

|

|

!=

|

number, date et text

|

|

>

|

number et date

|

|

<

|

number et date

|

|

LIKE

|

text

|

Description :

• = et != : si vous utilisez ces opérateurs, les valeurs des champs que vous souhaitez interroger peuvent être nulles.

• LIKE : si vous utilisez cet opérateur, seule la correspondance de préfixe est prise en charge. Le préfixe doit comporter au moins quatre caractères et ne peut pas contenir de caractères spéciaux, tels que les barres obliques inverses (\), les barres obliques (/), les esperluettes (&), les signes plus (+), les traits d'union (-), les points d'exclamation (!), les parenthèses (), les deux-points (:), les tildes (~), les accolades {}, les astérisques (*) et les points d'interrogation (?). Le préfixe doit se terminer par un signe pourcentage (%).

  Exemple : SELECT * FROM device where product_key = "a1*********" and name LIKE "test%" limit 10.

Outre les paramètres de requête spécifiques à l'opération mentionnés ci-dessus, vous devez configurer les paramètres de requête communs lors de l'appel de cette opération. Pour plus d'informations sur les paramètres de requête communs, consultez Common parameters.

Paramètres de réponse

Exemples

Exemple de requête

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceBySQL
&IotInstanceId=iot-cn-0pp1n8t****
&SQL=SELECT * FROM device where product_key = "a1*********" limit 100, 20
&<Common request parameters>

Exemple de réponse réussie

Format XML

<QueryDeviceBySQLResponse>
  <RequestId>501CFABA-2C48-468D-B88C-3AA8E3B3A8F3</RequestId>
  <Data>
        <Status>OFFLINE</Status>
        <IotId>ii1*******</IotId>
        <GmtCreate>2020-04-04 16:38:17.000</GmtCreate>
        <ActiveTime>2020-04-04 16:38:18.607</ActiveTime>
        <GmtModified>2020-04-04 16:38:19.000</GmtModified>
        <ProductKey>a1*********</ProductKey>
        <DeviceName>testDevcieae7f3a</DeviceName>
  </Data>
  <Data>
        <Status>UNACTIVE</Status>
        <IotId>5wt*******</IotId>
        <GmtCreate>2020-04-04 16:37:32.000</GmtCreate>
        <Groups>
              <GroupId>Ix4*******</GroupId>
        </Groups>
        <Groups>
              <GroupId>Xrn*******</GroupId>
        </Groups>
        <Groups>
              <GroupId>J9l*******</GroupId>
        </Groups>
        <OTAModules>
              <ModuleName>SomeSampleModule</ModuleName>
              <FirmwareVersion>a1-dads2-dad2</FirmwareVersion>
        </OTAModules>
        <OTAModules>
              <ModuleName>SampleModule</ModuleName>
              <FirmwareVersion>a1-dads2-dad1</FirmwareVersion>
        </OTAModules>
        <GmtModified>2020-04-04 16:37:32.000</GmtModified>
        <ProductKey>a1*********</ProductKey>
        <DeviceName>testDevcie676a22</DeviceName>
  </Data>
  <Success>true</Success>
</QueryDeviceBySQLResponse>

Format JSON

{
    "RequestId": "501CFABA-2C48-468D-B88C-3AA8E3B3A8F3",
    "Data": [
        {
            "Status": "OFFLINE",
            "IotId": "ii1*******",
            "GmtCreate": "2020-04-04 16:38:17.000",
            "ActiveTime": "2020-04-04 16:38:18.607",
            "GmtModified": "2020-04-04 16:38:19.000",
            "ProductKey": "a1*********",
            "DeviceName": "testDevcieae7f3a"
        },
        {
            "Status": "UNACTIVE",
            "IotId": "5wt*******",
            "GmtCreate": "2020-04-04 16:37:32.000",
            "Groups": [
                {
                    "GroupId": "Ix4*******"
                },
                {
                    "GroupId": "Xrn*******"
                },
                {
                    "GroupId": "J9l*******"
                }
            ],
            "OTAModules": [
                {
                    "ModuleName": "SomeSampleModule",
                    "FirmwareVersion": "a1-dads2-dad2"
                },
                {
                    "ModuleName": "SampleModule",
                    "FirmwareVersion": "a1-dads2-dad1"
                }
            ],
            "GmtModified": "2020-04-04 16:37:32.000",
            "ProductKey": "a1*********",
            "DeviceName": "testDevcie676a22"
        }
    ],
    "Success": true
}

Codes d'erreur

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