DATASOURCE::ClickHouse::DBCluster_资源编排(ROS)-阿里云帮助中心

DATASOURCE::ClickHouse::DBCluster类型用于查询单个ClickHouse集群的信息。

语法

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

属性

属性名称

类型

必须

允许更新

描述

约束

DBClusterId

String

是

集群ID。

无

RefreshOptions

String

否

是

当资源栈更新时，数据源资源的刷新策略。

有效值：

Never（默认值）：更新堆栈时，从不刷新数据源资源。
Always：更新堆栈时，始终刷新数据源资源。

返回值

Fn::GetAtt

Category：副本配置。
ResourceGroupId：资源组的ID。
VpcIpAddr：VPC网络连接串的IP地址。
Port：HTTP端口号。
DBClusterId：集群ID。
EncryptionKey：KMS密钥。
DbNodeStorage：单节点存储空间。
DBClusterType：集群类型。
SupportBackup：支持回退方案。
CommodityCode：售卖商品Code。
PaymentType：付费类型。
SupportOss：是否支持冷热数据分层存储。
PublicConnectionString：外网连接地址。
SupportHttpsPort：是否支持HTTPS端口。
LockReason：锁定原因。
Bid：站点ID。
DbNodeClass：集群规格。
MaintainTime：集群的可维护时间段。
Engine：引擎类型。
IsExpired：集群是否过期
EncryptionType：加密类型。
SecurityIps：白名单支持IP。
EngineVersion：引擎版本。
StorageType：存储类型。
ZoneId：可用区ID。
PublicIpAddr：外网连接串的IP地址。
VSwitchId：交换机ID。
CreateTime：集群的创建时间。
DbNodeCount：节点数量。
LockMode：集群的锁定模式。
DBClusterName：集群名称。
ScaleOutStatus：数据搬迁状态。
VpcId：VPC ID。
DBClusterIPArrayName：待修改的白名单组名。
DbClusterNetworkType：网络类型。
VpcCloudInstanceId：VPC资源ID。
SupportMysqlPort：是否支持MySQL端口。
ConnectionString：VPC 连接地址。
ExpireTime：集群的到期时间。
PublicPort：公网TCP端口号。
AliUid：阿里云账号ID。

示例

`YAML`格式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DBClusterId:
    Description:
      en: Instance ID.
    Required: true
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      DBClusterId:
        Ref: DBClusterId
    Type: DATASOURCE::ClickHouse::DBCluster
