查询缓存分析任务列表的API接口_数据库自治服务(DAS)-阿里云帮助中心

调用DescribeCacheAnalysisJobs接口，查询缓存分析任务列表。

接口说明

使用该接口需满足以下前提条件：

使用阿里云或 DAS 的 SDK 时，建议使用最新版本。
使用 SDK 调用 DAS 服务时，需要将地域指定为 cn-shanghai。
本接口只适用于 Redis 引擎。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	r-bp18ff4a195d****
StartTime	string	是	查询任务开始时间，格式为 Unix 时间戳，单位为毫秒。	1596177993000
EndTime	string	是	查询任务结束时间，格式为 Unix 时间戳，单位为毫秒。说明查询任务结束时间需晚于查询任务开始时间。	1596177993001
PageNo	string	否	页码，取值大于 0 且不超过 Integer 数据类型的最大值，默认值为 1。	1
PageSize	string	否	每页最大记录数，默认值为 10。	10

返回参数

名称	类型	描述	示例值
	object
Code	string	返回的状态码。	200
Data	object	信息列表。
Extra	string	备用参数。	None
List	array<object>	信息详情。
CacheAnalysisJob	object
BigKeys	array<object>	大 Key 详细信息。说明当前已不再返回该参数的子参数及其内容，请调用 DescribeCacheAnalysisJob 接口查询缓存分析任务的详细信息。
KeyInfo	object
Bytes	long	Key 占用字节数。	12345
Count	long	Key 的元素个数。	127
Db	integer	数据库名称。	0
Encoding	string	Key 内部数据类型。	hashtable
ExpirationTimeMillis	long	Key 过期时间，单位：毫秒（ms），0 表示不过期。	1596256542547
Key	string	Key 的名称。	task_*****
NodeId	string	实例的数据节点 ID。	r-****-db-0
Type	string	Redis 数据结构类型。	hash
InstanceId	string	实例 ID。	r-bp18ff4a195d****
JobId	string	缓存分析任务 ID。	sf79-sd99-sa37-****
Message	string	请求返回消息。说明请求成功时该参数返回 Successful，请求失败时会返回请求异常信息（如错误码等）。	Successful
NodeId	string	实例的数据节点 ID。	r-x****-db-0
TaskState	string	缓存分析任务的状态： BACKUP：备份中。 ANALYZING：分析中。 FINISHED：分析完成。 FAILED：出现错误。	BACKUP
PageNo	long	页码，取值大于 0 且不超过 Integer 数据类型的最大值，默认值为 1。	1
PageSize	long	每页最大记录数，默认值为 10。	10
Total	long	结果数量。	4
Message	string	请求返回消息。说明请求成功时该参数返回 Successful，请求失败时会返回请求异常信息（如错误码等）。	Successful
RequestId	string	请求 ID。	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	请求是否执行成功： true：执行成功。 false：执行失败。	true

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Data": {
    "Extra": "None",
    "List": {
      "CacheAnalysisJob": [
        {
          "BigKeys": {
            "KeyInfo": [
              {
                "Bytes": 12345,
                "Count": 127,
                "Db": 0,
                "Encoding": "hashtable",
                "ExpirationTimeMillis": 1596256542547,
                "Key": "task_*****",
                "NodeId": "r-****-db-0",
                "Type": "hash"
              }
            ]
          },
          "InstanceId": "r-bp18ff4a195d****",
          "JobId": "sf79-sd99-sa37-****",
          "Message": "Successful",
          "NodeId": "r-x****-db-0",
          "TaskState": "BACKUP"
        }
      ]
    },
    "PageNo": 1,
    "PageSize": 10,
    "Total": 4
  },
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true"
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParams	The request parameters are invalid.	请求参数错误
403	NoPermission	You are not authorized to do this action.	没有权限执行该操作

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史