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 | 否 | 是 | 數據庫版本號。 | 取值:
|
ReplicationFactor | String | 否 | 是 | 副本集實例的節點數量。 | 取值:
|
DBInstanceStatus | String | 否 | 是 | 實例的狀態信息。 | 關于取值的更多信息,請參見實例狀態表。 |
ZoneId | String | 否 | 是 | 可用區ID。 | 您可以調用DescribeRegions查詢實例支持的可用區。 |
ResourceGroupId | String | 否 | 是 | 資源組ID。 | 無 |
DBInstanceClass | String | 否 | 是 | 實例規格。 | 關于取值的更多信息,請參見實例規格表。 |
VSwitchId | String | 否 | 是 | 交換機ID。 | 無 |
DBInstanceType | String | 否 | 是 | 實例類型。 | 取值:
|
Expired | Boolean | 否 | 是 | 實例是否已過期。 | 取值:
|
ConnectionDomain | String | 否 | 是 | 節點的連接地址。 | 您可以調用DescribeDBInstanceAttribute查詢節點的連接地址。 |
VpcId | String | 否 | 是 | 專有網絡ID。 | 無 |
DBInstanceId | String | 否 | 是 | 實例ID。 | 無 |
ChargeType | String | 否 | 是 | 實例的付費類型。 | 取值:
|
NetworkType | String | 否 | 是 | 實例的網絡類型。 | 取值:
|
DBInstanceDescription | String | 否 | 是 | 實例的描述信息。 | 無 |
Tags | List | 否 | 是 | 實例的標簽。 | 最多支持指定20個標簽。 更多信息,請參見Tags屬性。 |
RefreshOptions | String | 否 | 是 | 當資源棧更新時,數據源資源的刷新策略。 | 有效值:
|
Tags語法
"Tags": [
{
"Value": String,
"Key": String
}
]
Tags屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
Value | String | 否 | 否 | 實例的標簽值。 | 長度為1~128個字符。不能以 |
Key | String | 是 | 否 | 實例的標簽鍵。 | 長度為1~128個字符。不能以 |
返回數據(Fn::GetAtt)
InstanceIds:實例的ID列表。
Instances:實例的詳情列表。
屬性名稱 | 類型 | 描述 | 約束 |
InstanceIds | List | 實例的ID列表。 | 無 |
Instances | List | 實例的詳情列表。 | 無 |
ChargeType | String | 實例的付費類型。 | 取值:
|
Tags | List | 實例的標簽。 | 無 |
VpcAuthMode | String | 是否已開啟專有網絡免密訪問功能。 | 取值:
|
NetworkType | String | 實例的網絡類型。 | 取值:
|
LockMode | String | 實例的鎖定狀態。 | 取值:
|
EngineVersion | String | 數據庫版本號。 | 無 |
MongosList | List | Mongos節點信息列表。 | 當DBInstanceType取值為sharding時,返回該參數。 |
DBInstanceDescription | String | 實例的描述信息。 | 無 |
DBInstanceType | String | 實例類型。 | 取值:
|
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 | 實例的類型。 | 取值:
|
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"
]
}
}
}
}