文档

CreateCacheAnalysisJob - 创建缓存分析任务

更新时间:

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

接口说明

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

  • 使用阿里云或 DAS 的 SDK 时,建议使用最新版本。
  • 使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。
  • 只支持分析 Redis 数据结构和以下 Tair 自研数据结构:TairString、TairHash、TairGIS、TairBloom、TairDoc、TairCpc、TairZset,暂不支持分析其他 Tair 自研数据结构。
  • 如果目标实例规格已发生变更,则不支持分析实例变更前的备份文件。
  • 暂不支持 Tair 磁盘型实例。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
InstanceIdstring

Redis 实例 ID。

r-bp18ff4a195d****
NodeIdstring

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

说明 当您传入 BackupSetId 参数,系统会忽略此参数,您可调用 DescribeLogicInstanceTopology 接口查询节点 ID。
r-x****-db-0
BackupSetIdstring

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

  • 如需传入多个备份文件 ID,请使用英文逗号(,)分隔,例如12345,67890
  • 如果不传入本参数,系统会自动执行备份并对该备份文件执行缓存分析。
12345
Separatorsstring

用于识别 Key 前缀的分隔符。当分隔符为默认的:;,_-+@=|#时,不需要输入。

&

返回参数

名称类型描述示例值
object
Messagestring

请求返回消息。

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

请求 ID。

B6D17591-B48B-4D31-9CD6-9B9796B2****
Dataobject

详细信息列表。

TaskStatestring

缓存分析任务的状态:

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

缓存分析任务 ID。

说明 此参数可用于查询缓存分析任务使用,当您调用该 API 时,由于创建缓存分析任务需要一定的时间,不会立即返回分析结果,您需要通过此参数,结合 DescribeCacheAnalysisJob 接口,查询具体的分析结果。
sf79-sd99-sa37-****
Messagestring

请求返回消息。

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

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

Typestring

Redis 数据结构类型。

hash
Dbinteger

数据库名称。

0
ExpirationTimeMillislong

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

1596256542547
Keystring

Key 的名称。

task_x****
Encodingstring

Key 内部数据类型。

hashtable
Byteslong

Key 占用字节数。

12345
NodeIdstring

实例的数据节点 ID。

r-x****-db-0
Countlong

Key 的元素个数。

127
InstanceIdstring

实例 ID。

r-bp18ff4a195d****
NodeIdstring

实例的数据节点 ID。

r-x****-db-0
Codestring

返回的状态码。

200
Successstring

请求是否执行成功:

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

示例

正常返回示例

JSON格式

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

错误码

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

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

变更历史

变更时间变更内容概要操作
2023-07-06OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    新增错误码:400
    新增错误码:403
入参OpenAPI 入参发生变更
    新增入参:Separators
  • 本页导读 (1)