DescribeSnapshots - Elastic Compute Service - Alibaba Cloud ドキュメントセンター

クラウドディスクのスナップショットリストを照会します。スナップショットのステータス、作成中のスナップショットの残り時間、自動スナップショットの保持日数などの情報を取得できます。

操作説明

InstanceId、DiskId、SnapshotIds は必須のリクエストパラメーターではありませんが、フィルターロジックの構築に使用できます。これらのパラメーターは論理 AND の関係で評価されます。

クラウドアシスタント CLI を使用してこの操作を呼び出す場合、異なるデータタイプのリクエストパラメーターは特定の形式要件に従う必要があります。詳細については、CLI パラメーター形式を参照してください。

リクエスト例:

中国 (杭州) リージョンの ECS インスタンスのすべてのディスクのスナップショットリストを照会する

。

RegionId:  ap-southeast-1,   //リージョンを指定します。
InstanceId:  i-bp1fh7by6d9mw7zr****   //クエリするインスタンス ID を指定します。

。

中国 (杭州) リージョンの特定のディスクのスナップショット情報の詳細を照会する

。

RegionId:  ap-southeast-1,   //リージョンを指定します。
DiskId:   d-bp10e7ej8z743dmu****   //クエリするディスク ID を指定します。

。

中国 (杭州) リージョンの 2 つのスナップショットの詳細をスナップショット ID で照会する

。

RegionId:  ap-southeast-1,   //リージョンを指定します。
SnapshotIds:   ["d-bp10e7ej8z743dmu****", "s-bp19vd1lorzgzt2s****"]   //クエリするスナップショット ID の配列を指定します。

。

中国 (杭州) リージョンの特定の時点以降に作成されたスナップショットの詳細を照会する

。

RegionId:  ap-southeast-1,   //リージョンを指定します。
Filter.1.Key:   CreationStartTime,   //作成開始時刻のフィルターキーを指定します。
Filter.1.Value:   2024-11-27T00:00Z.

。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ecs:DescribeSnapshots

get

Snapshot

