# 修改指定实例的参数 - ModifyingParametersofaSpecifiedDBInstance #### 功能介绍 修改指定实例的参数模板参数。 - 调用接口前，您需要了解API [认证鉴权](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_011.html)。 - 调用接口前，您需要提前获取到[地区和终端节点](https://developer.huaweicloud.com/endpoint)。 #### 接口约束 修改的参数必须在指定数据库版本的默认参数范围内，具体可配置范围请参见《GaussDB用户指南》中"查看和修改实例参数"的内容。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforopenGauss&api=UpdateInstanceConfiguration)中调试该接口。 #### URI PUT /v3/{project_id}/instances/{instance_id}/configurations 表1参数说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_196.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释：** 实例ID，此参数是用户创建实例的唯一标识。请参考[查询数据库实例列表 - QueryingDBInstances](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_328.html)接口获取实例ID。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为36个字符。 **默认取值** **：** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | X-Language | 否 | String | **参数解释：** 指定接口返回信息的语言类型。 **约束限制：** 不涉及。 **取值范围：** - **zh-cn**：中文 - **en-us**：英文 **默认取值** **：** **en-us** | 表3参数说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | values | 是 | Map\ | **参数解释：** 参数值对象，用户基于默认参数模板自定义的参数值。 填写示例："failed_login_attempts":"4"，其中"failed_login_attempts"就是需要修改的参数名，"4"就是需要将参数修改的值。 **约束限制：** 不涉及。 | #### 响应参数 表4参数说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | restart_required | Boolean | **参数解释：** 实例是否需要重启。 **取值范围：** - true：需要重启。 - false：不需要重启。 | | job_id | String | **参数解释：** 修改指定实例参数的任务ID。 **取值范围：** 不涉及。 | #### 请求示例 - 修改实例的参数failed_login_attempts的值为4。不需要重启。 ``` PUT https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dd93e98e103b4fc4b5a978a6bd6f03a9in14/configurations { "values": { "failed_login_attempts": "4" } } ``` - 修改实例的参数track_activity_query_size的值为2048，修改参数max_replication_slots的值为25。需要重启。 ``` PUT https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dd93e98e103b4fc4b5a978a6bd6f03a9in14/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" } ``` #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。