利用可能なスナップショットの 1 つ以上を照会します。InstanceId、DiskId、および  SnapshotIdsは必須ではありません。しかし、それらはフィルターとして機能します。 論理的に、それらはAndの関係にあります。

リクエストパラメータ

名前 型 必須かどうか 説明
Action String はい このインタフェースの名前。 値：DescribeSnapshots。
RegionId String はい スナップショットのリージョン ID。
InstanceId String いいえ 指定されたインスタンス ID。
DiskId String いいえ 指定されたディスクデバイス ID。
Encrypted Boolean いいえ 暗号化されたスナップショットを照会します。 オプションの値：
  • true: 暗号化されたスナップショット。
  • false: 暗号化属性の制限がありません。
デフォルト値：false.
SnapshotIds String いいえ スナップショット ID。この値には、最大 10 のスナップショット ID の配列を含めることができます。ID は[“s-xxxxxxxxx”, “s-yyyyyyyyy”, … “s-zzzzzzzzz”]  の形式で表示され、(,)で区切られます。
SnapshotName String いいえ スナップショット名。
Status String いいえ スナップショットのステータス。 オプションの値：
  • progressing: スナップショットが作成されています。
  • accomplished: スナップショットはすぐに使用できます。
  • failed: スナップショットの作成に失敗しました。
  • all: すべてのステータス。
デフォルト値：all。
SnapshotType String いいえ スナップショットカテゴリ。 オプションの値：
  • auto: 自動スナップショット。
  • user: 手動スナップショット。
  • all: 自動スナップショットと手動スナップショット。
デフォルト値: all。
SourceDiskType String いいえ システムディスクまたはデータディスク用にスナップショットを作成するかどうか。 オプションの値：
  • システム：スナップショットはシステムディスク用に作成されます。
  • データ：スナップショットはデータディスク用に作成されます。
Usage String いいえ スナップショットを使用してリソースを作成するかどうか。 オプションの値：
  • image: スナップショットを使用してカスタムイメージを作成します。
  • disk: スナップショットはディスクの作成に使用されます。
  • mage_disk: スナップショットは、カスタムイメージとデータディスクの作成に使用されます。
  • none: スナップショットはまだ使用されていません。
Tag.n.Key String いいえ スナップショットのタグキー。nの有効範囲は[1, 5]です。このパラメータを使用すると、null 文字列にすることはできません。
Tag.n.Value String いいえ スナップショットのタグ値。nの有効範囲は[1, 5]です。このパラメータを使用すると、null 文字列にすることはできません。
PageNumber Integer いいえ 複数のページにスナップショットを表示します。  開始値： 1 

デフォルト値： 1
PageSize Integer いいえ ページの最大エントリ数。 最大値：100 

デフォルト値：10。

レスポンスパラメーター

名前 型 説明
TotalCount Integer 総数
PageNumber Integer リストのページ番号
PageSize Integer 入力時に設定された 1 ページあたりの行数
Snapshots SnapshotType スナップショットの詳細 SnapshotType で構成されるコレクション

例

リクエスト例 
  1. https://ecs.aliyuncs.com/?Action=DescribeSnapshots&RegionId=cn-hangzhou&<Common Request Parameters>
レスポンスパラメータ

XML 形式 

  1. <DescribeSnapshotsResponse>    <Snapshots>        <Snapshot>            <CreationTime>2014-07-24T13:00:52Z</CreationTime>            <Description></Description>            <SourceDiskId>d-23x0r79qy</SourceDiskId>            <SourceDiskType>DATA</SourceDiskType>            <ProductCode></ProductCode>            <SnapshotName>auto_20140724_2</SnapshotName>            <Progress>100%</Progress>            <SourceDiskSize>50</SourceDiskSize>            <Status>accomplished</Status>            <SnapshotId>s-23f2i9s4t</SnapshotId>            <Usage>none</Usage>        </Snapshot>        <Snapshot>            <CreationTime>2014-07-24T13:00:42Z</CreationTime>            <Description></Description>            <SourceDiskId>101-70105379</SourceDiskId>            <SourceDiskType>DATA</SourceDiskType>            <ProductCode></ProductCode>            <SnapshotName>auto_20140724_2</SnapshotName>            <Progress>100%</Progress>            <SourceDiskSize>5</SourceDiskSize>            <Status>accomplished</Status>            <SnapshotId>s-23izto5qm</SnapshotId>            <Usage>none</Usage>        </Snapshot>    </Snapshots>    <PageNumber>1</PageNumber>    <PageSize>2</PageSize>    <TotalCount>36</TotalCount>    <RequestId>2F409D67-329A-4405-B924-2FC28566B366</RequestId></DescribeSnapshotsResponse>
JSON 形式 
  1. {  “PageNumber”: 1,  “PageSize”: 2,  “RequestId”: “659F91C6-1949-43B0-90C4-B6342CA757D5”,  “Snapshots”: {    “Snapshot”: [      {        “CreationTime”: “2015-07-30T05:00:14Z”,        “Progress”: “100%”,        “SnapshotId”: “s-943ypfgic”,        “SnapshotName”: “auto_20150730_3”,        “SourceDiskId”: “d-944qyqjfa”,        “SourceDiskSize”: 20,        “SourceDiskType”: “system”,        “Status”: “accomplished”,        “Usage”: “none”      },      {        “CreationTime”: “2015-07-30T05:00:14Z”,        “Progress”: “100%”,        “SnapshotId”: “s-94osg320e”,        “SnapshotName”: “auto_20150730_3”,        “SourceDiskId”: “d-94j355jsq”,        “SourceDiskSize”: 20,        “SourceDiskType”: “system”,        “Status”: “accomplished”,        “Usage”: “none”      }    ]  },  “TotalCount”: 36}

エラーコード

このインタフェースに固有のエラーコードは次のとおりです。

エラーコード  エラーメッセージ HTTP ステータスコード 意味
InvalidTag.Mismatch The specified Tag.n.Key and Tag.n.Value are not match. 400 指定されたTag.n.Key およびTag.n.Value は、一致する Key-Value でなければなりません。
InvalidTagCount The specified tags are beyond the permitted range. 400 Tag.n.Key と Tag.n.Value の最大数は 5 です。
InvalidSnapshotIds.Malformed The amount of specified specified snapshot Ids exceeds the limit. 403 指定されたSnapshotIdsの値が正しくありません。
InvalidSnapshotType.NotFound The specfied SnapshotType is not found. 404 指定されたSnapshotTypeは存在しません。
InvalidSourceDiskType The specifed SourceDiskType is not valid. 404 指定されたSourceDiskTypeは無効です。
InvalidStatus.NotFound The specified Status is not found. 404 指定されたStatusは無効です。
InvalidUsage The specifed Usage is not valid. 404 指定されたUsageは無効です。