すべてのプロダクト
Search

このプロダクト

    ApsaraMQ for RocketMQ:ListDisasterRecoveryCheckpoints

    ドキュメントセンター

    ApsaraMQ for RocketMQ:ListDisasterRecoveryCheckpoints

    最終更新日:Sep 24, 2026

    コンシューマーオフセット同期チェックポイントのリストを照会します。

    操作説明

    この操作の呼び出し前に、Global Replicator バックアッププランを作成し、そのプランに Topic マッピング項目を追加します。その後、対応する planId、itemId、およびソースインスタンス ID を使用して、コンシューマーオフセット同期チェックポイントをクエリします。Global Replicator を使用するには、アカウントに AliyunServiceRoleForRMQDisasterRecovery サービスリンクロールがあることを確認してください。通常、関連する特徴を初めて使用する際に、システムがこのロールを自動作成します。

    今すぐお試しください

    この 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:ListDisasterRecoveryCheckpoints

    list

    *すべてのリソース。

    *

    		 なし なし

    リクエスト構文

    GET /disaster_recovery/{planId}/items/{itemId}/checkpoints HTTP/1.1

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    planId

    string

    必須

    バックアッププランの ID。

    1300000016
    itemId

    string

    必須

    バックアップマッピングの ID。

    100070284

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    instanceId

    string

    必須

    ソースインスタンスのインスタンス ID。

    rmq-cn-7e22ody****
    filter

    string

    任意

    フィルター条件。

    topic_test
    pageNumber

    integer

    任意

    現在のページ番号。1 から始まります。

    1
    pageSize

    integer

    任意

    ページサイズ。1 ページあたりに返す結果の最大値。

    10

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答。

    requestId

    string

    リクエストの ID。

    AF9A8B10-C426-530F-A0DD-96320B39****
    success

    boolean

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

    true
    data

    object

    返されるデータ。

    pageNumber

    integer

    現在のページ番号。

    1
    pageSize

    integer

    ページサイズ。

    10
    totalCount

    integer

    レコードの総数。

    1
    list

    array<object>

    ページネーションされたデータ。

    array<object>

    ページネーションされたデータ。

    planId

    integer

    バックアッププランの ID。

    13000000xx
    itemId

    integer

    バックアップマッピングの ID。

    10000000xx
    checkpointId

    integer

    コンシューマーオフセットチェックポイントの ID。

    10000000xx
    lastSyncTime

    integer

    最新の同期時間。値はミリ秒単位の UNIX タイムスタンプです。

    1740724080343
    sourceProgress

    object

    ソースのコンシューマーオフセット。

    regionId

    string

    リージョンの ID。

    cn-hangzhou
    instanceId

    string

    インスタンスの ID。

    rmq-cn-3mp3vblzxxx
    instanceType

    string

    インスタンスタイプ。有効な値:

    • ALIYUN_ROCKETMQ: Alibaba Cloud インスタンス。

    • EXTERNAL_ROCKETMQ: 外部インスタンス、オープンソースインスタンス、またはオープンソースクラスター。

    ALIYUN_ROCKETMQ
    consumerGroupId

    string

    コンシューマーグループの ID。

    GID_TEST
    topicName

    string

    Topic 名。

    TOPIC_TEST
    lastFetchTime

    integer

    最新のフェッチ時間。値はミリ秒単位の UNIX タイムスタンプです。

    1740724080343
    progressData

    object

    コンシューマーオフセットデータ。

    consumeTimestamp

    integer

    最新の消費時間。

    1740724080343
    targetProgress

    object

    ターゲットのコンシューマーオフセット。

    regionId

    string

    リージョンの ID。

    cn-hangzhou
    instanceId

    string

    インスタンスの ID。

    rmq-cn-nwy3i065xxx
    instanceType

    string

    インスタンスタイプ。有効な値:

    • ALIYUN_ROCKETMQ: Alibaba Cloud インスタンス。

    • EXTERNAL_ROCKETMQ: 外部インスタンス、オープンソースインスタンス、またはオープンソースクラスター。

    ALIYUN_ROCKETMQ
    consumerGroupId

    string

    コンシューマーグループの ID。

    GID_TEST
    topicName

    string

    Topic 名。

    TOPIC_TEST
    lastFetchTime

    integer

    最新のフェッチ時間。値はミリ秒単位の UNIX タイムスタンプです。

    1740724080343
    progressData

    object

    コンシューマーオフセットデータ。

    consumeTimestamp

    integer

    最新の消費時間。

    1740724080343
    code

    string

    エラーコード。

    200
    message

    string

    エラーメッセージ。

    インスタンスが見つかりません
    httpStatusCode

    integer

    HTTP 状態コード。

    200
    dynamicCode

    string

    動的エラーコード。

    InstanceId
    dynamicMessage

    string

    動的エラーメッセージ。

    インスタンス ID

    例

    成功レスポンス

    JSONJSON

    {
  "requestId": "AF9A8B10-C426-530F-A0DD-96320B39****",
  "success": true,
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 1,
    "list": [
      {
        "planId": 0,
        "itemId": 0,
        "checkpointId": 0,
        "lastSyncTime": 1740724080343,
        "sourceProgress": {
          "regionId": "cn-hangzhou",
          "instanceId": "rmq-cn-3mp3vblzxxx",
          "instanceType": "ALIYUN_ROCKETMQ",
          "consumerGroupId": "GID_TEST",
          "topicName": "TOPIC_TEST",
          "lastFetchTime": 1740724080343,
          "progressData": {
            "consumeTimestamp": 1740724080343
          }
        },
        "targetProgress": {
          "regionId": "cn-hangzhou",
          "instanceId": "rmq-cn-nwy3i065xxx",
          "instanceType": "ALIYUN_ROCKETMQ",
          "consumerGroupId": "GID_TEST",
          "topicName": "TOPIC_TEST",
          "lastFetchTime": 1740724080343,
          "progressData": {
            "consumeTimestamp": 1740724080343
          }
        }
      }
    ]
  },
  "code": "200",
  "message": "The instance cannot be found.",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

    エラーコード

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

    変更履歴

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