分布式数据库 TiDB

describeParameters

产品文档

分布式数据库 TiDB

帮助中心 > 分布式数据库 TiDB > describeParameters
搜本产品

2024-06-03 06:08:51

describeParameters

描述

查看TiDB实例的主要配置参数。

请求方式

GET

请求地址

https://tidb.jdcloud-api.com/v1/regions/{regionId}/instances/{instanceId}/parameters

名称 类型 是否必需 默认值 描述
regionId String True 地域代码
instanceId String True 实例ID

请求参数

无

返回参数

名称 类型 描述
result Result

Result

名称 类型 描述
parameters DescribeParam[ ]

DescribeParam

名称 类型 描述
name String 参数名称
description String 参数的描述
nodeType String 参数的节点类型，包括TiKV,TiDB,PD,TiFlash
defaultValue String 参数的默认数值
currentValue String 参数的当前值
needRestart Boolean 参数修改是否需要重启生效，大小写敏感 -true:参数需要重启才能生效 -false:参数无需重启生效

返回码

返回码 描述
200 OK
文档反馈

开始与售前顾问沟通

可直接拨打电话 400-098-8505转1

我们的产品专家为您找到最合适的产品/解决⽅案

在线咨询 5*8⼩时

1v1线上咨询获取售前专业咨询

点击咨询
企微服务助手

专业产品顾问，随时随地沟通