すべてのプロダクト
Search

このプロダクト

    :DescribeCacheAnalysisJob

    ドキュメントセンター

    :DescribeCacheAnalysisJob

    最終更新日:Mar 13, 2026

    キャッシュ解析タスクの詳細を照会します。

    操作説明

    この API オペレーションを呼び出す前に、以下の点にご注意ください：

    • Alibaba Cloud SDK または Database Autonomy Service (DAS) SDK を使用してこの API オペレーションを呼び出す場合は、最新バージョンの SDK をご使用いただくことを推奨します。

    • DAS の API オペレーションを SDK で呼び出す場合、リージョン ID を cn-shanghai に設定する必要があります。

    • このオペレーションは、ApsaraDB for Redis のみで利用可能です。

    説明

    このオペレーションを呼び出すと、キャッシュ解析タスクにおける上位 500 個のキーを照会できます。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    hdm:DescribeCacheAnalysisJob

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    InstanceId

    string

    必須

    インスタンスの ID です。

    r-bp18ff4a195d****
    JobId

    string

    必須

    キャッシュ解析タスクの ID です。タスク ID は、CreateCacheAnalysisJob オペレーションのレスポンスパラメーターから取得できます。

    sf79-sd99-sa37-****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    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 です。

    sf79-sd99-sa37-****
    Message

    string

    リクエストに対する応答メッセージです。

    説明

    リクエストが成功した場合は Successful が返されます。失敗した場合は、エラーコードなどの情報を含むエラーメッセージが返されます。

    Successful
    BigKeys

    object

    KeyInfo

    array<object>

    大規模キーの詳細です。返される大規模キーは、キーが占めるバイト数の降順で並べられます。

    object

    Type

    string

    インスタンスのデータの型です。

    hash
    Db

    integer

    データベース名です。

    0
    ExpirationTimeMillis

    integer

    キーの有効期限が切れる時刻です。この値は UNIX タイムスタンプであり、1970 年 1 月 1 日 00:00:00 UTC からの経過ミリ秒数を表します。値が 0 の場合、キーには有効期限がありません。

    1596256542547
    Key

    string

    キー名です。

    task_x****
    Encoding

    string

    キーのデータの型です。

    hashtable
    Bytes

    integer

    キーが占めるバイト数です。

    12345
    NodeId

    string

    インスタンス上のデータノードの ID です。

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

    integer

    キー内の要素数です。

    127
    KeyPrefixes

    object

    Prefix

    array<object>

    キーのプレフィックスです。

    object

    KeyNum

    integer

    プレフィックスを含むキーの数です。

    123
    Type

    string

    インスタンスのデータの型です。

    hash
    Bytes

    integer

    キーが占めるバイト数です。

    12345
    Prefix

    string

    キーのプレフィックスです。

    task_
    Count

    integer

    キー内の要素数です。

    127
    BigKeysOfNum

    object

    KeyInfo

    array<object>

    大規模キーの詳細です。返される大規模キーは、キー数の降順で並べられます。

    object

    Type

    string

    インスタンスのデータの型です。

    hash
    Db

    integer

    データベース名です。

    0
    ExpirationTimeMillis

    integer

    キーの有効期限が切れる時刻です。この値は UNIX タイムスタンプであり、1970 年 1 月 1 日 00:00:00 UTC からの経過ミリ秒数を表します。値が 0 の場合、キーには有効期限がありません。

    1596256542547
    Key

    string

    キー名です。

    task_x****
    Encoding

    string

    キーのデータの型です。

    hashtable
    Bytes

    integer

    キーが占めるバイト数です。

    12345
    NodeId

    string

    インスタンス上のデータノードの ID です。

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

    integer

    キー内の要素数です。

    127
    UnexBigKeysOfBytes

    object

    KeyInfo

    array<object>

    永続キーの詳細です。返されるキーは、キーが占めるバイト数の降順で並べられます。

    object

    Type

    string

    インスタンスのデータの型です。

    hash
    Db

    integer

    データベース名です。

    0
    ExpirationTimeMillis

    integer

    キーの有効期限が切れる時刻です。この値は UNIX タイムスタンプであり、1970 年 1 月 1 日 00:00:00 UTC からの経過ミリ秒数を表します。値が 0 の場合、キーには有効期限がありません。

    1596256542547
    Key

    string

    キー名です。

    task_x****
    Encoding

    string

    キーのデータの型です。

    hashtable
    Bytes

    integer

    キーが占めるバイト数です。

    12345
    NodeId

    string

    インスタンス上のデータノードの ID です。

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

    integer

    キー内の要素数です。

    127
    UnexBigKeysOfNum

    object

    KeyInfo

    array<object>

    永続キーの詳細です。返されるキーは、キー数の降順で並べられます。

    object

    Type

    string

    インスタンスのデータの型です。

    hash
    Db

    integer

    データベース名です。

    0
    ExpirationTimeMillis

    integer

    キーの有効期限が切れる時刻です。この値は UNIX タイムスタンプであり、1970 年 1 月 1 日 00:00:00 UTC からの経過ミリ秒数を表します。値が 0 の場合、キーには有効期限がありません。

    1596256542547
    Key

    string

    キー名です。

    task_x****
    Encoding

    string

    キーのデータの型です。

    hashtable
    Bytes

    integer

    キーが占めるバイト数です。

    12345
    NodeId

    string

    インスタンス上のデータノードの ID です。

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

    integer

    キー内の要素数です。

    127
    InstanceId

    string

    インスタンス ID です。

    r-bp18ff4a195d****
    NodeId

    string

    インスタンス上のデータノードの ID です。

    r-x****-db-0
    ExpiryKeysLevelCount

    object

    ExpiryLevel

    array<object>

    期限切れとなったキーの統計情報です。

    object

    AnalysisTs

    integer

    キャッシュ解析タスクの完了時刻です。この値は UNIX タイムスタンプであり、1970 年 1 月 1 日 00:00:00 UTC からの経過ミリ秒数を表します。

    1717469347000
    Level

    integer

    有効期限レベルです。有効な値は以下のとおりです：

    • 0：キーには有効期限がありません。

    • 1：キーの有効期限が切れています。

    • 2：キーの有効期限が切れてから 0～1 時間経過しています。

    • 3：キーの有効期限が切れてから 1～3 時間経過しています。

    • 4：キーの有効期限が切れてから 3～12 時間経過しています。

    • 5：キーの有効期限が切れてから 12～24 時間経過しています。

    • 6：キーの有効期限が切れてから 1～2 日経過しています。

    • 7：キーの有効期限が切れてから 3～7 日経過しています。

    • 8：キーの有効期限が切れてから 7 日以上経過しています。

    0
    TotalBytes

    integer

    期限切れとなったキーが占めるバイト数です。

    8064
    TotalKeys

    integer

    期限切れとなったキーの合計数です。

    62
    Code

    string

    返される HTTP ステータスコードです。

    200
    Success

    string

    リクエストが成功したかどうかを示します。有効な値は以下のとおりです：

    • true

    • false

    true

    例

    成功レスポンス

    JSONJSON

    {
  "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
        }
      ]
    },
    "KeyPrefixes": {
      "Prefix": [
        {
          "KeyNum": 123,
          "Type": "hash",
          "Bytes": 12345,
          "Prefix": "task_",
          "Count": 127
        }
      ]
    },
    "BigKeysOfNum": {
      "KeyInfo": [
        {
          "Type": "hash",
          "Db": 0,
          "ExpirationTimeMillis": 1596256542547,
          "Key": "task_x****",
          "Encoding": "hashtable",
          "Bytes": 12345,
          "NodeId": "r-x****-db-0",
          "Count": 127
        }
      ]
    },
    "UnexBigKeysOfBytes": {
      "KeyInfo": [
        {
          "Type": "hash",
          "Db": 0,
          "ExpirationTimeMillis": 1596256542547,
          "Key": "task_x****",
          "Encoding": "hashtable",
          "Bytes": 12345,
          "NodeId": "r-x****-db-0",
          "Count": 127
        }
      ]
    },
    "UnexBigKeysOfNum": {
      "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",
    "ExpiryKeysLevelCount": {
      "ExpiryLevel": [
        {
          "AnalysisTs": 1717469347000,
          "Level": 0,
          "TotalBytes": 8064,
          "TotalKeys": 62
        }
      ]
    }
  },
  "Code": "200",
  "Success": "true"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

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

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。