全部產品
Search

搜尋本產品

    Tair (Redis® OSS-Compatible)：DescribeClusterBackupList - 查詢叢集執行個體的備份列表

    文件中心

    Tair (Redis® OSS-Compatible)：DescribeClusterBackupList - 查詢叢集執行個體的備份列表

    更新時間：Mar 30, 2026

    查詢雲資料庫 Tair（相容 Redis）叢集執行個體的備份列表。

    介面說明

    本介面僅適用於雲原生版執行個體。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    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

    否

    每頁可展示的記錄數。

    30
    PageNumber

    integer

    否

    當前頁的頁碼。

    1
    StartTime

    string

    是

    查詢開始時間，格式為yyyy-MM-ddTHH:mmZ（UTC 時間）。

    2024-06-28T08:26Z
    EndTime

    string

    是

    查詢結束時間，必須晚於查詢開始時間，格式為yyyy-MM-ddTHH:mmZ（UTC 時間）。

    2024-07-01T09:26Z
    NoShardBackup

    string

    否

    是否展示叢集節點的備份組詳情：

    • false（預設）：展示叢集節點的備份組資訊。

    • true：不展示叢集節點的備份組資訊。

    True

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    請求響應

    RequestId

    string

    請求 ID。

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

    integer

    MaxResults 本次請求所返回的最大記錄條數

    4
    PageNumber

    integer

    第幾頁，同請求參數

    1
    PageSize

    integer

    一頁最大多少條記錄，同請求參數

    30
    FullStorageSize

    integer

    當前執行個體全量備份檔案的大小，單位是位元組。全量備份來源於每天定時備份、手動備份、緩衝分析時產生的備份等。

    說明

    該值和當前請求所響應的備份組數量以及大小無關，而是該執行個體當前所有有效全量備份的大小。

    1000
    LogStorageSize

    integer

    當前執行個體記錄備份檔案的大小，單位是位元組，若且唯若開啟閃回時才有效。

    說明

    該值和當前請求所響應的備份組數量以及大小無關，而是該執行個體當前所有有效記錄備份的大小。

    5000
    FreeSize

    integer

    該參數未生效，請忽略該參數。

    100000
    ClusterBackups

    array<object>

    叢集備份組列表，一個叢集備份裡麵包含各個節點的備份組

    array<object>

    叢集備份組列表，一個叢集備份裡麵包含各個節點的備份組。

    IsAvail

    integer

    叢集備份組是否有效，子節點的備份組未完成或者失敗時，為 0

    1
    ClusterBackupId

    string

    叢集備份組 ID

    cb-zmdqj2m3xyxjtdt0
    ClusterBackupStatus

    string

    叢集備份組狀態。

    • 成功：OK

    • 運行中：RUNNING

    • 失敗：其他欄位

    OK
    ClusterBackupSize

    string

    叢集備份組大小

    2048
    ClusterBackupStartTime

    string

    叢集備份開始時間。

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

    string

    叢集備份結束時間。

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

    string

    叢集備份模式。

    Automated
    ShardClassMemory

    integer

    做全量備份時，當時單個 DB 節點的記憶體規格大小，單位為 MB

    1024
    Backups

    array<object>

    單個叢集備份組下，各個子節點的備份組集合

    array<object>

    備份組詳情。

    BackupId

    string

    備份檔案的 ID。

    514645788
    InstanceName

    string

    執行個體的名稱。

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

    string

    備份檔案的外網下載地址。

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

    string

    備份檔案的內網下載地址。

    說明

    您可以在與該執行個體連通的 ECS（二者需屬於同一 VPC 內）上使用該地址下載目標備份檔案。

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

    string

    該參數暫未生效，請忽略該參數。

    null
    BackupStartTime

    string

    本次備份開始時間，格式為yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。

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

    string

    本次備份結束時間，格式為yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。

    2024-01-09T17:21:57
    BackupSize

    string

    備份檔案大小，單位為 Byte。

    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

    DB 的版本

    5.0
    Progress

    string

    備份進度，僅正在啟動並執行備份才會顯示進度

    100%
    ExpectExpireTime

    string

    備份組到期時間，格式為 yyyy-MM-ddTHH:mmZ（UTC 時間）。

    2025-06-01T21:51:22Z

    樣本

    正常返回樣本

    JSON格式

    {
  "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"
    }
  ]
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。