Récupère les informations relatives à un cluster ApsaraDB for ClickHouse.
Syntaxe
{
"Type": "DATASOURCE::ClickHouse::DBCluster",
"Properties": {
"DBClusterId": String,
"RefreshOptions": String
}
}Propriétés
|
Propriété |
Type |
Obligatoire |
Modifiable |
Description |
Contrainte |
|
DBClusterId |
String |
Oui |
Oui |
ID du cluster. |
Aucune. |
|
RefreshOptions |
String |
Non |
Oui |
Politique d'actualisation des ressources de la source de données lors de la mise à jour de la pile. |
Valeurs valides :
|
Valeurs de retour
Fn::GetAtt
Category : édition du cluster.
ResourceGroupId : ID du groupe de ressources.
VpcIpAddr : adresse IP utilisée pour se connecter au cluster via le VPC.
Port : port HTTP.
DBClusterId : ID du cluster.
EncryptionKey : clé KMS (Key Management Service).
DbNodeStorage : capacité de stockage d'un seul nœud.
DBClusterType : type de cluster.
SupportBackup : indique si la sauvegarde des données est activée.
CommodityCode : code de produit.
PaymentType : méthode de facturation.
SupportOss : indique si le stockage hiérarchisé des données chaudes et froides est activé.
PublicConnectionString : endpoint public.
SupportHttpsPort : indique si les ports HTTPS sont pris en charge.
LockReason : raison du verrouillage du cluster.
Bid : ID du site.
DbNodeClass : spécifications du cluster.
MaintainTime : fenêtre de maintenance du cluster.
Engine : type de moteur de base de données.
IsExpired : indique si le cluster a expiré.
EncryptionType : type de chiffrement.
SecurityIps : adresses IP autorisées dans la liste d'autorisation.
EngineVersion : version du moteur de base de données.
StorageType : type de stockage.
ZoneId : ID de la zone.
PublicIpAddr : adresse IP utilisée pour se connecter au cluster via Internet.
VSwitchId : ID du vSwitch.
CreateTime : date de création du cluster.
DbNodeCount : nombre de nœuds.
LockMode : mode de verrouillage du cluster.
DBClusterName : nom du cluster.
ScaleOutStatus : statut de la tâche de migration des données.
VpcId : ID du VPC.
DBClusterIPArrayName : nom de la liste d'autorisation d'adresses IP modifiée.
DbClusterNetworkType : type de réseau.
VpcCloudInstanceId : ID de la ressource VPC.
SupportMysqlPort : indique si le cluster prend en charge les ports MySQL.
ConnectionString : endpoint VPC.
ExpireTime : date d'expiration du cluster.
PublicPort : port TCP de l'endpoint public.
AliUid : ID du compte Alibaba Cloud.
Exemples
Format 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
Format 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"
]
}
}
}
}