设置TiDB服务实例参数 - SetTiDBConfig
简介
设置TiDB服务实例参数
定义
公共参数
| 参数名 | 类型 | 描述信息 | 必填 |
|---|---|---|---|
| Action | string | 对应的 API 指令名称，当前 API 为 SetTiDBConfig | Yes |
| PublicKey | string | 用户公钥，可从 控制台 获取 | Yes |
| Signature | string | 根据公钥及 API 指令生成的用户签名，参见 签名算法 | Yes |
请求参数
| 参数名 | 类型 | 描述信息 | 必填 |
|---|---|---|---|
| Region | string | 地域。 参见 地域和可用区列表 | Yes |
| ProjectId | string | 项目ID。不填写为默认项目，子帐号必须填写。 请参考GetProjectList接口 | No |
| Id | string | 资源Id | Yes |
| Configs.N.Name | string | 修改的参数名: proxysql_mysql-max_connections:类型：string, 描述: 所有用户总共的最大连接数 。 proxysql_max_connections: 类型：string, 描述: 每个用户的最大连接数。 tidb_gc: 类型：string, 描述: tikv_gc_life_time。 | Yes |
| Configs.N.Value | string | 对应修改的参数值: string | Yes |
响应字段
| 字段名 | 类型 | 描述信息 | 必填 |
|---|---|---|---|
| RetCode | int | 返回状态码，为 0 则为成功返回，非 0 为失败 | Yes |
| Action | string | 操作指令名称 | Yes |
| Message | string | 返回错误消息，当 RetCode 非 0 时提供详细的描述信息 | No |
| ServiceId | string | ServiceId | No |
示例
请求示例
https://api.an-link.com/?Action=SetTiDBConfig
&Region=cn-zj
&ProjectId=WnXXJMCv
&Id=JSYqhWJH
&Configs.N.Name=Ybdhjbyj
&Configs.N.Value=wYTrwYvk响应示例
{
"Action": "SetTiDBConfigResponse",
"RetCode": 0,
"ServiceId": "IVSXmDir"
}