すべてのプロダクト
Search

このプロダクト

    ApsaraMQ for RocketMQ:GetConsumeTimespan

    ドキュメントセンター

    ApsaraMQ for RocketMQ:GetConsumeTimespan

    最終更新日:Oct 14, 2025

    Topic のコンシューマオフセットをリセットできる時間範囲を照会します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    rocketmq:GetConsumeTimespan

    get

    *ConsumerGroup

    acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}/topic/{#TopicName}/consumergroup/{#ConsumerGroupId}

    		 なし なし

    リクエスト構文

    GET /instances/{instanceId}/consumerGroups/{consumerGroupId}/consumeTimespan/{topicName} HTTP/1.1

    パスパラメータ

    パラメーター

    型

    必須 / 任意

    説明

    例
    instanceId

    string

    必須

    インスタンスの ID。

    rmq-cn-7e22ody****
    consumerGroupId

    string

    必須

    使用者グループの ID。

    CID-TEST
    topicName

    string

    必須

    使用者グループがサブスクライブする Topic の名前。

    topicxxx

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例

    リクエストパラメーターは必要ありません。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    結果

    requestId

    string

    リクエストの一意の ID。この ID を使用して問題をトラブルシューティングします。

    C115601B-8736-5BBF-AC99-7FEAE1245A80
    success

    boolean

    リクエストが成功したかどうかを示します。

    true
    data

    object

    返されたデータ。

    instanceId

    string

    インスタンスの ID。

    rmq-cn-7e22ody****
    topicName

    string

    使用者グループがサブスクライブする Topic。

    topic_test
    consumerGroupId

    string

    使用者グループの ID。

    CID-TEST
    minTimestamp

    integer

    Topic 内の最も古いメッセージの生成時間。

    1570761026222
    maxTimestamp

    integer

    Topic 内の最新メッセージの生成時間。

    1570761026833
    consumeTimestamp

    integer

    使用者グループがこの Topic からメッセージを最後に消費した時間。

    1570761026400
    code

    string

    エラーコード。

    MissingInstanceId
    message

    string

    エラーメッセージ。

    Parameter instanceId is mandatory for this action .
    httpStatusCode

    integer

    HTTP ステータスコード。

    200
    dynamicCode

    string

    動的エラーコード。

    xxx
    dynamicMessage

    string

    動的エラーメッセージ。

    xxx

    例

    成功レスポンス

    JSONJSON

    {
  "requestId": "C115601B-8736-5BBF-AC99-7FEAE1245A80",
  "success": true,
  "data": {
    "instanceId": "rmq-cn-7e22ody****",
    "topicName": "topic_test",
    "consumerGroupId": "CID-TEST",
    "minTimestamp": 1570761026222,
    "maxTimestamp": 1570761026833,
    "consumeTimestamp": 1570761026400
  },
  "code": "MissingInstanceId",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 200,
  "dynamicCode": "xxx",
  "dynamicMessage": "xxx"
}

    エラーコード

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

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。