ModifyParameterGroup--缓存数据库 Redis 版-火山引擎

文档中心

立即注册

导航

ModifyParameterGroup

最近更新时间：2025.02.14 11:14:44首次发布时间：2025.02.14 11:14:44

调用 ModifyParameterGroup 接口修改参数模板信息（例如参数模板名称、描述、模板中的参数值等）。

请求类型

同步请求。

请求参数

参数	类型	是否必选	示例值	描述
ParameterGroupId	String	是	pg-cnlfm5yzmxehmkw****	参数模板 ID。说明您可以调用 DescribeParameterGroups 接口查询当前账号和地域下所有的参数模板基本信息，包括参数模板 ID。仅自定义参数模板（即 `Source` 取值为 `User`）支持编辑，系统参数模板（即 `Source` 取值为 `System`）不可编辑。更多详情，请参见编辑参数模板。
Name	String	是	test_temp	参数模板名称。说明若不设置该参数，默认使用参数模板的原名称。若需修改参数模板名称，直接输入新的参数模板名称即可。名称需同时满足如下要求：不能以数字、中划线（-）开头。只能包含中文、字母、数字、下划线（_）和中划线（-）。长度需为 2~64 个字符。
Description	String	否	test template	参数模板的备注信息，长度不可超过 200 个字符。说明若不设置该参数，表示不修改参数模板的备注信息。若传入空字符串（即 `"Description":""`），表示清空参数模板的备注信息。
ParamValues	Object[]	是		修改后的参数模板中需要包含的参数信息列表。说明每个参数模板中需至少存在一个参数。更多关于 Redis 支持的参数详情，请参见参数支持。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

示例

请求示例

POST https://redis.volcengineapi.com/?Action=ModifyParameterGroup&Version=2020-12-07 HTTP/1.1
Host: redis.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "ParameterGroupId": "pg-cnlfm5yzmxehmkw****",
    "Name": "test_temp",
    "Description": "test template",
    "ParamValues": [
        {
            "Name": "maxmemory-policy",
            "Value": "allkeys-lru"
        }
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023060411042010023228002****",
        "Action": "ModifyParameterGroup",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": null
}

错误码

更多详情，请参见错误码。