調用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 入參發生變更 | 查看變更詳情 |