データソース::ECS::インスタンスを使用して ECS インスタンスの詳細をクエリします - Resource Orchestration Service

DATASOURCE::ECS::Instances は、Elastic Compute Service (ECS) インスタンスに関する情報をクエリするために使用されます。

構文

{
  "Type": "DATASOURCE::ECS::Instances",
  "Properties": {
    "InnerIpAddresses": List,
    "ResourceGroupId": String,
    "PrivateIpAddresses": List,
    "InstanceChargeType": String,
    "InstanceTypeFamily": String,
    "InstanceNetworkType": String,
    "Filters": List,
    "AdditionalAttributes": List,
    "ImageId": String,
    "PublicIpAddresses": List,
    "RdmaIpAddresses": String,
    "InstanceIds": List,
    "InstanceType": String,
    "Ipv6Address": List,
    "Tags": List,
    "Status": String,
    "KeyPairName": String,
    "IoOptimized": Boolean,
    "ZoneId": String,
    "InstanceId": String,
    "HpcClusterId": String,
    "VSwitchId": String,
    "SecurityGroupId": String,
    "InternetChargeType": String,
    "InstanceName": String,
    "EipAddresses": List,
    "VpcId": String,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
InnerIpAddresses	List	いいえ	はい	クラシックネットワークにデプロイされたインスタンスの内部 IP アドレス。	このプロパティは、InstanceNetworkType が classic に設定されている場合に有効になります。最大 100 個の IP アドレスを指定できます。複数の IP アドレスはコンマ (,) で区切ります。例: `["10.1.1.1", "10.1.2.1", … "10.1.10.1"]`。
ResourceGroupId	String	いいえ	はい	インスタンスが属するリソースグループの ID。	なし。
PrivateIpAddresses	List	いいえ	はい	仮想プライベートクラウド (VPC) にデプロイされたインスタンスのプライベート IP アドレス。	このプロパティは、InstanceNetworkType が vpc に設定されている場合に有効になります。最大 100 個の IP アドレスを指定できます。複数の IP アドレスはコンマ (,) で区切ります。例: `["172.16.1.1", "172.16.2.1", … "172.16.10.1"]`。
InstanceChargeType	String	いいえ	はい	インスタンスの課金方式。	有効な値: PostPaid PrePaid
InstanceTypeFamily	String	いいえ	はい	インスタンスファミリ。	なし。
InstanceNetworkType	String	いいえ	はい	インスタンスのネットワークタイプ。	有効な値: classic vpc
Filters	List	いいえ	はい	リソースのクエリに使用するフィルター。	詳細については、フィルターのプロパティをご参照ください。
AdditionalAttributes	List	いいえ	はい	追加属性。	有効な値: META_OPTIONS: インスタンスメタデータ DDH_CLUSTER: 専用ホストクラスター NETWORK_PRIMARY_ENI_IP: プライマリエラスティックネットワークインターフェース (ENI) に関連付けられたセカンダリ IP アドレス
ImageId	String	いいえ	はい	イメージ ID。	なし。
PublicIpAddresses	List	いいえ	はい	インスタンスのパブリック IP アドレス。	最大 100 個の IP アドレスを指定できます。複数の IP アドレスはコンマ (,) で区切ります。例: `["192.0.2.0", "192.0.2.1", …, "192.0.2.10"]`。
RdmaIpAddresses	String	いいえ	はい	高性能コンピューティング (HPC) クラスターに属するインスタンスのリモートダイレクトメモリアクセス (RDMA) IP アドレス。	なし。
InstanceIds	List	いいえ	はい	インスタンスの ID。	最大 100 個の ID を指定できます。複数の ID はコンマ (,) で区切ります。
InstanceType	String	いいえ	はい	インスタンスタイプ。	なし。
Ipv6Address	List	いいえ	はい	ENI の IPv6 アドレス。	最大 100 個の IP アドレスを指定できます。複数の IP アドレスはコンマ (,) で区切ります。
Tags	List	いいえ	はい	インスタンスのタグ。	最大 20 個のタグを追加できます。詳細については、タグのプロパティをご参照ください。
Status	String	いいえ	はい	インスタンスのステータス。	有効な値: Pending: インスタンスが作成されています。 Running: インスタンスは実行中です。 Starting: インスタンスが起動中です。 Stopping: インスタンスが停止中です。 Stopped: インスタンスは停止しています。
KeyPairName	String	いいえ	はい	インスタンスにバインドされている SSH キーペアの名前。	なし。
IoOptimized	Boolean	いいえ	はい	インスタンスが I/O 最適化インスタンスかどうかを指定します。	有効な値: true false
ZoneId	String	いいえ	はい	ゾーン ID。	なし。
InstanceId	String	いいえ	はい	インスタンス ID。	なし。
HpcClusterId	String	いいえ	はい	インスタンスが属する HPC クラスターの ID。	なし。
VSwitchId	String	いいえ	はい	vSwitch ID。	なし。
SecurityGroupId	String	いいえ	はい	セキュリティグループの ID。	なし。
InternetChargeType	String	いいえ	はい	ネットワーク使用量の計測方法。	有効な値: PayByBandwidth PayByTraffic
InstanceName	String	いいえ	はい	インスタンス名。	なし。
EipAddresses	List	いいえ	はい	インスタンスのエラスティック IP アドレス (EIP)。	このプロパティは、InstanceNetworkType が vpc に設定されている場合に有効になります。最大 100 個の EIP を指定できます。複数の EIP はコンマ (,) で区切ります。
VpcId	String	いいえ	はい	VPC ID。	なし。
RefreshOptions	String	いいえ	はい	スタックの更新時のデータソースリソースの更新ポリシー。	有効な値: Never (デフォルト): スタックの更新時にデータソースリソースを更新しません。常に更新: スタックの更新時にデータソースリソースを更新します。

フィルター構文

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

フィルターのプロパティ

プロパティ

タイプ

必須

編集可能

説明

制約

Key

String

はい

いいえ

フィルターキー。

値を CreationStartTime に設定します。CreationStartTime の値は、リソースが作成される期間の開始時刻を指定します。

Key と Value の両方を指定して、指定した時点より後に作成されたリソースをクエリできます。

Value

String

いいえ

フィルター値。

yyyy-MM-ddTHH:mmZ 形式の ISO 8601 標準で時刻を指定します。時刻は UTC+0 である必要があります。

フィルターの構文

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

タグのプロパティ

プロパティ	種類	必須	編集可能	説明	制約
キー	文字列	はい	いいえ	タグキー。	なし。
値	文字列	いいえ	いいえ	タグ値。	なし。

戻り値 (Fn::GetAtt)

InstanceIds: インスタンスの ID です。
Instances: インスタンスの詳細です。

プロパティ	タイプ	説明	制約
InstanceIds	リスト	インスタンスの ID です。	なし。
Instances	リスト	インスタンスの詳細です。	なし。
SerialNumber	文字列	インスタンスのシリアル番号です。	なし。
Status	文字列	インスタンスのステータスです。	なし。
DeploymentSetId	文字列	デプロイメントセットの ID です。	なし。
SpotStrategy	文字列	従量課金インスタンスのプリエンプションポリシーです。	有効な値： NoSpot: インスタンスは通常の従量課金インスタンスとして作成されます。 SpotWithPriceLimit: インスタンスは、ユーザー定義の 1 時間あたりの最大価格を持つプリエンプティブインスタンスとして作成されます。 SpotAsPriceGo: インスタンスは、購入時の市場価格が自動的に入札価格として使用されるプリエンプティブインスタンスとして作成されます。市場価格は、従量課金価格までになる可能性があります。
DeviceAvailable	ブール値	インスタンスにデータディスクを接続できるかどうかを示します。	有効な値： true false
Description	文字列	インスタンスの説明です。	なし。
InstanceNetworkType	文字列	インスタンスのネットワークタイプです。	有効な値： classic vpc
InstanceName	文字列	インスタンス名です。	なし。
OSNameEn	文字列	インスタンスの OS 名（英語）です。	なし。
SpotPriceLimit	数値	インスタンスの 1 時間あたりの最大価格です。	このプロパティは、SpotStrategy が SpotWithPriceLimit に設定されている場合に有効になります。
Memory	数値	メモリサイズです。	単位：MiB。
OSName	文字列	インスタンスの OS 名（中国語）です。	なし。
ImageId	文字列	イメージ ID です。	なし。
GPUSpec	文字列	インスタンスタイプで使用される GPU モデルです。	なし。
StoppedMode	文字列	インスタンスが停止されているモードです。このプロパティは、インスタンスの停止後もシステムがインスタンスの課金を実行するかどうかを決定します。	有効な値： KeepCharging: 標準モード。インスタンスの停止後もシステムはインスタンスの課金を実行し、インスタンスのリソースを保持します。 StopCharging: 節約モード。インスタンスの停止後、システムはインスタンスの特定のリソースの課金を実行せず、vCPU、メモリ、パブリック IP アドレスなどのリソースを解放します。 Not-applicable: 節約モードはインスタンスに適用できません。
GPUAmount	数値	インスタンスタイプで使用される GPU の数です。	なし。
HostName	文字列	インスタンスのホスト名です。	なし。
InstanceId	文字列	インスタンス ID です。	なし。
InternetMaxBandwidthOut	数値	最大アウトバウンドパブリック帯域幅です。	単位：Mbit/s。
InternetMaxBandwidthIn	数値	最大インバウンドパブリック帯域幅です。	単位：Mbit/s。
InstanceType	文字列	インスタンスタイプです。	なし。
InstanceChargeType	文字列	インスタンスの課金方法です。	有効な値： PrePaid PostPaid
IoOptimized	ブール値	インスタンスが I/O 最適化インスタンスかどうかを示します。	有効な値： true false
Cpu	数値	vCPU の数です。	なし。
ResourceGroupId	文字列	インスタンスが属するリソースグループの ID です。	なし。
InternetChargeType	文字列	ネットワーク使用量の計測方法です。	有効な値： PayByBandwidth PayByTraffic
ZoneId	文字列	ゾーン ID です。	なし。
InstanceTypeFamily	文字列	インスタンスファミリです。	なし。
OSType	文字列	インスタンスの OS タイプです。	有効な値： windows linux
NetworkInterfaces	リスト	インスタンスに接続されている ENI です。	なし。
Tags	リスト	インスタンスのタグです。	なし。
SecurityGroupIds	リスト	インスタンスが属するセキュリティグループの ID です。	なし。
PublicIpAddress	リスト	インスタンスのパブリック IP アドレスです。	なし。
InnerIpAddress	リスト	クラシックネットワークにデプロイされたインスタンスの内部 IP アドレスです。	なし。
EipAddress	リスト	インスタンスの EIP です。	なし。
DedicatedHostAttribute	リスト	専用ホストの属性です。	なし。
EcsCapacityReservationAttr	リスト	インスタンスの容量予約の属性です。	なし。
DedicatedInstanceAttribute	リスト	専用ホスト上のインスタンスの属性です。	なし。
OperationLocks	リスト	インスタンスがロックされている理由です。	なし。
PrivateIpAddress	リスト	インスタンスのプライベート IP アドレスです。	なし。
VpcId	文字列	VPC ID です。	なし。
VswitchId	文字列	vSwitch ID です。	なし。

フィルターのプロパティ

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  InstanceIds:
    Type: Json
    Default:
      - i-bp17f03tk0f4bi86***
Resources:
  NetworkInterfaces:
    Type: DATASOURCE::ECS::Instances
    Properties:
      InstanceIds:
        Ref: InstanceIds
Outputs:
  Images:
    Value:
      Fn::GetAtt:
        - NetworkInterfaces
        - InstanceIds
  ImageIds:
    Value:
      Fn::GetAtt:
        - NetworkInterfaces
        - Instances

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "InstanceIds": {
      "Type": "Json",
      "Default": [
        "i-bp17f03tk0f4bi86***"
      ]
    }
  },
  "Resources": {
    "NetworkInterfaces": {
      "Type": "DATASOURCE::ECS::Instances",
      "Properties": {
        "InstanceIds": {
          "Ref": "InstanceIds"
        }
      }
    }
  },
  "Outputs": {
    "Images": {
      "Value": {
        "Fn::GetAtt": [
          "NetworkInterfaces",
          "InstanceIds"
        ]
      }
    },
    "ImageIds": {
      "Value": {
        "Fn::GetAtt": [
          "NetworkInterfaces",
          "Instances"
        ]
      }
    }
  }
}