調用該接口查詢AMQP服務端訂閱的消費組詳情。

使用說明

使用AMQP服務端訂閱時，可以調用該接口根據消費組ID查詢消費組詳情。創建AMQP服務端訂閱的接口信息，請參見CreateSubscribeRelation。

QPS限制

單個阿里云賬號調用該接口的每秒請求數（QPS）最大限制為5。

說明 RAM用戶共享阿里云賬號配額。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String 是 QueryConsumerGroupByGroupId

系統規定參數。取值：QueryConsumerGroupByGroupId。
GroupId String 是 nJRaJPn5U1JITGf******

消費組ID。調用CreateConsumerGroup創建消費組成功后，會返回消費組ID。您可以調用QueryConsumerGroupList按消費組名稱查詢消費組ID。
IotInstanceId String 否 iot-cn-0pp1n8t****

實例ID。您可在物聯網平臺控制臺的實例概覽頁面，查看當前實例的ID。

重要
  • 若有ID值，必須傳入該ID值，否則調用會失敗。
  • 若無實例概覽頁面或ID值，則無需傳入。

實例的更多信息，請參見實例概述。

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

返回數據

名稱 類型 示例值 描述
Code String iot.system.SystemException

調用失敗時，返回的錯誤碼。更多信息，請參見錯誤碼。
Data Struct

調用成功時，返回的消費組詳情。
CreateTime String 2020-05-20T00:05:20.000Z

消費組創建時間。為UTC時間，以毫秒計，格式為“yyyy-MM-dd'T'HH:mm:ss.SSSZ”。
GroupId String nJRaJPn5U1JITGf******

消費組ID。
GroupName String 消費組1

消費組名稱。
ErrorMessage String 系統異常

調用失敗時，返回的出錯信息。
RequestId String 73B9DF43-7780-47DE-8BED-077729D28BD2

阿里云為該請求生成的唯一標識符。
Success Boolean true

是否調用成功。

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

示例

請求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryConsumerGroupByGroupId
&GroupId=nJRaJPn5U1JITGf******
&<公共請求參數>

正常返回示例

XML格式

<QueryConsumerGroupByGroupIdResponse>
    <Data>
        <GroupId>nJRaJPn5U1JITGf******</GroupId>
        <GroupName>消費組1</GroupName>
        <CreateTime>2019-11-12T11:19:13.000Z</CreateTime>
    </Data>
    <RequestId>73B9DF43-7780-47DE-8BED-077729D28BD2</RequestId>
    <Success>true</Success>
</QueryConsumerGroupByGroupIdResponse>

JSON格式

{
  "Data": {
        "GroupId": "nJRaJPn5U1JITGf******",
        "GroupName": "消費組1",
        "CreateTime": "2019-11-12T11:19:13.000Z"
    },
  "RequestId": "73B9DF43-7780-47DE-8BED-077729D28BD2",
  "Success": true
}