ApsaraDB for MongoDB インスタンスに関する情報をクエリするために DATASOURCE::MONGODB::Instances を使用します - Resource Orchestration Service

DATASOURCE::MONGODB::Instances は、ApsaraDB for MongoDB インスタンスに関する情報をクエリするために使用されます。

構文

{
  "Type": "DATASOURCE::MONGODB::Instances",
  "Properties": {
    "EngineVersion": String,
    "ReplicationFactor": String,
    "DBInstanceStatus": String,
    "ZoneId": String,
    "ResourceGroupId": String,
    "DBInstanceClass": String,
    "VSwitchId": String,
    "DBInstanceType": String,
    "Expired": Boolean,
    "ConnectionDomain": String,
    "VpcId": String,
    "DBInstanceId": String,
    "ChargeType": String,
    "NetworkType": String,
    "DBInstanceDescription": String,
    "Tags": List,
    "RefreshOptions": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
EngineVersion	String	いいえ	はい	データベースエンジンのバージョン。	有効な値: 5.0 4.4 4.2 4.0 3.4
ReplicationFactor	String	いいえ	はい	レプリカセットインスタンスのノード数。	有効な値: 3 5 7
DBInstanceStatus	String	いいえ	はい	インスタンスの状態。	有効な値については、インスタンスの状態をご参照ください。
ZoneId	String	いいえ	はい	ゾーン ID。	DescribeRegions オペレーションを呼び出して、インスタンスでサポートされているゾーンをクエリできます。
ResourceGroupId	String	いいえ	はい	リソースグループの ID。	なし。
DBInstanceClass	String	いいえ	はい	インスタンスタイプ。	有効な値については、インスタンスタイプをご参照ください。
VSwitchId	String	いいえ	はい	vSwitch ID。	なし。
DBInstanceType	String	いいえ	はい	インスタンスのアーキテクチャ。	有効な値: sharding: シャーディングクラスタインスタンス replicate (デフォルト): レプリカセットインスタンスまたはスタンドアロンインスタンス serverless: サーバーレスインスタンス
Expired	Boolean	いいえ	はい	インスタンスの期限が切れているかどうかを指定します。	有効な値: true false
ConnectionDomain	String	いいえ	はい	ノードのエンドポイント。	DescribeDBInstanceAttribute オペレーションを呼び出して、ノードのエンドポイントをクエリできます。
VpcId	String	いいえ	はい	仮想プライベートクラウド ( VPC ) の ID。	なし。
DBInstanceId	String	いいえ	はい	インスタンス ID。	なし。
ChargeType	String	いいえ	はい	インスタンスの課金方式。	有効な値: PrePaid: サブスクリプション PostPaid: 従量課金
NetworkType	String	いいえ	はい	インスタンスのネットワークタイプ。	有効な値: Classic VPC
DBInstanceDescription	String	いいえ	はい	インスタンスの説明。	なし。
Tags	List	いいえ	はい	インスタンスのタグ。	最大 20 個のタグを追加できます。詳細については、タグのプロパティをご参照ください。
RefreshOptions	String	いいえ	はい	スタックの更新時のデータソースリソースの更新ポリシー。	有効な値: Never (デフォルト): スタックの更新時にデータソースリソースを更新しません。 Always: スタックの更新時にデータソースリソースを更新します。

タグの構文

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

タグのプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Value	String	いいえ	いいえ	インスタンスのタグ値。	タグ値は 1 ～ 128 文字の長さでなければなりません。 `aliyun`、`acs:`、`http://`、または `https://` で始めることはできません。
Key	String	はい	いいえ	インスタンスのタグキー。	タグキーは 1 ～ 128 文字の長さでなければなりません。 `aliyun`、`acs:`、`http://`、または `https://` で始めることはできません。

戻り値 ( Fn::GetAtt )

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

プロパティ	タイプ	説明	制約
InstanceIds	List	インスタンスの ID。	なし。
Instances	List	インスタンスの詳細。	なし。
ChargeType	String	インスタンスの課金方式。	有効な値: PrePaid: サブスクリプション PostPaid: 従量課金
Tags	List	インスタンスのタグ。	なし。
VpcAuthMode	String	VPC 経由のパスワードなしアクセスが有効になっているかどうかを示します。	有効な値: Open Close
NetworkType	String	インスタンスのネットワークタイプ。	有効な値: Classic VPC
LockMode	String	インスタンスのロックモード。	有効な値: Unlock: インスタンスはロックされていません。 ManualLock: インスタンスは手動でロックされています。 LockByExpiration: インスタンスの期限が切れると自動的にロックされます。 LockByRestoration: インスタンスはロールバックされる前に自動的にロックされます。 LockByDiskQuota: インスタンスのディスク容量がなくなると自動的にロックされます。 Released: インスタンスは解放されています。インスタンスは解放されており、ロックを解除できません。バックアップからのみインスタンスを作成できます。このプロセスには時間がかかります。
EngineVersion	String	データベースエンジンのバージョン。	なし。
MongosList	List	mongos ノードの詳細。	このプロパティは、DBInstanceType が sharding に設定されている場合に返されます。
DBInstanceDescription	String	インスタンスの説明。	なし。
DBInstanceType	String	インスタンスのアーキテクチャ。	有効な値: sharding: シャーディングクラスタインスタンス replicate: レプリカセットインスタンスまたはスタンドアロンインスタンス serverless: サーバーレスインスタンス
ShardList	List	シャードノードの詳細。	このプロパティは、DBInstanceType が sharding に設定されている場合に返されます。
DBInstanceStatus	String	インスタンスの状態。	有効な値については、インスタンスの状態をご参照ください。
DBInstanceStorage	Number	インスタンスのストレージ容量。	なし。
ResourceGroupId	String	リソースグループの ID。	なし。
ZoneId	String	インスタンスのゾーン ID。	なし。
DBInstanceId	String	インスタンス ID。	なし。
DBInstanceClass	String	インスタンスタイプ。	有効な値については、インスタンス仕様をご参照ください。
Engine	String	データベースエンジン。	なし。
ReplicationFactor	String	インスタンス内のノード数。	このプロパティは、DBInstanceType が replicate に設定されている場合に返されます。
KindCode	String	インスタンスの種類コード。	有効な値: 0: 物理マシン 1: Elastic Compute Service ( ECS ) インスタンス 2: Docker クラスタ 18: Kubernetes クラスタ
CapacityUnit	String	インスタンスによって消費される読み取りおよび書き込みスループット。	このプロパティは、DBInstanceType が serverless に設定されている場合に返されます。

例

JSON 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ZoneId": {
      "Type": "String",
      "Description": "インスタンスのゾーン ID。 DescribeRegions オペレーションを呼び出して、最新のゾーンリストをクエリできます。", // 翻訳済みのコメント
      "AssociationProperty": "ALIYUN::ECS::Instance:ZoneId"
    },
    "DbType": {
      "Type": "String",
      "Description": "インスタンスのデータベースエンジンの種類。\nnormal: レプリカセットインスタンス\nsharding: シャーディングクラスタインスタンス", // 翻訳済みのコメント
      "Default": "normal"
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::MONGODB::InstanceClasses",
      "Properties": {
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "DbType": {
          "Ref": "DbType"
        }
      }
    }
  },
  "Outputs": {
    "InstanceClasses": {
      "Description": "インスタンスクラスのリスト。", // 翻訳済みのコメント
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceClasses"
        ]
      }
    },
    "InstanceClassIds": {
      "Description": "インスタンスクラス ID のリスト。", // 翻訳済みのコメント
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceClassIds"
        ]
      }
    }
  }
}