You need to enable JavaScript to run this app.
Cache for Redis

Cache for Redis

  • Documentation
    • Cache for RedisDevelopment reference (Control plane)API referencePerformance analysisInterruptKeyScanJob
Copy page
Download PDF
Performance analysis
InterruptKeyScanJob
Copy page
Download PDF
InterruptKeyScanJob

Call the InterruptKeyScanJob API to cancel specified expired key clear task.

Request type

Synchronous request.

Precautions

The status of the task to be cancelled must be Created or Running. For more details about task status, refer to Expired key cleanup task status.

Request parameters

Name
Type
Required
Example
Description
JobId
String
Yes
scan-sy01rcrwdhcwqg6gaq3g46r5uxt

Task ID.

tip

You can call the DescribeKeyScanJobs API to query the list of key scanning tasks for the target Redis instance within the specified time period, including task ID information.

Response parameters

The current API has no specified response parameters. For more information, see Response structure.

Sample request 

POST https://redis.cn-beijing.volcengineapi.com/?Action=InterruptKeyScanJob&Version=2020-12-07
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=****
{
    "JobId": "scan-sy01rcrwdhcwqg6gaq3g46r5uxt"
}

Sample response 

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

Error codes

For more information, refer to Error codes.

Last updated: 2025.12.23 11:42:22