すべてのプロダクト
Search

このプロダクト

    Tair (Redis® OSS-Compatible):DescribeBackups

    ドキュメントセンター

    Tair (Redis® OSS-Compatible):DescribeBackups

    最終更新日:Mar 30, 2026

    Redis 互換 ApsaraDB for Tair インスタンスのバックアップファイルに関する情報をクエリします。

    操作説明

    この操作はクラウドネイティブ クラスターインスタンスには適用されません。代わりに、DescribeClusterBackupList 操作を使用してください。

    今すぐお試しください

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

    get

    *DBInstance

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    InstanceId

    string

    必須

    インスタンスの ID。

    r-bp1zxszhcgatnx****
    BackupId

    integer

    任意

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

    11611111
    BackupJobId

    integer

    任意

    CreateBackup 操作によって返されるバックアップジョブの ID。CreateBackup が複数のバックアップジョブ ID を返す場合、各 ID に対してこの操作を呼び出します。

    10001
    PageSize

    integer

    任意

    1 ページあたりに返されるエントリの最大数。有効な値: 30、50、100、200、300。

    30
    PageNumber

    integer

    任意

    返すページ番号。値は 0 より大きい必要があります。デフォルト値は 1 です。

    1
    StartTime

    string

    必須

    クエリの開始時刻。時刻は協定世界時 (UTC) で yyyy-MM-ddTHH:mmZ 形式を使用して指定します。

    2019-03-11T10:00Z
    EndTime

    string

    必須

    クエリの終了時刻。終了時刻は開始時刻より後である必要があります。時刻は協定世界時 (UTC) で yyyy-MM-ddTHH:mmZ 形式を使用して指定します。

    2019-03-14T18:00Z
    NeedAof

    string

    任意

    AOF 永続化を有効にするかどうかを指定します。有効な値:

    • 0: 無効。

    • 1: 有効。

    説明

    デフォルト値は 0 です。

    1

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

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

    RequestId

    string

    リクエスト ID。

    963C20F0-7CE1-4591-AAF3-6F3CD1CE****
    PageNumber

    integer

    ページ番号。

    1
    PageSize

    integer

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

    30
    TotalCount

    integer

    バックアップセットの総数。

    5
    FullStorageSize

    integer

    インスタンスの完全バックアップの合計サイズ (バイト単位)。完全バックアップは、スケジュールされた日次バックアップ、手動バックアップ、またはキャッシュ解析から生成されます。

    説明

    この値は、このリクエストで返されるバックアップセットに関係なく、インスタンスのすべての有効な完全バックアップの合計サイズを表します。

    1000
    LogStorageSize

    integer

    インスタンスのログバックアップの合計サイズ (バイト単位)。このパラメーターは、フラッシュバックが有効な場合にのみ返されます。

    説明

    この値は、このリクエストで返されるバックアップセットに関係なく、インスタンスのすべての有効なログバックアップの合計サイズを表します。

    5000
    FreeSize

    integer

    このパラメーターは有効ではありません。このパラメーターは無視してください。

    100000
    Backups

    object

    バックアップセットに関する詳細。

    Backup

    array<object>

    バックアップセットの配列。

    object

    バックアップセットの詳細。

    BackupStatus

    string

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

    • Success: バックアップは成功しました。

    • Failed: バックアップは失敗しました。

    Success
    BackupStartTime

    string

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

    2019-03-14T05:28:50Z
    BackupType

    string

    バックアップタイプ。有効な値:

    • FullBackup: 完全バックアップ。

    • IncrementalBackup: 増分バックアップ。

    FullBackup
    BackupDownloadURL

    string

    バックアップセットの公開ダウンロード URL。

    https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********
    NodeInstanceId

    string

    ノード ID。

    説明

    Standard Edition インスタンスの場合、このパラメーターはインスタンス ID を返します。

    r-bp10noxlhcoim2****-db-1
    BackupEndTime

    string

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

    2019-03-14T05:31:13Z
    BackupId

    integer

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

    165*****50
    BackupDBNames

    string

    バックアップされたデータベース。all の値は、すべてのデータベースがバックアップされたことを示します。

    all
    EngineVersion

    string

    インスタンスのエンジンバージョン。互換性のある Redis バージョンを指定します。

    4.0
    BackupIntranetDownloadURL

    string

    バックアップセットの内部ダウンロード URL。

    説明

    この URL を使用して、データベースインスタンスと同じ VPC 内にある ECS インスタンスからバックアップセットをダウンロードできます。

    https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********
    BackupSize

    integer

    バックアップセットのサイズ (バイト単位)。

    1024
    BackupMode

    string

    バックアップモード。有効な値:

    • Automated: 自動バックアップ。

    • Manual: 手動バックアップ。

    Automated
    BackupMethod

    string

    バックアップ方法。有効な値:

    • Logical: 論理バックアップ。

    • Physical: 物理バックアップ。

    Physical
    BackupJobID

    integer

    バックアップジョブの ID。

    24340
    RecoverConfigMode

    string

    バックアップセットに、アカウント (account)、カーネルパラメータ (config)、ホワイトリスト (whitelist) などの構成情報が含まれるかどうかを示します。

    説明

    このパラメーターは、クラウドネイティブエディションインスタンスでのみ利用可能です。これらの設定を変更した場合 (例: アカウントを作成したり、ホワイトリストに IP アドレスを追加したりした場合)、更新された情報は後続のバックアップセットに自動的に含まれます。

    {"whitelist":true,"config":true,"account":true}
    ExpectExpireTime

    string

    バックアップセットの有効期限。時刻は協定世界時 (UTC) で yyyy-MM-ddTHH:mm:ssZ 形式を使用します。

    2025-06-01T21:51:22Z
    AccessDeniedDetail

    object

    このパラメーターは非推奨です。

    AuthAction

    string

    このパラメーターは非推奨です。

    -
    AuthPrincipalDisplayName

    string

    このパラメーターは非推奨です。

    -
    AuthPrincipalOwnerId

    string

    このパラメーターは非推奨です。

    -
    AuthPrincipalType

    string

    このパラメーターは非推奨です。

    -
    EncodedDiagnosticMessage

    string

    このパラメーターは非推奨です。

    -
    NoPermissionType

    string

    このパラメーターは非推奨です。

    -
    PolicyType

    string

    このパラメーターは非推奨です。

    -

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "963C20F0-7CE1-4591-AAF3-6F3CD1CE****",
  "PageNumber": 1,
  "PageSize": 30,
  "TotalCount": 5,
  "FullStorageSize": 1000,
  "LogStorageSize": 5000,
  "FreeSize": 100000,
  "Backups": {
    "Backup": [
      {
        "BackupStatus": "Success",
        "BackupStartTime": "2019-03-14T05:28:50Z",
        "BackupType": "FullBackup",
        "BackupDownloadURL": "https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********",
        "NodeInstanceId": "r-bp10noxlhcoim2****-db-1",
        "BackupEndTime": "2019-03-14T05:31:13Z",
        "BackupId": 0,
        "BackupDBNames": "all",
        "EngineVersion": "4.0",
        "BackupIntranetDownloadURL": "https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********",
        "BackupSize": 1024,
        "BackupMode": "Automated",
        "BackupMethod": "Physical",
        "BackupJobID": 24340,
        "RecoverConfigMode": "{\"whitelist\":true,\"config\":true,\"account\":true}",
        "ExpectExpireTime": "2025-06-01T21:51:22Z"
      }
    ]
  },
  "AccessDeniedDetail": {
    "AuthAction": "-",
    "AuthPrincipalDisplayName": "-",
    "AuthPrincipalOwnerId": "-",
    "AuthPrincipalType": "-",
    "EncodedDiagnosticMessage": "-",
    "NoPermissionType": "-",
    "PolicyType": "-"
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidStartTime.Malformed The Specified parameter StartTime is not valid.
    400 InvalidEndTime.Malformed The Specified parameter EndTime is not valid.
    400 InvalidEngineVersion.Malformed The Specified EngieVersion is not valid.
    400 InvalidStartTimeAndEndTime.Malformed The end time must be greater than the start time.
    400 InvalidPageSize.Malformed The specified parameter PageSize is not valid.

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

    変更履歴

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