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

文档中心

立即注册

导航

DescribeKeyScanJobs

最近更新时间：2025.07.15 21:29:14首次发布时间：2025.07.15 21:29:14

调用 DescribeKeyScanJobs 接口查询目标 Redis 实例在指定时间段内的扫描 key 任务列表。

请求类型

同步请求。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	redis-cnlfkmh6uiii8****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。
QueryStartTime	String	是	2025-07-07T13:00:00Z	查询开始时间，格式为 `yyyy-MM-ddTHH:mm:ssZ`（UTC）。说明查询开始时间需早于查询结束时间。
QueryEndTime	String	是	2025-07-07T13:30:00Z	查询结束时间，格式为 `yyyy-MM-ddTHH:mm:ssZ`（UTC）。说明查询结束时间需晚于查询开始时间。
PageSize	Integer	否	10	每页记录数。取值为 1~1000 间的整数，默认值为 10。
PageNumber	Integer	否	1	扫描 key 任务列表的页码。取值为不超过 Integer 数据类型的最大值，起始值与默认值均为 1。

返回参数

参数	类型	示例值	描述
TotalJobsNumber	Integer	1	扫描任务总数。
JobList	Object[]		扫描任务信息列表。

示例

请求示例

POST https://redis.cn-beijing.volcengineapi.com/?Action=DescribeKeyScanJobs&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****",
    "QueryStartTime": "2025-07-07T13:00:00Z",
    "QueryEndTime": "2025-07-07T13:30:00Z",
    "PageSize": 10,
    "PageNumber": 1
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420100232280022D31****",
        "Action": "DescribeKeyScanJobs",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": {
        "JobList": [
            {
                "CompletedCount": 10,
                "CreateTime": "2025-07-07T13:15:13Z",
                "FinishTime": "2025-07-07T13:15:21Z",
                "JobId": "scan-sy01rcrwdhcwqg6gaq3g46r5uxt",
                "StartTime": "2025-07-07T13:15:13Z",
                "Status": "Finished",
                "TotalCount": 10
            }
        ],
        "TotalJobsNumber": 1
    }
}

错误码

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