1. 接口描述
接口请求域名： postgres.tencentcloudapi.com 。
本接口 (CreateServerlessDBInstance) 用于创建一个ServerlessDB实例，创建成功返回实例ID。
默认接口请求频率限制：100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateServerlessDBInstance。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Zone | 是 | String | 可用区ID。公测阶段仅支持ap-shanghai-2、ap-beijing-1,ap-guangzhou-2. 示例值：ap-guangzhou-3 |
| DBInstanceName | 是 | String | DB实例名称，同一个账号下该值必须唯一。 示例值：serverlessdb-test |
| DBVersion | 是 | String | PostgreSQL内核版本，目前只支持：10.4。 示例值：10.4 |
| DBCharset | 是 | String | PostgreSQL数据库字符集，目前支持UTF8。 示例值：UTF8 |
| ProjectId | 否 | Integer | 项目ID。 示例值：0 |
| VpcId | 否 | String | 私有网络ID。 示例值：vpc-xxxx |
| SubnetId | 否 | String | 私有网络子网ID。 示例值：subnet-xxx |
| TagList.N | 否 | Array of Tag | 实例需要绑定的标签数组信息 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DBInstanceId | String | 实例ID，该ID全局唯一，如：postgres-xxxxx 示例值：postgres-xxxxx |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建serverlessDB实例
创建一个实例名为“serverlessdb-test”的serverless实例，实例数据库版本为10.4，服务端database字符集为UTF8。
输入示例
POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateServerlessDBInstance
<公共请求参数>
{
"VpcId": "vpc-xxxx",
"Zone": "ap-guangzhou-3",
"DBVersion": "10.4",
"DBInstanceName": "serverlessdb-test",
"DBCharset": "UTF8",
"SubnetId": "subnet-xxx"
}输出示例
{
"Response": {
"RequestId": "08fdf411-5d39-44f2-8e1d-a58ee60b237d",
"DBInstanceId": "postgres-xxxxx"
}
}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.CamSigAndAuthError | 鉴权失败，请稍后重试。如果持续不成功，请联系客服进行处理。 |
| FailedOperation.CreateBasicNetworkDeniedError | 不支持新增基础网络。 |
| FailedOperation.DatabaseAccessError | 管控元数据库访问失败，请稍后重试。如果持续不成功，请联系客服进行处理。 |
| FailedOperation.FailedOperationError | 操作失败，请稍后重试。 |
| FailedOperation.FlowCreateError | 创建流程失败，请稍后重试。如果持续不成功，请联系客服进行处理。 |
| FailedOperation.GetVpcInfoError | 获取VPC信息失败，请稍后重试。如果持续不成功，请联系客服进行处理。 |
| FailedOperation.QueryVpcFailed | 查询VPC失败。 |
| FlowError | 流程创建失败。 |
| InternalError | 内部错误。 |
| InternalError.DBError | 后台DB执行错误。 |
| InternalError.FlowError | 流程创建失败。 |
| InternalError.InternalHttpServerError | 请求执行异常。 |
| InternalError.SystemError | 系统错误。出现这种错误时，请联系客服支持。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InstanceNameExist | 实例名已存在。 |
| InvalidParameter.ParameterCheckError | 参数检查失败。 |
| InvalidParameterValue.DataConvertError | 数据格式转换失败，请联系客服处理。 |
| InvalidParameterValue.IllegalRegion | 非法的Region参数。 |
| InvalidParameterValue.IllegalZone | 非法的Zone参数。 |
| InvalidParameterValue.InstanceNameExist | 当前账号已存在。 |
| InvalidParameterValue.InvalidAccountFormat | 账号格式不正确。 |
| InvalidParameterValue.InvalidCharset | 数据库字符集错误，当前只支持UTF8、LATIN1。 |
| InvalidParameterValue.InvalidParameterValueError | 参数值有误。 |
| InvalidParameterValue.InvalidPasswordFormat | 密码格式不正确。 |
| InvalidParameterValue.InvalidZoneIdError | 无效的可用区。 |
| InvalidParameterValue.ParameterCharacterError | 参数无效，只允许英文字母、数字、下划线、中划线，以及全体汉字。 |
| InvalidParameterValue.ParameterHandleError | 参数处理失败，请检参数值设置是否有效。 |
| InvalidParameterValue.ParameterLengthLimitError | 参数长度超过限制。 |
| InvalidParameterValue.RegionNotSupported | 不支持当前地域。 |
| InvalidParameterValue.StructParseFailed | 解析参数出错。 |
| OperationDenied.CamDeniedError | 当前操作被限制。 |
| OperationDenied.NotSupportZoneError | Serverless不支持当前可用区。 |
| OperationDenied.VersionNotSupportError | Serverless不支持该版本。 |
| ResourceNotFound.InstanceNotFoundError | 实例不存在。 |
| ResourceUnavailable.InvalidInstanceStatus | 实例状态错误。 |
| UnauthorizedOperation.UserHasNoRealnameAuthentication | 用户未进行实名认证。 |