すべてのプロダクト
Search

このプロダクト

    Tair (Redis® OSS-Compatible):DescribeClusterBackupList

    ドキュメントセンター

    Tair (Redis® OSS-Compatible):DescribeClusterBackupList

    最終更新日:Mar 30, 2026

    Tair (Redis OSS-compatible) クラスターインスタンスのバックアップリストを照会します。

    操作説明

    この API は、クラウドネイティブインスタンスにのみ適用されます。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    kvstore:DescribeClusterBackupList

    get

    *DBInstance

    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    インスタンスのリージョン ID。最新のリージョン一覧を照会するには、DescribeRegions 操作を呼び出します。

    cn-zhangjiakou
    InstanceId

    string

    必須

    インスタンス ID。

    r-t4nj72oug5r5646qog
    ClusterBackupId

    string

    任意

    バックアップセット ID。

    cb-hyxdof5x9kqbtust

    PageSize

    integer

    任意

    1 ページあたりのエントリ数。

    有効な値：

    • 30

    • 50

    • 100

    • 200

    • 300

    • 5

    • 10

    • 15

    • 20

    30
    PageNumber

    integer

    任意

    ページ番号。

    1
    StartTime

    string

    必須

    照会対象の時間範囲の開始時刻。ISO 8601 標準に従い、yyyy-MM-ddTHH:mmZ 形式で指定してください。時刻は協定世界時 (UTC) で表記します。

    2024-06-28T08:26Z
    EndTime

    string

    必須

    照会対象の時間範囲の終了時刻。ISO 8601 標準に従い、yyyy-MM-ddTHH:mmZ 形式で指定してください。時刻は協定世界時 (UTC) で表記します。終了時刻は開始時刻より後である必要があります。

    2024-07-01T09:26Z
    NoShardBackup

    string

    任意

    インスタンス内のシャードのバックアップセット情報を表示するかどうかを指定します。

    • true：インスタンス内のシャードのバックアップセット情報を表示しません。

    • false（デフォルト）：インスタンス内のシャードのバックアップセット情報を表示します。

    有効な値：

    • True

    • False

    True

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーター。

    RequestId

    string

    リクエスト ID。

    C009DA42-3B19-5B81-963D-1509DE2408DD
    MaxResults

    integer

    返される最大エントリ数。

    4
    PageNumber

    integer

    ページ番号。

    1
    PageSize

    integer

    1 ページあたりに返される最大エントリ数。

    30
    FullStorageSize

    integer

    インスタンスの完全バックアップファイルのサイズ。単位：バイト。完全バックアップは、スケジュールされたバックアップ、手動バックアップ、およびキャッシュ解析中に生成されたバックアップから作成されます。

    説明

    このパラメーターの値は、返されるバックアップセットの数およびサイズとは無関係です。代わりに、インスタンスのすべての有効な完全バックアップの合計サイズを表します。

    1000
    LogStorageSize

    integer

    インスタンスのログバックアップファイルのサイズ。単位：バイト。このパラメーターは、フラッシュバックが有効な場合にのみ有効です。

    説明

    このパラメーターの値は、返されるバックアップセットの数およびサイズとは無関係です。代わりに、インスタンスのすべての有効なログバックアップの合計サイズを表します。

    5000
    FreeSize

    integer

    このパラメーターは機能しません。無視してください。

    100000
    ClusterBackups

    array<object>

    インスタンスのバックアップセット。1 つのバックアップには、インスタンス内のすべてのシャードのバックアップセットが含まれます。

    array<object>

    インスタンスのバックアップセット。1 つのバックアップには、インスタンス内のすべてのシャードのバックアップセットが含まれます。

    IsAvail

    integer

    バックアップセットが有効かどうかを示します。値が 0 の場合、シャードレベルのバックアップが失敗したか、まだ完了していないことを意味します。

    1
    ClusterBackupId

    string

    バックアップセットの ID。

    cb-zmdqj2m3xyxjtdt0
    ClusterBackupStatus

    string

    バックアップセットのステータス。

    • OK

    • RUNNING

    • Failed

    OK
    ClusterBackupSize

    string

    バックアップセットのサイズ。

    2048
    ClusterBackupStartTime

    string

    バックアップの開始時刻。

    2024-01-10T17:21:25Z
    ClusterBackupEndTime

    string

    バックアップの終了時刻。

    2024-01-10T17:21:55Z
    ClusterBackupMode

    string

    バックアップモード。

    Automated
    ShardClassMemory

    integer

    完全バックアップ時の単一シャードのメモリサイズ。単位：MB。

    1024
    Backups

    array<object>

    インスタンス内のすべてのシャードのバックアップセット。

    array<object>

    照会されたバックアップセット。

    BackupId

    string

    バックアップファイルの ID。

    514645788
    InstanceName

    string

    インスタンス名。

    r-bp1y4is8svonly****-db-0
    BackupDownloadURL

    string

    バックアップファイルのパブリックダウンロード URL。

    http://rdsbakbucket-huhehaote-v2.oss-cn-huhehaote.aliyuncs.com/custins424747958/hins100322105_data_20240110012135.rdb
    BackupIntranetDownloadURL

    string

    バックアップファイルの内部ダウンロード URL。

    説明

    この URL を使用して、Tair (Redis OSS-compatible) インスタンスに接続されている Elastic Compute Service (ECS) インスタンスからバックアップファイルをダウンロードできます。ECS インスタンスは、Tair (Redis OSS-compatible) インスタンスと同じ仮想プライベートクラウド (VPC) 内に配置されている必要があります。

    http://rdsbakbucket-huhehaote-v2.oss-cn-huhehaote-internal.aliyuncs.com/custins424747958/hins100322105_data_20240110012135.rdb
    RecoverConfigMode

    string

    このパラメーターは機能しません。無視してください。

    null
    BackupStartTime

    string

    バックアップの開始時刻。ISO 8601 標準に従い、yyyy-MM-ddTHH:mm:ssZ 形式で表記されます。時刻は協定世界時 (UTC) で表示されます。

    2024-01-09T17:21:30Z
    BackupEndTime

    string

    バックアップの終了時刻。ISO 8601 標準に従い、yyyy-MM-ddTHH:mm:ssZ 形式で表記されます。時刻は協定世界時 (UTC) で表示されます。

    2024-01-09T17:21:57
    BackupSize

    string

    バックアップファイルのサイズ。単位：バイト。

    1024
    IsAvail

    string

    バックアップセットが利用可能かどうかを示します。有効な値：

    • 0：利用不可

    • 1：利用可能

    1
    BackupStatus

    string

    バックアップのステータス。有効な値：

    • OK

    • ERROR

    OK
    BackupName

    string

    バックアップの名前。

    hins100322105_data_20240110012135.rdb
    Engine

    string

    データベースエンジン。戻り値は redis です。

    redis
    ExtraInfo

    object

    追加情報。

    CustinsDbVersion

    string

    エンジンのバージョン。

    5.0
    Progress

    string

    バックアップの進行状況。システムでは、実行中のバックアップタスクの進行状況のみを表示します。

    100%
    ExpectExpireTime

    string

    バックアップセットの生存時間 (TTL)。形式は yyyy-MM-ddTHH:mmZ（協定世界時 (UTC)）です。

    2025-06-01T21:51:22Z

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "C009DA42-3B19-5B81-963D-1509DE2408DD",
  "MaxResults": 4,
  "PageNumber": 1,
  "PageSize": 30,
  "FullStorageSize": 1000,
  "LogStorageSize": 5000,
  "FreeSize": 100000,
  "ClusterBackups": [
    {
      "IsAvail": 1,
      "ClusterBackupId": "cb-zmdqj2m3xyxjtdt0",
      "ClusterBackupStatus": "OK",
      "ClusterBackupSize": "2048",
      "ClusterBackupStartTime": "2024-01-10T17:21:25Z",
      "ClusterBackupEndTime": "2024-01-10T17:21:55Z",
      "ClusterBackupMode": "Automated",
      "ShardClassMemory": 1024,
      "Backups": [
        {
          "BackupId": "514645788",
          "InstanceName": "r-bp1y4is8svonly****-db-0",
          "BackupDownloadURL": "http://rdsbakbucket-huhehaote-v2.oss-cn-huhehaote.aliyuncs.com/custins424747958/hins100322105_data_20240110012135.rdb",
          "BackupIntranetDownloadURL": "http://rdsbakbucket-huhehaote-v2.oss-cn-huhehaote-internal.aliyuncs.com/custins424747958/hins100322105_data_20240110012135.rdb",
          "RecoverConfigMode": "null",
          "BackupStartTime": "2024-01-09T17:21:30Z",
          "BackupEndTime": "2024-01-09T17:21:57",
          "BackupSize": "1024",
          "IsAvail": "1",
          "BackupStatus": "OK",
          "BackupName": "hins100322105_data_20240110012135.rdb",
          "Engine": "redis",
          "ExtraInfo": {
            "CustinsDbVersion": "5.0"
          }
        }
      ],
      "Progress": "100%",
      "ExpectExpireTime": "2025-06-01T21:51:22Z"
    }
  ]
}

    エラーコード

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

    変更履歴

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