查詢您可以使用的鏡像資源。

描述

調用該介面時，您需要注意：

  • 您可以查詢的鏡像資源套件括您的自訂鏡像、阿里雲提供的公共鏡像、雲市場的鏡像以及其他阿里雲用戶主動共用給您的共用鏡像。
  • 支援分頁查詢，查詢結果包括可使用的鏡像資源的總數和當前頁的鏡像資源。每頁的數量預設為10條。

請求參數

名稱 類型 是否必需 描述
Action String 是 系統規定參數。取值：DescribeImages
RegionId String 是 實例所屬的地域ID。您可以調用DescribeRegions查看最新的阿里雲地域列表。
ImageId String 否 鏡像ID。單次最多查詢100條ID，ID之間用半形逗號字元 ,隔開。
Status String 否 查詢某種狀態下的鏡像。取值範圍：
  • Creating：鏡像正在建立中。
  • Available：您可以使用的鏡像。
  • UnAvailable：您不能使用的鏡像。
  • CreateFailed：建立失敗的鏡像。
預設值：Available

支援同時取多個值，值之間以半形逗號 , 隔開。

SnapshotId String 否 根據某一快照ID建立的自訂鏡像。
ImageName String 否 鏡像名稱。
ImageOwnerAlias string 否 鏡像來源。取值範圍：
  • system：阿里雲提供的公共鏡像。
  • self：您建立的自訂鏡像。
  • others：其他阿里雲用戶共用給您的鏡像。
  • marketplace：鏡像市場雲市場 提供的鏡像。 您查詢到的雲市場鏡像可以直接使用，無需提前訂閱。您需要自行留意雲市場鏡像的收費詳情。
預設值：空，空表示返回取值為 system、self 以及 others 的結果。
Usage String 否 鏡像是否已經運行在ECS實例中。取值範圍：
  • instance：鏡像處於運行狀態，有ECS實例使用。
  • none：鏡像處於閑置狀態，暫無ECS實例使用。
Tag.n.Key String 否 標籤鍵。n 的取值範圍：[1, 5]若您根據標籤查詢鏡像資源，標籤鍵不允許為Null 字元串。
Tag.n.Value String 否 標籤值。n 的取值範圍：[1, 5]若您根據標籤查詢鏡像資源，標籤值允許為Null 字元串。
PageNumber Integer 否 鏡像資源清單的頁碼。起始值：1

預設值：1
PageSize Integer 否 分頁查詢時設定的每頁行數。最大值：50

預設值：10
DryRun Boolean 否 是否只預檢此次請求。
  • true：發送檢查請求，不會查詢資源狀況。檢查項包括AccessKey是否有效、RAM使用者的授權情況和是否填寫了必需參數。如果檢查不通過，則返回對應錯誤。如果檢查通過，會返回錯誤碼 DryRunOperation。
  • false：發送正常請求，通過檢查後返回2XX HTTP狀態碼並直接查詢資源狀況。

預設值：false

返回參數

名稱 類型 描述
RegionId String 鏡像所屬地域ID
TotalCount Integer 鏡像資源總數
PageNumber Integer 當前頁碼
PageSize Integer 當前分頁包含多少條目
Images Array 鏡像資訊 ImageType 組成的集合。

樣本

請求樣本 
https://ecs.aliyuncs.com/?Action=DescribeImages
&RegionId=cn-hangzhou
&<公共請求參數>
返回樣本

XML 格式

<DescribeImagesResponse>
    <Images>
        <Image>
            <Architecture>i386</Architecture>
            <CreationTime>2014-07-22T09:53:44Z</CreationTime>
            <Description></Description>
            <DiskDeviceMappings>
                <DiskDeviceMapping>
                    <Device>/dev/xvda</Device>
                    <Size>20</Size>
                    <SnapshotId></SnapshotId>
                </DiskDeviceMapping>
            </DiskDeviceMappings>
            <ImageId>suse11sp3_64_20G_aliaegis_20150428.vhd</ImageId>            
            <ImageName>suse11sp3_64_20G_aliaegis_20150428.vhd</ImageName>
            <ImageOwnerAlias>system</ImageOwnerAlias>
            <ImageVersion>1.0</ImageVersion>
            <IsCopied>false</IsCopied>
            <IsSubscribed>false</IsSubscribed>
            <OSName>SUSE Linux  Enterprise Server 11 SP3 64位</OSName>
            <ProductCode></ProductCode>
            <OSType>linux</OSType>
            <Platform>SUSE</Platform>
            <Progress>100</Progress>
            <Size>20</Size>
            <Status>Available</Status>
            <Usage>instance</Usage>
        </Image>
    </Images>
    <PageNumber>1</PageNumber>
    <PageSize>2</PageSize>
    <RegionId>cn-hangzhou</RegionId>
    <TotalCount>24</TotalCount>
    <RequestId>7871BB26-3002-4950-B2E6-98D333077EA5</RequestId>
</DescribeImagesResponse>
JSON 格式 
{
  "Images": {
    "Image": [
      {
        "Architecture": "x86_64",
        "CreationTime": "2015-05-06T09:01:32Z",
        "DiskDeviceMappings": {
          "DiskDeviceMapping": [
            {
              "Device": "/dev/xvda",
              "Size": "20"
            }
          ]
        },
        "ImageId": "suse11sp3_64_20G_aliaegis_20150428.vhd",
        "ImageName": "suse11sp3_64_20G_aliaegis_20150428.vhd",
        "ImageOwnerAlias": "system",
        "ImageVersion": "1",
        "IsCopied": false,
        "IsSubscribed": false,
        "OSName": "SUSE Linux  Enterprise Server 11 SP3 64位",
        "OSType": "linux",
        "Platform": "SUSE",
        "Progress": "100%",
        "Size": 20,
        "Status": "Available",
        "Usage": "instance"
      }
    ]
  }
  "PageNumber": 1,
  "PageSize": 1,
  "RegionId": "cn-hangzhou",
  "RequestId": "49CBCED4-C9B9-4851-BEB5-8FB5E5169E30",
  "TotalCount": 24
}

錯誤碼

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

錯誤碼 錯誤資訊 HTTP 狀態碼 說明
InvalidImageOwnerAlias.ValueNotSupported The specified ImageOwnerAlias value is not supported. 400 參數 ImageOwnerAlias取值不合法。
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 指定的標籤數不能超過五個。
DryRunOperation Request validation has been passed with DryRun flag set. 400 此次DryRun預檢請求合格。
InvalidUsage The specifed Usage is not valid 404 指定的 Usage 不合法。