文档首页/云数据库 GaussDB/API参考/API（推荐）/实例管理/查询扩容优化参数设置模板 - QueryingtheParameterSettingTemplateforScale-outOptimization
更新时间：2025-11-13 GMT+08:00
查看PDF
分享

查询扩容优化参数设置模板 - QueryingtheParameterSettingTemplateforScale-outOptimization

功能介绍

查询扩容优化参数设置模板。

调试

您可以在API Explorer中调试该接口。

URI

GET /v3/{project_id}/expansion-parameters

表1 参数说明

名称

参数类型

是否必选

说明

project_id

String

是

参数解释：

租户在某一Region下的项目ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

语言。

约束限制：

不涉及。

取值范围：

  • zh-cn
  • en-us

默认取值：

en-us

响应参数

表3 参数说明

名称

参数类型

说明

expansion_parameters

Array of objects

参数解释：

参数信息。

详情请参见表3参数信息。

表4 参数信息

名称

参数类型

说明

name

String

参数解释：

参数名称。

取值范围：

不涉及。

value

String

参数解释：

参数值。

取值范围：

不涉及。

restart_required

Boolean

参数解释：

修改参数是否需要重启。

取值范围：

  • true：需要重启。
  • false：不需要重启。

value_range

String

参数解释：

参数取值范围。

取值范围：

不涉及。

type

String

参数解释：

参数类型。

取值范围：

  • integer：整数。
  • boolean：布尔类型。
  • string：字符串。

description

String

参数解释：

参数描述。

取值范围：

不涉及。

请求示例

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/expansion-parameters

响应示例

{
  "expansion_parameters": [
    {
      "name": "lockwait_timeout",
      "value": "",
      "restart_required": false,
      "value_range": "1-1200000",
      "type": "integer",
      "description": "重分布session级别锁超时时间，单位毫秒"
    }
  ]
}

状态码

错误码

请参见错误码。

父主题：实例管理