UpgradeInstance

Last updated: 2021-10-21 10:26:48

1. API Description

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

This API is used to upgrade an instance.

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 parameter. The value used for this API: UpgradeInstance.
Version Yes String Common parameter. The value used for this API: 2019-01-07.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
InstanceId Yes String Instance ID
Cpu Yes Integer Database CPU
Memory Yes Integer Database memory
UpgradeType Yes String Upgrade type. Valid values: upgradeImmediate, upgradeInMaintain
StorageLimit No Integer Storage upper limit. 0 indicates to use the standard configuration
AutoVoucher No Integer Whether to automatically select a voucher. 1: yes; 0: no. Default value: 0
DbType No String Database type. Valid values:
  • MYSQL
  • DealMode No Integer Transaction mode. Valid values: 0 (place and pay for an order), 1 (place an order)

    3. Output Parameters

    Parameter Name Type Description
    TranId String Freezing transaction ID
    Note: this field may return null, indicating that no valid values can be obtained.
    BigDealIds Array of String Big order ID.
    Note: this field may return null, indicating that no valid values can be obtained.
    DealNames Array of String Order ID
    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://cynosdb.tencentcloudapi.com/?Action=UpgradeInstance
    &InstanceId=cynosdbpg-ins-n7ocdslw
    &Cpu=2
    &Memory=4
    &UpgradeType=upgradeImmediate
    &<Common request parameters>
    

    Output Example

    {
      "Response": {
        "BigDealIds": [
          "xx"
        ],
        "RequestId": "165202",
        "TranId": "xx",
        "DealNames": [
          "xx"
        ]
      }
    }
    

    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.CreateOrder Failed to create the order and make a payment.
    FailedOperation.DatabaseAccessError Failed to access the database. Please try again later. If the problem persists, please contact customer service.
    FailedOperation.OperationFailedError Operation failed ({{1}}). Please try again later. If the problem persists, please contact customer service.
    InternalError.SystemError Internal system error.
    InvalidParameterValue.DBTypeNotFound Unsupported instance type.
    InvalidParameterValue.InstanceNotFound The instance does not exist.
    InvalidParameterValue.ParamError Incorrect parameter.
    OperationDenied.ClusterOpNotAllowedError This operation is not allowed for the current cluster. Reason: {{1}}.
    ResourceNotFound.ClusterNotFoundError The cluster ({{1}}) does not exist.
    UnauthorizedOperation.PermissionDenied CAM authentication failed.