Domain name for API request: postgres.intl.tencentcloudapi.com.
This API is used to create a database, requiring the specified database name and owner.
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: CreateDatabase. |
| 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 | Specifies the instance ID, such as postgres-6fego161. obtain through the api DescribeDBInstances. |
| DatabaseName | Yes | String | Specifies the user-created database name. Name specification: consists of letters (a-z, a-z), digits (0-9), and underscores (_), starting with a letter or underscore (_), up to 63 characters. system reserved keywords cannot be used, and 'postgres' is not allowed. |
| DatabaseOwner | Yes | String | Owner of the database. obtain through the api DescribeAccounts. |
| Encoding | No | String | Specifies the character encoding of the database. Supported character sets include UTF8, LATIN1, LATIN2, WIN1250, WIN1251, WIN1252, KOI8R, EUC_JP, and EUC_KR. Default value: UTF8. |
| Collate | No | String | Specifies the database sorting rule. |
| Ctype | No | String | Specifies the character category of the database. |
| 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. |
POST / HTTP/1.1
Host: postgres.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDatabase
<Common request parameters>
{
"DBInstanceId": "postgres-5cz25tr5",
"DatabaseName": "mydatabase",
"DatabaseOwner": "data_team"
}
{
"Response": {
"RequestId": "28004847-7a50-4740-a536-19ee9db9ccc0"
}
}
POST / HTTP/1.1
Host: postgres.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDatabase
<Common request parameters>
{
"DBInstanceId": "postgres-5cz25tr5",
"DatabaseName": "mydatabase",
"DatabaseOwner": "data_team",
"Encoding": "UTF8",
"Collate": "zh_CN.utf8",
"Ctype": "zh_CN.utf8"
}
{
"Response": {
"RequestId": "28004847-7a50-4740-a536-19ee9db9ccc0"
}
}
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 |
|---|---|
| AuthFailure.UnauthorizedOperation | Authentication failed. |
| FailedOperation.DatabaseAccessError | Failed to access database management service. Please try again later. If the problem persists, please contact customer service. |
| FailedOperation.DatabaseAffectedError | Data operation failed. 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.CharsetNotFoundError | Incorrect database character set |
| InvalidParameterValue.InvalidAccountError | Invalid account. The account name is case-insensitive, must contain 1-16 characters comprised of letters, digits, underscores, and should neither be "postgres" nor start with a digit or "pg_". |
| InvalidParameterValue.ParameterLengthLimitError | The length of parameter exceeds the limit. |
| InvalidParameterValue.ParameterOutRangeError | Invalid parameter values. |
| OperationDenied.InstanceStatusLimitError | This operation cannot be performed on an instance in this status. |
| ResourceNotFound.InstanceNotFoundError | The instance does not exist. |
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