首页 数据库自治服务 DAS API参考指南 API目录 缓存分析 DescribeCacheAnalysisJobs - 查询缓存分析任务列表

DescribeCacheAnalysisJobs - 查询缓存分析任务列表

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

接口说明

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

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

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 访问级别 资源类型 条件关键字 关联操作
hdm:DescribeCacheAnalysisJobs List
  • DAS
    acs:hdm:*:{#accountId}:*

请求参数

名称 类型 必填 描述 示例值
InstanceId string

实例ID。

r-bp18ff4a195d****
StartTime string

查询任务开始时间,格式为Unix时间戳,单位为毫秒。

1596177993000
EndTime string

查询任务结束时间,格式为Unix时间戳,单位为毫秒。

说明 查询任务结束时间需晚于查询任务开始时间。
1596177993001
PageNo string

页码,取值大于0且不超过Integer数据类型的最大值,默认值为1。

1
PageSize string

每页最大记录数,默认值为10。

10

返回参数

名称 类型 描述 示例值
object
Message string

请求返回消息。

说明 请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。
Successful
RequestId string

请求ID。

B6D17591-B48B-4D31-9CD6-9B9796B2****
Data object

信息列表。

List array

信息详情。

object
TaskState string

缓存分析任务的状态:

  • BACKUP:备份中。
  • ANALYZING:分析中。
  • FINISHED:分析完成。
  • FAILED:出现错误。
BACKUP
JobId string

缓存分析任务ID。

sf79-sd99-sa37-****
Message string

请求返回消息。

说明 请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。
Successful
BigKeys array

大Key详细信息,根据Key占用字节数降序排列。

object
Type string

Redis数据结构类型。

hash
Db integer

数据库名称。

0
ExpirationTimeMillis long

Key过期时间,单位:毫秒(ms),0表示不过期。

1596256542547
Key string

Key的名称。

task_*****
Encoding string

Key内部数据类型。

hashtable
Bytes long

Key占用字节数。

12345
NodeId string

实例的数据节点ID。

r-****-db-0
Count long

Key的元素个数。

127
InstanceId string

实例ID。

r-bp18ff4a195d****
NodeId string

实例的数据节点ID。

r-x****-db-0
PageNo long

页码,取值大于0且不超过Integer数据类型的最大值,默认值为1。

1
PageSize long

每页最大记录数,默认值为10。

10
Extra string

备用参数。

None
Total long

结果数量。

4
Code string

返回的状态码。

200
Success string

请求是否执行成功:

  • true:执行成功。
  • false:执行失败。
true

示例

正常返回示例

JSON格式

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

XML格式

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

错误码

Http code 错误码 错误信息 描述
400 InvalidParams The request parameters are invalid. 请求参数错误

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

阿里云首页 数据库自治服务 相关技术圈