全部產品
Search
文件中心

IoT Platform:ResetConsumerGroupPosition

更新時間:Feb 13, 2025

使用AMQP服務端訂閱時,調用該介面清空某個消費組的堆積訊息。

QPS限制

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

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

調試

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

請求參數

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

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

GroupId String nJRaJPn5U1JITGf******

消費組ID。調用CreateConsumerGroup建立消費組成功後,會返回消費組ID。您可以調用QueryConsumerGroupList按消費組名稱查詢消費組ID,也可以在物聯網平台控制台,選擇規則引擎>服務端訂閱>消費組列表,查看消費組ID。

IotInstanceId String iot-cn-0pp1n8t****

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

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

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

調用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=ResetConsumerGroupPosition
&GroupId=nJRaJPn5U1JITGf******
&<公用請求參數>

正常返回樣本

XML格式

<ResetConsumerGroupPositionResponse>
       <RequestId>73B9DF43-7780-47DE-8BED-077729D28BD2</RequestId>
       <Success>true</Success>
</ResetConsumerGroupPositionResponse>

JSON格式

{
  "RequestId": "73B9DF43-7780-47DE-8BED-077729D28BD2",
  "Success": true
}

錯誤碼

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