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

语法

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

属性

属性名称类型必须允许更新描述约束
DescriptionString集群描述。
DbVersionString数据库版本。取值:
  • 5.6
  • 5.7
  • 8.0
  • 11
  • 14
ResourceGroupIdString资源组ID。
DbClusterIdString集群ID。
ExpiredString集群是否已过期。取值:
  • true:集群已过期。
  • false:集群未过期。
DbTypeString数据库类型。

返回值

Fn::GetAtt

  • DbClusterIds:集群ID列表。
  • DBClusters:集群列表。
属性名称类型描述约束
DbClusterIdsList集群ID列表。
DBClustersList集群列表。
CategoryString集群系列。取值:
  • Normal:集群版。
  • Basic:单节点。
  • Archive:高压缩引擎(X-Engine)。
  • NormalMultimaster:多主集群(库表)。
LockModeString集群的锁定状态。取值:
  • Unlock:正常。
  • ManualLock:手动触发锁定。
  • LockByExpiration:集群过期自动锁定。
DeletionLockString集群删除的保护状态。取值:
  • 0:未锁定。
  • 1:锁定。
说明 锁定状态时,无法删除集群。
DbClusterIdString集群ID。
VpcIdString专有网络ID。
DescriptionString集群描述。
TagsList标签列表。例如:
[ {
      "Key" : "MySQL",
      "Value" : "5.6"
    } ]
ClusterNetworkTypeString集群的网络类型。
RegionIdString地域ID。
ResourceGroupIdString资源组ID。
DbNodesList节点列表。例如:
[ {
      "DBNodeClass" : "polar.mysql.x4.large",
      "ZoneId" : "cn-hangzhou-i",
      "DBNodeRole" : "Reader",
      "DBNodeId" : "pi-****************",
      "RegionId" : "cn-hangzhou"
    } ]
DbNodeClassString节点规格。
ExpiredString集群是否到期。取值:
  • true:集群已到期。
  • false:集群未到期。
说明 当集群的付费方式为Prepaid(包年包月)时,返回该参数。
StatusString集群状态。
DbVersionString数据库版本。
ZoneIdString可用区ID。
StorageUsedString集群已经使用的存储用量。单位:Byte。
EngineString集群引擎。
StorageSpaceString按空间计费(包年包月)的存储空间。单位:Byte。
DbTypeString数据库类型。
DbNodeNumberInteger节点数量。
ExpireTimeString集群到期时间。
  • 当集群的付费方式为Prepaid(包年包月)时,会返回具体参数值。
  • 当集群的付费方式为Postpaid(按量付费)时,返回空值。
PaymentTypeString付费类型。取值:
  • Postpaid:按量付费。
  • Prepaid:包年包月(预付费)。
CreateTimeString创建时间。

示例

  • 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"
            ]
          }
        }
      }
    }