tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

UpgradeInstance

最后更新时间：2023-08-23 14:22:59

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 Params. The value used for this API: UpgradeInstance.
Version Yes String Common Params. The value used for this API: 2019-01-07.
Region Yes String Common Params. 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 in GB
UpgradeType Yes String Upgrade type. Valid values: upgradeImmediate, upgradeInMaintain
StorageLimit No Integer This parameter has been disused.
AutoVoucher No Integer Whether to automatically select a voucher. 1: yes; 0: no. Default value: 0
DbType No String This parameter has been disused.
DealMode No Integer Transaction mode. Valid values: 0 (place and pay for an order), 1 (place an order)
UpgradeMode No String Valid values: NormalUpgrade (Normal mode), FastUpgrade (QuickChange). If the system detects that the configuration modification process will cause a momentary disconnection, the process will be terminated.

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

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

{
    "InstanceId": "cynosdbmysql-ins-n7ocdslw",
    "UpgradeType": "upgradeImmediate",
    "Cpu": "2",
    "Memory": "4"
}

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. Try again later. If the problem persists, contact customer service.
FailedOperation.TradeCreateOrderError Failed to create the order and make a payment. Please try again later. If the problem persists, please contact customer service.
InternalError.SystemError Internal system error.
InternalError.UnknownError Unknown internal error.
InvalidParameterValue.DBTypeNotFound Unsupported instance type.
InvalidParameterValue.InstanceNotFound The instance does not exist.
InvalidParameterValue.ParamError Incorrect parameter.
OperationDenied.ClusterOpNotAllowedError The current cluster does not allow the operation.
OperationDenied.InstanceStatusDeniedError For the instance in this status, the operation is not allowed.
ResourceNotFound.ClusterNotFoundError The cluster does not exist.
UnauthorizedOperation.PermissionDenied CAM authentication failed.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
隐私条款服务条款缓存条款