調用DATASOURCE::MONGODB::Instances查詢MongoDB執行個體詳情列表 -

DATASOURCE::MONGODB::Instances類型用於查詢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	否	是	交換器ID。	無
DBInstanceType	String	否	是	執行個體類型。	取值： sharding：分區叢集執行個體。 replicate（預設值）：複本集執行個體和單節點執行個體。 serverless：Serverless執行個體。
Expired	Boolean	否	是	執行個體是否已到期。	取值： true：已到期。 false：未到期。
ConnectionDomain	String	否	是	節點的串連地址。	您可以調用DescribeDBInstanceAttribute查詢節點的串連地址。
VpcId	String	否	是	專用網路ID。	無
DBInstanceId	String	否	是	執行個體ID。	無
ChargeType	String	否	是	執行個體的付費類型。	取值： PrePaid：預付費，訂用帳戶。 PostPaid：隨用隨付。
NetworkType	String	否	是	執行個體的網路類型。	取值： Classic：傳統網路。 VPC：專用網路。
DBInstanceDescription	String	否	是	執行個體的描述資訊。	無
Tags	List	否	是	執行個體的標籤。	最多支援指定20個標籤。更多資訊，請參見Tags屬性。
RefreshOptions	String	否	是	當資源棧更新時，資料來源資源的重新整理策略。	有效值： Never（預設值）：更新堆棧時，從不重新整理資料來源資源。 Always：更新堆棧時，始終重新整理資料來源資源。

Tags文法

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

Tags屬性

屬性名稱	類型	必須	允許更新	描述	約束
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	是否已開啟專用網路免密訪問功能。	取值： 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：Serverless執行個體。
ShardList	List	Shard節點資訊列表。	當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：ECS。 2：DOCKER。 18：K8s新架構執行個體。
CapacityUnit	String	執行個體消耗的讀寫輸送量。	當DBInstanceType取值為serverless時，返回該參數。

樣本

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ZoneId": {
      "Type": "String",
      "Description": "The zone ID of the instance. You can call the DescribeRegions operation to query the most recent zone list. ",
      "AssociationProperty": "ALIYUN::ECS::Instance:ZoneId"
    },
    "DbType": {
      "Type": "String",
      "Description": "The database engine type of the instance.\nnormal: replica set instance\nsharding: sharded cluster instance",
      "Default": "normal"
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::MONGODB::InstanceClasses",
      "Properties": {
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "DbType": {
          "Ref": "DbType"
        }
      }
    }
  },
  "Outputs": {
    "InstanceClasses": {
      "Description": "The list of The instance classes.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceClasses"
        ]
      }
    },
    "InstanceClassIds": {
      "Description": "The list of The instance class Ids.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceClassIds"
        ]
      }
    }
  }
}