閱讀635 返回首頁    go 阿裏雲 go 技術社區[雲棲]

查詢可用鏡像__鏡像相關接口_API 參考_雲服務器 ECS-阿裏雲

描述

查詢用戶可以使用的鏡像列表。顯示出的鏡像資源列表包括用戶自定義的鏡像，阿裏雲提供的公共鏡像，第三方鏡像市場的鏡像和其他用戶主動共享給您的共享鏡像。鏡像市場的鏡像需要先到鏡像市場的網站上訂閱後才能進行創建ECS實例。此接口支持分頁查詢，查詢結果包括可使用的鏡像資源的總數和當前頁的鏡像資源。每頁的數量默認為10條。

請求參數

名稱 類型 是否必須 描述
Action String 是 係統規定參數，取值：DescribeImages
RegionId String 是 實例所屬於的 Region ID
ImageId String 否 鏡像 ID，最多 100 個Id，用半角逗號字符隔開。
Status String 否 鏡像狀態，
取值：
  • UnAvailable | Available | Creating | CreateFailed
默認值：Available
取值說明：
  • Creating 創建中
  • Available 可用
  • UnAvailable 不可用
  • CreateFailed 創建失敗
SnapshotId String 否 創建鏡像的快照 ID
ImageName String 否 鏡像的名稱
ImageOwnerAlias string 否 鏡像所有者別名。
取值：
  • system | self | others | marketplace
默認值：無，表示返回 system + self + others
不設置該參數說明不使用該參數進行過濾條件
取值說明：
  • system 阿裏雲官方提供鏡像
  • self 用戶自定義鏡像
  • others 非自己的可用鏡像
  • marketplace 鏡像市場提供的鏡像
Usage String 否 有引用關係的資源類型，instance | none
Tag.n.Key String 否 標簽 key，n 從 1 開始，最大為 5。
不允許為空字符串。
Tag.n.Value String 否 標簽 value，n 從 1 開始，最大為 5。
允許為空字符串。
PageNumber Integer 否 實例狀態列表的頁碼，起始值為 1，默認值為 1
PageSize Integer 否 分頁查詢時設置的每頁行數，最大值 100 行，默認值為 10

返回參數

名稱 類型 描述
RegionId String 鏡像所屬地域 Id
TotalCount Integer 列表條條目數
PageNumber Integer 當前頁碼
PageSize Integer 當前分頁包含多少條目
Images ImageType 鏡像信息 ImageType 組成的集合

錯誤碼

錯誤代碼 描述 Http 狀態碼 語義
MissingParameter The input parameter “RegionId” that is mandatory for processing this request is not supplied. 400 缺少 RegionId 字段
InvalidImageOwnerAlias.ValueNotSupported The specified ImageOwnerAlias value is not supported. 400 無效的 ImageOwnerAlias 取值
InvalidParameter The specified parameter “PageNumber” is not valid. 400 指定的 PageNumber 不合法
InvalidParameter The specified parameter “PageSize” is not valid. 400 指定的 PageSize 不合法
InvalidUsage The specifed Usage is not valid 404 指定的 Usage 不合法

示例

請求示例

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

返回示例

XML格式

  1. <DescribeImagesResponse>
  2.     <Images>
  3.         <Image>
  4.             <Architecture>i386</Architecture>
  5.             <CreationTime>2014-07-22T09:53:44Z</CreationTime>
  6.             <Description></Description>
  7.             <DiskDeviceMappings>
  8.                 <DiskDeviceMapping>
  9.                     <Device>/dev/xvda</Device>
  10.                     <Size>20</Size>
  11.                     <SnapshotId></SnapshotId>
  12.                 </DiskDeviceMapping>
  13.             </DiskDeviceMappings>
  14.             <ImageId>suse11sp3_64_20G_aliaegis_20150428.vhd</ImageId>
  15.             <ImageName>suse11sp3_64_20G_aliaegis_20150428.vhd</ImageName>
  16.             <ImageOwnerAlias>system</ImageOwnerAlias>
  17.             <ImageVersion>1.0</ImageVersion>
  18.             <IsCopied>false</IsCopied>
  19.             <IsSubscribed>false</IsSubscribed>
  20.             <OSName>SUSE Linux  Enterprise Server 11 SP3 64位</OSName>
  21.             <ProductCode></ProductCode>
  22.             <OSType>linux</OSType>
  23.             <Platform>SUSE</Platform>
  24.             <Progress>100</Progress>
  25.             <Size>20</Size>
  26.             <Status>Available</Status>
  27.             <Usage>instance</Usage>
  28.         </Image>
  29.     </Images>
  30.     <PageNumber>1</PageNumber>
  31.     <PageSize>2</PageSize>
  32.     <RegionId>cn-hangzhou</RegionId>
  33.     <TotalCount>24</TotalCount>
  34.     <RequestId>7871BB26-3002-4950-B2E6-98D333077EA5</RequestId>
  35. </DescribeImagesResponse>

JSON格式

  1. {
  2.   "Images": {
  3.     "Image": [
  4.       {
  5.         "Architecture": "x86_64",
  6.         "CreationTime": "2015-05-06T09:01:32Z",
  7.         "DiskDeviceMappings": {
  8.           "DiskDeviceMapping": [
  9.             {
  10.               "Device": "/dev/xvda",
  11.               "Size": "20"
  12.             }
  13.           ]
  14.         },
  15.         "ImageId": "suse11sp3_64_20G_aliaegis_20150428.vhd",
  16.         "ImageName": "suse11sp3_64_20G_aliaegis_20150428.vhd",
  17.         "ImageOwnerAlias": "system",
  18.         "ImageVersion": "1",
  19.         "IsCopied": false,
  20.         "IsSubscribed": false,
  21.         "OSName": "SUSE Linux  Enterprise Server 11 SP3 64位",
  22.         "OSType": "linux",
  23.         "Platform": "SUSE",
  24.         "Progress": "100%",
  25.         "Size": 20,
  26.         "Status": "Available",
  27.         "Usage": "instance"
  28.       }
  29.     ]
  30.   }
  31.   "PageNumber": 1,
  32.   "PageSize": 1,
  33.   "RegionId": "cn-hangzhou",
  34.   "RequestId": "49CBCED4-C9B9-4851-BEB5-8FB5E5169E30",
  35.   "TotalCount": 24
  36. }

最後更新：2016-11-23 16:03:50

  上一篇：go 取消自動快照策略__快照相關接口_API 參考_雲服務器 ECS-阿裏雲
  下一篇：go 創建自定義鏡像__鏡像相關接口_API 參考_雲服務器 ECS-阿裏雲