すべてのプロダクト
Search

このプロダクト

    IoT Platform:関数別の操作リスト

    ドキュメントセンター

    IoT Platform:関数別の操作リスト

    最終更新日:Mar 22, 2025

    次の表は、IoT Platform で使用できる API 操作について説明します。

    プロダクト

    API説明
    CreateProductプロダクトを作成します。
    UpdateProductプロダクトに関する情報を変更します。
    QueryProductListプロダクトを照会します。
    QueryProductプロダクトの詳細を照会します。
    DeleteProductプロダクトを削除します。
    CreateProductTagsプロダクトタグを作成します。
    UpdateProductTagsプロダクトのタグを変更します。
    DeleteProductTagsプロダクトタグを削除します。
    ListProductTagsプロダクトのすべてのタグを照会します。
    ListProductByTagsタグによってプロダクトを照会します。
    UpdateProductFilterConfigプロダクトのデバイスから送信されたプロパティメッセージの重複排除ルールを変更します。
    ReleaseProductプロダクトを公開します。
    CancelReleaseProductプロダクトの公開を取り消します。

    デバイス

    API説明
    RegisterDeviceデバイスを登録します。
    QueryClientIdsデバイスの ClientID を照会します。この API 操作は、事前登録不要のプロダクトごとに一意の証明書による検証でサポートされています。
    TransformClientIdデバイスに複数の ClientID がある場合、不正なログインを防ぐために、デバイスに有効な ClientID を指定します。この API 操作は、事前登録不要のプロダクトごとに一意の証明書による検証でサポートされています。
    DeleteClientIdsClientID の数が制限（5）を超えた場合、デバイスのすべての ClientID を削除します。この API 操作は、事前登録不要のプロダクトごとに一意の証明書による検証でサポートされています。
    QueryDeviceInfoデバイスに関する基本情報を照会します。情報には、デバイス ID、デバイス証明書、エイリアスが含まれます。
    QueryDeviceDetailデバイスの詳細を照会します。
    BatchQueryDeviceDetail複数のデバイスの詳細を照会します。
    QueryDeviceプロダクトのデバイスを照会します。
    DeleteDeviceデバイスを削除します。
    GetDeviceStatusデバイスのステータスを照会します。
    BatchGetDeviceStateデバイスのステータスを照会します。
    DisableThingデバイスを無効にします。
    EnableThing無効になっているデバイスを有効にします。
    ResetThingデバイスをリセットします。
    BatchCheckDeviceNames一度に複数のデバイスの名前を指定します。IoT Platform は、名前が有効かどうかを確認します。
    BatchRegisterDeviceWithApplyIdアプリケーション ID を使用して、一度に複数のデバイスを登録します。
    BatchRegisterDevice一度に複数のデバイスを登録します。
    QueryBatchRegisterDeviceStatus複数のデバイスの登録の処理ステータスを照会します。
    QueryPageByApplyIdアプリケーション ID で複数のデバイスを照会します。
    SaveDevicePropデバイスのタグを作成します。
    QueryDevicePropデバイスのタグを照会します。
    DeleteDevicePropデバイスのタグを削除します。
    GetThingTopoゲートウェイ デバイスのサブデバイスを照会します。
    NotifyAddThingTopoゲートウェイ デバイスに、サブデバイスとのトポロジー関係を確立するように通知します。
    BatchAddThingTopo複数のサブデバイスとゲートウェイ デバイスの間にトポロジー関係を確立します。
    RemoveThingTopoデバイスのトポロジー関係を削除します。
    QueryDeviceStatisticsデバイス統計情報を照会します。
    GetGatewayBySubDeviceサブデバイス情報に基づいて、ゲートウェイ デバイスに関する情報を照会します。
    QueryDeviceByTagsタグ別にデバイスを照会します。
    QueryDeviceFileListデバイスから IoT Platform にアップロードされたファイルを照会します。
    QueryDeviceFileデバイスから IoT Platform にアップロードされたファイルの詳細を照会します。
    DeleteDeviceFileデバイスから IoT Platform にアップロードされたファイルを削除します。
    BatchUpdateDeviceNickname複数のデバイスのエイリアスを変更します。
    QueryDeviceByStatusステータス別にデバイスを照会します。
    ListOTAModuleVersionsByDevice無線（OTA）モジュールのバージョンを照会します。バージョンはデバイスによって送信されます。
    ImportDeviceMQTT ゲートウェイ プロダクトにデバイスを追加します。
    BatchImportDevice一度に複数のデバイスを MQTT ゲートウェイ プロダクトに追加します。
    BatchCheckImportDevice一度に MQTT ゲートウェイ プロダクトに追加された複数のデバイスを検証します。
    QueryImportedDeviceByApplyIdアプリケーション ID で一度に追加された複数のデバイスを照会します。
    BatchImportVehicleDevice一度に複数のデバイスを JT/T 808 ゲートウェイ プロダクトに追加します。
    BatchCheckVehicleDevice一度に JT/T 808 ゲートウェイ プロダクトに追加された複数のデバイスを検証します。
    QueryVehicleDeviceJT/T 808 ゲートウェイ プロダクトのデバイスに関する情報を照会します。

    デバイス分散

    APIDescription
    CreateDeviceDistributeJobデバイスを分散するためのタスクを作成します。デバイスが属するプロダクトも分散されます。
    CreateProductDistributeJobプロダクトをインスタンスに分散するためのタスクを作成します。
    QueryDeviceDistributeDetailデバイス分散タスクの結果を照会します。
    QueryDeviceDistributeJobデバイス分散タスクの詳細を照会します。
    ListDeviceDistributeJobデバイス分散タスクを照会します。
    DeleteDeviceDistributeJobデバイス分散タスクを削除します。
    ListDistributedDevice分散済みデバイスを照会します。
    ListDistributedProduct分散済みプロダクトを照会します。

    デバイスグループ

    API説明
    CreateDeviceGroupデバイスグループを作成します。
    DeleteDeviceGroupデバイスグループを削除します。
    UpdateDeviceGroupデバイスグループに関する情報を変更します。
    QueryDeviceGroupInfoデバイスグループの詳細を照会します。
    QueryDeviceGroupListすべてのデバイスグループを照会します。
    BatchAddDeviceGroupRelationsデバイスグループにデバイスを追加します。
    BatchDeleteDeviceGroupRelationsデバイスグループからデバイスを削除します。
    SetDeviceGroupTagsデバイスグループのタグを作成、または更新します。
    QueryDeviceGroupTagListデバイスグループのタグを照会します。
    QueryDeviceGroupByDeviceデバイスが属するグループを照会します。
    QuerySuperDeviceGroup子グループ ID に基づいて親グループの詳細を照会します。
    QueryDeviceListByDeviceGroupデバイスグループ内のデバイスを照会します。
    QueryDeviceGroupByTagsタグに基づいてデバイスグループを照会します。

    TSL（Thing Specification Language）モデル

    API説明
    CreateThingModelプロダクトの TSL モデルに機能または拡張情報を追加します。
    UpdateThingModelプロダクトの TSL モデルの機能または拡張情報を変更します。
    QueryThingModelプロダクトの TSL モデルの詳細を照会します。
    CopyThingModelプロダクトの TSL モデルを宛先プロダクトにコピーします。
    PublishThingModelプロダクトの TSL モデルを公開します。
    DeleteThingModelプロダクトの TSL モデルから機能を削除します。
    ListThingTemplatesIoT Platform に事前定義されているすべてのプロダクトカテゴリを照会します。
    GetThingTemplateカテゴリに関する標準 TSL モデル情報を照会します。
    ListThingModelVersionプロダクトの TSL モデルバージョンを照会します。
    GetThingModelTslプロダクトの TSL モデルを照会します。
    ImportThingModelTslプロダクトに TSL モデルをインポートします。拡張情報はインポートできません。
    QueryThingModelPublishedプロダクトの公開済み TSL モデルの詳細を照会します。
    GetThingModelTslPublishedプロダクトの公開済み TSL モデルの基本情報を照会します。
    QueryThingModelExtendConfigプロダクトの TSL モデルの拡張情報を照会します。
    QueryThingModelExtendConfigPublished公開済み TSL モデルの拡張情報を照会します。
    CreateThingScriptプロダクトのデータ解析スクリプトを送信します。
    UpdateThingScriptプロダクトのデータ解析スクリプトを変更します。
    GetThingScriptプロダクトのデータ解析スクリプトを照会します。

    TSL モデルの使用

    API説明
    SetDevicePropertyデバイスのプロパティを設定します。
    SetDevicesProperty複数のデバイスのプロパティを一度に設定します。
    InvokeThingServiceデバイスのサービスを呼び出します。
    InvokeThingsService複数のデバイスのサービスを一度に呼び出します。
    QueryDevicePropertyDataデバイスのプロパティレコードをクエリします。
    QueryDevicePropertiesDataデバイスの複数のプロパティのレコードをクエリします。
    QueryDeviceEventDataデバイスのイベントレコードをクエリします。
    QueryDeviceServiceDataデバイスのサービスレコードをクエリします。
    SetDeviceDesiredPropertyデバイスに複数の目的の属性値を一度に指定します。
    QueryDeviceDesiredPropertyデバイスの目的の属性値をクエリします。
    QueryDevicePropertyStatusデバイスのプロパティスナップショットをクエリします。
    QueryDeviceOriginalPropertyStatusデバイスの元のプロパティスナップショットをクエリします。
    QueryDeviceOriginalPropertyDataデバイスの元のプロパティレコードをクエリします。
    QueryDeviceOriginalEventDataデバイスの元のイベントレコードをクエリします。
    QueryDeviceOriginalServiceDataデバイスの元のサービスレコードをクエリします。
    ClearDeviceDesiredPropertyデバイスのプロパティの目的の値を削除します。

    データ転送 (旧バージョン)

    API説明
    ListRuleルールを照会します。
    CreateRuleルールを作成します。
    GetRuleルールの詳細を照会します。
    UpdateRuleルールを変更します。
    DeleteRuleルールを削除します。
    ListDataSourceItemルールエンジン内のデータソースのトピックを照会します。
    ListRuleActionsルールアクションを照会します。
    GetRuleActionルールアクションの詳細を照会します。
    CreateRuleActionルールアクションを作成します。
    UpdateRuleActionルールアクションを変更します。
    DeleteRuleActionルールアクションを削除します。
    StartRuleルールを有効にします。
    StopRuleルールを無効にします。

    データ転送 (新バージョン)

    API説明
    CreateParserパーサーを作成します。
    UpdateParserパーサーの名前と説明を更新します。
    ListParserパーサーの詳細を照会します。詳細には、基本情報、状態、作成時刻、および変更時刻が含まれます。
    GetParserパーサーの詳細を照会します。詳細には、基本情報、解析スクリプト、状態、および関連付けられているデータソースが含まれます。
    DeleteParserパーサーを削除します。
    CreateParserDataSourceデータを転送するデータソースを作成します。
    UpdateParserDataSourceデータソースの名前と説明を更新します。
    ListParserDataSourceすべてのデータソースを照会します。
    GetParserDataSourceデータソースの詳細を照会します。
    DeleteParserDataSourceデータソースを削除します。
    CreateDataSourceItemデータソースに Topic を追加します。
    ListDataSourceItemデータソースの Topic を照会します。
    DeleteDataSourceItemデータソースから Topic の関連付けを解除します。
    CreateDestinationデータを転送するデータ転送先を作成します。
    UpdateDestinationデータ転送先の名前、タイプ、および説明を更新します。
    ListDestinationデータ転送先を照会します。
    GetDestinationデータ転送先の詳細を照会します。
    DeleteDestinationデータ転送先を削除します。
    AttachParserDataSourceパーサーをデータソースに関連付けます。
    ListParserDestinationパーサーに関連付けられているデータ転送先を照会します。
    DetachParserDataSourceパーサーからデータソースの関連付けを解除します。
    AttachDestinationパーサーをデータ転送先に関連付けます。
    DetachDestinationパーサーからデータ転送先の関連付けを解除します。
    SaveScriptパーサースクリプトのドラフトを変更して保存します。
    PublishScriptパーサースクリプトを公開します。
    StartParserパーサーを有効にします。
    StopParserパーサーを無効にします。

    トピック

    API説明
    CreateProductTopic製品のカスタム Topic カテゴリを作成します。
    UpdateProductTopicカスタム Topic カテゴリを修正します。
    QueryProductTopic製品のカスタム Topic カテゴリを照会します。
    DeleteProductTopicカスタム Topic カテゴリを削除します。
    CreateTopicRouteTableTopic のルートテーブルを作成します。
    QueryTopicRouteTableTopic のルートテーブルを照会します。
    QueryTopicReverseRouteTableTopic の逆ルートテーブルを照会します。
    DeleteTopicRouteTableTopic のルートテーブルを削除します。

    サーバー側サブスクリプション

    API説明
    CreateSubscribeRelationメッセージサービス（MNS）サーバー側サブスクリプションまたは Advanced Message Queuing Protocol（AMQP）サーバー側サブスクリプションを作成します。
    UpdateSubscribeRelationMNS サーバー側サブスクリプションまたは AMQP サーバー側サブスクリプションを変更します。
    QuerySubscribeRelationMNS サーバー側サブスクリプションまたは AMQP サーバー側サブスクリプションの詳細を照会します。
    DeleteSubscribeRelationMNS サーバー側サブスクリプションまたは AMQP サーバー側サブスクリプションを削除します。
    CreateConsumerGroupAMQP サーバー側サブスクリプションを作成するために、コンシューマーグループを作成します。
    UpdateConsumerGroupコンシューマーグループの名前を変更します。
    QueryConsumerGroupByGroupIdコンシューマーグループ ID に基づいてコンシューマーグループの詳細を照会します。
    QueryConsumerGroupListアカウントのすべてのコンシューマーグループを照会するか、コンシューマーグループ名であいまい検索を実行します。
    QueryConsumerGroupStatusAMQP サーバー側サブスクリプションが有効になっている場合、コンシューマーグループのステータスを照会します。ステータス情報には、オンラインクライアント情報、メッセージ消費率、累積メッセージ数、最新のメッセージ消費時間が含まれます。
    ResetConsumerGroupPositionAMQP サーバー側サブスクリプションが有効になっている場合、コンシューマーグループの累積メッセージをクリアします。
    DeleteConsumerGroupコンシューマーグループを削除します。
    CreateConsumerGroupSubscribeRelationAMQP サーバー側サブスクリプションにコンシューマーグループを追加します。
    DeleteConsumerGroupSubscribeRelationAMQP サーバー側サブスクリプションからコンシューマーグループを削除します。

    メッセージング

    API説明
    RRpcデバイスにリクエストを送信し、デバイスからレスポンスを同期的に受信します。
    PubBroadcastプロダクトのすべてのデバイス、または Topic をサブスクライブしているすべてのデバイスにメッセージをブロードキャストします。
    Pubカスタム Topic を使用してデバイスにメッセージを配信します。この操作を呼び出して、カスタム Topic をサブスクライブしているオンライン デバイスにメッセージをブロードキャストできます。オンライン デバイスは、指定されたプロダクトに属しています。
    BatchPubカスタム Topic を使用して、プロダクトの複数のデバイスにメッセージを配信します。
    SubscribeTopicデバイスの Topic をサブスクライブします。
    QueryDeviceSubTopicデバイスがサブスクライブしている Topic を照会します。

    デバイスシャドウ

    API説明
    GetDeviceShadowデバイスに関するシャドウ情報を照会します。
    UpdateDeviceShadowデバイスに関するシャドウ情報を変更します。

    OTA アップデート

    API説明
    GenerateOTAUploadURLOSS にアップロードされる更新パッケージの URL と詳細を生成します。
    GenerateDeviceNameListURLOSS にアップロードされるデバイス リスト ファイルの URL と詳細を生成します。静的更新バッチを作成するときに、デバイス リスト ファイルで更新対象のデバイスを指定できます。
    CreateOTAFirmware更新パッケージを追加します。
    DeleteOTAFirmware更新パッケージを削除します。
    ListOTAFirmware更新パッケージを照会します。
    QueryOTAFirmware更新パッケージの詳細を照会します。
    CreateOTAVerifyJob更新パッケージの検証バッチを作成します。
    CreateOTAStaticUpgradeJob静的更新バッチを作成します。
    CreateOTADynamicUpgradeJob動的更新バッチを作成します。
    ListOTAJobByFirmware更新パッケージの更新バッチを照会します。
    ListOTAJobByDeviceデバイス別に更新パッケージの更新バッチを照会します。
    ListOTATaskByJob更新バッチ別にデバイスの更新タスクを照会します。
    QueryOTAJob更新バッチの詳細を照会します。
    CancelOTAStrategyByJob動的更新バッチに関連付けられている更新ポリシーをキャンセルします。
    CancelOTATaskByDevice更新パッケージの保留中のデバイス更新タスクをキャンセルします。
    CancelOTATaskByJob更新バッチのデバイス更新タスクをキャンセルします。
    CreateOTAModuleプロダクトの OTA モジュールを作成します。
    UpdateOTAModuleOTA モジュールのエイリアスと説明を変更します。
    DeleteOTAModuleカスタム OTA モジュールを削除します。
    ListOTAModuleByProductプロダクトの OTA モジュールを照会します。
    ConfirmOTATask確認待ち状態のデバイス更新タスクを確認します。
    ListOTAUnfinishedTaskByDeviceデバイスの未完了のデバイス更新タスクを照会します。