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.
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 |
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. |
This example shows you how to upgrade a dedicated TDSQL cluster instance.
POST / HTTP/1.1
Host: dcdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpgradeDedicatedDCDBInstance
<Common request parameters>
{
"UpgradeType": "EXPAND",
"InstanceId": "tdsqlshard-jv8z8fhl",
"ExpandShardConfig": {
"ShardInstanceIds": [
"shard-xxx1",
"shard-xxx2"
],
"ShardMemory": 2,
"ShardStorage": 20
}
}
{
"Response": {
"RequestId": "14f6980a-7fe1-11ea-b896-525400542aa6",
"FlowId": 1122
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
Was this page helpful?