调用CheckCreateCluster对创建集群进行预检查_云数据库 ClickHouse-阿里云帮助中心

调用CheckCreateCluster接口对创建云数据库ClickHouse云原生版集群进行预检查，预判创建请求是否成功。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
PayType	string	是	付费类型，取值说明： Postpaid：按量付费。 Prepaid：预付费（包年包月）。	Postpaid
AutoRenew	boolean	否	仅当付费类型为Prepaid时，该参数才生效且为可选参数。预付费集群是否自动续费，取值说明： true：自动续费。 false：不自动续费，默认值。	true
Period	string	否	仅当付费类型为Prepaid时，该参数才生效且为必填参数。预付费集群为包年或包月类型，取值说明： Year：包年。 Month：包月。	Month
UsedTime	string	否	仅当付费类型为Prepaid时，该参数才生效且为必填参数。预付费集群的购买时长。当Period为Year时，取值范围：1~3（整数）。当Period为Month时，取值范围：1~9（整数）。	1
VpcId	string	是	VPC ID。	vpc-uf6xmupdn7v6ui9f7****
VswitchId	string	是	交换机ID。	vsw-uf632qye9oqt4x4sr5****
DBClusterDescription	string	否	集群描述。说明不能以http://或https://开头。长度为2~256个字符。	test
VirtualWareHouseClass	string	是	计算组的规格码。您可以通过调用DescribeVirtualWareHouseClassSet接口查询规格码。	n1.xlarge
VirtualWareHouseCacheStorage	integer	是	计算组的缓存大小，单位：GB。取值范围：200~32000。说明步长为100 GB。	200
VirtualWareHouseDescription	string	否	计算组描述。说明不能以http://或https://开头。长度为2~256个字符。	test
ZoneId	string	是	可用区ID。您可以通过调用DescribeRegions接口查询可用区ID。	cn-hangzhou-h
RegionId	string	是	地域ID。您可以通过调用DescribeRegions接口查询地域ID。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	PlainResponse
Data	object	预检查的结果。
ExpectedDBClusterStatus	string	创建时集群的状态，预期结果为Creating：创建中。	Creating
ExpectedTargetVirtualWareHouseStatus	string	创建时计算组的状态，预期结果为Creating：创建中。	Creating
ExpectedOrderFinishSeconds	long	创建云原生版集群所需的时间，单位：秒。	60
RequestId	string	请求ID。	9A23C87D-87DF-4DA0-A50E-CB13F4F7923D

示例

正常返回示例

JSON格式

{
  "Data": {
    "ExpectedDBClusterStatus": "Creating",
    "ExpectedTargetVirtualWareHouseStatus": "Creating",
    "ExpectedOrderFinishSeconds": 60
  },
  "RequestId": "9A23C87D-87DF-4DA0-A50E-CB13F4F7923D"
}

错误码

HTTP status code	错误码	错误信息
500	InternalError	The request processing has failed due to some unknown error, exception or failure.

访问错误中心查看更多错误码。