利用可能なイメージをクエリする方法 - Resource Orchestration Service

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: Alibaba Cloud が提供するパブリックイメージ。 self: 作成したカスタムイメージ。 others: 別の Alibaba Cloud アカウントからの共有イメージ。 marketplace: Alibaba Cloud Marketplace のイメージ。Alibaba Cloud Marketplace イメージが返された場合、購読せずにイメージを使用できます。Alibaba Cloud Marketplace イメージの課金詳細に注意する必要があります。説明このプロパティを空のままにすると、デフォルトで system、self、および others の値に一致する結果が返されます。
Usage	String	いいえ	はい	イメージが Elastic Compute Service (ECS) インスタンスによって使用されているかどうかを指定します。	有効な値: instance: イメージは ECS インスタンスによって使用されています。 none: イメージは ECS インスタンスによって使用されていません。
ActionType	String	いいえ	はい	イメージを使用するシナリオ。	有効な値: CreateEcs (デフォルト): インスタンスを作成するためにイメージを使用します。 ChangeOS: システムディスクまたは OS を変更するためにイメージを使用します。
ResourceGroupId	String	いいえ	はい	カスタムイメージが属するリソースグループの ID。	このプロパティを使用してリソースをクエリする場合、指定されたリソースグループに属する最大 1,000 個のリソースが返されます。説明このプロパティは、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	いいえ	はい	イメージの OS タイプ。	有効な値: windows linux
ImageId	String	いいえ	はい	イメージ ID。	なし。
InstanceType	String	いいえ	はい	イメージが使用されるインスタンスタイプ。	なし。
Tags	List	いいえ	はい	イメージのタグ。	最大 20 個のタグを追加できます。詳細については、タグのプロパティをご参照ください。
RefreshOptions	String	いいえ	はい	スタックが更新されたときのデータソースリソースの更新ポリシー。	有効な値: Never (デフォルト): スタックが更新されたときにデータソースリソースを更新しません。 Always: スタックが更新されたときにデータソースリソースを更新します。

タグの構文

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

タグのプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Value	String	いいえ	いいえ	イメージのタグ値。	タグ値は最大 128 文字で、`http://` または `https://` を含めることはできません。`aliyun` または `acs:` で始めることはできません。
Key	String	はい	いいえ	イメージのタグキー。	タグキーは 1 ～ 128 文字で、`http://` または `https://` を含めることはできません。`aliyun` または `acs:` で始めることはできません。

戻り値 (Fn::GetAtt)

ImageIds: イメージの ID。
Images: イメージの詳細。

プロパティ	タイプ	説明	制約
ImageIds	List	イメージの ID。	例: `['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: Alibaba Cloud が提供するパブリックイメージ。 self: 作成したカスタムイメージ。 others: 別の Alibaba Cloud アカウントからの共有イメージ。 marketplace: Alibaba Cloud Marketplace のイメージ。Alibaba Cloud Marketplace イメージが返された場合、購読せずにイメージを使用できます。Alibaba Cloud Marketplace イメージの課金詳細に注意する必要があります。
IsSupportCloudinit	Boolean	イメージで cloud-init がサポートされているかどうかを示します。	有効な値: true false
ImageVersion	String	イメージのバージョン。	なし。
Usage	String	イメージが ECS インスタンスによって使用されているかどうかを示します。	有効な値: instance: イメージは ECS インスタンスによって使用されています。 none: イメージは ECS インスタンスによって使用されていません。
IsSelfShared	String	カスタムイメージが他の Alibaba Cloud アカウントと共有されているかどうかを示します。	有効な値: true false
Description	String	説明。	なし。
Size	Integer	イメージサイズ。	単位: GiB。
ResourceGroupId	String	イメージが属するリソースグループの ID。	例: `rg-bp67acfmxazb4p****`。
Platform	String	OS プラットフォーム。	例: Windows Server 2016。
OSNameEn	String	英語での OS の表示名。	例: `Windows Server 2016 Data Center Edition 64bit Chinese Edition`。
ImageName	String	イメージ名。	なし。
OSName	String	中国語での OS の表示名。	`None`。
ImageId	String	イメージ ID。	例: `m-bp1g7004ksh0oeuc****`。
OSType	String	イメージの OS タイプ。	有効な値: windows linux
IsSubscribed	Boolean	プロダクトコードに対応するイメージサービスの利用規約に同意しているかどうかを示します。	有効な値: true false
ProductCode	String	Alibaba Cloud Marketplace イメージのプロダクトコード。	なし。
Architecture	String	イメージの OS アーキテクチャ。	有効な値: i386 x86_64 arm64
DiskDeviceMappings	List	イメージ内のディスクとスナップショットのマッピング。	なし。
Tags	List	イメージのタグ。	なし。
IsPublic	Boolean	クエリされたイメージが公開されているコミュニティイメージであるかどうかを示します。	有効な値: true false
ImageOwnerId	String	イメージが属する Alibaba Cloud アカウントの 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"
      }
    }
  }
}

構文

プロパティ

タグの構文

タグのプロパティ

戻り値 (Fn::GetAtt)

例

YAML 形式

JSON 形式

`YAML` 形式

`JSON` 形式