DescribeSnapshots -

請求參數


名稱	類型	是否必需	描述
Action	String	是	系統規定參數。取值：DescribeSnapshots
RegionId	String	是	磁碟所屬於的地域ID。您可以調用DescribeRegions查看最新的阿里雲地域列表。
InstanceId	String	否	指定的實例ID。
DiskId	String	否	指定的磁碟裝置ID。
Encrypted	Boolean	否	過濾加密快照。取值範圍： true：只篩選出加密快照 false：不做加密屬性的篩選預設值：False
SnapshotIds	String	否	快照標識編碼。取值可以由多個快照ID組成一個JSON數組，格式為["s-xxxxxxxxx", "s-yyyyyyyyy", … "s-zzzzzzzzz"]，最多支援100個ID，ID之間用半形逗號（`,`）隔開。
SnapshotName	String	否	快照名稱。
Status	String	否	快照狀態。取值範圍： progressing：正在建立的快照 accomplished：建立成功的快照 failed：建立失敗的快照 all：所有快照狀態預設值：all
SnapshotType	String	否	快照類型。取值範圍： auto：自動快照 user：手動建立的快照 all：所有快照類型預設值：all
SourceDiskType	String	否	快照源磁碟的磁碟類型。取值範圍： System：根據系統盤建立的快照 Data：根據數據盤建立的快照
Usage	String	否	有參考關聯性的資源類型。取值範圍： image：使用快照 CreateImage disk：使用快照 CreateDisk image_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
DryRun	Boolean	否	是否只預檢此次請求。 true：發送檢查請求，不會查詢資源狀況。檢查項包括AccessKey是否有效、RAM使用者的授權情況和是否填寫了必需參數。如果檢查不通過，則返回對應錯誤。如果檢查通過，會返回錯誤碼 `DryRunOperation`。 false：發送正常請求，通過檢查後返回2XX HTTP狀態碼並直接查詢資源狀況。預設值：false

返回參數


名稱	類型	描述
TotalCount	Integer	快照總個數
PageNumber	Integer	快照列表的頁碼
PageSize	Integer	輸入時設定的每頁行數
Snapshots	SnapshotType	快照詳情集合

樣本

請求樣本

https://ecs.aliyuncs.com/?Action=DescribeSnapshots
&RegionId=cn-hangzhou
&<公共請求參數>

返回樣本

XML格式

<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格式

{
  "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
}

錯誤碼

以下為本介面特有的錯誤碼。更多錯誤碼，請訪問 API錯誤中心。


錯誤碼	錯誤資訊	HTTP狀態碼	說明
DryRunOperation	Request validation has been passed with DryRun flag set.	400	此次DryRun預檢請求合格。
InvalidTag.Mismatch	The specified Tag.n.Key and Tag.n.Value are not match.	400	指定的參數`Tag.n.Key`和`Tag.n.Value`不匹配。
InvalidTagCount	The specified tags are beyond the permitted range.	400	指定的標籤數超過了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`不合法。