全部產品
Search
文件中心

Key Management Service:ListBackups - 查詢備份列表

更新時間:Aug 14, 2025

擷取符合查詢條件的備份組合。

調試

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

調試

授權資訊

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

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

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-hsm:ListBackups

list

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

RegionId

string

地區 ID。

cn-hangzhou

CurrentPage

integer

當前分頁。

1

PageSize

integer

每頁顯示的備份個數。取值:1~1000。

20

Name

string

備份名稱。

hsm-te****

BackupId

string

備份 ID。

backup-1648438****

InstanceId

string

密碼機執行個體 ID。

hsm-cn-vj30bil8****

返回參數

名稱

類型

描述

樣本值

object

響應資訊。

RequestId

string

本次調用請求的 ID,是由阿里雲為該請求產生的唯一識別碼,可用於排查和定位問題。

4C467B38-3910-447D-87BC-AC049166F216

TotalCount

integer

查詢結果總數。

30

PageSize

integer

每頁顯示的備份個數。

20

CurrentPage

integer

當前分頁。

1

Backups

array<object>

返回的備份列表。

object

備份詳情。

BackupId

string

備份 ID。

backup-1648438****

CreateTime

integer

備份建立時間,精確到毫秒。時間戳記格式。

1637229596000

ExpireTime

integer

備份到期時間,精確到毫秒。時間戳記格式。

1682417553781

InstanceId

string

備份關聯的密碼機執行個體 ID。

hsm-cn-vj30bil8****

Name

string

備份名稱。

backup-te****

RegionId

string

地區 ID。

ap-southeast-1

Remark

string

備份備忘。

normal backup

Status

string

備份狀態。

  • NEW:未啟用

  • EXPIRED:已到期

  • ENABLED:已啟用

ENABLED

MaxImageCount

string

鏡像數量。

3

Type

string

備份類型。

  • DEFAULT:預設備份

  • NORMAL:標準備份

NORMAL

BackupPeriod

integer

自動備份周期,單位天數。

3

NextImageCreateTime

integer

鏡像下一次建立時間,精確到毫秒。時間戳記格式。

1682417553781

AutoImageCount

integer

自動備份鏡像數量。

1

BackupHourInDay

string

備份時間,24 小時制整點時間。

13

SpInstanceId

string

售賣域備份 ID。 僅中國內地密碼機備份有此屬性。

backup-fdb897sdfg534-****

ReleaseTime

integer

備份釋放時間,精確到毫秒。時間戳記格式。

1641275680000

OwnerInstanceId

string

備份所屬的密碼機執行個體 ID。僅非中國內地密碼機備份有此屬性,且與 InstanceId 一致。

hsm-cn-vj30bil8****

樣本

正常返回樣本

JSON格式

{
  "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
  "TotalCount": 30,
  "PageSize": 20,
  "CurrentPage": 1,
  "Backups": [
    {
      "BackupId": "backup-1648438****",
      "CreateTime": 1637229596000,
      "ExpireTime": 1682417553781,
      "InstanceId": "hsm-cn-vj30bil8****",
      "Name": "backup-te****",
      "RegionId": "ap-southeast-1",
      "Remark": "normal backup",
      "Status": "ENABLED",
      "MaxImageCount": "3",
      "Type": "NORMAL",
      "BackupPeriod": 3,
      "NextImageCreateTime": 1682417553781,
      "AutoImageCount": 1,
      "BackupHourInDay": "13",
      "SpInstanceId": "backup-fdb897sdfg534-****",
      "ReleaseTime": 1641275680000,
      "OwnerInstanceId": "hsm-cn-vj30bil8****"
    }
  ]
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

403 NoPermission caller has no permission

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

變更歷史

更多資訊,參考變更詳情