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

修改指定实例的参数

功能介绍

修改指定实例的参数。

接口约束

该接口支持如下数据库实例：
  • GeminiDB Cassandra
  • GeminiDB Mongo
  • GeminiDB Influx经典部署模式实例
  • GeminiDB Redis经典部署模式实例

values只能传入系统定义的，可修改的参数，其他情况则忽略不处理。

该接口为异步接口，接口响应成功不代表修改参数完成。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

PUT /v3.1/{project_id}/instances/{instance_id}/configurations

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一region下的project ID。获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

参数模板ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

values

是

Map<String,String>

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

为空时不修改参数值。

响应参数

状态码： 202

表4 响应Body参数

参数

参数类型

描述

job_id

String

参数解释：

修改实例参数的异步任务ID。

取值范围：

不涉及。

restart_required

Boolean

参数解释：

实例是否需要重启。

取值范围：

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

请求示例

  • URI样例 
    PUT https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3.1/054e292c9880d4992f02c0196d3ea468/instances/392850e624504e1490901d50b585a60din06/configurations
  • 修改指定实例的参数 
    {
  "values" : {
    "request_timeout_in_ms" : "10000"
  }
}

响应示例

状态码： 202

Success

{
  "job_id" : "463b4b58-d0e8-4e2b-9560-5dea4552fde9",
  "restart_required" : false
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 参数配置

相关文档