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

文档中心

立即注册

导航

ModifyDBInstanceBanKeys

最近更新时间：2025.06.17 15:43:36首次发布时间：2024.10.24 21:25:27

调用 ModifyDBInstanceBanKeys 接口为目标 Redis 实例设置 Key 封禁。

请求类型

异步请求。

注意事项

Key 封禁功能正处于邀测阶段，如需使用请提交工单联系技术支持。
开启 Key 封禁后，系统需要一些时间（不超过 30s）将修改后的配置下发给 Proxy，被封禁的 Key 才会生效。
开启 Key 封禁后，匹配到的 Key 不支持读写访问，对封禁 Key 进行读写操作时会返回 key qps limit exceed 报错。请详细评估业务情况后谨慎开启。
开启 Key 封禁后，如需再次访问被封禁的 Key ，需手动关闭 Key 封禁功能，否则封禁列表里的 Key 将被永久封禁。更多详情，请参见 Key 封禁。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	redis-cn0212gzmh2x****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。
BanKeysSwitch	Boolean	是	true	是否开启 Key 封禁功能。取值范围如下： `true`：开启。 `false`：关闭。注意开启 Key 封禁后，匹配到的 Key 不支持读写访问，对封禁 Key 进行读写操作时会返回 `key qps limit exceed` 报错。请详细评估业务情况后谨慎开启。开启 Key 封禁后，如需再次访问被封禁的 Key ，需手动关闭 Key 封禁功能，否则封禁列表里的 Key 将被永久封禁。更多详情，请参见 Key 封禁。
Keys	String[]	是	[ "apitest", "doctest" ]	需要封禁的 Key。说明每个实例最多允许封禁 10 个 Key，多个 Key 间用英文逗号（,）分隔。如果传入空字符串（即 `"Keys": [""]`），表示封禁空 Key。单个封禁 Key 的长度不可超过 64 字节。 Key 封禁匹配规则仅支持完全匹配。

返回参数

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

示例

请求示例

POST https://redis.cn-beijing.volcengineapi.com/?Action=ModifyDBInstanceBanKeys&Version=2020-12-07 HTTP/1.1
Host: redis.cn-beijing.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=****
{
    "InstanceId": "redis-cn0212gzmh2x****",
    "BanKeysSwitch": true,
    "Keys": [
        "apitest",
        "doctest"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024101511262075F8D4B87EAAD9C4F58C-01****",
        "Action": "ModifyDBInstanceBanKeys",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": null
}

错误码

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