全部產品
Search
文件中心

:DATASOURCE::ECS::Images

更新時間:Sep 30, 2024

DATASOURCE::ECS::Images類型用於查詢可用的鏡像資源。

文法

{
  "Type": "DATASOURCE::ECS::Images",
  "Properties": {
    "Status": String,
    "ImageOwnerAlias": String,
    "Usage": String,
    "ActionType": String,
    "ResourceGroupId": String,
    "Architecture": String,
    "ImageFamily": String,
    "IsSupportIoOptimized": Boolean,
    "IsSupportCloudinit": Boolean,
    "ImageName": String,
    "SnapshotId": String,
    "IsPublic": Boolean,
    "OSType": String,
    "ImageId": String,
    "InstanceType": String,
    "Tags": List,
    "RefreshOptions": String
  }
}

屬性

屬性名稱

類型

必須

允許更新

描述

約束

Status

String

鏡像的狀態。

取值:

  • Available(預設值):可用的鏡像。

  • Creating:正在建立中。

  • Waiting:多任務排隊中。

  • UnAvailable:停用鏡像。

  • CreateFailed:建立失敗的鏡像。

  • Deprecated:已棄用的鏡像。

說明

支援同時指定多個取值,取值之間以半形逗號(,)分隔。

ImageOwnerAlias

String

鏡像的來源。

取值:

  • system:阿里雲提供的公用鏡像。

  • self:您建立的自訂鏡像。

  • others:其他阿里雲使用者共用給您的鏡像。

  • marketplace:鏡像市場提供的鏡像。您查詢到的雲市場鏡像可以直接使用,無需提前訂閱。您需要自行留意雲市場鏡像的收費詳情。

說明

如果不指定該參數,預設返回取值為system、self和others的結果。

Usage

String

鏡像是否已經在ECS執行個體中運行。

取值:

  • instance:鏡像處於運行狀態,有ECS執行個體使用。

  • none:鏡像處於閑置狀態,暫無ECS執行個體使用。

ActionType

String

使用鏡像的情境。

取值:

  • CreateEcs(預設值):建立執行個體。

  • ChangeOS:更換系統硬碟或更換作業系統。

ResourceGroupId

String

自訂鏡像所在的資源群組ID。

使用該參數過濾資源時,資源數量不能超過1000個。

說明

當ImageOwnerAlias取值為self時該參數有效。

Architecture

String

鏡像的體系架構。

取值:

  • i386

  • x86_64

  • arm64

ImageFamily

String

鏡像族系名稱,用於過濾當前族系對應的鏡像。

IsSupportIoOptimized

Boolean

鏡像是否可以運行在I/O最佳化執行個體上。

取值:

  • true:可以。

  • false:不可以。

IsSupportCloudinit

Boolean

鏡像是否支援cloud-init。

取值:

  • true:支援。

  • false:不支援。

ImageName

String

鏡像名稱。

支援使用*。例如:centos_8_5*。

SnapshotId

String

自訂鏡像使用的快照ID。

IsPublic

Boolean

是否查詢發行的社區鏡像。

取值:

  • true:查詢發行的社區鏡像。將此參數設定為true時,必須將ImageOwnerAlias設定為others.

  • false(預設值):查詢社區鏡像以外的其他鏡像類型。具體要查詢的鏡像類型由ImageOwnerAlias的取值決定。

OSType

String

鏡像的作業系統類型。

取值:

  • windows

  • linux

ImageId

String

鏡像ID。

InstanceType

String

鏡像所屬的執行個體類型。

Tags

List

鏡像的標籤。

最多支援指定20個標籤。

更多資訊,請參見Tags屬性

RefreshOptions

String

當資源棧更新時,資料來源資源的重新整理策略。

取值:

  • Never(預設值):更新堆棧時,從不重新整理資料來源資源。

  • Always:更新堆棧時,始終重新整理資料來源資源。

Tags文法

"Tags": [
  {
    "Value": String,
    "Key": String
  }
]

Tags屬性

屬性名稱

類型

必須

允許更新

描述

約束

Value

String

鏡像的標籤值。

長度為0~128個字元,不能以aliyunacs:開頭,不能包含http://https://

