DescribeCacheAnalysisJobs - 查詢快取分析工作清單 -

調用DescribeCacheAnalysisJobs介面，查詢快取分析工作清單。

介面說明

使用該介面需滿足以下前提條件：

使用阿里雲或 DAS 的 SDK 時，建議使用最新版本。
使用 SDK 調用 DAS 服務時，需要將地區指定為 cn-shanghai。
本介面只適用於 Redis 引擎。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

hdm:DescribeCacheAnalysisJobs

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	執行個體 ID。	r-bp18ff4a195d****
StartTime	string	是	查詢任務開始時間，格式為 Unix 時間戳記，單位為毫秒。	1596177993000
EndTime	string	是	查詢任務結束時間，格式為 Unix 時間戳記，單位為毫秒。說明查詢任務結束時間需晚於查詢任務開始時間。	1596177993001
PageNo	string	否	頁碼，取值大於 0 且不超過整數資料類型的最大值，預設值為 1。	1
PageSize	string	否	每頁最大記錄數，預設值為 10。	10

返回參數

名稱	類型	描述	樣本值
	object
Message	string	請求返回訊息。說明請求成功時該參數返回 Successful，請求失敗時會返回請求異常資訊（如錯誤碼等）。	Successful
RequestId	string	請求 ID。	B6D17591-B48B-4D31-9CD6-9B9796B2****
Data	object	資訊列表。
List	object
CacheAnalysisJob	array<object>	資訊詳情。
	array<object>
TaskState	string	緩衝分析任務的狀態： BACKUP：備份中。 ANALYZING：分析中。 FINISHED：分析完成。 FAILED：出現錯誤。	BACKUP
JobId	string	緩衝分析任務 ID。	sf79-sd99-sa37-****
Message	string	請求返回訊息。說明請求成功時該參數返回 Successful，請求失敗時會返回請求異常資訊（如錯誤碼等）。	Successful
BigKeys	object
KeyInfo	array<object>	大 Key 詳細資料。說明當前已不再返回該參數的子參數及其內容，請調用 DescribeCacheAnalysisJob 介面查詢快取分析任務的詳細資料。
	object
Type	string	Redis 資料結構類型。	hash
Db	integer	資料庫名稱。	0
ExpirationTimeMillis	integer	Key 到期時間，單位：毫秒（ms），0 表示不到期。	1596256542547
Key	string	Key 的名稱。	task_*****
Encoding	string	Key 內部資料類型。	hashtable
Bytes	integer	Key 佔用位元組數。	12345
NodeId	string	執行個體的資料節點 ID。	r-****-db-0
Count	integer	Key 的元素個數。	127
InstanceId	string	執行個體 ID。	r-bp18ff4a195d****
NodeId	string	執行個體的資料節點 ID。	r-x****-db-0
PageNo	integer	頁碼，取值大於 0 且不超過整數資料類型的最大值，預設值為 1。	1
PageSize	integer	每頁最大記錄數，預設值為 10。	10
Extra	string	備用參數。	None
Total	integer	結果數量。	4
Code	string	返回的狀態代碼。	200
Success	string	請求是否執行成功： true：執行成功。 false：執行失敗。	true

樣本

正常返回樣本

JSON格式

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

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

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

變更歷史

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