1. 接口描述
接口请求域名: postgres.tencentcloudapi.com 。
本接口(CreateDBInstances)用于创建一个或者多个PostgreSQL实例,仅发货实例不会进行初始化。本接口已废弃,推荐使用接口CreateInstances替代。
默认接口请求频率限制:100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateDBInstances。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
SpecCode | 是 | String | 售卖规格ID。该参数可以通过调用DescribeClasses的返回值中的SpecCode字段来获取。 示例值:pg.it.2xlarge16 |
Storage | 是 | Integer | 实例容量大小,单位:GB。 示例值:64 |
InstanceCount | 是 | Integer | 一次性购买的实例数量。取值1-100 示例值:1 |
Period | 是 | Integer | 购买时长,单位:月。目前只支持1,2,3,4,5,6,7,8,9,10,11,12,24,36这些值,按量计费模式下该参数传1。 示例值:12 |
Zone | 是 | String | 可用区ID。该参数可以通过调用 DescribeZones 接口的返回值中的Zone字段来获取。 示例值:ap-guangzhou-6 |
ProjectId | 否 | Integer | 项目ID。 示例值:0 |
DBVersion | 否 | String | PostgreSQL社区大版本+小版本号。 一般场景不推荐传入该参数。如需指定,只能传当前大版本号下最新小版本号。 示例值:12.4 |
InstanceChargeType | 否 | String | 实例计费类型。目前支持:PREPAID(预付费,即包年包月),POSTPAID_BY_HOUR(后付费,即按量计费)。默认值:PREPAID。 示例值:POSTPAID_BY_HOUR |
AutoVoucher | 否 | Integer | 是否自动使用代金券。1(是),0(否),默认不使用。 示例值:0 |
VoucherIds.N | 否 | Array of String | 代金券ID列表,目前仅支持指定一张代金券。 示例值:[ "OZRCGNAV8D9BMI9KMG1FIQ" ] |
VpcId | 否 | String | 私有网络ID。 示例值:vpc-8e0ypm3z |
SubnetId | 否 | String | 私有网络子网ID。 示例值:subnet-bthucmmy |
AutoRenewFlag | 否 | Integer | 续费标记:0-正常续费(默认);1-自动续费; 示例值:0 |
ActivityId | 否 | Integer | 活动ID 示例值:123 |
Name | 否 | String | 实例名(后续支持) 示例值:pg-instance-1 |
NeedSupportIpv6 | 否 | Integer | 是否需要支持Ipv6,1:是,0:否 示例值:0 |
TagList.N | 否 | Array of Tag | 实例需要绑定的Tag信息,默认为空 示例值:[ { "TagKey": "abc", "TagValue": "123", "CanDelete": 1 } ] |
SecurityGroupIds.N | 否 | Array of String | 安全组id 示例值:[ { "SecurityGroupId": "sg-05bb4upy", "SecurityGroupName": "TestGroup", "SecurityGroupDesc": "test-group-desc", "ProjectId": "0", "IsDefault": true, "CreatedTime": "2017-04-18 21:02:30", "UpdateTime": "", "TagSet": [] } ] |
DBMajorVersion | 否 | String | PostgreSQL大版本号(该参数当前必传),版本信息可从DescribeDBVersions获取。目前支持10,11,12,13,14,15这几个大版本,详情见内核版本概述。 输入该参数时,会基于此大版本号创建对应的最新小版本的最新内核版本号实例。 示例值:12 |
DBKernelVersion | 否 | String | PostgreSQL内核版本号。 一般场景不推荐传入该参数。如需指定,只能传当前大版本号下最新内核版本号。 示例值:v12.4_r1.0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DealNames | Array of String | 订单号列表。每个实例对应一个订单号。 示例值:[ "20180119110001" ] |
BillId | String | 冻结流水号 示例值:20181225711000768276471 |
DBInstanceIdSet | Array of String | 创建成功的实例ID集合,只在后付费情景下有返回值 示例值:[ "postgres-jdlmoll9" ] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建PostgreSQL实例
新购实例
输入示例
POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDBInstances
<公共请求参数>
{
"InstanceCount": "1",
"AutoRenewFlag": "1",
"Zone": "ap-guangzhou-5",
"DBVersion": "12.4",
"Storage": "10",
"Period": "1",
"SpecCode": "cdb.pg.z1.2g",
"InstanceChargeType": "prepaid",
"AutoVoucher": "0"
}
输出示例
{
"Response": {
"RequestId": "6ace8140-6b9e-4e81-a8ad-ef3f92b2aa90",
"DealNames": [
"20180119110001"
],
"DBInstanceIdSet": [
"postgres-xxxx"
],
"BillId": "xxxxxxxxx"
}
}
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 | 请求支付订单失败。 |
InternalError.CgwError | CGW相关错误。 |
InternalError.CnsError | 基础网络相关错误。 |
InternalError.DBError | 后台DB执行错误。 |
InternalError.DfwError | DFW相关错误。 |
InternalError.FlowError | 流程创建失败。 |
InternalError.InternalHttpServerError | 请求执行异常。 |
InternalError.SystemError | 系统错误。出现这种错误时,请联系客服支持。 |
InternalError.UnknownError | 其他未知错误。出现这种错误时,请联系客服支持。 |
InternalError.VpcError | VPC相关错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.ParameterCheckError | 参数检查失败。 |
InvalidParameter.TradeAccessDeniedError | pid错误。 |
InvalidParameter.VpcNotFoundError | 未获取到VPC信息。 |
InvalidParameterValue.AccountExist | 当前账号已存在。 |
InvalidParameterValue.BadSpec | 当前实例所要扩容的规格目前不售卖。 |
InvalidParameterValue.DataConvertError | 数据格式转换失败,请联系客服处理。 |
InvalidParameterValue.IllegalInstanceChargeType | 计费模式错误。 |
InvalidParameterValue.IllegalProjectId | 非法ProjectId。 |
InvalidParameterValue.IllegalRegion | 非法的Region参数。 |
InvalidParameterValue.IllegalZone | 非法的Zone参数。 |
InvalidParameterValue.InterfaceNameNotFound | ACTION输入错误。 |
InvalidParameterValue.InvalidAccountFormat | 账号格式不正确。 |
InvalidParameterValue.InvalidAccountName | 当前账号名称不允许是保留字符。 |
InvalidParameterValue.InvalidCharset | 数据库字符集错误,当前只支持UTF8、LATIN1。 |
InvalidParameterValue.InvalidInstanceNum | 购买实例数超过限制。 |
InvalidParameterValue.InvalidOrderNum | 计费相关错误,订单类型ID无效。 |
InvalidParameterValue.InvalidParameterValueError | 参数值有误。 |
InvalidParameterValue.InvalidPasswordFormat | 密码格式不正确。 |
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 | 其他未知错误。出现这种错误时,请联系客服支持。 |