tencent cloud

All product documents
TencentDB for PostgreSQL
DocumentationTencentDB for PostgreSQLAPI DocumentationInstance APIsModifyDBInstanceChargeType
ModifyDBInstanceChargeType
Download PDF
Last updated: 2024-06-17 14:26:22
ModifyDBInstanceChargeType
Last updated: 2024-06-17 14:26:22
Download PDF

1. API Description

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

This API is used to switch the instance billing mode from pay-as-you-go to monthly subscription.

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: ModifyDBInstanceChargeType.
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.
DBInstanceId Yes String Instance ID in the format of postgres-6fego161
InstanceChargeType Yes String Instance billing mode. Valid values:
  • PREPAID: Monthly subscription.
  • POSTPAID_BY_HOUR: Pay-as-you-go.
    Default value: PREPAID.
    		•
    Period Yes Integer Validity period in months
  • Monthly subscription: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
  • Pay-as-you-go: 1.
    		•
    AutoRenewFlag No Integer Auto-renewal flag. Valid values:
  • 0: Manual renewal.
  • 1: Automatic renewal.
    Default value: 0.
    		•
    AutoVoucher No Integer Whether to use vouchers automatically. Valid values:
  • 0: No.
  • 1: Yes.
    Default value: 0.
    		•

    3. Output Parameters

    Parameter Name Type Description
    DealName String Order name
    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 Modifying the billing mode for the instance postgres-apzvwncr

    This example shows you how to modify the billing mode to monthly subscription for the instance postgres-apzvwncr.

    Input Example

    POST / HTTP/1.1Host: postgres.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: ModifyDBInstanceChargeType<common request parameters>{    "DBInstanceId": "postgres-apzvwncr",    "InstanceChargeType": "PREPAID",    "AutoRenewFlag": 0,    "AutoVoucher": 0,    "Period": 1}

    Output Example

    {    "Response": {        "RequestId": "08fdf411-5d39-44f2-8e1d-a58ee60b237d",        "DealName": 201806181256"    }}

    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
    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.
    InvalidParameter.ParameterCheckError Failed to check the parameter.
    InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
    InvalidParameterValue.ParameterHandleError Failed to process the parameter. Please check if the parameter value is valid.
    OperationDenied.CamDeniedError This operation cannot be performed.
    OperationDenied.InstanceStatusLimitError This operation cannot be performed on an instance in this status.
    Was this page helpful?
    You can also Contact Sales or Submit a Ticket for help.
    Yes
    No

    Feedback

    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
    Hong Kong, China
    +852 800 906 020 (Toll Free)
    United States
    +1 844 606 0804 (Toll Free)
    United Kingdom
    +44 808 196 4551 (Toll Free)
    Canada
    +1 888 605 7930 (Toll Free)
    Australia
    +61 1300 986 386 (Toll Free)
    EdgeOne hotline
    +852 300 80699
    More local hotlines coming soon