Key

String

鏡像的標籤鍵。

長度為1~128個字元,不能以aliyunacs:開頭,不能包含http://https://

返回資料(Fn::GetAtt)

  • ImageIds:鏡像列表。

  • Images:鏡像列表詳情。

屬性名稱

類型

描述

約束

ImageIds

List

鏡像列表。

樣本:['centos_8_5_x64_20G_alibase_20211228.vhd']

Images

List

鏡像列表詳情。

Status

String

鏡像的狀態。

取值:

  • Available:可用的鏡像。

  • Creating:正在建立中。

  • Waiting:多任務排隊中。

  • UnAvailable:停用鏡像。

  • CreateFailed:建立失敗的鏡像。

  • Deprecated:已棄用的鏡像。

ImageFamily

String

鏡像族系名稱。

Progress

String

鏡像完成的進度。

單位:百分比。

IsCopied

Boolean

是否是拷貝的鏡像。

取值:

  • true:是拷貝的鏡像。

  • false:不是拷貝的鏡像。

IsSupportIoOptimized

Boolean

鏡像是否可以運行在I/O最佳化執行個體上。

取值:

  • true:可以。

  • false:不可以。

ImageOwnerAlias

String

鏡像的來源。

取值:

  • system:阿里雲提供的公用鏡像。

  • self:您建立的自訂鏡像。

  • others:其他阿里雲使用者共用給您的鏡像。

  • marketplace:鏡像市場提供的鏡像。您查詢到的雲市場鏡像可以直接使用,無需提前訂閱。您需要自行留意雲市場鏡像的收費詳情。

IsSupportCloudinit

Boolean

鏡像是否支援cloud-init。

取值:

  • true:支援。

  • false:不支援。

ImageVersion

String

鏡像版本。

Usage

String

鏡像是否已經在ECS執行個體中運行。

取值:

  • instance:鏡像處於運行狀態,有ECS執行個體使用。

  • none:鏡像處於閑置狀態,暫無ECS執行個體使用。

IsSelfShared

String

是否已共用該自訂鏡像給其他使用者。

取值:

  • true:已共用。

  • false:未共用。

Description

String

描述資訊。

Size

Integer

鏡像大小。

單位:GiB。

ResourceGroupId

String

鏡像所在的企業資源組ID。

樣本:rg-bp67acfmxazb4p****

Platform

String

作業系統平台。

樣本:Windows Server 2016

OSNameEn

String

作業系統的英文顯示名稱。

樣本:Windows Server 2016 Data Center Edition 64bit Chinese Edition

ImageName

String

鏡像的名稱。

OSName

String

作業系統的中文顯示名稱。

樣本:Windows Server 2016資料中心版64位中文版

ImageId

String

鏡像ID。

樣本:m-bp1g7004ksh0oeuc****

OSType

String

鏡像的作業系統類型。

取值:

  • windows

  • linux

IsSubscribed

Boolean

是否訂閱了該鏡像的商品碼對應的鏡像商品的服務條款。

取值:

  • true:已訂閱。

  • false:未訂閱。

ProductCode

String

鏡像市場的鏡像商品標示。

Architecture

String

鏡像系統架構類型。

取值:

  • i386

  • x86_64

  • arm64

DiskDeviceMappings

List

鏡像下包含雲端硬碟和快照的映射關係。

Tags

List

鏡像的標籤。

IsPublic

Boolean

是否是發行的社區鏡像。

取值:

  • true:是發行的社區鏡像。

  • false:不是發行的社區鏡像。

ImageOwnerId

String

鏡像所屬的阿里雲帳號ID。

該參數僅在查詢共用鏡像時返回。

樣本

YAML格式

ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
  Images:
    Type: DATASOURCE::ECS::Images
    Properties:
      ImageName: centos_8_5*
Outputs:
  ImageIds:
    Value:
      Ref: Images                    

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "Images": {
      "Type": "DATASOURCE::ECS::Images",
      "Properties": {
        "ImageName": "centos_8_5*"
      }
    }
  },
  "Outputs": {
    "ImageIds": {
      "Value": {
        "Ref": "Images"
      }
    }
  }
}