acs:ecs:{#regionId}:{#accountId}:snapshot/*

Snapshot

acs:ecs:{#regionId}:{#accountId}:snapshot/{#snapshotId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	任意	インスタンス ID。このパラメーターを指定すると、指定されたインスタンスにアタッチされたディスクのスナップショット情報をクエリできます。	i-bp67acfmxazb4p****
DiskId	string	任意	ディスクの ID。	d-bp67acfmxazb4p****
SnapshotLinkId	string	任意	スナップショットチェーンの ID。	sl-bp1grgphbcc9brb5****
RegionId	string	必須	ディスクのリージョン ID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。	cn-hangzhou
SnapshotIds	string	任意	スナップショットの ID。値は最大 100 個のスナップショット ID で構成される JSON 配列です。ID はコンマ (,) で区切ります。	["s-bp67acfmxazb4p**", "s-bp67acfmxazb5p", … "s-bp67acfmxazb6p**"]
PageNumber	integer	任意	説明このパラメーターは非推奨になる予定です。ページングクエリ操作には NextToken と MaxResults を使用してください。	1
PageSize	integer	任意	説明このパラメーターは非推奨になる予定です。ページングクエリ操作には NextToken と MaxResults を使用してください。	10
NextToken	string	任意	ページネーショントークン。前回のリクエストの応答から取得されます。	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	任意	ページングクエリの 1 ページあたりの最大エントリ数。最大値: 100。デフォルト値: 10。	10
SnapshotName	string	任意	スナップショットの名前。	testSnapshotName
Status	string	任意	スナップショットのステータス。有効な値: progressing: スナップショットは作成中です。 accomplished: スナップショットは作成済みです。 failed: スナップショットの作成に失敗しました。 all (デフォルト): すべてのスナップショットステータス。	all
SnapshotType	string	任意	自動作成のタイプ。有効な値: auto: 自動スナップショット。 user: 手動スナップショット。 all (デフォルト): すべての自動作成タイプ。	all
Filter.1.Key	string	任意	リソースのクエリに使用するフィルターキー。値を `CreationStartTime` に設定します。`Filter.1.Key` と `Filter.1.Value` の両方を指定すると、指定された時点以降に作成されたリソースをクエリできます。	CreationStartTime
Filter.2.Key	string	任意	リソースのクエリに使用するフィルターキー。値を `CreationEndTime` に設定します。`Filter.2.Key` と `Filter.2.Value` の両方を指定すると、指定された時点以前に作成されたリソースをクエリできます。	CreationEndTime
Filter.1.Value	string	任意	リソースのクエリに使用するフィルター値。このパラメーターを指定する場合、`Filter.1.Key` も指定する必要があります。時間は協定世界時 (UTC) の `yyyy-MM-ddTHH:mmZ` 形式で指定します。	2019-12-13T17:00Z
Filter.2.Value	string	任意	リソースのクエリに使用するフィルター値。このパラメーターを指定する場合、`Filter.2.Key` も指定する必要があります。時間は協定世界時 (UTC) の `yyyy-MM-ddTHH:mmZ` 形式で指定します。	2019-12-13T22:00Z
Usage	string	任意	スナップショットがイメージまたはディスクの作成に使用されたかどうかを指定します。有効な値: image: スナップショットはカスタムイメージの作成に使用されました。 disk: スナップショットはディスクの作成に使用されました。 image_disk: スナップショットはデータディスクとカスタムイメージの両方の作成に使用されました。 none: スナップショットは使用されていません。	none
SourceDiskType	string	任意	ソースディスクのタイプ。有効な値: system: システムディスク。 data: データディスク。説明値は大文字と小文字を区別しません。	system
Encrypted	boolean	任意	暗号化されたスナップショットをフィルターするかどうかを指定します。デフォルト値: false。	false
ResourceGroupId	string	任意	リソースグループの ID。このパラメーターを使用してリソースをフィルターする場合、リソース数は 1000 を超えることはできません。説明デフォルトのリソースグループによるフィルターはサポートされていません。	rg-bp67acfmxazb4p****
DryRun	boolean	任意	実際のリクエストを実行せずにドライランのみを実行するかどうかを指定します。 true: チェックリクエストのみを送信し、リソースステータスはクエリしません。チェック項目には、AccessKey ペアが有効かどうか、Resource Access Management (RAM) ユーザーの権限付与が有効かどうか、必須パラメーターが指定されているかどうかが含まれます。チェックに失敗した場合、対応するエラーが返されます。チェックに成功した場合、DryRunOperation エラーコードが返されます。 false (デフォルト): 通常のリクエストを送信します。チェックに成功した後、2xx HTTP 状態コードが返され、リソースステータスがクエリされます。	false
KMSKeyId	string	任意	データディスクで使用される Key Management サービス (KMS) キーの ID。	0e478b7a-4262-4802-b8cb-00d3fb40****
Category	string	任意	スナップショットのカテゴリ。有効な値: Standard: 標準スナップショット。 Flash: ローカルスナップショット。この値は非推奨になる予定です。ローカルスナップショットはスナップショットのインスタントアクセス機能に置き換えられました。メトリックの説明は以下のとおりです: 2020 年 12 月 14 日より前にローカルスナップショットを使用していた場合、このパラメーターはまだアクティブなため引き続き使用できます。 2020 年 12 月 14 日より前にローカルスナップショットを使用していなかった場合、このパラメーターは使用できません。 archive: アーカイブスナップショット。	Standard
Tag	array<object>	任意	タグ。
	object	任意
key	string	任意	リソースのタグキー。説明互換性を高めるため、代わりに Tag.N.Key を使用してください。	SnapshotTest
Key	string	任意	スナップショットのタグキー。N の有効な値: 1 ～ 20。単一のタグを使用してリソースをフィルターする場合、指定されたタグを持つリソース数は 1000 を超えることはできません。複数のタグを使用してリソースをフィルターする場合、指定されたすべてのタグがアタッチされたリソース数は 1000 を超えることはできません。リソース数が 1000 を超える場合は、 ListTagResources 操作を呼び出してください。	TestKey
Value	string	任意	スナップショットのタグ値。N の有効な値: 1 ～ 20。	TestValue
value	string	任意	リソースのタグ値。説明互換性を高めるため、代わりに Tag.N.Value を使用してください。	SnapshotTest

レスポンスフィールド

フィールド	型	説明	例
	object
NextToken	string	次のクエリのページネーショントークン。	caeba0bbb2be03f84eb48b699f0a4883
PageSize	integer	説明このパラメーターは非推奨になる予定です。ページングクエリ操作には NextToken と MaxResults を使用してください。	10
PageNumber	integer	説明このパラメーターは非推奨になる予定です。ページングクエリ操作には NextToken と MaxResults を使用してください。	1
RequestId	string	リクエスト ID	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	スナップショットの総数。説明 `MaxResults` と `NextToken` パラメーターを使用してページングクエリを行う場合、返される `TotalCount` パラメーターの値は無効です。	1
Snapshots	object
Snapshot	array<object>	スナップショットの詳細。
	array<object>
Status	string	スナップショットのステータス。有効な値： `progressing`：スナップショットは作成中です。 `accomplished`：スナップショットは正常に作成されました。 `failed`：スナップショットの作成に失敗しました。	accomplished
CreationTime	string	スナップショットが作成された時刻。時刻は ISO 8601 標準に準拠し、協定世界時 (UTC) で表示されます。フォーマットは yyyy-MM-ddTHH:mm:ssZ です。	2020-08-20T14:52:28Z
Progress	string	スナップショット作成の進捗状況 (パーセンテージ)。	100%
InstantAccess	boolean	即時アクセス機能が有効になっているかどうかを示します。有効な値： `true`：機能は有効です。即時アクセス機能は、ESSD クラウドディスクおよび ESSD Entry クラウドディスクのスナップショットに対してデフォルトで有効になっています。 `false`：機能は無効で、スナップショットは標準スナップショットです。説明このパラメーターは非推奨です。ESSD クラウドディスクの標準スナップショットは、デフォルトで即時アクセスが有効になっています。この機能を設定する必要はなく、追加料金は発生しません。	false
Available	boolean	スナップショットを使用してクラウドディスクを作成したり、クラウドディスクをロールバックしたりできるかどうかを示します。有効な値： `true`：スナップショットは利用可能です。 `false`：スナップショットは利用できません。	false
RemainTime	integer	スナップショット作成の残り時間 (秒)。	38
SourceDiskSize	string	ソースクラウドディスクのサイズ (GiB)。	40
RetentionDays	integer	自動スナップショットの保持期間 (日)。	30
SourceDiskType	string	ソースクラウドディスクのタイプ。有効な値： `system`：システムディスク `data`：データディスク	system
SourceStorageType	string	ソースディスクのカテゴリ。説明このパラメーターは非推奨です。互換性を確保するために、他のパラメーターを使用することを推奨します。	disk
Usage	string	スナップショットがカスタムイメージまたはクラウドディスクの作成に使用されたかどうかを示します。有効な値： `image`：スナップショットはカスタムイメージの作成に使用されました。 `disk`：スナップショットはクラウドディスクの作成に使用されました。 `image_disk`：スナップショットはカスタムイメージとデータディスクの作成に使用されました。 `none`：スナップショットは使用されていません。	image
LastModifiedTime	string	スナップショットが最後に変更された時刻。時刻は ISO 8601 標準に準拠し、協定世界時 (UTC) で表示されます。フォーマットは yyyy-MM-ddTHH:mm:ssZ です。	2020-08-25T14:18:09Z
Encrypted	boolean	スナップショットが暗号化されているかどうかを示します。有効な値： `true`：スナップショットは暗号化されています。 `false`：スナップショットは暗号化されていません。	false
SnapshotType	string	スナップショットの作成に使用されたメソッド。有効な値： `auto` または `timer`：自動スナップショット。 `user`：手動スナップショット。 `all`：すべてのスナップショット作成メソッド。	all
SourceDiskId	string	ソースディスクがリリースされた後も、ソースディスクの ID は保持されます。	d-bp67acfmxazb4ph****
SnapshotName	string	スナップショットの名前。作成時に名前が指定された場合にのみ返されます。	testSnapshotName
InstantAccessRetentionDays	integer	即時アクセス機能の保持期間。保持期間が終了すると、即時アクセス機能は自動的に無効になります。デフォルトでは、このパラメーターの値は `RetentionDays` の値と同じです。説明このパラメーターは非推奨です。ESSD クラウドディスクの標準スナップショットは、デフォルトで即時アクセスが有効になっています。この機能を設定する必要はなく、追加料金は発生しません。	30
Description	string	スナップショットの説明。	testDescription
SnapshotId	string	スナップショット ID。	s-bp67acfmxazb4p****
RegionId	string	スナップショットが存在するリージョンの ID。	cn-hangzhou
ResourceGroupId	string	スナップショットが属するリソースグループの ID。	rg-bp67acfmxazb4p****
Category	string	スナップショットのカテゴリ。有効な値： `Standard`：標準スナップショット。 `Flash`：ローカルスナップショット。この値は非推奨です。ローカルスナップショット機能は即時アクセス機能に置き換えられました。 `archive`：アーカイブスナップショット。	standard
KMSKeyId	string	スナップショットの暗号化に使用される KMS キーの ID。	0e478b7a-4262-4802-b8cb-00d3fb40****
SnapshotSN	string	スナップショットのシリアル番号。	64472-116742336-61976****
ProductCode	string	Marketplace イメージから継承されたプロダクトコード。	jxsc000****
SourceSnapshotId	string	ソーススナップショットの ID。	s-bp67acfmxazb4p****
SourceRegionId	string	スナップショットのソースリージョンの ID。	cn-hangzhou
FullSnapshotSizeInBytes	integer	完全スナップショットのサイズ (バイト単位)。	65535
Tags	object	スナップショットのタグ。
Tag	array<object>	タグの配列。
	object
TagValue	string	タグの値。	TestValue
TagKey	string	タグのキー。	TestKey
SnapshotLinkId	string	スナップショットが属するスナップショットチェーンの ID。	sl-bp1grgphbcc9brb5****

例

成功レスポンス

JSONJSON

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "PageSize": 10,
  "PageNumber": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 1,
  "Snapshots": {
    "Snapshot": [
      {
        "Status": "accomplished",
        "CreationTime": "2020-08-20T14:52:28Z",
        "Progress": "100%",
        "InstantAccess": false,
        "Available": false,
        "RemainTime": 38,
        "SourceDiskSize": "40",
        "RetentionDays": 30,
        "SourceDiskType": "system",
        "SourceStorageType": "disk",
        "Usage": "image",
        "LastModifiedTime": "2020-08-25T14:18:09Z",
        "Encrypted": false,
        "SnapshotType": "all",
        "SourceDiskId": "d-bp67acfmxazb4ph****",
        "SnapshotName": "testSnapshotName",
        "InstantAccessRetentionDays": 30,
        "Description": "testDescription",
        "SnapshotId": "s-bp67acfmxazb4p****",
        "RegionId": "cn-hangzhou",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "Category": "standard",
        "KMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****",
        "SnapshotSN": "64472-116742336-61976****",
        "ProductCode": "jxsc000****",
        "SourceSnapshotId": "s-bp67acfmxazb4p****",
        "SourceRegionId": "cn-hangzhou",
        "FullSnapshotSizeInBytes": 65535,
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "SnapshotLinkId": "sl-bp1grgphbcc9brb5****"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidTag.Mismatch	The specified Tag.n.Key and Tag.n.Value are not match.
400	InvalidTagCount	The specified tags are beyond the permitted range.
500	InternalError	The request processing has failed due to some unknown error.
403	InvalidSnapshotIds.Malformed	The amount of specified specified snapshot Ids exceeds the limit.
403	InvalidSnapshotCategory.Malformed	The specified Category is not valid.
403	InvalidCategory.SnapshotLinkMismatch	The specified category does not match the actual category of the snapshot link.
404	InvalidFilterKey.NotFound	The specified FilterKey is not found.
404	InvalidFilterValue	The specified FilterValue exceeds the limit.
404	InvalidUsage	The specifed Usage is not valid.
404	InvalidSourceDiskType	The specifed SourceDiskType is not valid.
404	InvalidStatus.NotFound	The specified Status is not found.
404	InvalidSnapshotType.NotFound	The specfied SnapshotType is not found.
404	InvalidSnapshotLinkId.NotFound	The specified snapshot link is not found.

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

変更履歴

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