tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
TencentDB for PostgreSQL
    Documentation
    Download PDF

    CreateReadOnlyDBInstance

    Last updated: 2024-06-17 14:25:56
    Download PDF

      1. API Description

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

      This API is used to create read-only replicas.

      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: CreateReadOnlyDBInstance.
      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.
      Zone Yes String Primary AZ of an instance, such as "ap-guangzhou-3".
      The information of AZ can be obtained from the Zone field in the return value of the DescribeZones API.
      MasterDBInstanceId Yes String ID of the primary instance to which the read-only instance belongs
      SpecCode Yes String Purchasable code, which can be obtained from the SpecCode field in the return value of the DescribeClasses API.
      Storage Yes Integer Instance storage capacity in GB
      InstanceCount Yes Integer The number of instances to be purchased at a time. Value range: 1-10. To purchase more than 10 instances each time, you can make multiple calls.
      Period Yes Integer Validity period in months, valid values:
    • Monthly subscription: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.<br/><li>Pay-as-you-go: 1`.
      		•
      VpcId No String VPC ID in the format of vpc-xxxxxxx, which can be obtained in the console or from the unVpcId field in the return value of the DescribeVpcEx API.
      SubnetId No String VPC subnet ID in the format of subnet-xxxxxxxx which can be obtained in the console or from the unSubnetId field in the return value of the DescribeSubnets API.
      InstanceChargeType No String Instance billing mode. Valid values:
    • PREPAID: Monthly subscription
    • POSTPAID_BY_HOUR: Pay-as-you-go
      Default value: PREPAID. If the primary instance is pay-as-you-go, so is the read-only instance.
      		•
      AutoVoucher No Integer Whether to use vouchers automatically. Valid values:
    • 0: No.
    • 1: Yes.
      Default value: 0.
      		•
      VoucherIds.N No Array of String Voucher ID list. Currently, you can specify only one voucher.
      AutoRenewFlag No Integer Auto-renewal flag. Valid values:
    • 0: Manual renewal.
    • 1: Automatic renewal.
      Default value: 0.
      		•
      ProjectId No Integer Project ID
      ActivityId No Integer Special offer ID
      ReadOnlyGroupId No String RO group ID
      TagList No Tag The information of tags to be bound with the instance, which is left empty by default. This parameter can be obtained from the Tags field in the return value of the DescribeTags API.
      SecurityGroupIds.N No Array of String Security group of the instance, which can be obtained from the sgld field in the return value of the DescribeSecurityGroups API. If this parameter is not specified, the default security group will be bound.
      NeedSupportIpv6 No Integer Whether IPv6 is supported.
    • 0: No.
    • 1: Yes.
      Default value: 0.
      		•
      Name No String Instance name (which will be supported in the future)
      DBVersion No String (Disused) You don’t need to specify a version, as the kernel version is as the same as that of the instance.

      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, 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 CreateReadOnlyDBInstance

      This example shows you how to create a read-only instance.

      Input Example

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

{
    "InstanceCount": "1",
    "AutoRenewFlag": "1",
    "Zone": "ap-guangzhou-2",
    "MasterDBInstanceId": "Postgres-testmaster",
    "DBVersion": "9.3.5",
    "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": [
            "123"
        ],
        "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.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.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.PreCheckError Pre-check failed
      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.ROGroupNotFoundError The RO group does not exist.
      FailedOperation.ROGroupNumExceedError The maximum number of RO groups has been reached.
      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.
      FailedOperation.WhitelistConnectError Failed to query the allowlist. Try again later. If the problem persists, contact customer service.
      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.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.RegionNotSupported The current region is not supported.
      InvalidParameterValue.StructParseFailed An error occurred while parsing parameters.
      InvalidPid Incorrect PID parameter.
      OperationDenied.CamDeniedError This operation cannot be performed.
      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.PayModeError Unsupported billing mode
      OperationDenied.ROGroupStatusError This operation cannot be performed on an RO group in this status.
      OperationDenied.RoInstanceCountExeedError The total number of read-only nodes should not exceed the upper limit.
      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.
      ResourceNotFound.InstanceNotFoundError The instance does not exist.
      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.

      Contact Us
      Technical Support

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

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy