UpgradeDBInstance

Last updated: 2021-08-11 20:06:46

1. API Description

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

This API is used to upgrade instance configurations.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: postgres.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: UpgradeDBInstance.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
Memory Yes Integer Instance memory size in GB after upgrade
Storage Yes Integer Instance disk size in GB after upgrade
DBInstanceId Yes String Instance ID in the format of postgres-lnp6j617
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)
ActivityId No Integer Activity ID
SwitchTag No Integer Switch time after instance configurations are modified. Valid values: 0 (switch immediately), 1 (switch at specified time). Default value: 0
SwitchStartTime No String The earliest time to start a switch
SwitchEndTime No String The latest time to start a switch

3. Output Parameters

Parameter Name Type Description
DealName String Transaction name.
BillId String Bill ID of frozen fees
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Upgrading an instance

Input Example

https://postgres.tencentcloudapi.com/?Action=UpgradeDBInstance
&DBInstanceId=postgres-6bwgamo3
&Memory=2
&Storage=200
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "08fdf411-5d39-44f2-8e1d-a58ee60b237d",
    "DealName": "201806127634",
    "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.CamSigAndAuthError Authentication failed. Please try again later. If the problem persists, please contact customer service.
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.FailedOperationError Operation failed. Please try again later.
FailedOperation.GetPurchaseRecordFailed Failed to get the purchase record.
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.StorageMemoryCheckError The memory and storage capacity to which an instance is upgraded should be higher than its original memory and storage capacity.
FailedOperation.TradeAccessError Failed to access the billing platform. Please try again later. If the problem persists, please contact customer service.
InternalError.DBError Backend database execution error.
InternalError.SystemError System error. When this error occurs, please contact customer service for assistance.
InvalidParameter Parameter error.
InvalidParameterValue.BadSpec The instance specification to upgrade to is not purchasable.
InvalidParameterValue.IllegalRegion Invalid Region parameter.
InvalidParameterValue.IllegalZone Invalid Zone parameter.
InvalidParameterValue.InstanceNotExist The current instance does not exist.
InvalidParameterValue.InvalidInstanceVolume The instance specification to upgrade to cannot be lower than the current instance specification.
InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
InvalidParameterValue.ParameterHandleError Failed to process the parameter. Please check if the parameter value is valid.
InvalidPid Incorrect PID parameter.
OperationDenied.CamDeniedError This operation cannot be performed.
OperationDenied.InstanceAccessDeniedError You do not have the permission to operate this resource.
OperationDenied.InstanceStatusLimitOpError This operation cannot be performed on an instance in this status.
ResourceNotFound.InstanceNotFoundError The instance does not exist.
ResourceUnavailable.InvalidInstanceStatus Incorrect instance status.