すべてのプロダクト
Search

このプロダクト

    IoT Platform:デバイスの無効化

    ドキュメントセンター

    IoT Platform:デバイスの無効化

    最終更新日:Apr 17, 2025

    デバイスを無効にします。

    制限

    • デバイスが無効化されると、デバイスを IoT Platform に接続できなくなります。デバイス固有の操作は実行できます。ただし、デバイスに関する情報は IoT Platform に保持されます。EnableThing API 操作を使用すると、無効化されたデバイスを IoT Platform に再び接続できます。
    • 各 Alibaba Cloud アカウントは、最大 500 クエリ/秒（QPS）を実行できます。
      説明 Alibaba Cloud アカウントの RAM ユーザーは、アカウントのクォータを共有します。

    デバッグ

    Alibaba Cloud は、API の使用を簡素化するために OpenAPI Explorer を提供しています。OpenAPI Explorer は署名の値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。OpenAPI Explorer は、さまざまな SDK 用の操作のサンプルコードを動的に生成します。

    リクエストパラメーター

    パラメータータイプ必須例説明
    ActionStringはいDisableThing

    実行する操作。値を DisableThing に設定します。

    IotInstanceIdStringいいえiot_instc_pu****_c*-v64********

    インスタンスの ID。インスタンス ID は、IoT Platform コンソールの 概要 ページで確認できます。

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

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

    ProductKeyStringいいえa1BwAGV****

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

    説明 このパラメーターを指定する場合は、DeviceName パラメーターも指定する必要があります。
    DeviceNameStringいいえlight

    デバイスの DeviceName。

    説明 このパラメーターを指定する場合は、ProductKey パラメーターも指定する必要があります。
    IotIdStringいいえQ7uOhVRdZRRlDnTLv****00100

    デバイスの ID。ID は、IoT Platform がデバイスに発行する一意の識別子です。

    説明 このパラメーターを指定する場合は、ProductKey または DeviceName を指定する必要はありません。IotId パラメーターは、ProductKey と DeviceName の組み合わせに対応する、デバイスのグローバル一意識別子（GUID）を指定します。IotId と ProductKey と DeviceName の組み合わせの両方を指定した場合、IotId が優先されます。

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

    レスポンスパラメーター

    パラメータータイプ例説明
    CodeStringiot.system.SystemException

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

    ErrorMessageStringシステム例外が発生しました。

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

    RequestIdStringE55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

    リクエストの ID。

    SuccessBooleantrue

    呼び出しが成功したかどうかを示します。

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

    例

    リクエストの例

    https://iot.cn-shanghai.aliyuncs.com/?Action=DisableThing
&ProductKey=a1rYuVF****
&DeviceName=device1
&<共通リクエストパラメーター>

    成功レスポンスの例

    XML 形式

    <DisableThingResponse>
  <RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId>
  <Success>true</Success>
</DisableThingResponse>

    JSON 形式

    {
  "RequestId":"57b144cf-09fc-4916-a272-a62902d5b207",
  "Success": true
}

    エラーコード

    エラーコードの一覧については、API エラーセンター をご参照ください。