DescribeImageFromFamily - 查詢鏡像族系內可用鏡像 - Elastic Compute Service

查詢指定鏡像族系內最新建立的可用自訂鏡像。

介面說明

指定查詢的鏡像族系如果不存在可用的鏡像，則返回結果為空白。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ecs:DescribeImageFromFamily

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	鏡像所在的地區 ID。您可以調用 DescribeRegions 查看最新的阿里雲地區列表。	cn-hangzhou
ImageFamily	string	是	鏡像族系名稱。自訂鏡像、公用鏡像、社區鏡像、共用鏡像均已支援鏡像族系，使用方法及介紹請參見鏡像族系概述。	hangzhou-daily-update

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Image	object	返回的鏡像資訊。
CreationTime	string	鏡像的建立時間。	2018-01-10T01:01:10Z
Status	string	鏡像的狀態。可能值： UnAvailable：不可用 Available：可用 Creating：建立中 CreateFailed：建立失敗	Available
ImageFamily	string	鏡像族系。	testImageFamily
Progress	string	鏡像完成的進度，單位為百分比。	100
IsCopied	boolean	是否是複製的鏡像。	false
IsSupportIoOptimized	boolean	是否可以在 I/O 最佳化執行個體上運行。	true
ImageOwnerAlias	string	鏡像所有者別名。可能值： system：公用鏡像。 self：您的自訂鏡像。 others：其他使用者的公開鏡像。 marketplace：雲市場鏡像。	self
IsSupportCloudinit	boolean	是否支援 cloud-init。	true
ImageVersion	string	鏡像版本。	2
Usage	string	有參考關聯性的資源類型。可能值： instance：建立了一台或多台 ECS 執行個體。 none：未建立過 ECS 執行個體。	none
IsSelfShared	string	是否共用過該自訂鏡像給其他使用者。	true
Description	string	描述資訊。	testDescription
Size	integer	鏡像大小，單位 GiB。	80
Platform	string	作業系統平台。	Aliyun
ImageName	string	鏡像的名稱。	testImageName
OSName	string	作業系統的中文顯示名稱。	Alibaba Cloud Linux 2.1903
ImageId	string	鏡像 ID。	m-bp1g7004ksh0oeuc****
OSType	string	作業系統類型。可能值： windows linux	linux
IsSubscribed	boolean	是否訂閱了該鏡像商品碼對應的鏡像商品服務條款。	false
ProductCode	string	鏡像市場的鏡像商品標示。	jxsc00****
Architecture	string	鏡像系統架構類型。可能值： i386 x86_64	x86_64
DiskDeviceMappings	object
DiskDeviceMapping	array<object>	鏡像下包含雲端硬碟和快照的映射關係。
	object
Type	string	鏡像的類型。	custom
ImportOSSBucket	string	匯入鏡像所屬 OSS 的 Bucket。	testEcsImport
SnapshotId	string	快照 ID。	s-bp17ot2q7x72ggtw****
ImportOSSObject	string	匯入鏡像所屬 OSS 的 Object。	imageImport
Size	string	雲端硬碟大小，單位 GiB。	80
Device	string	雲端硬碟的裝置資訊，例如/dev/xvdb。說明該參數即將停止使用，為提高代碼的相容性，建議您盡量不要使用該參數。	/dev/xvdb
Format	string	鏡像格式。	qcow2
Tags	object
Tag	array<object>	鏡像的標籤對資訊。
	object
TagValue	string	自訂鏡像的標籤值。	TestValue
TagKey	string	自訂鏡像的標籤鍵。	TestKey

樣本

正常返回樣本

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Image": {
    "CreationTime": "2018-01-10T01:01:10Z",
    "Status": "Available",
    "ImageFamily": "testImageFamily",
    "Progress": "100",
    "IsCopied": false,
    "IsSupportIoOptimized": true,
    "ImageOwnerAlias": "self",
    "IsSupportCloudinit": true,
    "ImageVersion": "2",
    "Usage": "none",
    "IsSelfShared": "true",
    "Description": "testDescription",
    "Size": 80,
    "Platform": "Aliyun",
    "ImageName": "testImageName",
    "OSName": "Alibaba Cloud Linux 2.1903",
    "ImageId": "m-bp1g7004ksh0oeuc****",
    "OSType": "linux",
    "IsSubscribed": false,
    "ProductCode": "jxsc00****",
    "Architecture": "x86_64",
    "DiskDeviceMappings": {
      "DiskDeviceMapping": [
        {
          "Type": "custom",
          "ImportOSSBucket": "testEcsImport",
          "SnapshotId": "s-bp17ot2q7x72ggtw****",
          "ImportOSSObject": "imageImport",
          "Size": "80",
          "Device": "/dev/xvdb",
          "Format": "qcow2"
        }
      ]
    },
    "Tags": {
      "Tag": [
        {
          "TagValue": "TestValue",
          "TagKey": "TestKey"
        }
      ]
    }
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
403	InvalidUser.Unauthorized	The user is not authorized.
404	InvalidRegionId.NotFound	The RegionId provided does not exist.	指定的地區不存在，請確認該參數是否正確。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。