全部產品
Search

搜尋本產品

    ：DATASOURCE::POLARDB::DBClusters

    文件中心

    ：DATASOURCE::POLARDB::DBClusters

    更新時間：Nov 06, 2024

    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

    建立時間。

    無

    樣本

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