使用DATASOURCE::RDS::DBInstances查詢RDS執行個體列表-Resource Orchestration Service-阿里雲

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,
    "RefreshOptions": 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。	無
RefreshOptions	String	否	是	當資源棧更新時，資料來源資源的重新整理策略。	有效值： Never（預設值）：更新堆棧時，從不重新整理資料來源資源。 Always：更新堆棧時，始終重新整理資料來源資源。

返回資料（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