修改指定实例的参数
功能介绍
修改指定实例的参数模板参数。
须知:
该接口计划于2025-03-31下线,建议及时切换到新接口修改指定实例的参数。
接口约束
- 修改的参数必须在指定数据库版本的默认参数范围内,具体可配置范围请参见《GaussDB用户指南》中“编辑参数模板”的内容。
URI
PUT https://{
Endpoint
}/gaussdb/v3/{project_id}/instances/{instance_id}/configurations
表1 参数说明
名称
是否必选
说明
project_id
是
参数解释:
租户在某一Region下的项目ID。
获取方法请参见获取项目ID。
约束限制:
不涉及。
取值范围:
只能由英文字母、数字组成,且长度为32个字符。
默认取值:
不涉及。
instance_id
是
实例ID。
请求参数
表2 请求参数
名称
是否必选
参数类型
说明
values
是
Map<String,String>
参数值对象,用户基于默认参数模板自定义的参数值。详情请参见表3。
表3 values字段数据结构说明
名称
是否必选
参数类型
说明
key
是
String
参数名称,以参数名称作为key,例如:对于"failed_login_attempts":"4",key就是"failed_login_attempts"。
value
是
String
参数值,以参数对应的值作为value,例如:对于"failed_login_attempts":"4",value就是"4"。
响应参数
表4 响应参数
名称
参数类型
说明
restart_required
Boolean
实例是否需要重启。
- “true”需要重启。
- “false”不需要重启。
请求示例
https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/opengauss/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/configurations
{
"values": {
"xxx": "10",
"yyy": "OFF"
}
}
响应示例
{
"restart_required": false
}
状态码
-
正常
200
-
异常
请参见状态码。
错误码
请参见错误码。