tencent cloud

APIs

文档APIsTencentDB for PostgreSQLRead-Only Instance APIsCreateReadOnlyDBInstance

CreateReadOnlyDBInstance

Download
聚焦模式
字号
最后更新时间： 2026-05-11 20:29:37

1. API Description

Domain name for API request: postgres.intl.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 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.
Zone Yes String

Primary availability zone of the instance, such as: ap-guangzhou-3.
The availability zone can be obtained from the returned Zone field of the DescribeZones API.
MasterDBInstanceId Yes String

Primary instance ID of the read-only instance, which can be obtained through the DescribeDBInstances API.
SpecCode Yes String

Purchasable specification code. The value of this parameter can be obtained from the returned SpecCode field of the DescribeClasses API.
Storage Yes Integer

Instance disk capacity, in GB. The value for this parameter must be set in increments of 10.
InstanceCount Yes Integer

Number of instances to purchase. Value range: [1-6]. The maximum allowed number is 6.
Period Yes Integer

Purchase duration, in months.

  • Prepaid: supports 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, and 36.
  • Postpaid: supports only 1.
    		•
    VpcId No String

    VPC ID, such as vpc-xxxxxxxx (this parameter is required). A valid VPC ID can be queried by logging in to the console. You can also call the DescribeVpcEx API to obtain it from the unVpcId field in the return value.
    SubnetId No String

    VPC subnet ID, such as subnet-xxxxxxxx (this parameter is required). A valid VPC subnet ID can be queried by logging in to the console. You can also call the DescribeSubnets API and obtain it from the unSubnetId field in the return value.
    InstanceChargeType No String

    Instance billing type. Valid values:

  • PREPAID: prepaid (yearly/monthly subscription).
  • POSTPAID_BY_HOUR: postpaid (pay-as-you-go).
    • Default value: PREPAID. If the primary instance is postpaid, the read-only instance must also be postpaid.
    AutoVoucher No Integer

    Indicates whether to use vouchers automatically:

  • 0: No.
  • 1: Yes.
    • Default value: 0.
    VoucherIds.N No Array of String

    Voucher ID list. Only one voucher can be specified.
    AutoRenewFlag No Integer

    Renewal flag:

  • 0: manual renewal.
  • 1: auto-renewal.
    • Default value: 0.
    ProjectId No Integer

    Project ID. The default value is 0, which means it belongs to the default project.
    ActivityId No Integer

    Discount offer ID.
    ReadOnlyGroupId No String

    Read-only group ID.
    TagList No Tag

    Tags to be bound to the instance. This is empty by default. Tags can be obtained from the returned Tags field of the DescribeTags API.
    SecurityGroupIds.N No Array of String

    Security group to which the instance belongs. The value of this parameter can be obtained from the returned sgId field of the DescribeSecurityGroups API. If this parameter is not specified, the default security group is bound.
    NeedSupportIpv6 No Integer

    Indicates whether to support IPv6:

  • 0: No.
  • 1: Yes.
    • Default value: 0.
    Name No String

    Instance name. The name can contain only Chinese characters, letters, digits, underscores ("_"), and hyphens ("-"), with a length of less than 60.
    DedicatedClusterId No String

    Dedicated cluster ID.
    DeletionProtection No Boolean

    Indicates whether to enable deletion protection for the instance: true - enables deletion protection. false - disables deletion protection.

    3. Output Parameters

    Parameter Name Type Description
    DealNames Array of String

    Order number list. Each instance corresponds to an order number.
    BillId String

    Frozen bill ID.
    DBInstanceIdSet Array of String

    ID set of successfully created instances. The return value is available only in postpaid scenarios.
    BillingParameters String

    The output parameter has a value only when the input parameter BillingParameters has a value. The value is the parameters for product order placement.
    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 Read-Only Instance

    This example shows you how to create a read-only instance, specify postgres-abcdef as the primary instance, and trigger the creation process.

    Input Example

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

{
    "DBVersion": "12.22",
    "InstanceChargeType": "POSTPAID_BY_HOUR",
    "InstanceCount": 1,
    "MasterDBInstanceId": "postgres-abcdef",
    "Period": 1,
    "ProjectId": 1,
    "ReadOnlyGroupId": "",
    "SecurityGroupIds": [
        "sg-iwnfp51z"
    ],
    "SpecCode": "pg.it.small2",
    "Storage": 100,
    "SubnetId": "subnet-1i9huswn",
    "VpcId": "vpc-8btfafeo",
    "Zone": "ap-beijing-4"
}

    Output Example

    {
    "Response": {
        "BillId": "2701077795",
        "DBInstanceIdSet": [],
        "DealNames": [
            "20251009929109544409421"
        ],
        "RequestId": "f3b13348-be76-4631-8d2f-0c8da1e07958"
    }
}

    Example2 Creating a Read-Only Instance Using Verification Mode

    This example shows you how to create a read-only instance, specify postgres-abcdef as the primary instance, and perform verification only without triggering the creation process.

    Input Example

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

{
    "DBVersion": "12.22",
    "InstanceChargeType": "POSTPAID_BY_HOUR",
    "InstanceCount": 1,
    "MasterDBInstanceId": "postgres-abcdef",
    "Period": 1,
    "ProjectId": 1,
    "ReadOnlyGroupId": "",
    "SecurityGroupIds": [
        "sg-iwnfp51z"
    ],
    "SpecCode": "pg.it.small2",
    "Storage": 100,
    "SubnetId": "subnet-1i9huswn",
    "VpcId": "vpc-8btfafeo",
    "Zone": "ap-beijing-4"
}

    Output Example

    {
    "Response": {
        "BillId": "",
        "DBInstanceIdSet": [],
        "DealNames": [],
        "RequestId": "e0726ee5-3f5f-414c-9976-17e94dd0023e"
    }
}

    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.JsonParseError Json data parsing failed. contact our customer service for assistance.
    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.InsufficientBalanceError Insufficient account balance.
    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.TradePermissionError No payment permission. activation failed.
    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.
    上一篇: ModifyDBInstanceDeletionProtection下一篇: CreateReadOnlyGroup

    帮助和支持

    本页内容是否解决了您的问题？

    填写满意度调查问卷，共创更好文档体验。

    文档反馈