文档首页/ 云数据库 GaussDB/ API参考/ API（推荐）/ 参数配置/ 修改指定实例的参数
更新时间：2024-08-20 GMT+08:00
查看PDF
分享

修改指定实例的参数

功能介绍

修改指定实例的参数模板参数。

接口约束

修改的参数必须在指定数据库版本的默认参数范围内，具体可配置范围请参见《GaussDB用户指南》中“查看和修改实例参数”的内容。

URI

PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/configurations

表1 参数说明

名称

是否必选

说明

project_id

是

参数解释：

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

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

instance_id

是

实例ID。

请求参数

表2 参数说明

名称

是否必选

参数类型

说明

values

是

Map<String,String>

参数值对象，用户基于默认参数模板自定义的参数值。

填写示例："failed_login_attempts":"4"，其中"failed_login_attempts"就是需要修改的参数名，"4"就是需要将参数修改的值。

响应参数

表3 参数说明

名称

参数类型

说明

restart_required

Boolean

实例是否需要重启。

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

job_id

String

修改指定实例参数的任务ID。

请求示例

  • 修改实例的参数failed_login_attempts的值为4。不需要重启。 
    PUT https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/configurations
{ 
    "values": { 
        "failed_login_attempts": "4"
    }
}
  • 修改实例的参数track_activity_query_size的值为2048，修改参数max_replication_slots的值为25。需要重启。 
    PUT https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/configurations
{
    "values": {
        "track_activity_query_size": "2048",
        "max_replication_slots": "25"
    }
}

响应示例

  • 修改无需重启的参数成功。 
    {
  "restart_required": false,
  "job_id": "5a08604b-7820-4cf1-9356-b378c4fac694"
}
  • 修改需要重启的参数成功。 
    {
  "restart_required": true,
  "job_id": "e51532df-b94d-4fbc-9cf0-aea030ade45d"
}

状态码

错误码

请参见错误码。

父主题： 参数配置