调用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:CreateCacheAnalysisJob | create | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | Redis 实例 ID。 | r-bp18ff4a195d**** |
NodeId | string | 否 | 实例的数据节点 ID,传入本参数可查询指定节点的监控信息。 说明
当您传入 BackupSetId 参数,系统会忽略此参数,您可调用 DescribeLogicInstanceTopology 接口查询节点 ID。
| r-x****-db-0 |
BackupSetId | string | 否 | 备份文件 ID,可以通过 DescribeBackups 接口获取。
| 12345 |
Separators | string | 否 | 用于识别 Key 前缀的分隔符。当分隔符为默认的 | & |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParams | The request parameters are invalid. | 请求参数错误 |
403 | NoPermission | You are not authorized to do this action. | 没有权限执行该操作 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-07-06 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |