全部產品
Search
文件中心

IoT Platform:DeleteDeviceFile

更新時間:Feb 13, 2025

調用該介面刪除指定裝置上傳到物聯網平台的指定檔案。

QPS限制

單個阿里雲帳號調用該介面的每秒請求數(QPS)最大限制為500。

說明 RAM使用者共用阿里雲帳號配額。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱 類型 是否必選 樣本值 描述
Action String DeleteDeviceFile

系統規定參數。取值:DeleteDeviceFile。

FileId String 6UCo1SqbqnQEoh9aK4561****

要刪除的檔案ID。可調用QueryDeviceFileList,從返回結果中查看對應檔案ID。

IotInstanceId String iot_instc_pu****_c*-v64********

執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面,查看當前執行個體的ID

重要
  • 若有ID值,必須傳入該ID值,否則調用會失敗。
  • 若無執行個體概覽頁面或ID值,則無需傳入。

執行個體的更多資訊,請參見執行個體概述

ProductKey String a1BwAGV****

要刪除檔案所屬的裝置所隸屬的產品ProductKey。

說明 如果傳入該參數,需同時傳入DeviceName
DeviceName String light

要刪除檔案所屬的裝置名稱。

說明 如果傳入該參數,需同時傳入ProductKey
IotId String Q7uOhVRdZRRlDnTLv****00100

要刪除檔案所屬的裝置ID。物聯網平台為該裝置頒發的ID,裝置的唯一識別碼。

說明 如果傳入該參數,則無需傳入ProductKeyDeviceNameIotId作為裝置唯一識別碼,和ProductKeyDeviceName組合是一一對應的關係。如果您同時傳入IotIdProductKeyDeviceName組合,則以IotId為準。

調用API時,除了本文介紹的該API的特有請求參數,還需傳入公用請求參數。公用請求參數說明,請參見公用參數文檔

返回資料

名稱 類型 樣本值 描述
Code String iot.system.SystemException

調用失敗時,返回的錯誤碼。更多資訊,請參見錯誤碼

ErrorMessage String 系統異常

調用失敗時,返回的出錯資訊。

RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

阿里雲為該請求產生的唯一識別碼。

Success Boolean true

表示是否調用成功。

  • true:調用成功。
  • false:調用失敗。

樣本

請求樣本

https://iot.cn-shanghai.aliyuncs.com/?Action=DeleteDeviceFile
&ProductKey=aliYSOl****
&DeviceName=deviceName1
&FileId=6UCo1SqbqnQEoh9aK4561****
&<公用請求參數>

正常返回樣本

XML格式

<DeleteDeviceFileResponse>
  <RequestId>C25255EA-9F6E-4E04-85FE-AC1E9C136EBB</RequestId>
  <Success>true</Success>
</DeleteDeviceFileResponse>

JSON格式

{
    "RequestId": "C25255EA-9F6E-4E04-85FE-AC1E9C136EBB",
    "Success": true
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。