ListSnapshots を使用してスナップショット情報をクエリ - SAS

簡易アプリケーションサーバー用に作成されたスナップショットの情報を照会します。

操作説明

InstanceId、DiskId、SnapshotIds、および ResourceGroupId パラメーターはオプションです。ただし、これらをフィルター条件として指定し、論理 AND 演算子と組み合わせて、照会するスナップショットをフィルターできます。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

swas-open:ListSnapshots

get

*Snapshot

acs:swas-open:{#regionId}:{#accountId}:snapshot/*

*Snapshot

acs:swas-open:{#regionId}:{#accountId}:snapshot/{#SnapshotId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	スナップショットに対応する簡易アプリケーションサーバーのリージョン ID。	cn-hangzhou
InstanceId	string	任意	簡易アプリケーションサーバーの ID。	2ad1ae67295445f598017499dc****
DiskId	string	任意	ディスク ID。	d-bp14wq0149cpp2xy****
SnapshotIds	string	任意	スナップショット ID。値は最大 100 個のスナップショット ID で構成される JSON 配列にできます。複数のスナップショット ID はコンマ (,) で区切ります。	["s-bp16oazlsold4dks**", "s-bp16oazlsold4abc**"]
PageSize	integer	任意	ページあたりのエントリ数。最大値： 100。デフォルト値： 10。	10
PageNumber	integer	任意	ページ番号。デフォルト値： 1。	1
SourceDiskType	string	任意	ソースディスクのタイプ。有効な値： system: システムディスク。 data: データディスク。	Data
Tag	array<object>	任意	スナップショットに追加するタグ N。
	object	任意	スナップショットのタグ。
Key	string	任意	スナップショットに追加するタグ N のキー。タグキーは 1～64 文字の長さです。N の有効な値： 1～20。	TestKey
Value	string	任意	スナップショットに追加するタグ N の値。タグ値は最大 64 文字の長さです。N の有効な値： 1～20。	TestValue
ResourceGroupId	string	任意	リソースグループの ID。	rg-aek2bti7cf7****

レスポンスフィールド

フィールド	型	説明	例
	object
TotalCount	integer	返されたエントリの総数。	1
RequestId	string	リクエスト ID。	20758A-585D-4A41-A9B2-28DA8F4F534F
PageSize	integer	ページあたりのエントリ数。	10
PageNumber	integer	ページ番号。	1
Snapshots	array<object>	スナップショットの詳細。
	array<object>	スナップショットの詳細。
Status	string	スナップショットのステータス。有効な値： Progressing: スナップショット作成中。 Accomplished: スナップショット作成済み。 Failed: スナップショット作成に失敗しました。	Accomplished
CreationTime	string	スナップショットが作成された時刻。ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 形式に従います。時刻は UTC で表示されます。	2021-03-09T07:12:49Z
SourceDiskId	string	ソースディスクの ID。このパラメーターは、ソースディスクがリリースされた後でも値を持っています。	d-bp14wq0149cpp2xy****
SnapshotName	string	スナップショットの名前。	test-SnapshotName
Progress	string	スナップショット作成の進捗。	100%
Remark	string	スナップショットの備考。	test-Remark
SnapshotId	string	スナップショット ID。	s-bp16oazlsold4dks****
SourceDiskType	string	ソースディスクのタイプ。有効な値： system: システムディスク。 data: データディスク。	System
RegionId	string	リージョン ID。	cn-hangzhou
InstanceId	string	簡易アプリケーションサーバーの ID。注: このパラメーターは、システムディスクのスナップショットに対してのみ返される値です。	2ad1ae67295445f598017499dc****
Tags	array<object>	スナップショットのタグ。
	object	スナップショットのタグ。
Key	string	スナップショットのタグキー。	TestKey
Value	string	スナップショットのタグ値。	TestValue
RollbackTime	string	最後のディスクロールバックが実行された時刻。	2021-03-09T07:12:49Z
ResourceGroupId	string	スナップショットが属するリソースグループの ID。	rg-aek2bti7cf7****

例

成功レスポンス

JSONJSON

{
  "TotalCount": 1,
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "PageSize": 10,
  "PageNumber": 1,
  "Snapshots": [
    {
      "Status": "Accomplished",
      "CreationTime": "2021-03-09T07:12:49Z",
      "SourceDiskId": "d-bp14wq0149cpp2xy****",
      "SnapshotName": "test-SnapshotName",
      "Progress": "100%",
      "Remark": "test-Remark",
      "SnapshotId": "s-bp16oazlsold4dks****",
      "SourceDiskType": "System",
      "RegionId": "cn-hangzhou",
      "InstanceId": "2ad1ae67295445f598017499dc****",
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "RollbackTime": "2021-03-09T07:12:49Z",
      "ResourceGroupId": "rg-aek2bti7cf7****"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	RegionIdNotMatchHost	The parameter regionId does not match the endpoint host.
400	InvalidSnapshotIds	The specified SnapshotIds is not valid.
500	InternalError	An error occurred while processing your request.
403	InvalidParam	The specified parameter value is invalid.
404	InvalidInstanceId.NotFound	The specified InstanceId does not exist.
404	InvalidDiskId.NotFound	The specified DiskId does not exist.

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

変更履歴

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