文档首页/ 云数据库 GeminiDB/ API参考/ API v3（即将下线）/ 参数模板管理/ 修改参数模板参数
更新时间：2024-10-28 GMT+08:00
查看PDF
分享

修改参数模板参数

功能介绍

修改指定参数模板的参数信息，包括名称、描述、指定参数的值。

该接口计划下线，建议及时切换到新接口修改参数模板参数。

接口约束

该接口支持如下数据库实例：
  • GeminiDB Cassandra
  • GeminiDB Mongo
  • GeminiDB Influx

修改参数模板名称“name”不能与默认参数模板或已有参数模板的名称重复。

默认参数模板不允许修改。

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

调试

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

URI

PUT https://{Endpoint}/v3/{project_id}/configurations/{config_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

config_id

是

String

参数模板ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。
表3 请求Body参数

参数

是否必选

参数类型

描述

name

否

String

参数模板名称。最长64个字符，只允许大写字母、小写字母、数字和特殊字符中划线、下划线和点。

description

否

String

参数模板描述。最长256个字符，不支持!<>=&"'特殊字符。默认为空。

values

否

Map<String,String>

参数值对象，用户基于默认参数模板自定义的参数值。为空时不修改参数值。

响应参数

状态码：200

无响应参数。

请求示例

  • URI样例 
    PUT https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/e02e76567ae04662a2753492b77f965bpr06
  • 修改参数模板参数

    请求体参数中，至少有一个非空，否则会下发失败。

    {
  "name" : "configuration_test",
  "description" : "configuration_test",
  "values" : {
    "concurrent_reads" : "64"
  }
}

响应示例

无。

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 参数模板管理

相关文档