全部產品
Search

搜尋本產品

    ：CreateCacheAnalysisJob - 建立緩衝分析任務

    文件中心

    ：CreateCacheAnalysisJob - 建立緩衝分析任務

    更新時間：Dec 19, 2025

    調用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 介面擷取。

    • 如需傳入多個備份檔案 ID，請使用英文逗號（,）分隔，例如12345,67890。

    • 如果不傳入本參數，系統會自動執行備份並對該備份檔案執行緩衝分析。

    12345
    Separators

    string

    否

    用於識別 Key 首碼的分隔字元。當分隔字元為預設的:;,_-+@=|#時，不需要輸入。

    &

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Message

    string

    請求返回訊息。

    說明

    請求成功時該參數返回 Successful，請求失敗時會返回請求異常資訊（如錯誤碼等）。

    Successful
    RequestId

    string

    請求 ID。

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

    object

    詳細資料列表。

    TaskState

    string

    緩衝分析任務的狀態：

    • BACKUP：備份中。

    • ANALYZING：分析中。

    • FINISHED：分析完成。

    • FAILED：出現錯誤。

    BACKUP
    JobId

    string

    緩衝分析任務 ID。

    說明

    此參數可用於查詢快取分析任務使用，當您調用該 API 時，由於建立緩衝分析任務需要一定的時間，不會立即返回分析結果，您需要通過此參數，結合 DescribeCacheAnalysisJob 介面，查詢具體的分析結果。

    sf79-sd99-sa37-****
    Message

    string

    請求返回訊息。

    說明

    請求成功時該參數返回 Successful，請求失敗時會返回請求異常資訊（如錯誤碼等）。

    Successful
    BigKeys

    object

    KeyInfo

    array<object>

    大 Key 詳細資料，根據 Key 佔用位元組數降序排列。

    object

    Type

    string

    Redis 資料結構類型。

    hash
    Db

    integer

    資料庫名稱。

    0
    ExpirationTimeMillis

    integer

    Key 到期時間，單位：毫秒（ms），0 表示不到期。

    1596256542547
    Key

    string

    Key 的名稱。

    task_x****
    Encoding

    string

    Key 內部資料類型。

    hashtable
    Bytes

    integer

    Key 佔用位元組數。

    12345
    NodeId

    string

    執行個體的資料節點 ID。

    r-x****-db-0
    Count

    integer

    Key 的元素個數。

    127
    InstanceId

    string

    執行個體 ID。

    r-bp18ff4a195d****
    NodeId

    string

    執行個體的資料節點 ID。

    r-x****-db-0
    Code

    string

    返回的狀態代碼。

    200
    Success

    string

    請求是否執行成功：

    • 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

    錯誤碼

    錯誤資訊

    描述
    400 InvalidParams The request parameters are invalid.
    403 NoPermission You are not authorized to do this action.

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。