API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心 > TDSQL-C PostgreSQL 版 > 集群管理相关接口 > 创建集群

创建集群

最近更新时间：2024-03-12 01:53:13

我的收藏

本页目录：

1. 接口描述

接口请求域名： tdcpg.tencentcloudapi.com 。

创建集群

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：CreateCluster。
Version 是 String 公共参数，本接口取值：2021-11-18。
Region 是 String 公共参数，详见产品支持的 地域列表。
Zone 是 String 可用区
示例值：ap-guangzhou-2
MasterUserPassword 是 String 数据库用户密码，必须满足 8-64个字符，至少包含 大写字母、小写字母、数字和符号~!@#$%^&*_-+=`|(){}[]:;'<>,.?/中的任意三种
示例值：1111@AAAA
CPU 是 Integer CPU核数。取值参考文档【购买指南】
示例值：1
Memory 是 Integer 内存大小，单位GiB。取值参考文档【购买指南】
示例值：2
VpcId 是 String 私有网络ID
示例值：vpc-xxx
SubnetId 是 String 已配置的私有网络中的子网ID
示例值：subnet-xxx
PayMode 是 String 实例付费模式
- PREPAID：预付费，即包年包月
- POSTPAID_BY_HOUR：按小时后付费
示例值：PREPAID
ClusterName 否 String 集群名，1-60个字符，可以包含中文、英文、数字和符号"-"、"_"、"."。不输入此参数时默认与ClusterId保持一致
示例值：MyClusterName
DBVersion 否 String TDSQL-C PostgreSQL 合入的社区版本号。
支持入参值为：10.17。当输入该参数时，会基于此版本号创建对应的最新DBKernelVersion数据库内核。
注：该参数与DBMajorVersion、DBKernelVersion只能传递一个，且需要传递一个。
示例值：10.17
ProjectId 否 Integer 项目Id，默认为0表示默认项目
示例值：0
Port 否 Integer 连接数据库时，Endpoint使用的端口。取值范围为[1,65534]，默认值为5432
示例值：5432
InstanceCount 否 Integer 集群下实例数量。取值范围为[1,4]，默认值为1
示例值：1
Period 否 Integer 购买时长，单位：月。取值范围为[1,60]，默认值为1。
只有当PayMode为PREPAID时生效。
示例值：1
AutoRenewFlag 否 Integer 是否自动续费，0-不 1-是。默认值为0，只有当PayMode为PREPAID时生效。
示例值：0
DBMajorVersion 否 String TDSQL-C PostgreSQL 合入的社区主要版本号。
支持入参值为：10。当输入该参数时，会基于此版本号创建对应的最新DBKernelVersion数据库内核。
注：该参数和DBVersion、DBKernelVersion只能传递一个，且需要传递一个。
示例值：10
DBKernelVersion 否 String TDSQL-C PostgreSQL 内核版本号。
支持入参值为：v10.17_r1.4。当输入该参数时，会创建此版本号对应的数据库内核。
注：该参数和DBVersion、DBMajorVersion只能传递一个，且需要传递一个。
示例值：v10.17_r1.4
StoragePayMode 否 String 存储付费模式
- PREPAID：预付费，即包年包月
- POSTPAID_BY_HOUR：按小时后付费
默认为POSTPAID_BY_HOUR，实例付费模式为按小时付费时，存储付费模式不支持包年包月
示例值：PREPAID
Storage 否 Integer 存储最大使用量，单位GB。取值参考文档【购买指南】。存储使用预付费模式时必须设置，存储使用按小时后付费时不可设置
示例值：100

3. 输出参数

参数名称 类型 描述
DealNameSet Array of String 订单号
示例值：["aaaa"]
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建集群

输入示例

POST / HTTP/1.1
Host: tdcpg.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCluster
<公共请求参数>

{
    "InstanceCount": 1,
    "AutoRenewFlag": 0,
    "Zone": "ap-guangzhou-3",
    "ClusterName": "MyClusterName",
    "ProjectId": 0,
    "DBVersion": "10.17",
    "Period": 12,
    "MasterUserPassword": "111@abc",
    "CPU": 1,
    "PayMode": "PREPAID",
    "VpcId": "vpc-xxxx",
    "Memory": 2,
    "SubnetId": "subnet-xxxx",
    "Port": 5432
}

输出示例

{
    "Response": {
        "DealNameSet": [
            "20211028111234680033121"
        ],
        "RequestId": "03ea3f94-297d-11eb-8f30-525400b7dd5a"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
FailedOperation.DatabaseAccessError 元数据库访问失败，请稍后重试。如果持续不成功，请联系客服进行处理。
FailedOperation.FlowError 创建流程失败,请稍后重试。如果持续不成功，请联系客服进行处理。
FailedOperation.GetVpcFailed 获取VPC信息异常，请稍后重试。如果持续不成功，请联系客服进行处理。
FailedOperation.InternalServiceAccessError 内部服务访问失败，请稍后重试。如果持续不成功，请联系客服。
FailedOperation.PayModeInvalid 当前的付费模式不支持此操作。
FailedOperation.StoragePayModeInvalid 当前存储的付费模式不支持此操作。
FailedOperation.TradeAccessError 请求计费服务异常，请稍后重试。如果持续不成功，请联系客服进行处理。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.DatabaseVersionParamCountError 数据库版本号相关参数数量错误。
InvalidParameterValue.IllegalInstanceName 集群/实例名字非法，需要满足：长度在1-60个字符，只能由中文、字母、数字、'-'或'.'或'_'组成，区分大小写。
InvalidParameterValue.IllegalPassword 密码设置无效，需要满足： 8-64个字符，至少包含 大写字母、小写字母、数字和符号~!@#$%^&*_-+=`|(){}[]:;'<>,.?/中的任意三种
InvalidParameterValue.InvalidDBVersion 数据库版本信息无法被识别。
InvalidParameterValue.InvalidDatabaseVersion 数据库版本号相关参数不合法。
InvalidParameterValue.InvalidParameterValueError 传入的参数非法。
InvalidParameterValue.InvalidSpec 规格信息(CPU/Memory)信息无法被识别。
InvalidParameterValue.RegionZoneUnavailable 不支持当前地域/可用区的售卖。
InvalidParameterValue.VpcDeniedError 您没有权限操作该VPC网络。
InvalidParameterValue.VpcNotFound 未获取到VPC信息，请检查输入的VPC相关参数。
InvalidParameterValue.VpcSubnetIpLack VPC子网中IP数量不够。
LimitExceeded 超过配额限制。
LimitExceeded.ClusterInstanceLimit 当前集群下实例数量超过限制。
LimitExceeded.UserClusterLimit 用户集群数量超过限制。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
ResourceUnavailable.InstanceStatusAbnormal 当前集群/实例状态不允许操作。
UnauthorizedOperation 未授权操作。
UnauthorizedOperation.PermissionDenied 未经授权的操作。
UnknownParameter 未知参数错误。
中国站