创建ServerlessDB实例

最近更新时间:2020-03-23 08:11:29

1. 接口描述

接口请求域名: postgres.tencentcloudapi.com 。

本接口 (CreateServerlessDBInstance) 用于创建一个ServerlessDB实例,创建成功返回实例ID。

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:postgres.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateServerlessDBInstance。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
Zone String 可用区ID。该参数可以通过调用 DescribeZones 接口的返回值中的Zone字段来获取。
DBInstanceName String DB实例名称,同一个账号下该值必须唯一。
DBVersion String PostgreSQL内核版本,目前只支持:9.3.5、9.5.4、10.4三种版本。
DBCharset String PostgreSQL数据库字符集,目前支持UTF8、LATIN1两种。
ProjectId Integer 项目ID。
VpcId String 私有网络ID。
SubnetId String 私有网络子网ID。

3. 输出参数

参数名称 类型 描述
DBInstanceId String 实例ID,该ID全局唯一,如:postgres-xxxxx
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建serverlessDB实例

创建一个实例名为“serverlessdb-test”的serverless实例,实例数据库版本为10.4,服务端database字符集为UTF8。

输入示例

https://postgres.tencentcloudapi.com/?Action=CreateServerlessDBInstance
&Zone=ap-guangzhou-3
&VpcId=vpc-xxxx
&SubnetId=subnet-xxx
&DBInstanceName=serverlessdb-test
&DBVersion=10.4
&DBCharset=UTF8
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "08fdf411-5d39-44f2-8e1d-a58ee60b237d",
    "DBInstanceId": "postgres-xxxxx"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。出现这种错误时,请联系客服支持。
InternalError.DBError 后台DB执行错误。
InvalidParameter.InstanceNameExist 实例名已存在
InvalidParameterValue.InstanceNameExist 当前账号已存在。
InvalidParameterValue.InvalidCharset 数据库字符集错误,当前只支持UTF8、LATIN1。
InvalidParameterValue.RegionNotSupported 不支持当前地域。
InvalidParameterValue.StructParseFailed 解析参数出错。
目录