DATASOURCE::ClickHouse::DBClusters類型用于查詢ClickHouse集群的信息。
語法
{
"Type": "DATASOURCE::ClickHouse::DBClusters",
"Properties": {
"DBClusterName": String,
"DBClusterId": String,
"RefreshOptions": String
}
}
屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
DBClusterName | String | 否 | 是 | 集群描述信息。 | 無 |
DBClusterId | String | 否 | 是 | 集群ID。 | 無 |
RefreshOptions | String | 否 | 是 | 當資源棧更新時,數據源資源的刷新策略。 | 有效值:
|
返回值
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。 | 無 |
| 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"
]
}
}
}
}