DATASOURCE::RDS::DBInstances类型用于查询RDS实例列表。

语法

{
  "Type": "DATASOURCE::RDS::DBInstances",
  "Properties": {
    "DedicatedHostId": String,
    "EngineVersion": String,
    "DBInstanceStatus": String,
    "ResourceGroupId": String,
    "ZoneId": String,
    "DBInstanceClass": String,
    "DedicatedHostGroupId": String,
    "VSwitchId": String,
    "DBInstanceType": String,
    "InstanceLevel": Number,
    "Expired": String,
    "PayType": String,
    "InstanceNetworkType": String,
    "VpcId": String,
    "DBInstanceId": String,
    "SearchKey": String,
    "ConnectionMode": String,
    "ConnectionString": String,
    "Engine": String,
    "proxyId": String
  }
}

属性

属性名称 类型 必须 允许更新 描述 约束
DedicatedHostId String 否 是 专属集群内的主机ID。 无
EngineVersion String 否 是 数据库版本。 无
DBInstanceStatus String 否 是 实例状态。 更多信息，请参见实例状态表。
ResourceGroupId String 否 是 资源组ID。 无
ZoneId String 否 是 可用区ID。 无
DBInstanceClass String 否 是 实例规格。 更多信息，请参见主实例规格列表。
DedicatedHostGroupId String 否 是 专属集群ID。 无
VSwitchId String 否 是 交换机ID。 无
DBInstanceType String 否 是 实例类型。 取值：
  • Primary：主实例。
  • Readonly：只读实例。
  • Guard：灾备实例。
  • Temp：临时实例。
InstanceLevel Number 否 是 是否返回实例系列（Category）信息。 取值：
  • 0：不返回实例系列信息。
  • 1：返回实例系列信息。
Expired String 否 是 实例的过期状态。 取值：
  • true：已过期。
  • false：未过期。
PayType String 否 是 付费类型。 取值：
  • Postpaid：按量付费。
  • Prepaid：包年包月。
InstanceNetworkType String 否 是 实例的网络类型。 取值：
  • VPC：专有网络下的实例。
  • Classic：经典网络下的实例。
VpcId String 否 是 专有网络ID。 无
DBInstanceId String 否 是 实例ID。 无
SearchKey String 否 是 可基于实例ID或者实例备注模糊搜索。 无
ConnectionMode String 否 是 实例的访问模式。 取值：
  • Standard：标准访问模式。
  • Safe：数据库代理模式。
ConnectionString String 否 是 实例的连接地址。 无
Engine String 否 是 数据库类型。 取值：
  • MySQL
  • SQLServer
  • PostgreSQL
  • MariaDB
proxyId String 否 是 代理模式ID。 无

返回数据（Fn::GetAtt）

  • DBInstanceIds：RDS实例ID列表。
  • DBInstances：RDS实例详情列表。
属性名称 类型 描述 约束
DBInstanceIds List RDS实例ID列表。 无
DBInstances List RDS实例详情列表。 无
VpcId String 专有网络ID。 无
CreateTime String 创建时间。 按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。
PayType String 实例的付费类型。 取值：
  • Postpaid：按量付费。
  • Prepaid：包年包月。
EngineVersion String 数据库版本。 无
VpcName String VPC名称。 无
ConnectionString String 实例的连接地址。 无
InstanceNetworkType String 实例的网络类型。 取值：
  • Classic：经典网络。
  • VPC：VPC网络。
MasterInstanceId String 主实例的ID。 如果未返回此参数（即为null），则表示该实例是主实例。
ExpireTime String 到期时间。 按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。
说明 按量付费实例无到期时间。
GuardDBInstanceId String 灾备实例的ID。 无
ZoneId String 可用区ID。 无
DBInstanceId String 实例ID。 无
TempDBInstanceId String 临时实例的ID。 无
DBInstanceStorageType String 实例储存类型。 无
ConnectionMode String 实例的访问模式。 取值：
  • Standard：标准访问模式。
  • Safe：数据库代理模式。
DBInstanceDescription String 实例描述。 无
DBInstanceNetType String 实例的网络连接类型。 取值：
  • Internet：公网连接。
  • Intranet：私网连接。
DBInstanceType String 实例类型。 取值：
  • Primary：主实例。
  • Readonly：只读实例。
  • Guard：灾备实例。
  • Temp：临时实例。
DBInstanceStatus String 实例状态。 更多信息，请参见实例状态表。
VSwitchId String 交换机ID。 无
ResourceGroupId String 资源组ID。 无
Category String 实例系列。 取值：
  • Basic：基础版。
  • HighAvailability：高可用版。
  • Finance：三节点企业版。
说明 当InstanceLevel参数为1时，返回该参数。
Engine String 数据库类型。 取值：
  • MySQL
  • SQLServer
  • PostgreSQL
  • MariaDB
DBInstanceClass String 实例规格。 更多信息，请参见主实例规格列表。
ReadOnlyDBInstanceIds List 只读实例的ID列表。 无
DeletionProtection Boolean 是否已开启释放保护功能。 取值：
  • true：已开启。
  • false：未开启。

示例

  • JSON格式 

    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DBInstanceId": {
      "Type": "String",
      "Description": "The ID of the instance."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::RDS::DBInstances",
      "Properties": {
        "DBInstanceId": {
          "Ref": "DBInstanceId"
        }
      }
    }
  },
  "Outputs": {
    "DBInstances": {
      "Description": "The list of The RDS Database instances.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBInstances"
        ]
      }
    },
    "DBInstanceIds": {
      "Description": "The list of The RDS Database instance Ids.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBInstanceIds"
        ]
      }
    }
  }
}

  • YAML格式 

    ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DBInstanceId:
    Type: String
    Description: The ID of the instance.
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::RDS::DBInstances
    Properties:
      DBInstanceId:
        Ref: DBInstanceId
Outputs:
  DBInstances:
    Description: The list of The RDS Database instances.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DBInstances
  DBInstanceIds:
    Description: The list of The RDS Database instance Ids.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DBInstanceIds