调用CreateCacheAnalysisJob接口创建缓存分析任务。

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

  • 本接口只适用于Redis社区版、企业版性能增强型。
  • 在使用阿里云SDK时，需要保证aliyun-sdk-core的版本大于4.3.3，建议使用最新版本。
  • 使用DAS的SDK的版本为1.0.3或以上。
  • 在调用DAS服务时，需要将地域指定为cn-shanghai。

请求参数

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

系统规定参数，取值：CreateCacheAnalysisJob。

InstanceId String 是 r-bp18ff4a195d****

Redis实例ID。
NodeId String 否 r-x****-db-0

实例的数据节点ID，传入本参数可查询指定节点的监控信息。

说明 当您传入BackupSetId参数，系统会忽略此参数，您可调用DescribeLogicInstanceTopology接口查询节点ID。
BackupSetId String 否 12345

备份文件ID，可以通过DescribeBackups接口获取。

说明
  • Redis实例为集群或读写分离架构时，本参数必须传入。如需传入多个备份文件ID，请使用英文逗号（,）分隔，例如12345,67890。
  • Redis实例为标准架构时，如果不传入本参数，系统会自动执行备份并对该备份文件执行缓存分析。

返回数据

名称 类型 示例值 描述
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-x****-db-0

实例的数据节点ID。
Type String hash

Redis数据结构类型。
InstanceId String r-bp18ff4a195d****

实例ID。
JobId String sf79-sd99-sa37-****

缓存分析任务ID。

说明 此参数可用于查询缓存分析任务使用，当您调用该API时，由于创建缓存分析任务需要一定的时间，不会立即返回分析结果，您需要通过此参数，结合DescribeCacheAnalysisJob接口，查询具体的分析结果。
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：执行失败

示例

请求示例

http(s)://das.cn-shanghai.aliyuncs.com/?Action=CreateCacheAnalysisJob
&InstanceId=r-bp18ff4a195d****
&NodeId=r-x****-db-0
&<公共请求参数>

正常返回示例

XML格式 

<CreateCacheAnalysisJobReponse>
  <RequestId> B6D17591-B48B-4D31-9CD6-9B9796B2270A</RequestId>
  <Message>Successful</Message>
  <Data>
        <BigKeys>
              <KeyInfo>
                    <Bytes>12345</Bytes>
                    <Type>hash</Type>
                    <NodeId>r-xxxxx-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-bp18ff4a195dxxxx</InstanceId>
        <NodeId>r-xxxxx-db-0</NodeId>
        <TaskState>BACKUP</TaskState>
        <JobId>xxxx-xxxx-xxxx-xxxx</JobId>
  </Data>
  <Code>200</Code>
  <Success>true</Success>
</CreateCacheAnalysisJobReponse>

JSON格式 

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

错误码

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