全部產品
Search
文件中心

:DATASOURCE::ClickHouse::DBClusters

更新時間:Sep 19, 2024

DATASOURCE::ClickHouse::DBClusters類型用於查詢ClickHouse叢集的資訊。

文法

{
  "Type": "DATASOURCE::ClickHouse::DBClusters",
  "Properties": {
    "DBClusterName": String,
    "DBClusterId": String,
    "RefreshOptions": String
  }
}

屬性

屬性名稱

類型

必須

允許更新

描述

約束

DBClusterName

String

叢集描述資訊。

DBClusterId

String

叢集ID。

RefreshOptions

String

當資源棧更新時,資料來源資源的重新整理策略。

有效值:

  • Never(預設值):更新堆棧時,從不重新整理資料來源資源。

  • Always:更新堆棧時,始終重新整理資料來源資源。

傳回值

Fn::GetAtt

  • DBClusterIds:叢集ID列表。

  • DBClusters:叢集詳情列表

屬性名稱

類型

描述

約束

DBClusterIds

List

叢集ID列表。

DBClusters

List

叢集詳情列表

Category

String

副本配置。

DBClusterName

String

叢集描述資訊。

LockMode

String

叢集的鎖定模式。

ConnectionString

String

VPC串連地址。

DbNodeCount

String

節點數量。

DbClusterNetworkType

String

網路類型。

IsExpired

String

叢集是否到期。

LockReason

String

鎖定原因。

Status

String

叢集狀態。

VpcId

String

VPC ID。

AliUid

String

阿里雲帳號ID。

DBClusterId

String

叢集ID。

Bid

String

網站ID。

RegionId

String

地區ID。

VSwitchId

String

交換器ID。

DbNodeClass

String

叢集規格。

DbNodeStorage

String

單節點儲存空間。

CommodityCode

String

售賣商品Code。

ZoneId

String

可用性區域ID。

VpcCloudInstanceId

String

VPC資源ID。

StorageType

String

儲存類型。

Port

String

HTTP連接埠號碼。

ExpireTime

String

叢集的到期時間。

PaymentType

String

付費類型。

ScaleOutStatus

String

資料搬遷狀態。

CreateTime

String

叢集的建立時間。

樣本

YAML格式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DBClusterId:
    Description: Instance ID.
    Type: String
  DBClusterName:
    Description: The cluster description information.
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      DBClusterId:
        Ref: DBClusterId
      DBClusterName:
        Ref: DBClusterName
    Type: DATASOURCE::ClickHouse::DBClusters
Outputs:
  DBClusterIds:
    Description: The list of db cluster IDs.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DBClusterIds
  DBClusters:
    Description: The list of db clusters.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DBClusters

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DBClusterName": {
      "Type": "String",
      "Description": "The cluster description information."
    },
    "DBClusterId": {
      "Type": "String",
      "Description": "Instance ID."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ClickHouse::DBClusters",
      "Properties": {
        "DBClusterName": {
          "Ref": "DBClusterName"
        },
        "DBClusterId": {
          "Ref": "DBClusterId"
        }
      }
    }
  },
  "Outputs": {
    "DBClusterIds": {
      "Description": "The list of db cluster IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBClusterIds"
        ]
      }
    },
    "DBClusters": {
      "Description": "The list of db clusters.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBClusters"
        ]
      }
    }
  }
}