IoT Platform:QueryDeviceBySQL

説明

• Enterprise Edition インスタンス上のデバイスは、中国 (上海) リージョンと 日本 (東京) リージョンでのみクエリできます。
• QueryDeviceBySQL 操作は、操作を呼び出すたびに最大 10,000 台のデバイスを返すことができます。詳細については、このトピックの「LIMIT 句の構文」セクションをご参照ください。

QPS 制限

この API 操作は、アカウントごとに 1 秒あたり最大 10 回呼び出すことができます。

リクエストパラメーター

QueryDeviceBySQL 操作を呼び出してデバイスをクエリする場合、SQL に似た文を指定する必要があります。 SQL に似た文には、SELECT 句と WHERE 句が含まれている必要があります。文には、ORDER BY 句と LIMIT 句を含めることもできます。各文の長さは 400 文字を超えることはできません。

例：

LIMIT 句の構文

説明：

• = および !=：これらの演算子を使用する場合、クエリするフィールドの値は null にすることができます。

• LIKE：この演算子を使用する場合、プレフィックス一致のみがサポートされます。プレフィックスは 4 文字以上で、バックスラッシュ (\)、スラッシュ (/)、アンパサンド (&)、プラス記号 (+)、ハイフン (-)、感嘆符 (!)、括弧 ()、コロン (:)、チルダ (~)、中括弧 {}、アスタリスク (*)、疑問符 (?) などの特殊文字を含めることはできません。プレフィックスはパーセント記号 (%) で終わる必要があります。

  例：SELECT * FROM device where product_key = "a1*********" and name LIKE "test%" limit 10。

上記の操作固有のリクエストパラメーターに加えて、この操作を呼び出すときは共通リクエストパラメーターを設定する必要があります。共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。

レスポンスパラメーター

例

リクエストの例

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceBySQL
&IotInstanceId=iot-cn-0pp1n8t****
&SQL=SELECT * FROM device where product_key = "a1*********" limit 100, 20
&<共通リクエストパラメーター>

成功レスポンスの例

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>

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
}

エラーコード

エラーコードのリストについては、「サービスエラーコード」をご参照ください。