全部產品
Search

搜尋本產品

    IoT Platform：API列表

    文件中心

    IoT Platform：API列表

    更新時間：Jun 30, 2024

    以下是物聯網平台API列表。

    產品管理的API

    API描述
    CreateProduct建立產品。
    UpdateProduct修改產品資訊。
    QueryProductList查詢產品列表。
    QueryProduct查詢產品詳細資料。
    DeleteProduct刪除指定產品。
    CreateProductTags建立產品標籤。
    UpdateProductTags更新產品標籤。
    DeleteProductTags刪除產品標籤。
    ListProductTags查詢產品的所有標籤。
    ListProductByTags根據標籤查詢產品。
    UpdateProductFilterConfig更新產品下裝置上報的屬性去重規則。
    ReleaseProduct發布指定產品。
    CancelReleaseProduct取消指定產品的發布。

    裝置管理的API

    API描述
    RegisterDevice註冊裝置。
    QueryClientIds一型一密免註冊情境下，查看單個裝置的識別欄位表。
    TransformClientId一型一密免註冊情境下，若裝置包含多個裝置標識，需指定一個正確的裝置標識，以防止非法的裝置登入。
    DeleteClientIds一型一密免註冊情境下，若單個裝置的標識個數超出限制（5個），可刪除裝置下的所有標識。
    QueryDeviceInfo查詢指定裝置的基本資料（裝置ID、裝置認證和備忘名稱）。
    QueryDeviceDetail查詢裝置詳情。
    BatchQueryDeviceDetail批量查詢裝置詳情。
    QueryDevice查詢產品的裝置列表。
    DeleteDevice刪除裝置。
    GetDeviceStatus擷取裝置的運行狀態。
    BatchGetDeviceState批量擷取裝置狀態。
    DisableThing禁用裝置。
    EnableThing解禁裝置。
    ResetThing重設裝置。
    BatchCheckDeviceNames批量自訂裝置名稱，物聯網平台會檢查名稱的合法性。
    BatchRegisterDeviceWithApplyId根據ApplyId批量申請裝置。
    BatchRegisterDevice批次申請特定數量裝置。
    QueryBatchRegisterDeviceStatus查詢大量註冊裝置狀態。
    QueryPageByApplyId查詢批次裝置列表。
    SaveDeviceProp設定裝置標籤。
    QueryDeviceProp查詢裝置標籤列表。
    DeleteDeviceProp刪除裝置標籤。
    GetThingTopo查詢網關裝置的子裝置列表。
    NotifyAddThingTopo通知網關增加裝置拓撲關係。
    BatchAddThingTopo大量新增裝置拓撲關係。
    RemoveThingTopo移除網關裝置或子裝置所具有的拓撲關係。
    QueryDeviceStatistics擷取裝置的統計數量。
    GetGatewayBySubDevice根據掛載的子裝置資訊查詢對應的網關裝置資訊。
    QueryDeviceByTags根據標籤查詢裝置。
    QueryDeviceFileList查詢指定裝置上傳到物聯網平台的所有檔案。
    QueryDeviceFile查詢指定裝置上傳到物聯網平台的指定檔案資訊。
    DeleteDeviceFile刪除指定裝置上傳到物聯網平台的指定檔案。
    BatchUpdateDeviceNickname批次更新裝置備忘名稱。
    QueryDeviceByStatus根據裝置狀態查詢裝置列表。
    ListOTAModuleVersionsByDevice查詢裝置上報過的OTA模組版本列表。
    ImportDevice在MQTT雲網關產品下單個匯入裝置。
    BatchImportDevice在MQTT雲網關產品下大量匯入裝置。
    BatchCheckImportDevice批量校正在MQTT雲網關產品下大量匯入的裝置。
    QueryImportedDeviceByApplyId根據申請批次ID（ApplyId）查詢大量匯入的裝置列表。
    BatchImportVehicleDevice在JT/T 808協議雲網關產品下大量匯入裝置。
    BatchCheckVehicleDevice批量校正匯入的JT/T 808協議雲網關裝置。
    QueryVehicleDevice查詢JT/T 808協議雲網關裝置資訊。

    裝置分發的API

    API描述
    CreateDeviceDistributeJob建立裝置分發任務，預設同時分發裝置所屬產品。
    CreateProductDistributeJob建立產品分發任務，分髮指定產品到指定的目標執行個體。
    QueryDeviceDistributeDetail擷取裝置分發任務執行完成後的結果資訊。
    QueryDeviceDistributeJob擷取裝置分發任務的詳細資料。
    ListDeviceDistributeJob擷取裝置分發工作清單。
    DeleteDeviceDistributeJob刪除裝置分發任務。
    ListDistributedDevice查詢已分發的裝置列表。
    ListDistributedProduct查詢已分發的產品列表。

    分組管理的API

    API描述
    CreateDeviceGroup建立分組。
    DeleteDeviceGroup刪除分組。
    UpdateDeviceGroup修改分組資訊。
    QueryDeviceGroupInfo查詢分組詳情。
    QueryDeviceGroupList分頁查詢分組列表。
    BatchAddDeviceGroupRelations添加裝置到分組。
    BatchDeleteDeviceGroupRelations刪除分組中已添加的指定裝置。
    SetDeviceGroupTags添加或更新分組標籤。
    QueryDeviceGroupTagList查詢分組標籤列表。
    QueryDeviceGroupByDevice查詢指定裝置所在的分組列表。
    QuerySuperDeviceGroup根據子分組ID查詢父分組資訊。
    QueryDeviceListByDeviceGroup查詢分組中的裝置列表。
    QueryDeviceGroupByTags根據標籤查詢裝置分組。

    物模型管理的API

    API描述
    CreateThingModel為指定產品的物模型新增功能，支援定義物模型擴充描述。
    UpdateThingModel更新指定產品物模型中的單個功能，支援更新物模型擴充描述。
    QueryThingModel查看指定產品的物模型中的功能定義詳情。
    CopyThingModel複製指定產品的物模型到目標產品。
    PublishThingModel發布指定產品的物模型。
    DeleteThingModel刪除指定產品物模型中的指定功能。
    ListThingTemplates擷取物聯網平台預定義的產品品類列表。
    GetThingTemplate查詢指定品類的標準物模型資訊。
    ListThingModelVersion擷取指定產品的物模型歷史版本列表。
    GetThingModelTsl查詢指定產品的物模型。
    ImportThingModelTsl為指定產品匯入物模型TSL，暫不支援擴充描述配置。
    QueryThingModelPublished查看指定產品的發行物模型中的功能定義詳情。
    GetThingModelTslPublished查詢指定產品的發行物模型TSL。
    QueryThingModelExtendConfig匯出指定產品的物模型擴充描述配置。
    QueryThingModelExtendConfigPublished匯出發行物模型的擴充描述配置。
    CreateThingScript為指定產品提交資料解析指令碼。
    UpdateThingScript修改指定產品的資料解析指令碼。
    GetThingScript查詢指定產品的資料解析指令碼。

    物模型使用的API

    API描述
    SetDeviceProperty設定裝置的屬性。
    SetDevicesProperty大量設定裝置屬性。
    InvokeThingService調用裝置的服務。
    InvokeThingsService批量調用裝置的服務。
    QueryDevicePropertyData查詢裝置的屬性歷史資料。
    QueryDevicePropertiesData批量查詢指定裝置的多個屬性的歷史資料。
    QueryDeviceEventData查詢裝置的事件歷史資料。
    QueryDeviceServiceData擷取裝置的服務記錄歷史資料。
    SetDeviceDesiredProperty為指定裝置大量設定期望屬性值。
    QueryDeviceDesiredProperty查詢指定裝置的期望屬性值。
    QueryDevicePropertyStatus查詢指定裝置的屬性快照。
    QueryDeviceOriginalPropertyStatus查詢指定裝置的原始屬性快照。
    QueryDeviceOriginalPropertyData查詢指定裝置的原始屬性記錄。
    QueryDeviceOriginalEventData查詢指定裝置的原始事件記錄。
    QueryDeviceOriginalServiceData查詢指定裝置的原始服務調用記錄。
    ClearDeviceDesiredProperty清空裝置下已設定的期望屬性值。

    雲產品流轉（舊版）的API

    API描述
    ListRule查詢規則列表。
    CreateRule建立規則。
    GetRule查詢規則資訊。
    UpdateRule修改規則。
    DeleteRule刪除規則。
    ListDataSourceItem分頁查詢規則引擎中指定資料來源下的Topic列表。
    ListRuleActions查詢規則動作列表。
    GetRuleAction查詢規則動作資訊。
    CreateRuleAction建立規則動作。
    UpdateRuleAction更新規則動作。
    DeleteRuleAction刪除規則動作。
    StartRule啟動規則。
    StopRule停止規則。

    雲產品流轉（新版）的API

    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停止解析器運行。

    Topic管理API

    API描述
    CreateProductTopic建立產品自訂Topic類。
    UpdateProductTopic修改產品自訂Topic類。
    QueryProductTopic查詢產品自訂Topic類。
    DeleteProductTopic刪除產品自訂Topic類。
    CreateTopicRouteTable添加Topic路由表。
    QueryTopicRouteTable查詢Topic路由表。
    QueryTopicReverseRouteTable查詢Topic反向路由表。
    DeleteTopicRouteTable刪除Topic路由表。

    服務端訂閱API

    API描述
    CreateSubscribeRelation建立MNS或AMQP服務端訂閱。
    UpdateSubscribeRelation修改MNS或AMQP服務端訂閱。
    QuerySubscribeRelation查詢MNS或AMQP服務端訂閱。
    DeleteSubscribeRelation刪除MNS或AMQP服務端訂閱。
    CreateConsumerGroup建立一個消費組，用於建立AMQP服務端訂閱。
    UpdateConsumerGroup修改消費組名稱。
    QueryConsumerGroupByGroupId根據消費組ID查詢消費組詳情。
    QueryConsumerGroupList查詢使用者所有消費組列表，或按消費組名稱進行模糊查詢。
    QueryConsumerGroupStatus使用AMQP服務端訂閱時，查詢某個消費組的狀態，包括線上用戶端資訊、訊息消費速率、訊息堆積數、最近訊息消費時間。
    ResetConsumerGroupPosition使用AMQP服務端訂閱時，清空某個消費組的堆積訊息。
    DeleteConsumerGroup刪除消費組。
    CreateConsumerGroupSubscribeRelation在AMQP訂閱中添加一個消費組。
    DeleteConsumerGroupSubscribeRelation從AMQP訂閱中的多個消費組移除指定消費組。

    訊息通訊API

    API描述
    RRpc向指定裝置發送請求訊息，並同步返迴響應。
    PubBroadcast向指定產品所有裝置，或向訂閱了指定Topic的所有裝置發布廣播訊息。
    Pub通過自訂Topic向指定裝置發布訊息，支援向指定產品下訂閱了指定自訂Topic的線上裝置發送廣播訊息。
    BatchPub通過自訂Topic向指定產品下的多個裝置批量發送訊息。
    SubscribeTopic為指定裝置訂閱Topic。
    QueryDeviceSubTopic查詢裝置已訂閱的Topic列表。
    UpdateTopicConfig設定自訂Topic是否支援保留訊息廣播。

    裝置影子API

    API描述
    GetDeviceShadow查詢裝置影子。
    UpdateDeviceShadow更新裝置影子。

    OTA升級API

    API描述
    GenerateOTAUploadURL產生升級包檔案上傳到OSS的URL及詳細資料。
    GenerateDeviceNameListURL產生裝置列表檔案上傳到OSS的URL及詳細資料。在建立靜態升級批次時，裝置列表檔案可用於指定要升級的裝置。
    CreateOTAFirmware添加升級包。
    DeleteOTAFirmware刪除指定升級包。
    ListOTAFirmware查詢升級包列表。
    QueryOTAFirmware查詢指定升級包的詳細資料。
    CreateOTAVerifyJob建立升級包驗證批次。
    CreateOTAStaticUpgradeJob建立靜態升級批次。
    CreateOTADynamicUpgradeJob建立動態升級批次。
    ListOTAJobByFirmware擷取升級包下的升級批次列表。
    ListOTAJobByDevice擷取裝置所在的升級包升級批次列表。
    ListOTATaskByJob查詢指定升級批次下的裝置升級作業列表。
    QueryOTAJob查詢指定升級批次的詳情。
    CancelOTAStrategyByJob取消動態升級批次所關聯的動態升級策略。
    CancelOTATaskByDevice取消指定升級包下狀態為待升級的裝置升級作業。
    CancelOTATaskByJob取消指定批次下的裝置升級作業。
    CreateOTAModule建立產品的OTA模組。
    UpdateOTAModule修改OTA模組別名、描述。
    DeleteOTAModule刪除自訂OTA模組。
    ListOTAModuleByProduct查詢產品下的OTA模組列表。
    ConfirmOTATask批量確認處於待確認狀態的裝置升級作業。
    ListOTAUnfinishedTaskByDevice查詢指定裝置下，未完成狀態的裝置升級作業列表。