Skip to Content
Distributed NewSQL Database(TiDB)ModifyTiDBClusterUhostDisk

scale tidb cluster node disk - ModifyTiDBClusterUhostDisk

Overview

scale tidb cluster node disk

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is ModifyTiDBClusterUhostDisk.Yes
PublicKeystringThe user’s public key can be obtained from Console Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See Region and Zone ListYes
IdstringTiDB service idYes
ScaleTypestringScaling type. Enum values: SCALEOUT — scale out ; SCALEIN — scale in.Yes
NodeConfig.ServerTypestringnode server typeYes
NodeConfig.DiskSizeintnode disk sizeYes
StartTimeintStartTimeNo

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
ServiceIdstringTiDB service idYes

Example

Request Example

https://api.ucloud-global.com/?Action=ModifyTiDBClusterUhostDisk &Region=cn-zj &Id=pIFlYobP &ScaleType=OxKZKKVR &NodeConfig.ServerType=nzOvTpzB &NodeConfig.DiskSize=1 &StartTime=5

Response Example

{ "Action": "ModifyTiDBClusterUhostDiskResponse", "RetCode": 0, "ServiceId": "TNbkUIEc" }