tencent cloud

Feedback

CreateInstances

Last updated: 2022-05-05 15:25:31

1. API Description

Domain name for API request: postgres.tencentcloudapi.com.

This API is used to create and initialize one or more TencentDB for PostgreSQL instances.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: CreateInstances.
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.
SpecCode Yes String Purchasable specification ID, which can be obtained through the SpecCode field in the returned value of the DescribeProductConfig API.
Storage Yes Integer Instance storage capacity in GB
InstanceCount Yes Integer The number of instances purchased at a time. Value range: 1-10.
Period Yes Integer Valid period in months of purchased instances. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. This parameter is set to 1 when the pay-as-you-go billing mode is used.
Zone Yes String Availability zone ID, which can be obtained through the Zone field in the returned value of the DescribeZones API.
Charset Yes String Instance character set. Valid values: UTF8, LATIN1.
AdminName Yes String Instance root account name
AdminPassword Yes String Instance root account password
ProjectId No Integer Project ID
DBVersion No String PostgreSQL version. If it is specified, an instance running the latest kernel of PostgreSQL DBVersion will be created. You must pass in at least one of the following parameters: DBVersion, DBMajorVersion, DBKernelVersion.
InstanceChargeType No String Instance billing mode. Valid values: PREPAID (monthly subscription), POSTPAID_BY_HOUR (pay-as-you-go).
AutoVoucher No Integer Whether to automatically use vouchers. Valid values: 1 (yes), 0 (no). Default value: 0.
VoucherIds.N No Array of String Voucher ID list. Currently, you can specify only one voucher.
VpcId No String VPC ID
SubnetId No String ID of a subnet in the VPC specified by VpcId
AutoRenewFlag No Integer Renewal flag. Valid values: 0 (manual renewal), 1 (auto-renewal). Default value: 0.
ActivityId No Integer Campaign ID
Name No String Instance name
NeedSupportIpv6 No Integer Whether to support IPv6 address access. Valid values: 1 (yes), 0 (no). Default value: 0
TagList.N No Array of Tag The information of tags to be associated with instances. This parameter is left empty by default.
SecurityGroupIds.N No Array of String Security group IDs
DBMajorVersion No String PostgreSQL major version. Valid values: 10, 11, 12, 13. If it is specified, an instance running the latest kernel of PostgreSQL DBMajorVersion will be created. You must pass in at least one of the following parameters: DBMajorVersion, DBVersion, DBKernelVersion.
DBKernelVersion No String PostgreSQL kernel version. If it is specified, an instance running the latest kernel of PostgreSQL DBKernelVersion will be created. You must pass in one of the following parameters: DBKernelVersion, DBVersion, DBMajorVersion.
DBNodeSet.N No Array of DBNode Instance node information, which is required if you purchase a multi-AZ deployed instance.
NeedSupportTDE No Integer Whether to support transparent data encryption. Valid values: 1 (yes), 0 (no). Default value: 0.
KMSKeyId No String KeyId of custom key, which is required if you select custom key encryption. It is also the unique CMK identifier.
KMSRegion No String The region where the KMS service is enabled. When “KMSRegion” is left empty, the “KMS” of the local domain will be enabled by default. If the local domain is not supported, you need to select another region supported by KMS.

3. Output Parameters

Parameter Name Type Description
DealNames Array of String Order number list. Each instance corresponds to an order number.
BillId String Bill ID of frozen fees
DBInstanceIdSet Array of String ID set of instances which have been created successfully. The parameter value will be returned only when the pay-as-you-go billing mode is used.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a PostgreSQL 12.4 instance

This example shows you how to create an instance running the latest kernel of PostgreSQL 12.4.

Input Example

https://postgres.tencentcloudapi.com/?Action=CreateInstances
&SpecCode=cdb.pg.z1.2g
&Storage=10
&InstanceCount=1
&Period=1
&InstanceChargeType=prepaid
&Zone=ap-guangzhou-2
&DBVersion=12.4
&AutoVoucher=0
&AutoRenewFlag=1
&Charset=UTF8
&AdminName=test2313
&AdminPassword= xxxxxxx
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "6ace8140-6b9e-4e81-a8ad-ef3f92b2aa90",
    "DealNames": [
      "20180119110001"
    ],
    "DBInstanceIdSet": [
      "postgres-xxxxx"
    ],
    "BillId": "123"
  }
}

Example2 Creating an instance running the latest kernel of PostgreSQL 12

This example shows you how to create a multi-AZ deployed instance running the latest kernel of PostgreSQL 12.

Input Example

https://postgres.tencentcloudapi.com/?Action=CreateInstances
&SpecCode=cdb.pg.z1.2g
&Storage=10
&InstanceCount=1
&Period=1
&InstanceChargeType=prepaid
&Zone=ap-guangzhou-2
&DBMajorVersion=12
&AutoVoucher=0
&AutoRenewFlag=1
&Charset=UTF8
&AdminName=test2313
&AdminPassword= xxxxxxx
&DBNodeSet.0.Role=Primary
&DBNodeSet.0.Zone=ap-guangzhou-2
&DBNodeSet.1.Role=Standby
&DBNodeSet.1.Zone=ap-guangzhou-3
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "6ace8140-6b9e-4e81-a8ad-ef3f92b2aa90",
    "DealNames": [
      "20180119110001"
    ],
    "DBInstanceIdSet": [
      "postgres-xxxxx"
    ],
    "BillId": "123"
  }
}

Example3 Creating a PostgreSQL instance running a specific version of kernel

This example shows you how to create a PostgreSQL instance running kernel v12.4_r1.0.

Input Example

