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
  }
}

属性

属性名称 类型 必须 允许更新 描述 约束
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属性

Tags语法

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

Tags属性

属性名称 类型 必须 允许更新 描述 约束
Value String 实例的标签值。 长度为1~128个字符。不能以aliyunacs:http://https://开头。
Key String 实例的标签键。 长度为1~128个字符。不能以aliyunacs: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"
        ]
      }
    }
  }
}