ECS インスタンスまたはディスクのすべてのスナップショットを照会するための呼び出しで DATASOURCE::ECS::Snapshots を使用します - Resource Orchestration Service

DATASOURCE::ECS::Snapshots は、Elastic Compute Service (ECS) インスタンスまたはディスクのすべてのスナップショットを照会するために使用されます。

構文

{
  "Type": "DATASOURCE::ECS::Snapshots",
  "Properties": {
    "Status": String,
    "Usage": String,
    "Category": String,
    "KMSKeyId": String,
    "ResourceGroupId": String,
    "InstanceId": String,
    "Encrypted": Boolean,
    "SnapshotLinkId": String,
    "SnapshotIds": List,
    "SnapshotName": String,
    "Filters": List,
    "SnapshotType": String,
    "SourceDiskType": String,
    "Tags": List,
    "DiskId": String,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Status	String	いいえ	はい	スナップショットの状態。	有効な値: progressing: スナップショットは作成中です。 accomplished: スナップショットは作成されました。 failed: スナップショットの作成に失敗しました。 all (デフォルト): すべてのスナップショット状態。
Usage	String	いいえ	はい	スナップショットがカスタムイメージまたはディスクの作成に使用されるかどうかを指定します。	有効な値: image: スナップショットはカスタムイメージの作成に使用されます。 disk: スナップショットはディスクの作成に使用されます。 image_disk: スナップショットはカスタムイメージとデータディスクの作成に使用されます。 none: スナップショットは使用されません。
Category	String	いいえ	はい	スナップショットタイプ。	有効な値: Standard: 標準スナップショット Flash: ローカルスナップショット
KMSKeyId	String	いいえ	はい	データディスクに使用される Key Management Service (KMS) キーの ID。	なし。
ResourceGroupId	String	いいえ	はい	リソースグループの ID。	このプロパティを使用してリソースをフィルタリングする場合、指定されたリソースグループに属する最大 1,000 個のリソースを返すことができます。
InstanceId	String	いいえ	はい	インスタンス ID。	なし。
Encrypted	Boolean	いいえ	はい	スナップショットが暗号化されているかどうかを指定します。	有効な値: true false (デフォルト)
SnapshotLinkId	String	いいえ	はい	スナップショットチェーンの ID。	なし。
SnapshotIds	List	いいえ	はい	スナップショットの ID。	最大 100 個のスナップショット ID を指定できます。複数の ID はカンマ (,) で区切ります。
SnapshotName	String	いいえ	はい	スナップショット名。	なし。
Filters	List	いいえ	はい	リソースの照会に使用されるフィルターキーとフィルター値。	最大 2 セットのフィルターキーとフィルター値を指定できます。詳細については、フィルターのプロパティをご参照ください。
SnapshotType	String	いいえ	はい	スナップショット作成のタイプ。	有効な値: auto: 自動作成 user: 手動作成 all (デフォルト): すべての作成タイプ
SourceDiskType	String	いいえ	はい	ソースディスクのタイプ。	有効な値: system: システムディスク Data: データディスク
Tags	List	いいえ	はい	スナップショットのタグ。	最大 20 個のタグを追加できます。詳細については、タグのプロパティをご参照ください。
DiskId	String	いいえ	はい	ディスク ID。	なし。
RefreshOptions	String	いいえ	はい	スタックの更新時のデータソースリソースの更新ポリシー。	有効な値: Never (デフォルト): スタックの更新時にデータソースリソースを更新しません。 Always: スタックの更新時にデータソースリソースを更新します。

フィルターの構文

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

フィルターのプロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

Value

String

いいえ

リソースの照会に使用されるフィルター値。

値は UTC+0 の時点である必要があります。

yyyy-MM-ddTHH:mmZ 形式の ISO 8601 標準で時間を指定します。

Key

String

はい

いいえ

リソースの照会に使用されるフィルターキー。

有効な値:

CreationStartTime
CreationEndTime

タグの構文

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

タグのプロパティ

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

戻り値 (Fn::GetAtt)

SnapshotIds: スナップショットの ID。
Snapshots: スナップショットの詳細。

プロパティ	タイプ	説明	制約
SnapshotIds	List	スナップショットの ID。	例: `["s-bp67acfmxazb4p**", "s-bp67acfmxazb5p", … "s-bp67acfmxazb6p**"]`。
Snapshots	List	スナップショットの詳細。	なし。
Status	String	スナップショットの状態。	有効な値: progressing: スナップショットは作成中です。 accomplished: スナップショットは作成されました。 failed: スナップショットの作成に失敗しました。
Progress	String	スナップショット作成の進捗状況。	単位: パーセント。例: `100%`。
Usage	String	スナップショットがカスタムイメージまたはディスクの作成に使用されるかどうかを示します。	有効な値: image: スナップショットはカスタムイメージの作成に使用されます。 disk: スナップショットはディスクの作成に使用されます。 image_disk: スナップショットはカスタムイメージとデータディスクの作成に使用されます。 none: スナップショットは使用されません。
Description	String	説明。	なし。
Category	String	スナップショットタイプ。	有効な値: Standard: 標準スナップショット Flash: ローカルスナップショット
KMSKeyId	String	データディスクに使用される KMS キーの ID。	なし。
ProductCode	String	Alibaba Cloud Marketplace イメージのプロダクトコード。	なし。
Encrypted	Boolean	スナップショットが暗号化されているかどうかを示します。	有効な値: true false
SnapshotName	String	スナップショット名。	なし。
SourceDiskId	String	ソースディスクの ID。	このプロパティは、スナップショットのソースディスクが解放された後も保持されます。
SourceStorageType	String	ソースディスクのタイプ。	なし。
SnapshotId	String	スナップショット ID。	なし。
SnapshotSN	String	スナップショットのシリアル番号。	なし。
SourceDiskSize	String	ソースディスクのサイズ。	単位: GiB。
SnapshotType	String	スナップショット作成のタイプ。	有効な値: auto: 自動作成 user: 手動作成
SourceDiskType	String	ソースディスクのタイプ。	有効な値: system: システムディスク Data: データディスク
Tags	List	タグ。	例: `[{'Value': 'value_test', 'Key': 'test123'}]`。

例

JSON 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "SnapshotName": {
      "Type": "String",
      "Description": "スナップショットの名前。", // Translated comment
      "Default": "auto_20150730_3"
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ECS::Snapshots",
      "Properties": {
        "SnapshotName": {
          "Ref": "SnapshotName"
        }
      }
    }
  },
  "Outputs": {
    "SnapshotIds": {
      "Description": "スナップショット ID のリスト。", // Translated comment
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SnapshotIds"
        ]
      }
    },
    "Snapshots": {
      "Description": "スナップショットのリスト。", // Translated comment
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Snapshots"
        ]
      }
    }
  }
}