1. 接口描述
接口请求域名: postgres.tencentcloudapi.com 。
此接口用于创建数据账号,返回的Oid为账号唯一标识。与数据库系统表pg_roles中记录的oid一致。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateAccount。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
DBInstanceId | 是 | String | 实例ID。 示例值:postgres-4sfuv15b |
UserName | 是 | String | 创建的账号名称。 示例值:test |
Password | 是 | String | 账号对应的密码。 示例值:1234qwe |
Type | 是 | String | 账号类型。当前支持normal、tencentDBSuper两个输入。normal指代普通用户,tencentDBSuper为拥有pg_tencentdb_superuser角色的账号。 示例值:normal |
Remark | 否 | String | 账号备注。 示例值:test Remark |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建数据库普通账号
创建数据库普通账号
输入示例
POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAccount
<公共请求参数>
{
"DBInstanceId": "postgres-5cz25tr5",
"UserName": "user_normal",
"Password": "Test_password1",
"Type": "normal",
"Remark": ""
}
输出示例
{
"Response": {
"RequestId": "5d19322f-50fe-4084-a5d3-b0bc680fd3a1"
}
}
示例2 创建数据库超级账号
创建数据库超级账号
输入示例
POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAccount
<公共请求参数>
{
"DBInstanceId": "postgres-5cz25tr5",
"UserName": "user_Super",
"Password": "Test_password1",
"Type": "tencentDBSuper",
"Remark": "超级用户"
}
输出示例
{
"Response": {
"RequestId": "fad9ac43-c906-4494-bbb5-88d154d2829c"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.DatabaseAccessError | 管控元数据库访问失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
FailedOperation.FailedOperationError | 操作失败,请稍后重试。 |
FailedOperation.PreCheckError | 操作预检查失败。 |
InvalidParameter.ParameterCheckError | 参数检查失败。 |
InvalidParameterValue.DecryptPasswordFailed | 解密密码失败,请确认密码加密是否正确。 |
InvalidParameterValue.InvalidAccountNameError | 账号设置无效,请遵循账号命名规则:账号名需要1-16个字符,只能由字母、数字或下划线组成;不能为postgres;不能由数字、pg_及tencentdb_开头;所有规则均不区分大小写。 |
InvalidParameterValue.InvalidAccountNameFormatError | 账号无效,请遵循账号命名规则:由字母(a-z, A-Z)、数字(0-9)、下划线()组成,以字母或()开头,最多63个字符。不能使用系统保留关键字,不能为postgres,且不能由pg_或tencentdb_开头。 |
InvalidParameterValue.InvalidDatabaseNameFormatError | 数据库名称无效,请遵循命名规则:由字母(a-z, A-Z)、数字(0-9)、下划线()组成,以字母或()开头,最多63个字符。不能使用系统保留关键字。 |
InvalidParameterValue.InvalidPasswordLengthError | 密码设置无效,长度不满足规则。 |
InvalidParameterValue.InvalidPasswordValueError | 密码设置无效,不能以“/”开头,必须包含大写字母、小写字母、符号()`~!@#$%^&*-+=_|{}[]:;'<>,.?/和数字。 |
InvalidParameterValue.ParameterCharacterError | 参数无效,只允许英文字母、数字、下划线、中划线,以及全体汉字。 |
InvalidParameterValue.ParameterLengthLimitError | 参数长度超过限制。 |
OperationDenied.InstanceAccessDeniedError | 您没有权限操作当前资源。 |
OperationDenied.InstanceStatusLimitError | 实例当前状态限制本次操作。 |
OperationDenied.InstanceStatusLimitOpError | 实例状态限制当前操作。 |
OperationDenied.KernelVersionError | 内核版本过低,导致实例无法创建tencentDBSuper账号。如果您想使用此功能,请升级内核版本。 |