すべてのプロダクト
Search

このプロダクト

    IoT Platform:QueryImportedDeviceByApplyId

    ドキュメントセンター

    IoT Platform:QueryImportedDeviceByApplyId

    最終更新日:Apr 17, 2025

    アプリケーション ID によって一度に追加された複数のデバイスをクエリします。

    QPS 制限

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

    説明 Alibaba Cloud アカウントの RAM ユーザーは、Alibaba Cloud アカウントのクォータを共有します。

    デバッグ

    OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

    リクエストパラメーター

    パラメーター タイプ 必須 例 説明
    Action String Yes QueryImportedDeviceByApplyId

    実行する操作。値を QueryImportedDeviceByApplyId に設定します。
    ApplyId Long Yes 1295006

    アプリケーション ID。BatchImportDevice 操作を呼び出して、アプリケーション ID を取得できます。
    PageNo Integer Yes 1

    返すページ番号。有効な値：1 ～ 10000。
    PageSize Integer Yes 10

    各ページに返すエントリの数。デフォルト値：10。最大値：50。
    IotInstanceId String No iot-1n8t****

    インスタンスの ID。IoT Platform コンソールの [概要] ページでインスタンスの ID を取得できます。

    重要
    • インスタンスに ID がある場合は、このパラメーターに ID を指定する必要があります。指定しないと、呼び出しは失敗します。
    • インスタンスに対して [概要] ページまたは ID が生成されない場合は、このパラメーターを設定する必要はありません。

    詳細については、「概要」をご参照ください。

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

    レスポンスパラメーター

    パラメーター タイプ 例 説明
    TotalPage Integer 100

    返されるページの総数。
    PageNo Integer 1

    返されたページのページ番号。
    PageSize Integer 10

    1 ページあたりに返されるエントリの数。
    RequestId String E4C0FF92-2A86-41DB-92D3-73B60310D25E

    リクエストの ID。
    ProductKey String a1BwAGV****

    デバイスが属するプロダクトの ProductKey。
    DeviceList Array of device

    返されたデバイスの詳細。
    device
    DeviceName String light

    デバイスの DeviceName。

    重要

    この情報は機密にしてください。
    DeviceSecret String b4d43f7******10ba5e5

    デバイスの DeviceSecret。

    重要

    この情報は機密にしてください。
    ProductKey String a1BwAGV****

    デバイスが属するプロダクトの ProductKey。
    Sn String QC4******001

    デバイスのシリアル番号 (SN)。

    説明 デバイスの SN を指定しない場合、このパラメーターは空になります。
    Code String iot.system.SystemException

    呼び出しが失敗した場合に返されるエラーコード。エラーコードの詳細については、「エラーコード」をご参照ください。
    ErrorMessage String A system exception occurred.

    呼び出しが失敗した場合に返されるエラーメッセージ。
    Success Boolean true

    呼び出しが成功したかどうかを示します。有効な値：

    • true: 呼び出しは成功しました。
    • false: 呼び出しは失敗しました。

    例

    リクエストの例

    http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryImportedDeviceByApplyId
&ApplyId=1295006
&PageNo=1
&PageSize=10
&IotInstanceId=iot-1n8t****
&<共通リクエストパラメーター>

    成功レスポンスの例

    XML 形式

    <QueryImportedDeviceByApplyIdResponse>
  <TotalPage>100</TotalPage>
  <PageSize>10</PageSize>
  <PageNo>1</PageNo>
  <RequestId>E4C0FF92-2A86-41DB-92D3-73B60310D25E</RequestId>
  <ProductKey>a1BwAGV****</ProductKey>
  <DeviceList>
        <device>
              <DeviceSecret>b4d43f7******10ba5e5</DeviceSecret>
              <Sn>QC4******001</Sn>
              <ProductKey>a1BwAGV****</ProductKey>
              <DeviceName>light</DeviceName>
        </device>
  </DeviceList>
  <Success>true</Success>
</QueryImportedDeviceByApplyIdResponse>

    JSON 形式

    {
    "TotalPage": 100,
    "PageSize": 10,
    "PageNo": 1,
    "RequestId": "E4C0FF92-2A86-41DB-92D3-73B60310D25E",
    "ProductKey": "a1BwAGV****",
    "DeviceList": {
        "device": {
            "DeviceSecret": "b4d43f7******10ba5e5",
            "Sn": "QC4******001",
            "ProductKey": "a1BwAGV****",
            "DeviceName": "light"
        }
    },
    "Success": true
}

    エラーコード

    HttpCode エラーコード エラーメッセージ 説明
    200 iot.device.DeviceApplyIsNotFound The application ID for the device does not exist. アプリケーション ID が存在しないために返されるエラーメッセージ。

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