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

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

  • 本接口只适用于Redis引擎。
  • 在使用阿里云SDK时,需要保证aliyun-sdk-core的版本大于4.3.3,建议使用最新版本。
  • 使用DAS的SDK的版本为1.0.2或以上。
  • 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeCacheAnalysisJobs

系统规定参数,取值:DescribeCacheAnalysisJobs

InstanceId String r-bp18ff4a195d****

实例ID。

StartTime String 1596177993000

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

EndTime String 1596177993000

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

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

页码。

PageSize String 10

页面大小。

RegionId为cn-shanghai。

返回数据

名称 类型 示例值 描述
Code String 200

返回的状态码。

Data Struct

信息列表。

Extra String None

备用参数。

List Array of CacheAnalysisJob

信息详情。

CacheAnalysisJob
BigKeys Array of KeyInfo

大Key详细信息。

KeyInfo
Bytes Long 12345

Key占用字节数。

Count Long 127

Key的元素个数。

Db Integer 0

数据库名称。

Encoding String hashtable

Key内部数据类型。

ExpirationTimeMillis Long 1596256542547

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

Key String task_xxxxx

Key的名称。

NodeId String r-xxxx-db-0

实例分片ID。

Type String hash

Redis数据结构类型。

InstanceId String r-bp18ff4a195d****

实例ID。

JobId String sf79-sd99-sa37-****

缓存分析任务ID。

Message String Successful

请求返回消息。

说明 请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。
NodeId String r-x****-db-0

示例分片ID。

TaskState String BACKUP

缓存分析任务的状态:

  • BACKUP:备份中
  • ANALYZING:分析中
  • FINISHED:分析完成
  • FAILED:出现错误
PageNo Long 1

页码。

PageSize Long 10

页面大小。

Total Long 2

结果数量。

Message String Successful

请求返回消息。

说明 请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。
RequestId String B6D17591-B48B-4D31-9CD6-9B9796B2****

请求ID。

Success String true

请求是否执行成功:

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

示例

请求示例

http(s)://das.cn-shanghai.aliyuncs.com/?Action=DescribeCacheAnalysisJobs
&InstanceId=r-bp18ff4a195d****
&Region=cn-shanghai
&StartTime=1596177993000
&EndTime=1596177993000
&PageNo=1
&PageSize=10
&<公共请求参数>

正常返回示例

XML格式

<DescribeCacheAnalysisJobsReponse>
  <RequestId> B6D17591-B48B-4D31-9CD6-9B9796B2xxxx</RequestId>
  <Message>Successful</Message>
  <Data>
        <Extra>None</Extra>
        <PageSize>10</PageSize>
        <Total>2</Total>
        <PageNo>1</PageNo>
        <List>
              <CacheAnalysisJob>
                    <NodeId>r-xxxxx-db-0</NodeId>
                    <Message>Successful</Message>
                    <InstanceId>r-bp18ff4a195dxxxx</InstanceId>
                    <TaskState>BACKUP</TaskState>
                    <JobId>xxxx-xxxx-xxxx-xxxx</JobId>
              </CacheAnalysisJob>
              <CacheAnalysisJob>
                    <BigKeys>
                          <KeyInfo>
                                <Bytes>12345</Bytes>
                                <Type>hash</Type>
                                <NodeId>r-xxxx-db-0</NodeId>
                                <ExpirationTimeMillis>1596256542547</ExpirationTimeMillis>
                                <Encoding>hashtable</Encoding>
                                <Count>127</Count>
                                <Key>task_xxxxx</Key>
                                <Db>0</Db>
                          </KeyInfo>
                    </BigKeys>
              </CacheAnalysisJob>
        </List>
  </Data>
  <Code>200</Code>
  <Success>true</Success>
</DescribeCacheAnalysisJobsReponse>

JSON格式

{"RequestId":" B6D17591-B48B-4D31-9CD6-9B9796B2xxxx","Message":"Successful","Data":{"Extra":"None","PageSize":"10","Total":"2","PageNo":"1","List":{"CacheAnalysisJob":[{"NodeId":"r-xxxxx-db-0",
"Message":"Successful",
"InstanceId":"r-bp18ff4a195dxxxx",
"TaskState":"BACKUP",
"JobId":"xxxx-xxxx-xxxx-xxxx"},{
    "BigKeys":{
        "KeyInfo":[{
            "Bytes":"12345",
            "Type":"hash",
            "NodeId":"r-xxxx-db-0",
            "ExpirationTimeMillis":"1596256542547",
            "Encoding":"hashtable",
            "Count":"127",
            "Key":"task_xxxxx",
            "Db":"0"}]}}]}},
            "Code":"200",
            "Success":"true"}

错误码

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