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

文档中心

立即注册

缓存数据库 Redis 版

性能分析

CreateKeyScanJob

调用 CreateKeyScanJob 接口为目标 Redis 实例创建过期 key 扫描任务。

请求类型

异步请求。

注意事项

调用 CreateKeyScanJob 接口后，系统会自动执行一次 SCAN 命令来扫描所有数据，此时实例的 CPU 负载会上升，可能会对实例性能产生影响，建议您在业务低峰期执行该任务。更多详情，请参见过期 key 管理。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	redis-cnlfkmh6uiii8****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。
ScanKeyNumPerSecond	Integer	是	2000	每秒扫描过期 key 数量。取值范围：2000~100000 内的整数。
TimeoutMinutes	Integer	是	30	扫描超时时间。取值范围：30~1440 内的整数，单位：分钟。

返回参数

参数	类型	示例值	描述
JobId	String	scan-sy01rcrwdhcwqg6gaq3g46r****	扫描任务的任务 ID。

示例

请求示例

POST https://redis.cn-beijing.volcengineapi.com/?Action=CreateKeyScanJob&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-cnlfkmh6uiii8****",
    "ScanKeyNumPerSecond": 2000,
    "TimeoutMinutes": 30
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420100232280022D31****",
        "Action": "CreateKeyScanJob",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": {
        "JobId": "scan-sy01rcrwdhcwqg6gaq3g46r****"
    }
}

错误码

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

最近更新时间：2025.12.11 10:38:57

这个页面对您有帮助吗？

有用

无用