1. 接口描述
接口请求域名: postgres.tencentcloudapi.com 。
本接口 (CreateInstances) 用于创建一个或者多个PostgreSQL实例,通过此接口创建的实例无需进行初始化,可直接使用。
默认接口请求频率限制:100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateInstances。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Zone | 是 | String | 实例所属主可用区, 如:ap-guangzhou-3;若需要支持多可用区,在DBNodeSet.N字段中进行添加主可用区和备可用区信息; 可用区信息可以通过调用 DescribeZones 接口的返回值中的Zone字段来获取。 示例值:ap-guangzhou-6 |
SpecCode | 是 | String | 售卖规格码。该参数可以通过调用DescribeClasses的返回值中的SpecCode字段来获取。 示例值:pg.it.2xlarge16 |
Storage | 是 | Integer | 实例容量大小,单位:GB。 示例值:64 |
InstanceCount | 是 | Integer | 购买实例数量,取值范围:[1-10]。一次性购买支持最大数量10个,若超过该数量,可进行多次调用进行购买。 示例值:1 |
Period | 是 | Integer | 购买时长,单位:月。 示例值:12 |
Charset | 是 | String | 实例字符集,目前只支持: 示例值:UTF8 |
AdminName | 是 | String | 实例根账号用户名,具体规范如下: 示例值:pgadmin1 |
AdminPassword | 是 | String | 实例根账号用户名对应的密码,长度8 ~ 32位,推荐使用12位以上的密码;不能以" / "开头; 必须包含以下四项,字符种类: 示例值:A8b!C2d#E4f& |
DBMajorVersion | 否 | String | PostgreSQL大版本号(该参数当前必传),版本信息可从DescribeDBVersions获取。目前支持10,11,12,13,14,15这几个大版本,详情见内核版本概述。 输入该参数时,会基于此大版本号创建对应的最新小版本的最新内核版本号实例。 示例值:12 |
DBVersion | 否 | String | PostgreSQL社区大版本+小版本号。 一般场景不推荐传入该参数。如需指定,只能传当前大版本号下最新小版本号。 示例值:12.7 |
DBKernelVersion | 否 | String | PostgreSQL内核版本号。 一般场景不推荐传入该参数。如需指定,只能传当前大版本号下最新内核版本号。 示例值:v12.7_r1.8 |
InstanceChargeType | 否 | String | 实例计费类型,目前支持: 默认值:PREPAID 示例值:POSTPAID_BY_HOUR |
VpcId | 否 | String | 私有网络ID,形如vpc-xxxxxxxx(该参数当前必传)。有效的VpcId可通过登录控制台查询;也可以调用接口 DescribeVpcEx ,从接口返回中的unVpcId字段获取。 示例值:vpc-8e0ypm3z |
SubnetId | 否 | String | 私有网络子网ID,形如subnet-xxxxxxxx(该参数当前必传)。有效的私有网络子网ID可通过登录控制台查询;也可以调用接口 DescribeSubnets ,从接口返回中的unSubnetId字段获取。 示例值:subnet-bthucmmy |
DBNodeSet.N | 否 | Array of DBNode | 实例节点部署信息,支持多可用区部署时需要指定每个节点的部署可用区信息。 可用区信息可以通过调用 DescribeZones 接口的返回值中的Zone字段来获取。 示例值:[ { "Zone": "ap-guangzhou-6", "ZoneName": "广州六区", "ZoneId": 100006, "ZoneState": "AVAILABLE", "ZoneSupportIpv6": 0, "StandbyZoneSet": [ "ap-guangzhou-6", "ap-guangzhou-7" ] } ] |
AutoRenewFlag | 否 | Integer | 续费标记: 默认值:0 示例值:0 |
AutoVoucher | 否 | Integer | 是否自动使用代金券: 默认值:0 示例值:0 |
VoucherIds.N | 否 | Array of String | 代金券ID列表,目前仅支持指定一张代金券。 示例值:[ "OZRCGNAV8D9BMI9KMG1FIQ" ] |
ProjectId | 否 | Integer | 项目ID。 示例值:0 |
ActivityId | 否 | Integer | 活动ID。 示例值:123 |
Name | 否 | String | 实例名称,仅支持长度小于60的中文/英文/数字/"_"/"-",不指定实例名称则默认显示"未命名"。 示例值:pg-instance-1 |
TagList.N | 否 | Array of Tag | 实例需要绑定的Tag信息,默认为空;可以通过调用 DescribeTags 返回值中的 Tags 字段来获取。 示例值:[ { "TagKey": "abc", "TagValue": "123", "CanDelete": 1 } ] |
SecurityGroupIds.N | 否 | Array of String | 实例所属安全组,该参数可以通过调用 DescribeSecurityGroups 的返回值中的sgId字段来获取。若不指定该参数,则绑定默认安全组。 示例值:[ { "SecurityGroupId": "sg-05bb4upy", "SecurityGroupName": "TestGroup", "SecurityGroupDesc": "test-group-desc", "ProjectId": "0", "IsDefault": true, "CreatedTime": "2017-04-18 21:02:30", "UpdateTime": "", "TagSet": [] } ] |
NeedSupportTDE | 否 | Integer | 是否需要支持数据透明加密: 默认值:0 参考数据透明加密概述 示例值:1 |
KMSKeyId | 否 | String | 自定义密钥的KeyId,若选择自定义密匙加密,则需要传入自定义密匙的KeyId,KeyId是CMK的唯一标识。 KeyId创建获取相关参考开启透明数据加密 示例值:7f370325-bb06-11ec-b54a-525400bb1222 |
KMSRegion | 否 | String | 使用KMS服务的地域,KMSRegion为空默认使用本地域的KMS,本地域不支持的情况下需自选其他KMS支持的地域。 KMSRegion相关介绍参考开启透明数据加密 示例值:ap-guangzhou |
DBEngine | 否 | String | 数据库引擎,支持: 默认值:postgresql 示例值:postgresql |
DBEngineConfig | 否 | String | 数据库引擎的配置信息,配置格式如下: {"$key1":"$value1", "$key2":"$value2"} 各引擎支持如下: mssql_compatible引擎: "af_ZA", "sq_AL", "ar_DZ", "ar_BH", "ar_EG", "ar_IQ", "ar_JO", "ar_KW", "ar_LB", "ar_LY", "ar_MA", "ar_OM", "ar_QA", "ar_SA", "ar_SY", "ar_TN", "ar_AE", "ar_YE", "hy_AM", "az_Cyrl_AZ", "az_Latn_AZ", "eu_ES", "be_BY", "bg_BG", "ca_ES", "zh_HK", "zh_MO", "zh_CN", "zh_SG", "zh_TW", "hr_HR", "cs_CZ", "da_DK", "nl_BE", "nl_NL", "en_AU", "en_BZ", "en_CA", "en_IE", "en_JM", "en_NZ", "en_PH", "en_ZA", "en_TT", "en_GB", "en_US", "en_ZW", "et_EE", "fo_FO", "fa_IR", "fi_FI", "fr_BE", "fr_CA", "fr_FR", "fr_LU", "fr_MC", "fr_CH", "mk_MK", "ka_GE", "de_AT", "de_DE", "de_LI", "de_LU", "de_CH", "el_GR", "gu_IN", "he_IL", "hi_IN", "hu_HU", "is_IS", "id_ID", "it_IT", "it_CH", "ja_JP", "kn_IN", "kok_IN", "ko_KR", "ky_KG", "lv_LV", "lt_LT", "ms_BN", "ms_MY", "mr_IN", "mn_MN", "nb_NO", "nn_NO", "pl_PL", "pt_BR", "pt_PT", "pa_IN", "ro_RO", "ru_RU", "sa_IN", "sr_Cyrl_RS", "sr_Latn_RS", "sk_SK", "sl_SI", "es_AR", "es_BO", "es_CL", "es_CO", "es_CR", "es_DO", "es_EC", "es_SV", "es_GT", "es_HN", "es_MX", "es_NI", "es_PA", "es_PY","es_PE", "es_PR", "es_ES", "es_TRADITIONAL", "es_UY", "es_VE", "sw_KE", "sv_FI", "sv_SE", "tt_RU", "te_IN", "th_TH", "tr_TR", "uk_UA", "ur_IN", "ur_PK", "uz_Cyrl_UZ", "uz_Latn_UZ", "vi_VN"。 示例值:{ "migrationMode": "single-db", "defaultLocale": "zh_CN", "serverCollationName": "sql_latin1_general_cp1250_ci_as" } |
SyncMode | 否 | String | 主从同步方式,支持: 主实例默认值:Semi-sync 只读实例默认值:Async 示例值:Async |
NeedSupportIpv6 | 否 | Integer | 是否需要支持Ipv6: 默认值:0 示例值:0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DealNames | Array of String | 订单号列表。每个实例对应一个订单号。 示例值:[ "20180119110001" ] |
BillId | String | 冻结流水号。 示例值:20181225711000768276471 |
DBInstanceIdSet | Array of String | 创建成功的实例ID集合,只在后付费情景下有返回值。 示例值:[ "postgres-2uepfuz1" ] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建12.4版本的PostgreSQL实例
创建12.4版本中最新内核版的PostgreSQL实例
输入示例
POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateInstances
<公共请求参数>
{
"InstanceCount": "1",
"AutoRenewFlag": "1",
"AdminName": "test2313",
"Zone": "ap-guangzhou-2",
"AdminPassword": " xxxxxxx",
"DBVersion": "12.4",
"DBEngine": "postgresql",
"Storage": "10",
"Period": "1",
"SpecCode": "cdb.pg.z1.2g",
"InstanceChargeType": "prepaid",
"AutoVoucher": "0",
"Charset": "UTF8"
}
输出示例
{
"Response": {
"RequestId": "6ace8140-6b9e-4e81-a8ad-ef3f92b2aa90",
"DealNames": [
"20180119110001"
],
"DBInstanceIdSet": [
"postgres-xxxxx"
],
"BillId": "123"
}
}
示例2 创建指定内核版本号的PostgreSQL实例
创建内核版本号为v12.4_r1.0版本的PostgreSQL实例
输入示例
POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateInstances
<公共请求参数>
{
"InstanceCount": "1",
"AutoRenewFlag": "1",
"AdminName": "test2313",
"Zone": "ap-guangzhou-2",
"AdminPassword": " xxxxxxx",
"Charset": "UTF8",
"Storage": "10",
"Period": "1",
"SpecCode": "cdb.pg.z1.2g",
"DBKernelVersion": "v12.4_r1.0",
"DBEngine": "postgresql",
"InstanceChargeType": "prepaid",
"AutoVoucher": "0"
}
输出示例
{
"Response": {
"RequestId": "6ace8140-6b9e-4e81-a8ad-ef3f92b2aa90",
"DealNames": [
"20180119110001"
],
"DBInstanceIdSet": [
"postgres-xxxxx"
],
"BillId": "123"
}
}
示例3 创建12版本中最新内核版本的PostgreSQL实例
创建12版本中最新内核版本的PostgreSQL实例(跨可用区)
输入示例
POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateInstances
<公共请求参数>
{
"InstanceCount": "1",
"AutoRenewFlag": "1",
"DBMajorVersion": "12",
"Zone": "ap-guangzhou-2",
"AdminPassword": " xxxxxxx",
"Charset": "UTF8",
"Storage": "10",
"Period": "1",
"SpecCode": "cdb.pg.z1.2g",
"InstanceChargeType": "prepaid",
"AutoVoucher": "0",
"DBNodeSet": [
{
"Role": "Standby",
"Zone": "ap-guangzhou-3"
},
{
"Role": "Primary",
"Zone": "ap-guangzhou-2"
}
],
"AdminName": "test2313"
}
输出示例
{
"Response": {
"RequestId": "6ace8140-6b9e-4e81-a8ad-ef3f92b2aa90",
"DealNames": [
"20180119110001"
],
"DBInstanceIdSet": [
"postgres-xxxxx"
],
"BillId": "123"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure.UnauthorizedOperation | 鉴权失败。 |
FailedOperation.AllocateQuotasError | 申请资源标签的配额失败。 |
FailedOperation.CamAuthFailed | CAM鉴权失败。 |
FailedOperation.CamSigAndAuthError | 鉴权失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
FailedOperation.CdbCgwConnectError | 获取项目信息失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
FailedOperation.CreateBasicNetworkDeniedError | 不支持新增基础网络。 |
FailedOperation.CreateOrderFailed | 创建续费订单失败。 |
FailedOperation.DatabaseAccessError | 管控元数据库访问失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
FailedOperation.DatabaseAffectedError | 数据操作失败,请联系客服进行处理。 |
FailedOperation.FailedOperationError | 操作失败,请稍后重试。 |
FailedOperation.FlowCreateError | 创建流程失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
FailedOperation.GetSubnetError | 获取VPC子网失败。 |
FailedOperation.GetVpcInfoError | 获取VPC信息失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
FailedOperation.InvalidTradeOperate | 计费相关错误,不允许对当前实例进行对应的新购/续费/配置变更操作。 |
FailedOperation.PayOrderFailed | 支付订单失败。 |
FailedOperation.QueryPriceFailed | 查询价格失败。 |
FailedOperation.QuerySpecError | 查询规格信息失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
FailedOperation.QueryVpcFailed | 查询VPC失败。 |
FailedOperation.QueryVpcFalied | 获取VPC详情失败。 |
FailedOperation.ServiceAccessError | 访问内部服务失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
FailedOperation.StorageMemoryCheckError | 实例升配时,存储或内存需要高于原实例规格。 |
FailedOperation.TradeCreateError | 请求计费平台创建订单失败。 |
FailedOperation.TradePayOrdersError | 请求支付订单失败。 |
FailedOperation.WhitelistConnectError | 查询白名单失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
InternalError.CgwError | CGW相关错误。 |
InternalError.CnsError | 基础网络相关错误。 |
InternalError.DBError | 后台DB执行错误。 |
InternalError.DfwError | DFW相关错误。 |
InternalError.FlowError | 流程创建失败。 |
InternalError.InternalHttpServerError | 请求执行异常。 |
InternalError.JsonParseError | Json数据解析失败,请联系客服进行处理。 |
InternalError.SystemError | 系统错误。出现这种错误时,请联系客服支持。 |
InternalError.UnknownError | 其他未知错误。出现这种错误时,请联系客服支持。 |
InternalError.VpcError | VPC相关错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.ParameterCheckError | 参数检查失败。 |
InvalidParameter.TradeAccessDeniedError | pid错误。 |
InvalidParameter.VpcNotFoundError | 未获取到VPC信息。 |
InvalidParameterValue.AccountExist | 当前账号已存在。 |
InvalidParameterValue.BadSpec | 当前实例所要扩容的规格目前不售卖。 |
InvalidParameterValue.CharsetNotFoundError | 数据库字符集错误。 |
InvalidParameterValue.DataConvertError | 数据格式转换失败,请联系客服处理。 |
InvalidParameterValue.DecryptPasswordFailed | 解密密码失败,请确认密码加密是否正确。 |
InvalidParameterValue.IllegalInstanceChargeType | 计费模式错误。 |
InvalidParameterValue.IllegalProjectId | 非法ProjectId。 |
InvalidParameterValue.IllegalRegion | 非法的Region参数。 |
InvalidParameterValue.IllegalZone | 非法的Zone参数。 |
InvalidParameterValue.InterfaceNameNotFound | ACTION输入错误。 |
InvalidParameterValue.InvalidAccountError | 账号设置无效,请遵循账号命名规则:账号名需要1-16个字符,只能由字母、数字或下划线组成;不能为postgres;不能由数字和pg_开头;所有规则均不区分大小写。 |
InvalidParameterValue.InvalidAccountFormat | 账号格式不正确。 |
InvalidParameterValue.InvalidAccountName | 当前账号名称不允许是保留字符。 |
InvalidParameterValue.InvalidAccountNameError | 账号设置无效,请遵循账号命名规则:账号名需要1-16个字符,只能由字母、数字或下划线组成;不能为postgres;不能由数字、pg_及tencentdb_开头;所有规则均不区分大小写。 |
InvalidParameterValue.InvalidAccountNameFormatError | 账号无效,请遵循账号命名规则:由字母(a-z, A-Z)、数字(0-9)、下划线()组成,以字母或()开头,最多63个字符。不能使用系统保留关键字,不能为postgres,且不能由pg_或tencentdb_开头。 |
InvalidParameterValue.InvalidCharset | 数据库字符集错误,当前只支持UTF8、LATIN1。 |
InvalidParameterValue.InvalidInstanceNum | 购买实例数超过限制。 |
InvalidParameterValue.InvalidOrderNum | 计费相关错误,订单类型ID无效。 |
InvalidParameterValue.InvalidParameterValueError | 参数值有误。 |
InvalidParameterValue.InvalidPasswordFormat | 密码格式不正确。 |
InvalidParameterValue.InvalidPasswordLengthError | 密码设置无效,长度不满足规则。 |
InvalidParameterValue.InvalidPasswordValueError | 密码设置无效,不能以“/”开头,必须包含大写字母、小写字母、符号()`~!@#$%^&*-+=_|{}[]:;'<>,.?/和数字。 |
InvalidParameterValue.InvalidPid | PID参数输入错误。 |
InvalidParameterValue.InvalidZoneIdError | 无效的可用区。 |
InvalidParameterValue.ParameterCharacterError | 参数无效,只允许英文字母、数字、下划线、中划线,以及全体汉字。 |
InvalidParameterValue.ParameterHandleError | 参数处理失败,请检参数值设置是否有效。 |
InvalidParameterValue.ParameterLengthLimitError | 参数长度超过限制。 |
InvalidParameterValue.ParameterOutRangeError | 存在无效的参数值。 |
InvalidParameterValue.RegionNotSupported | 不支持当前地域。 |
InvalidParameterValue.SpecNotRecognizedError | 规格信息{{1}}无法被识别。 |
InvalidParameterValue.StructParseFailed | 解析参数出错。 |
InvalidPid | PID参数输入错误。 |
OperationDenied.CamDeniedError | 当前操作被限制。 |
OperationDenied.InstanceStatusLimitOpError | 实例状态限制当前操作。 |
OperationDenied.UserNotAuthenticatedError | 用户未进行实名认证,请先进行实名认证才可购买。 |
OperationDenied.VpcDeniedError | 您没有权限操作该VPC网络。 |
ResourceInsufficient.ResourceNotEnough | 当前地域购买此规格的实例没有足够的资源。 |
ResourceUnavailable.InvalidInstanceStatus | 实例状态错误。 |
ResourceUnavailable.ResourceNoPermission | 没有该VPC网络权限。 |
ResourceUnavailable.VpcResourceNotFound | 没有找到实例所属VPC信息。 |
UnauthorizedOperation.UserHasNoRealnameAuthentication | 用户未进行实名认证。 |
UnknownError | 其他未知错误。出现这种错误时,请联系客服支持。 |