作成済みのEBSデバイスをクエリするための呼び出しでDATASOURCE::ECS::Disksを使用する - Resource Orchestration Service

DATASOURCE::ECS::Disksは、クラウドディスクとローカルディスクを含む、作成したElastic Block Storage（EBS）デバイスをクエリするために使用されます。

構文

{
  "Type": "DATASOURCE::ECS::Disks",
  "Properties": {
    "Status": String,
    "DiskIds": List,
    "EnableShared": String,
    "Category": String,
    "KMSKeyId": String,
    "ResourceGroupId": String,
    "ZoneId": String,
    "InstanceId": String,
    "Encrypted": Boolean,
    "DeleteWithInstance": Boolean,
    "DeleteAutoSnapshot": String,
    "EnableAutomatedSnapshotPolicy": Boolean,
    "DiskChargeType": String,
    "EnableAutoSnapshot": Boolean,
    "AutoSnapshotPolicyId": String,
    "DiskName": String,
    "MultiAttach": String,
    "DiskType": String,
    "SnapshotId": String,
    "Portable": String,
    "Filters": List,
    "AdditionalAttributes": List,
    "Tags": List,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Status	String	いいえ	はい	クラウドディスクのステータス。	有効な値： In_use：クラウドディスクは使用中です。 Available：クラウドディスクはアタッチできます。 Attaching：クラウドディスクはアタッチ中です。 Detaching：クラウドディスクはデタッチ中です。 Creating：クラウドディスクは作成中です。 ReIniting：クラウドディスクは初期化中です。 All（デフォルト）：すべての状態。
DiskIds	List	いいえ	はい	クラウドディスクまたはローカルディスクのID。	最大 100 個のIDを指定できます。複数のIDはカンマ（,）で区切ります。例：`["d-bp67acfmxazb4p**", "d-bp67acfmxazb4g", … "d-bp67acfmxazb4d**"]`。
EnableShared	String	いいえ	はい	ディスクが共有ブロックストレージデバイスかどうかを指定します。	有効な値： true false（デフォルト）
Category	String	いいえ	はい	クラウドディスクまたはローカルディスクのカテゴリ。	有効な値： all：すべてのディスクカテゴリ cloud：ベーシックディスク cloud_efficiency：ウルトラディスク cloud_ssd：スタンダードSSD cloud_essd：エンタープライズSSD（ESSD） local_ssd_pro：I/O集中型ローカルディスク local_hdd_pro：スループット集中型ローカルディスク
KMSKeyId	String	いいえ	はい	クラウドディスクに使用されるKey Management Service（KMS）キーのID。	なし。
ResourceGroupId	String	いいえ	はい	クラウドディスクまたはローカルディスクが属するリソースグループのID。	なし。
ZoneId	String	いいえ	はい	ゾーンID。	なし。
InstanceId	String	いいえ	はい	クラウドディスクまたはローカルディスクがアタッチされているインスタンスのID。	なし。
Encrypted	Boolean	いいえ	はい	ディスクが暗号化されたクラウドディスクかどうかを指定します。	有効な値： true false（デフォルト）
DeleteWithInstance	Boolean	いいえ	はい	関連付けられているインスタンスが解放されたときにクラウドディスクを解放するかどうかを指定します。	有効な値： true：関連付けられているインスタンスが解放されたときにクラウドディスクを解放します。 false（デフォルト）：関連付けられているインスタンスが解放されたときにクラウドディスクを保持し、従量課金制のデータディスクに変換します。
DeleteAutoSnapshot	String	いいえ	はい	ディスクが解放されたときにクラウドディスクの自動スナップショットを削除するかどうかを指定します。	有効な値： true false（デフォルト）
EnableAutomatedSnapshotPolicy	Boolean	いいえ	はい	クラウドディスクに自動スナップショットポリシーが構成されているかどうかを指定します。	有効な値： true false（デフォルト）
DiskChargeType	String	いいえ	はい	クラウドディスクまたはローカルディスクの課金方式。	有効な値： PrePaid：サブスクリプション PostPaid：従量課金制
EnableAutoSnapshot	Boolean	いいえ	はい	クラウドディスクの自動スナップショットポリシー機能が有効になっているかどうかを指定します。	有効な値： true false (既定値)
AutoSnapshotPolicyId	String	いいえ	はい	クラウドディスクに適用される自動スナップショットポリシーの ID です。	なし。
AutoSnapshotPolicyId	String	いいえ	はい	クラウドディスクに適用される自動スナップショットポリシーのID。	なし。
DiskName	String	いいえ	はい	クラウドディスクまたはローカルディスクの名前。	有効な値: 無効: マルチアタッチ機能が無効になっています。有効: マルチアタッチ機能が有効になっています。 LegacyShared: この値は、共有ブロックストレージデバイスを照会するために使用されます。
MultiAttach	String	いいえ	はい	マルチアタッチ機能が有効になっているかどうかを指定します。	有効な値： all（デフォルト）: システムディスクとデータディスク system: システムディスク data: データディスク
SnapshotId	String	いいえ	はい	クラウドディスクの作成に使用するスナップショットの ID です。	なし。
ポータブル	文字列	いいえ	はい	クラウドディスクまたはローカルディスクが取り外し可能かどうかを指定します。	有効な値: true false
フィルター	リスト	いいえ	はい	リソースを照会するために使用するフィルター。	1 つまたは 2 つのフィルターを指定できます。詳細については、「フィルターのプロパティ」をご参照ください。
追加属性	リスト	いいえ	はい	追加の属性。	値を IOPS に設定します。IOPS の値は、クエリ対象のディスクの最大 IOPS を指定します。
タグ	リスト	いいえ	はい	クラウドディスクまたはローカルディスクのタグ。	詳細については、「タグのプロパティ」をご参照ください。
DiskType	String	いいえ	はい	クエリするクラウドディスクまたはローカルディスクのタイプ。	有効な値： Never（デフォルト）: スタックの更新時にデータソースリソースを更新しません。常に: スタックが更新されると、データソースリソースを更新します。

フィルター構文

"Filters": [
  {
    "Value": String, // 値
    "Key": String // キー
  }
]

フィルターのプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
値	文字列	いいえ	いいえ	フィルター値。	例: `2021-12-12T12:12Z`。
キー	文字列	はい	いいえ	フィルターキー。	例: `CreationStartTime`。

タグの構文

"Tags": [
  {
    "Value": String, // 値
    "Key": String // キー
  }
]

タグのプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Value	String	いいえ	いいえ	タグ値。	なし。
Key	String	はい	いいえ	タグキー。	なし。

戻り値 (Fn::GetAtt)

DiskIds: クラウドディスクまたはローカルディスクのID。
Disks: クラウドディスクまたはローカルディスクの詳細。

プロパティ	タイプ	説明	制約
DiskIds	リスト	クラウドディスクまたはローカルディスクの ID。	例: `['d-bp180bogui4ky7o4**','d-bp180bogui4ky7o4**']`。
Disks	リスト	クラウドディスクまたはローカルディスクの詳細。	なし。
Type	文字列	クラウドディスクまたはローカルディスクのタイプ。	なし。
Status	文字列	クラウドディスクのステータス。	なし。
SerialNumber	文字列	クラウドディスクまたはローカルディスクのシリアル番号。	例: `bp18um4r4f2fve2****`。
PerformanceLevel	文字列	ESSD のパフォーマンスレベル (PL)。	有効な値: PL0: ESSD は最大 10,000 ランダム読み書き IOPS を提供できます。 PL1: ESSD は最大 50,000 ランダム読み書き IOPS を提供できます。 PL2: ESSD は最大 100,000 ランダム読み書き IOPS を提供できます。 PL3: ESSD は最大 1,000,000 ランダム読み書き IOPS を提供できます。
EnableAutoSnapshot	ブール値	クラウドディスクで自動スナップショットポリシー機能が有効になっているかどうかを示します。	なし。
StorageSetId	文字列	ストレージセットの ID。	例: `ss-i-bp1j4i2jdf3owlhe****`。
DiskId	文字列	クラウドディスクまたはローカルディスクの ID。	例: `d-bp18um4r4f2fve24****`。
StorageSetPartitionNumber	整数	ストレージセットの最大パーティション数。	なし。
MultiAttach	文字列	複数のアタッチ機能が有効になっているかどうかを示します。	なし。
DeleteAutoSnapshot	ブール値	ディスクが解放されたときに、クラウドディスクの自動スナップショットが削除されるかどうかを示します。	なし。
Encrypted	ブール値	ディスクが暗号化されたクラウドディスクかどうかを示します。	なし。
IOPSRead	整数	1 秒あたりの読み取り操作の数。
MountInstanceNum	整数	共有ブロックストレージデバイスが接続されているインスタンスの数。	なし。
Description	文字列	クラウドディスクまたはローカルディスクの説明。	なし。
Device	文字列	クラウドディスクまたはローカルディスクが接続されているインスタンスのデバイス名。	このプロパティは、Status が In_use に設定されている場合に返されます。複数のアタッチ機能が有効になっているクラウドディスクの場合、このプロパティは空です。例: `/dev/xvda`。
DiskName	文字列	クラウドディスクまたはローカルディスクの名前。	なし。
Portable	ブール値	クラウドディスクまたはローカルディスクが取り外し可能かどうかを示します。	なし。
StorageClusterId	文字列	クラウドディスクが属する専用ブロックストレージクラスタの ID。	クラウドディスクがパブリックブロックストレージクラスタに属している場合、このプロパティは空です。
ImageId	文字列	Elastic Compute Service (ECS) インスタンスの作成に使用されるイメージの ID。	このプロパティは、イメージを使用してクラウドディスクが作成された場合にのみ返されます。それ以外の場合、このプロパティは空です。
DeleteWithInstance	ブール値	関連付けられているインスタンスが解放されたときに、クラウドディスクが解放されるかどうかを示します。	なし。
KMSKeyId	文字列	クラウドディスクに使用される KMS キーの ID。	なし。
DetachedTime	文字列	クラウドディスクが最後にデタッチされた日時。時刻は UTC で表示されます。	例: `2021-06-07T21:01:22Z`。
SourceSnapshotId	文字列	クラウドディスクの作成に使用されたスナップショットの ID。	スナップショットを使用してクラウドディスクが作成されていない場合、このプロパティは空です。
AutoSnapshotPolicyId	文字列	クラウドディスクに適用される自動スナップショットポリシーの ID。	なし。
EnableAutomatedSnapshotPolicy	ブール値	クラウドディスクに自動スナップショットポリシーが構成されているかどうかを示します。	なし。
IOPSWrite	整数	1 秒あたりの書き込み操作の数。
InstanceId	文字列	クラウドディスクまたはローカルディスクが接続されているインスタンスの ID。	なし。
IOPS	整数	1 秒あたりの読み取りおよび書き込み操作の数。
ExpiredTime	文字列	サブスクリプションクラウドディスクの有効期限。時刻は UTC で表示されます。	例: `2021-07-07T16:00Z`。
Size	整数	クラウドディスクまたはローカルディスクのサイズ。	例: 60。
ResourceGroupId	文字列	クラウドディスクまたはローカルディスクが属するリソースグループの ID。	なし。
ZoneId	文字列	クラウドディスクまたはローカルディスクのゾーン ID。	なし。
DiskChargeType	文字列	クラウドディスクまたはローカルディスクの課金方法。	なし。
Category	文字列	クラウドディスクまたはローカルディスクのカテゴリ。	なし。
AttachedTime	文字列	クラウドディスクが最後にアタッチされた日時。時刻は UTC で表示されます。	例: `2021-06-05T21:01:22Z`。
ProductCode	文字列	Alibaba Cloud Marketplace でのディスクのプロダクトコード。	なし。
OperationLocks	リスト	クラウドディスクまたはローカルディスクがロックされている理由。	なし。
Tags	リスト	クラウドディスクまたはローカルディスクのタグ。	例: `[ { "Value": "value_test", // "値_テスト" "Key": "key_test" // "キー_テスト" }, { "Value": "value_test2", // "値_テスト2" "Key": "key_test2" // "キー_テスト2" } ]`
Attachments	リスト	クラウドディスクの接続情報。	値は Attachment 値で構成されるリストであり、共有ブロックストレージデバイスが照会された場合は返されません。例: `[ { "AttachedTime": "2022-02-14T09:13:39Z", // 接続日時: "2022-02-14T09:13:39Z" "InstanceId": "i-bp1evllqxw6b1srq**", // インスタンスID: "i-bp1evllqxw6b1srq**" "Device": "/dev/xvda" // デバイス: "/dev/xvda" } ],`

例

`JSON` 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Resources": {
    "Disks": {
      "Type": "DATASOURCE::ECS::Disks",
      "Properties": {
        "Filters": [
          {
            "Key": "CreationStartTime",
            "Value": "2021-12-12T12:12Z"
          }
        ]
      }
    }
  },
  "Outputs": {
    "Disks": {
      "Value": {
        "Fn::GetAtt": [
          "Disks",
          "Disks"
        ]
      }
    },
    "DisksIds": {
      "Value": {
        "Fn::GetAtt": [
          "Disks",
          "DiskIds"
        ]
      }
    }
  }
}

`YAML` 形式

ROSTemplateFormatVersion: '2015-09-01'
Resources:
  Disks:
    Type: DATASOURCE::ECS::Disks
    Properties:
      Filters:
        - Key: CreationStartTime
          Value: 2021-12-12T12:12Z
Outputs:
  Disks:
    Value:
      Fn::GetAtt:
        - Disks
        - Disks
  DisksIds:
    Value:
      Fn::GetAtt:
        - Disks
        - DiskIds

構文

プロパティ

フィルター構文

フィルターのプロパティ

タグの構文

タグのプロパティ

戻り値 (Fn::GetAtt)

例

JSON 形式

YAML 形式

`JSON` 形式

`YAML` 形式