ListBackups API で HSM バックアップセットをフィルタリングして取得 - KMS - Alibaba Cloud - Key Management Service

指定された条件を満たすバックアップセットのリストを取得します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

yundun-hsm:ListBackups

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。	cn-hangzhou
CurrentPage	integer	必須	現在のページ番号。	1
PageSize	integer	必須	各ページに返すバックアップの数。有効値：1～1000。	20
Name	string	任意	バックアップの名前。	hsm-te****
BackupId	string	任意	バックアップの ID。	backup-1648438****
InstanceId	string	任意	ハードウェアセキュリティモジュール (HSM) インスタンスの 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	バックアップに関連付けられている HSM インスタンスの 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。このパラメーターは、中国本土の HSM インスタンスのバックアップに対してのみ返されます。	backup-fdb897sdfg534-****
ReleaseTime	integer	バックアップがリリースされた時刻。これはミリ秒単位のタイムスタンプです。	1641275680000
OwnerInstanceId	string	バックアップを所有する HSM インスタンスの ID。このパラメーターは、中国本土以外の HSM インスタンスのバックアップに対してのみ返されます。値は InstanceId と同じです。	hsm-cn-vj30bil8****

例

成功レスポンス

JSONJSON

{
  "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 ステータスコード	エラーコード	エラーメッセージ	説明
403	NoPermission	caller has no permission

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

変更履歴

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