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

属性

属性名称 类型 必须 允许更新 描述 约束
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属性

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。 该参数仅在查询共享镜像时返回。

示例

  • JSON格式

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "ImageName": {
          "Type": "String",
          "Default": "CentOS*"
        }
      },
      "Resources": {
        "Images": {
          "Type": "DATASOURCE::ECS::Images",
          "Properties": {
            "ImageName": {
              "Ref": "ImageName"
            }
          }
        }
      },
      "Outputs": {
        "ImageIds": {
          "Value": {
            "Ref": "Images"
          }
        }
      }
    }
  • YAML格式

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      ImageName:
        Type: String
        Default: CentOS*
    Resources:
      Images:
        Type: DATASOURCE::ECS::Images
        Properties:
          ImageName:
            Ref: ImageName
    Outputs:
      ImageIds:
        Value:
          Ref: Images