tencent cloud



Last updated: 2023-09-05 09:56:34

1. API Description

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

This API is used to u200dupgrade a dedicated TDSQL cluster 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: UpgradeDedicatedDCDBInstance.
Version Yes String Common Params. The value used for this API: 2018-04-11.
Region No String Common Params. This parameter is not required for this API.
UpgradeType Yes String Upgrade type. Valid values: ADD (add a shard), SPLIT (split a shard), and EXPAND (Vertically expand a shard).
InstanceId Yes String Instance ID, such as dcdbt-mlfjm74h.
AddShardConfig No AddShardConfig A parameter for adding shards when UpgradeType is ADD.
ExpandShardConfig No ExpandShardConfig A parameter for vertically expand a shard when UpgradeType is EXPAND.
SplitShardConfig No SplitShardConfig A parameter for splitting a shard when UpgradeType is SPLIT.
SwitchAutoRetry No Integer Whether to automatically retry u200donce when missing the switch time window. Valid values: 0 (No), 1 (Yes).
SwitchStartTime No String Switch u200dstart u200dtime
SwitchEndTime No String Switch end time

3. Output Parameters

Parameter Name Type Description
FlowId Integer Async task flow ID
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Upgrading a dedicated TDSQL cluster instance

This example shows you how to upgrade a dedicated TDSQL cluster instance.

Input Example

Host: dcdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpgradeDedicatedDCDBInstance
<Common request parameters>

    "UpgradeType": "EXPAND",
    "InstanceId": "tdsqlshard-jv8z8fhl",
    "ExpandShardConfig": {
        "ShardInstanceIds": [
        "ShardMemory": 2,
        "ShardStorage": 20

Output Example

    "Response": {
        "RequestId": "14f6980a-7fe1-11ea-b896-525400542aa6",
        "FlowId": 1122

5. Developer Resources


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
InternalError.FenceError Failed to query the information of a dedicated cluster.
InvalidParameter Parameter error.
InvalidParameter.InstanceNotFound Failed to find the requested instance.
InvalidParameterValue.IllegalExclusterID The dedicated cluster to which the database instance belongs was not found.
ResourceUnavailable.ExclusterStatusAbnormal Abnormal dedicated cluster status
ResourceUnavailable.InstanceStatusAbnormal Incorrect database instance status. Operations are not allowed.
UnauthorizedOperation.PermissionDenied You have no permission to manipulate this API or resource.
UnsupportedOperation.InvalidOperation Unsupported operation.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support