使用DATASOURCE::POLARDB::DBClusters查询PolarDB集群-资源编排-阿里云

DATASOURCE::POLARDB::DBClusters类型用于查询PolarDB集群列表详情。

语法

{
  "Type": "DATASOURCE::POLARDB::DBClusters",
  "Properties": {
    "Description": String,
    "DbVersion": String,
    "ResourceGroupId": String,
    "DbClusterId": String,
    "Expired": String,
    "DbType": String,
    "RefreshOptions": String
  }
}

属性

属性名称	类型	必须	允许更新	描述	约束
Description	String	否	是	集群描述。	无
DbVersion	String	否	是	数据库版本。	取值： 5.6 5.7 8.0 11 14
ResourceGroupId	String	否	是	资源组ID。	无
DbClusterId	String	否	是	集群ID。	无
Expired	String	否	是	集群是否已过期。	取值： true：集群已过期。 false：集群未过期。
DbType	String	否	是	数据库类型。	无
RefreshOptions	String	否	是	当资源栈更新时，数据源资源的刷新策略。	有效值： Never（默认值）：更新堆栈时，从不刷新数据源资源。 Always：更新堆栈时，始终刷新数据源资源。

返回值

Fn::GetAtt

DbClusterIds：集群ID列表。
DBClusters：集群列表。

属性名称	类型	描述	约束
DbClusterIds	List	集群ID列表。	无
DBClusters	List	集群列表。	无
Category	String	集群系列。	取值： Normal：集群版。 Basic：单节点。 Archive：高压缩引擎（X-Engine）。 NormalMultimaster：多主集群（库表）。
LockMode	String	集群的锁定状态。	取值： Unlock：正常。 ManualLock：手动触发锁定。 LockByExpiration：集群过期自动锁定。
DeletionLock	String	集群删除的保护状态。	取值： 0：未锁定。 1：锁定。说明锁定状态时，无法删除集群。
DbClusterId	String	集群ID。	无
VpcId	String	专有网络ID。	无
Description	String	集群描述。	无
Tags	List	标签列表。	例如： `[ { "Key" : "MySQL", "Value" : "5.6" } ]`
ClusterNetworkType	String	集群的网络类型。	无
RegionId	String	地域ID。	无
ResourceGroupId	String	资源组ID。	无
DbNodes	List	节点列表。	例如： `[ { "DBNodeClass" : "polar.mysql.x4.large", "ZoneId" : "cn-hangzhou-i", "DBNodeRole" : "Reader", "DBNodeId" : "pi-****************", "RegionId" : "cn-hangzhou" } ]`
DbNodeClass	String	节点规格。	无
Expired	String	集群是否到期。	取值： true：集群已到期。 false：集群未到期。说明当集群的付费方式为Prepaid（包年包月）时，返回该参数。
Status	String	集群状态。	无
DbVersion	String	数据库版本。	无
ZoneId	String	可用区ID。	无
StorageUsed	String	集群已经使用的存储用量。	单位：Byte。
Engine	String	集群引擎。	无
StorageSpace	String	按空间计费（包年包月）的存储空间。	单位：Byte。
DbType	String	数据库类型。	无
DbNodeNumber	Integer	节点数量。	无
ExpireTime	String	集群到期时间。	当集群的付费方式为Prepaid（包年包月）时，会返回具体参数值。当集群的付费方式为Postpaid（按量付费）时，返回空值。
PaymentType	String	付费类型。	取值： Postpaid：按量付费。 Prepaid：包年包月（预付费）。
CreateTime	String	创建时间。	无

示例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::POLARDB::DBClusters
    Properties:
      DbVersion: '5.7'
Outputs:
  DbClusterIds:
    Description: The ID of the cluster.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DbClusterIds
  DBClusters:
    Description: The list of db clusters.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DBClusters

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::POLARDB::DBClusters",
      "Properties": {
        "DbVersion": "5.7"
      }
    }
  },
  "Outputs": {
    "DbClusterIds": {
      "Description": "The ID of the cluster.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbClusterIds"
        ]
      }
    },
    "DBClusters": {
      "Description": "The list of db clusters.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBClusters"
        ]
      }
    }
  }
}