Docs
api
Distributed NewSQL Database(TiDB)
SetTiDBConfig

Set TiDB Service Instance Parameters - SetTiDBConfig

Overview

Set TiDB Service Instance Parameters

Definition

Public Parameters

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

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See List of Regions and Availability ZonesYes
ProjectIdstringProject ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.No
IdstringResource IdYes
Configs.N.NamestringModified parameter name: proxysql_mysql-max_connections: Type: string, Description: The maximum number of connections for all users.
proxysql_max_connections: Type: string, Description: The maximum number of connections per user.
tidb_gc: Type: string, Description: tikv_gc_life_time.
Yes
Configs.N.ValuestringParameter value to be modified: stringYes

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
ServiceIdstringServiceIdNo

Example

Request Example

https://api.dezai.com/?Action=SetTiDBConfig
&Region=cn-zj
&ProjectId=WnXXJMCv
&Id=JSYqhWJH
&Configs.N.Name=Ybdhjbyj
&Configs.N.Value=wYTrwYvk

Response Example

{
  "Action": "SetTiDBConfigResponse",
  "RetCode": 0,
  "ServiceId": "IVSXmDir"
}