tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

CreateDBInstances

最后更新时间：2024-06-17 14:26:29

    1. API Description

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

    This API is used to create (but not initialize) one or more TencentDB for PostgreSQL instances. This API is disused and replaced by the CreateInstances API.

    A maximum of 100 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: CreateDBInstances.
    Version Yes String Common Params. The value used for this API: 2017-03-12.
    Region No String Common Params. This parameter is not required for this API.
    SpecCode Yes String Purchasable specification ID, which can be obtained through the SpecCode field in the returned value of the DescribeClasses API.
    Storage Yes Integer Instance capacity size in GB.
    InstanceCount Yes Integer Number of instances purchased at a time. Value range: 1-100.
    Period Yes Integer Length of purchase in months. Currently, only 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, and 36 are supported.
    Zone Yes String AZ ID, which can be obtained through the Zone field in the returned value of the DescribeZones API.
    ProjectId No Integer Project ID.
    DBVersion No String PostgreSQL community major version + minor version number.
    It's generally not recommended to pass in this parameter. If needed, only the latest minor version number under the current major version can be passed.
    InstanceChargeType No String Instance billing type.
    AutoVoucher No Integer Whether to automatically use vouchers. 1: yes, 0: no. Default value: no.
    VoucherIds.N No Array of String Voucher ID list (only one voucher can be specified currently).
    VpcId No String VPC ID.
    SubnetId No String VPC subnet ID.
    AutoRenewFlag No Integer Renewal flag. 0: normal renewal (default), 1: auto-renewal.
    ActivityId No Integer Activity ID
    Name No String Instance name (which will be supported in the future)
    NeedSupportIpv6 No Integer Whether to support IPv6 address access. Valid values: 1 (yes), 0 (no)
    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 ID
    DBMajorVersion No String The major version number of PostgreSQL (this parameter is currently required), and the version information can be obtained from DescribeDBVersions. Currently major versions 10, 11, 12, 13, 14, and 15 are supported. For details, see Kernel Version Overview.
    When this parameter is entered, an instance running the latest kernel version of the latest minor version will be created based on this major version number.
    DBKernelVersion No String PostgreSQL kernel version number.
    It's generally not recommended to pass in this parameter. If needed, only the latest kernel version number under the current major version can be passed.

    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 billing mode is postpaid.
    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.

    4. Example

    Example1 Creating a TencentDB for PostgreSQL instance

    u200cu200cu200cThis example shows you how to purchase an instance.

    Input Example

    POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDBInstances
<Common request parameters>

{
    "InstanceCount": "1",
    "AutoRenewFlag": "1",
    "Zone": "ap-guangzhou-5",
    "DBVersion": "12.4",
    "Storage": "10",
    "Period": "1",
    "SpecCode": "cdb.pg.z1.2g",
    "InstanceChargeType": "prepaid",
    "AutoVoucher": "0"
}

    Output Example

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

    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.AllocateQuotasError Failed to request a quota for resource tags.
    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.DatabaseAffectedError Data operation failed. 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.InternalHttpServerError An exception occurred while executing the request.
    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.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.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.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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款