Outputs:
  AliUid:
    Description: Alibaba Cloud account.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - AliUid
  Bid:
    Description: The ID of the business process flow.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Bid
  Category:
    Description: Copy configuration, value description:.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Category
  CommodityCode:
    Description: Buy Product Code.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - CommodityCode
  ConnectionString:
    Description: Connection string.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ConnectionString
  CreateTime:
    Description: The creation time of the resource.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - CreateTime
  DBClusterIPArrayName:
    Description: The name of the whitelist group to be modified.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DBClusterIPArrayName
  DBClusterId:
    Description: Instance ID.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DBClusterId
  DBClusterName:
    Description: The cluster description information.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DBClusterName
  DBClusterType:
    Description: Instance type.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DBClusterType
  DbClusterNetworkType:
    Description: Network type. Currently, only VPC is supported.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DbClusterNetworkType
  DbNodeClass:
    Description: Set the node type.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DbNodeClass
  DbNodeCount:
    Description: 'Value range: S-Series: 1 to 48 C Series: 1-24 units:.'
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DbNodeCount
  DbNodeStorage:
    Description: 'Single-node storage space. Value range: 100 GB to 32000GB.'
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DbNodeStorage
  EncryptionKey:
    Description: Key management service KMS key ID.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - EncryptionKey
  EncryptionType:
    Description: Currently only supports ECS disk encryption, with a value of CloudDisk,
      not encrypted when empty.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - EncryptionType
  Engine:
    Description: Engine.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Engine
  EngineVersion:
    Description: The engine version.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - EngineVersion
  ExpireTime:
    Description: The expiration time.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ExpireTime
  IsExpired:
    Description: If the instance has expired.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - IsExpired
  LockMode:
    Description: The lock mode.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - LockMode
  LockReason:
    Description: Lock reason.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - LockReason
  MaintainTime:
    Description: Examples of the maintenance window, in the format of hh:mmZ-hh:mm
      Z.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - MaintainTime
  PaymentType:
    Description: The paymen type of the resource.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - PaymentType
  Port:
    Description: Connection port.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - Port
  PublicConnectionString:
    Description: A public IP address for the connection.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - PublicConnectionString
  PublicIpAddr:
    Description: Public IP address.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - PublicIpAddr
  PublicPort:
    Description: Public network port.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - PublicPort
  ResourceGroupId:
    Description: The ID of the resource group.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ResourceGroupId
  ScaleOutStatus:
    Description: Scale state.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ScaleOutStatus
  SecurityIps:
    Description: The whitelist supports the following two formats:.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - SecurityIps
  StorageType:
    Description: 'Storage type CloudSSD:SSD cloud disk CloudEfficiency: Ultra cloud
      disk.'
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - StorageType
  SupportBackup:
    Description: Support fallback scheme.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - SupportBackup
  SupportHttpsPort:
    Description: The system supports http port number.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - SupportHttpsPort
  SupportMysqlPort:
    Description: Supports Mysql, and those of the ports.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - SupportMysqlPort
  SupportOss:
    Description: Whether hot and cold stratification is supported, 0 means not, and
      1st generation table supports it.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - SupportOss
  VSwitchId:
    Description: Switch ID.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - VSwitchId
  VpcCloudInstanceId:
    Description: Virtual Private Cloud (VPC cloud instance ID.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - VpcCloudInstanceId
  VpcId:
    Description: VPC ID.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - VpcId
  VpcIpAddr:
    Description: VPC IP address.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - VpcIpAddr
  ZoneId:
    Description: On behalf of the zone resource attribute field.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - ZoneId

`JSON`格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DBClusterId": {
      "Type": "String",
      "Description": {
        "en": "Instance ID."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ClickHouse::DBCluster",
      "Properties": {
        "DBClusterId": {
          "Ref": "DBClusterId"
        }
      }
    }
  },
  "Outputs": {
    "Category": {
      "Description": "Copy configuration, value description:.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Category"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "The ID of the resource group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "VpcIpAddr": {
      "Description": "VPC IP address.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VpcIpAddr"
        ]
      }
    },
    "Port": {
      "Description": "Connection port.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Port"
        ]
      }
    },
    "DBClusterId": {
      "Description": "Instance ID.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBClusterId"
        ]
      }
    },
    "EncryptionKey": {
      "Description": "Key management service KMS key ID.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EncryptionKey"
        ]
      }
    },
    "DbNodeStorage": {
      "Description": "Single-node storage space. Value range: 100 GB to 32000GB.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbNodeStorage"
        ]
      }
    },
    "DBClusterType": {
      "Description": "Instance type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBClusterType"
        ]
      }
    },
    "SupportBackup": {
      "Description": "Support fallback scheme.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SupportBackup"
        ]
      }
    },
    "CommodityCode": {
      "Description": "Buy Product Code.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CommodityCode"
        ]
      }
    },
    "PaymentType": {
      "Description": "The paymen type of the resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PaymentType"
        ]
      }
    },
    "SupportOss": {
      "Description": "Whether hot and cold stratification is supported, 0 means not, and 1st generation table supports it.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SupportOss"
        ]
      }
    },
    "PublicConnectionString": {
      "Description": "A public IP address for the connection.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PublicConnectionString"
        ]
      }
    },
    "SupportHttpsPort": {
      "Description": "The system supports http port number.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SupportHttpsPort"
        ]
      }
    },
    "LockReason": {
      "Description": "Lock reason.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "LockReason"
        ]
      }
    },
    "Bid": {
      "Description": "The ID of the business process flow.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Bid"
        ]
      }
    },
    "DbNodeClass": {
      "Description": "Set the node type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbNodeClass"
        ]
      }
    },
    "MaintainTime": {
      "Description": "Examples of the maintenance window, in the format of hh:mmZ-hh:mm Z.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MaintainTime"
        ]
      }
    },
    "Engine": {
      "Description": "Engine.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Engine"
        ]
      }
    },
    "IsExpired": {
      "Description": "If the instance has expired.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "IsExpired"
        ]
      }
    },
    "EncryptionType": {
      "Description": "Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EncryptionType"
        ]
      }
    },
    "SecurityIps": {
      "Description": "The whitelist supports the following two formats:.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SecurityIps"
        ]
      }
    },
    "EngineVersion": {
      "Description": "The engine version.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EngineVersion"
        ]
      }
    },
    "StorageType": {
      "Description": "Storage type CloudSSD:SSD cloud disk CloudEfficiency: Ultra cloud disk.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "StorageType"
        ]
      }
    },
    "ZoneId": {
      "Description": "On behalf of the zone resource attribute field.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ZoneId"
        ]
      }
    },
    "PublicIpAddr": {
      "Description": "Public IP address.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PublicIpAddr"
        ]
      }
    },
    "VSwitchId": {
      "Description": "Switch ID.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VSwitchId"
        ]
      }
    },
    "CreateTime": {
      "Description": "The creation time of the resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "DbNodeCount": {
      "Description": "Value range: S-Series: 1 to 48 C Series: 1-24 units:.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbNodeCount"
        ]
      }
    },
    "LockMode": {
      "Description": "The lock mode.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "LockMode"
        ]
      }
    },
    "DBClusterName": {
      "Description": "The cluster description information.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBClusterName"
        ]
      }
    },
    "ScaleOutStatus": {
      "Description": "Scale state.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ScaleOutStatus"
        ]
      }
    },
    "VpcId": {
      "Description": "VPC ID.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VpcId"
        ]
      }
    },
    "DBClusterIPArrayName": {
      "Description": "The name of the whitelist group to be modified.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DBClusterIPArrayName"
        ]
      }
    },
    "DbClusterNetworkType": {
      "Description": "Network type. Currently, only VPC is supported.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DbClusterNetworkType"
        ]
      }
    },
    "VpcCloudInstanceId": {
      "Description": "Virtual Private Cloud (VPC cloud instance ID.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "VpcCloudInstanceId"
        ]
      }
    },
    "SupportMysqlPort": {
      "Description": "Supports Mysql, and those of the ports.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SupportMysqlPort"
        ]
      }
    },
    "ConnectionString": {
      "Description": "Connection string.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ConnectionString"
        ]
      }
    },
    "ExpireTime": {
      "Description": "The expiration time.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ExpireTime"
        ]
      }
    },
    "PublicPort": {
      "Description": "Public network port.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PublicPort"
        ]
      }
    },
    "AliUid": {
      "Description": "Alibaba Cloud account.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AliUid"
        ]
      }
    }
  }
}

语法

属性

返回值

示例

YAML格式

JSON格式

`YAML`格式

`JSON`格式