调用DescribeCacheAnalysisJob接口查询缓存分析任务详情。

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

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

请求参数

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

系统规定参数,取值:DescribeCacheAnalysisJob

InstanceId String r-bp18ff4a195d****

实例ID。

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

分析任务ID。

返回数据

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

返回的状态码。

Data Struct

详细信息列表。

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_x****

Key的名称。

NodeId String r-****-db-0

实例分片ID。

Type String hash

Redis数据结构类型。

InstanceId String r-bp18ff4a195d****

实例ID。

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

缓存分析任务ID。

KeyPrefixes Array of Prefix

Key前缀列表。

Prefix
Bytes Long 3652000

占用的内存字节。

Count Long 1596256

该前缀元素的数量。

KeyNum Long 123

该前缀Key的数量。

Prefix String task_

Key的前缀。

Type String hash

Redis数据结构类型。

Message String Successful

请求返回消息。

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

实例分片ID。

TaskState String BACKUP

缓存分析任务的状态:

  • BACKUP:备份中
  • ANALYZING:分析中
  • FINISHED:分析完成
  • FAILED:出现错误
Message String Successful

请求返回消息。

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

请求ID。

Success String true

请求是否执行成功:

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

示例

请求示例

https://das.cn-shanghai.aliyuncs.com/?Action=DescribeCacheAnalysisJob
&InstanceId=r-bp18ff4a195d****
&JobId=sf79-sd99-sa37-****
&<公共请求参数>

正常返回示例

XML格式

</DescribeCacheAnalysisJobReponse>
<RequestId> B6D17591-B48B-4D31-9CD6-9B9796B2270A</RequestId>
<Message>Successful</Message>
<Data>
    <KeyPrefixes>
        <Prefix>
            <Bytes>3652000</Bytes>
            <Type>hash</Type>
            <Count>1596256</Count>
            <Prefix>task_</Prefix>
            <KeyNum>123</KeyNum>
        </Prefix>
    </KeyPrefixes>
    <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>
    <Message>Successful</Message>
    <InstanceId>r-xxxxxx</InstanceId>
    <NodeId>r-xxxxx-db-0</NodeId>
    <TaskState>BACKUP</TaskState>
    <JobId>xxxx-xxxx-xxxx-xxxx</JobId>
</Data>
<Code>200</Code>
<Success>true</Success>
</DescribeCacheAnalysisJobReponse>

JSON格式

{"RequestId":" B6D17591-B48B-4D31-9CD6-9B9796B2270A","Message":"Successful","Data":{"KeyPrefixes":{"Prefix":[{"Bytes":"3652000","Type":"hash","Count":"1596256","Prefix":"task_","KeyNum":"123"}]},"BigKeys":{"KeyInfo":[{"Bytes":"12345","Type":"hash","NodeId":"r-xxxx-db-0","ExpirationTimeMillis":"1596256542547",
"Encoding":"hashtable",
"Count":"127",
"Key":"task_xxxxx",
"Db":"0"}]},
"Message":"Successful",
"InstanceId":"r-xxxxxx",
"NodeId":"r-xxxxx-db-0",
"TaskState":"BACKUP",
"JobId":"xxxx-xxxx-xxxx-xxxx"},
"Code":"200",
"Success":"true"}

错误码

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