1. API Description
Domain name for API request: postgres.intl.tencentcloudapi.com.
This API is used to switch the instance billing mode from pay-as-you-go to yearly/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.
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 |
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. |
| DBInstanceId |
Yes |
String |
Specifies the instance ID, such as postgres-6fego161. obtain through the api DescribeDBInstances. |
| InstanceChargeType |
Yes |
String |
Instance billing type, which currently supports:. PREPAID: prepaid, i.e., yearly/monthly subscription. POSTPAID_BY_HOUR: pay-as-you-go, i.e., pay by consumption.. Default value: PREPAID |
| Period |
Yes |
Integer |
Purchase duration, in months. Prepaid: supports 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, and 36.. Pay-as-you-go: Only supports 1. |
| AutoRenewFlag |
No |
Integer |
Specifies the auto-renewal flag.
0: manual renewal..
1: auto-renewal. Default value: 0 |
| AutoVoucher |
No |
Integer |
Specifies whether to automatically use a voucher. 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 yearly/monthly subscription for the instance postgres-apzvwncr.
POST / HTTP/1.1Host: postgres.intl.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. |
| OperationDenied.InsufficientBalanceError |
Insufficient account balance. |
| OperationDenied.TradePermissionError |
No payment permission. activation failed. |
| OperationDenied.UserNotAuthenticatedError |
You need to verify your identity to make a purchase. |