すべてのプロダクト
Search

このプロダクト

    IoT Platform:DeleteDevice

    ドキュメントセンター

    IoT Platform:DeleteDevice

    最終更新日:Apr 17, 2025

    デバイスを削除します。この操作を呼び出してゲートウェイを削除すると、ゲートウェイと、ゲートウェイに接続されているサブデバイスとの間のトポロジ関係も削除されます。

    使用方法

    この操作を呼び出す前に

    Resource Access Management (RAM) ユーザーとしてこの操作を呼び出す場合は、カスタム権限ポリシーを作成して、RAM ユーザーに詳細な権限を付与できます。これにより、デバイスのセキュリティが確保されます。詳細については、「IoT Platform API 操作と RAM ポリシー間のマッピング」および「カスタム権限」をご参照ください。

    警告

    • デバイスが削除されると、デバイス ID（IotId）は無効になり、デバイスに関連付けられている他のすべての情報が削除されます。また、デバイスに対する操作を実行できなくなります。

    • IoT Platform コンソールでデバイスを削除する前に、実際のデバイスがオフラインになっていることを確認してください。そうしないと、デバイスが IoT Platform から削除された後、実際のデバイスは IoT Platform への接続リクエストを継続的に開始します。リクエスト数が上限を超えると、IoT Platform はリクエストをスロットルします。この場合、Alibaba Cloud アカウント内の他のデバイスが IoT Platform に接続できなくなる可能性があります。

    • デバイスを削除すると、デバイスの証明書は無効になり、復元できません。注意して進めてください。

    この操作を呼び出す場合

    • IotId、または ProductKey と DeviceName を指定して、デバイスを指定する必要があります。

    • この操作を呼び出して、2,000 を超えるサブデバイスが接続されているゲートウェイを削除すると、この操作によって非同期デバイスタスクが作成され、トポロジ関係が削除されます。この操作は、非同期ジョブの JobId を返します。

    QPS 制限

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

    説明

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

    デバッグ

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

    リクエストパラメーター

    パラメーター

    タイプ

    必須

    例

    説明

    Action

    String

    はい

    DeleteDevice

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

    IotInstanceId

    String

    いいえ

    iot-cn-0pp1n8t****

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

    重要

    • インスタンスに ID がある場合は、このパラメーターを指定する必要があります。指定しないと、リクエストは失敗します。

    • IoT Platform コンソールに 概要 タブまたはインスタンス ID が表示されない場合は、このパラメーターを指定する必要はありません。

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

    ProductKey

    String

    いいえ

    a1FlqIQ****

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

    重要

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

    DeviceName

    String

    いいえ

    light

    削除するデバイスの名前。

    重要

    このパラメーターを指定する場合は、ProductKey も指定する必要があります。

    IotId

    String

    いいえ

    MpEKNuEUJzIORNANAWJX0010929900*****

    削除するデバイスの ID。

    重要

    IotId は、デバイスの GUID を指定します。 IotId は、ProductKey と DeviceName の組み合わせに対応します。このパラメーターを指定する場合は、ProductKey または DeviceName を指定する必要はありません。 IotId、ProductKey、および DeviceName を同時に指定した場合、IotId が優先されます。

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

    レスポンスパラメーター

    パラメーター

    タイプ

    例

    説明

    Code

    String

    iot.prod.NullProductKey

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

    ErrorMessage

    String

    プロダクト ID が無効です。

    リクエストが失敗した場合に返されるエラーメッセージ。

    RequestId

    String

    57b144cf-09fc-4916-a272-a62902d5b207

    リクエスト ID。

    Success

    Boolean

    false

    リクエストが成功したかどうかを示します。有効な値：

    • true

    • false

    例

    リクエストの例

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

    成功レスポンスの例

    XML 形式

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

    JSON 形式

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

    エラーコード

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