https://postgres.tencentcloudapi.com/?Action=CreateInstances
&SpecCode=cdb.pg.z1.2g
&Storage=10
&InstanceCount=1
&Period=1
&InstanceChargeType=prepaid
&Zone=ap-guangzhou-2
&DBKernelVersion=v12.4_r1.0
&AutoVoucher=0
&AutoRenewFlag=1
&Charset=UTF8
&AdminName=test2313
&AdminPassword= xxxxxxx
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "6ace8140-6b9e-4e81-a8ad-ef3f92b2aa90",
    "DealNames": [
      "20180119110001"
    ],
    "DBInstanceIdSet": [
      "postgres-xxxxx"
    ],
    "BillId": "123"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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.CamAuthFailed CAM authentication failed.
FailedOperation.CamSigAndAuthError Authentication failed. Please try again later. If the problem persists, please contact customer service.
FailedOperation.CdbCgwConnectError Failed to get project information. Please try again later. If the problem persists, please contact customer service.
FailedOperation.CreateBasicNetworkDeniedError Classic network creation is unsupported.
FailedOperation.CreateOrderFailed Failed to create the renewal order.
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.FlowCreateError Failed to create a task. Please try again later. If the problem persists, please contact customer service.
FailedOperation.GetSubnetError Failed to query VPC subnets.
FailedOperation.GetVpcInfoError Failed to query VPC information. Please try again later. If the problem persists, please contact customer service.
FailedOperation.InvalidTradeOperate Billing error. Corresponding purchase/renewal/configuration change operations are not allowed for the current instance.
FailedOperation.PayOrderFailed Failed to make order payment.
FailedOperation.QueryPriceFailed Failed to query the price.
FailedOperation.QuerySpecError Failed to query specifications. Please try again later. If the problem persists, please contact customer service.
FailedOperation.QueryVpcFailed Failed to query VPC.
FailedOperation.QueryVpcFalied Failed to get VPC details.
FailedOperation.ServiceAccessError Failed to access internal service. Please try again later. If the problem persists, please contact customer service.
FailedOperation.StorageMemoryCheckError The memory and storage capacity to which an instance is upgraded should be higher than its original memory and storage capacity.
FailedOperation.TradeCreateError Failed to request the billing platform to create an order.
FailedOperation.TradePayOrdersError Failed to request to pay for the order.
InternalError.CgwError CGW error.
InternalError.CnsError Basic network error.
InternalError.DBError Backend database execution error.
InternalError.DfwError DFW error.
InternalError.FlowError Failed to create the flow.
InternalError.SystemError System error. When this error occurs, please contact customer service for assistance.
InternalError.UnknownError Unknown error. When this error occurs, please contact customer service for assistance.
InternalError.VpcError VPC error.
InvalidParameter Parameter error.
InvalidParameter.ParameterCheckError Failed to check the parameter.
InvalidParameter.TradeAccessDeniedError Incorrect PID
InvalidParameter.VpcNotFoundError Failed to query VPC information.
InvalidParameterValue.AccountExist The current account already exists.
InvalidParameterValue.BadSpec The instance specification to upgrade to is not purchasable.
InvalidParameterValue.CharsetNotFoundError Incorrect database character set
InvalidParameterValue.DataConvertError Failed to convert data format. Please contact customer service.
InvalidParameterValue.IllegalInstanceChargeType Incorrect billing mode.
InvalidParameterValue.IllegalProjectId Invalid ProjectId.
InvalidParameterValue.IllegalRegion Invalid Region parameter.
InvalidParameterValue.IllegalZone Invalid Zone parameter.
InvalidParameterValue.InterfaceNameNotFound Incorrect ACTION.
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.InvalidAccountFormat Incorrect account format.
InvalidParameterValue.InvalidAccountName The current account name cannot be a reserved character.
InvalidParameterValue.InvalidCharset Incorrect database character set. Currently, only UTF8 and LATIN1 are supported.
InvalidParameterValue.InvalidInstanceNum The number of purchased instances exceeds the limit.
InvalidParameterValue.InvalidOrderNum Billing error. Invalid order type ID.
InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
InvalidParameterValue.InvalidPasswordFormat Incorrect password format.
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 (()`~!@#$%^&*-+=_|{}[]:;'<>,.?/), and cannot start with a slash (/).
InvalidParameterValue.InvalidPid Incorrect PID parameter.
InvalidParameterValue.InvalidZoneIdError Invalid availability zone.
InvalidParameterValue.ParameterCharacterError Invalid parameter. The parameter can contain only letters, digits, underscores, and hyphens.
InvalidParameterValue.ParameterHandleError Failed to process the parameter. Please check if the parameter value is valid.
InvalidParameterValue.ParameterLengthLimitError The length of parameter exceeds the limit.
InvalidParameterValue.ParameterOutRangeError Invalid parameter values.
InvalidParameterValue.RegionNotSupported The current region is not supported.
InvalidParameterValue.SpecNotRecognizedError Failed to identify the specification ({{1}}).
InvalidParameterValue.StructParseFailed An error occurred while parsing parameters.
InvalidPid Incorrect PID parameter.
OperationDenied.CamDeniedError This operation cannot be performed.
OperationDenied.InstanceStatusLimitOpError This operation cannot be performed on an instance in this status.
OperationDenied.UserNotAuthenticatedError You need to verify your identity to make a purchase.
OperationDenied.VpcDeniedError You do not have the permission to operate the VPC.
ResourceInsufficient.ResourceNotEnough There are not enough resources to purchase instances of this specification in the current region.
ResourceUnavailable.InvalidInstanceStatus Incorrect instance status.
ResourceUnavailable.ResourceNoPermission No permission for the VPC.
ResourceUnavailable.VpcResourceNotFound Failed to get the information of the VPC where the instance resides.
UnauthorizedOperation.UserHasNoRealnameAuthentication Unverified user.
UnknownError Unknown error. When this error occurs, please contact customer service for assistance.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support