Domain name for API request: postgres.intl.tencentcloudapi.com.
This API is used to create a data account. The returned Oid is the unique identifier of the account, which matches the oid recorded in the database system table pg_roles.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: CreateAccount. |
| Version | Yes | String | Common Params. The value used for this API: 2017-03-12. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo. |
| DBInstanceId | Yes | String | Instance ID. can be obtained through the DescribeDBInstances api (https://www.tencentcloud.com/document/product/409/16773?lang=en). |
| UserName | Yes | String | The name of the account created. Consists of letters (a-z, A-Z), numbers (0-9), underscores (), starts with a letter or (_), up to 63 characters. Cannot use system reserved keywords, cannot be postgres, and cannot begin with pg_or tencentdb |
| Type | Yes | String | Account type. currently supported: normal, tencentDBSuper. normal references a general user, tencentDBSuper is an account that possesses the pg_tencentdb_superuser role. |
| Password | No | String | Specifies the corresponding password for the account. the password rules are as follows:. Valid values: a to z (lowercase letters). Uppercase letters: A - Z. Valid values: 0 - 9. Special symbols: ()`~!@#$%^&*-+=_ |
| Remark | No | String | Account remark. only allow english letters, digits, underscore, hyphen, and chinese characters, limited to 60 characters. |
| OpenCam | No | Boolean | Specifies whether CAM verification is enabled for the account. |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to create an ordinary account for a database.
POST / HTTP/1.1
Host: postgres.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAccount
<Common request parameters>
{
"DBInstanceId": "postgres-5cz25tr5",
"UserName": "user_normal",
"Password": "Test_password1",
"Type": "normal",
"Remark": "Ordinary account"
}
{
"Response": {
"RequestId": "5d19322f-50fe-4084-a5d3-b0bc680fd3a1"
}
}
This example shows you how to create a super account for the database.
POST / HTTP/1.1
Host: postgres.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAccount
<Common request parameters>
{
"DBInstanceId": "postgres-5cz25tr5",
"UserName": "user_Super",
"Password": "Test_password1",
"Type": "tencentDBSuper",
"Remark": "Super user"
}
{
"Response": {
"RequestId": "fad9ac43-c906-4494-bbb5-88d154d2829c"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.DatabaseAccessError | Failed to access database management service. Please try again later. If the problem persists, please contact customer service. |
| FailedOperation.FailedOperationError | Operation failed. Please try again later. |
| FailedOperation.PreCheckError | Pre-check failed |
| InvalidParameter.ParameterCheckError | Failed to check the parameter. |
| InvalidParameterValue.DecryptPasswordFailed | Decrypting the password failed. confirm whether the password encryption is correct. |
| InvalidParameterValue.InvalidAccountNameError | The account setting is invalid. please follow the account naming rules: the account name must be 1-16 characters, can only consist of letters, digits, or underscores; cannot be postgres; cannot start with a digit, pg_, or tencentdb_; all rules are case-insensitive. |
| InvalidParameterValue.InvalidAccountNameFormatError | The account is invalid. follow the account naming rules: it must consist of letters (a-z, a-z), digits (0-9), and underscores (_), start with a letter or underscore (_), and be no more than 63 characters. system reserved keywords cannot be used, 'postgres' is not allowed, and it cannot start with 'pg_' or 'tencentdb_'. |
| InvalidParameterValue.InvalidDatabaseNameFormatError | The database name is invalid. follow the naming rule: it must be made up of letters (a-z, a-z), digits (0-9), or underscores (_), start with a letter or underscore (_), and be no more than 63 characters. system reserved keywords cannot be used. |
| InvalidParameterValue.InvalidPasswordLengthError | Invalid password. The password length does not meet the requirements. |
| InvalidParameterValue.InvalidPasswordValueError | Invalid password. The password must contain uppercase letters, lowercase letters, digits, and symbols (()`~!@#$%^&*-+=_ |
| InvalidParameterValue.ParameterCharacterError | Invalid parameter. The parameter can contain only letters, digits, underscores, and hyphens. |
| InvalidParameterValue.ParameterLengthLimitError | The length of parameter exceeds the limit. |
| InvalidParameterValue.UnsupportedRegionError | The incoming region does not support this API feature. |
| OperationDenied.InstanceAccessDeniedError | You do not have the permission to operate this resource. |
| OperationDenied.InstanceStatusLimitError | This operation cannot be performed on an instance in this status. |
| OperationDenied.InstanceStatusLimitOpError | This operation cannot be performed on an instance in this status. |
| OperationDenied.KernelVersionError | The kernel version is too low, causing the instance to fail to create a tencentDBSuper account. if you want to use this feature, upgrade the kernel. |
| OperationDenied.UserNotInWhiteListError | User not in allowlist. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback