すべてのプロダクト
Search

このプロダクト

    :DescribeCacheAnalysisJobs

    ドキュメントセンター

    :DescribeCacheAnalysisJobs

    最終更新日:Dec 19, 2025

    キャッシュ分析タスクのリストを照会します。

    操作説明

    この操作を呼び出す前に、次の点にご注意ください。

    • Alibaba Cloud SDK または Database Autonomy Service (DAS) SDK を使用してこの操作を呼び出す場合は、最新バージョンの SDK を使用することを推奨します。

    • SDK を使用して DAS の API 操作を呼び出す場合は、リージョン ID を cn-shanghai (中国 (上海)) に設定する必要があります。

    • この操作は ApsaraDB for Redis にのみ適用されます。

    今すぐお試しください

    この 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:DescribeCacheAnalysisJobs

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    InstanceId

    string

    必須

    インスタンス ID。

    r-bp18ff4a195d****
    StartTime

    string

    必須

    照会する時間範囲の開始時刻。 協定世界時 (UTC) 1970 年 1 月 1 日 00:00:00 から経過したミリ秒数で表した UNIX タイムスタンプに設定します。

    1596177993000
    EndTime

    string

    必須

    照会する時間範囲の終了時刻。 協定世界時 (UTC) 1970 年 1 月 1 日 00:00:00 から経過したミリ秒数で表した UNIX タイムスタンプに設定します。

    説明

    終了時刻は開始時刻より後である必要があります。

    1596177993001
    PageNo

    string

    任意

    ページ番号。 0 より大きい整数である必要があります。 デフォルト値：1。

    1
    PageSize

    string

    任意

    1 ページあたりのエントリ数。 デフォルト値：10。

    10

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Message

    string

    返されたメッセージ。

    説明

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

    Successful
    RequestId

    string

    リクエスト ID。

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

    object

    キャッシュ分析タスクのリスト。

    List

    object

    CacheAnalysisJob

    array<object>

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

    array<object>

    TaskState

    string

    キャッシュ分析タスクの状態。 有効な値：

    • BACKUP：データはバックアップ中です。

    • ANALYZING：データは分析中です。

    • FINISHED：データは分析済みです。

    • FAILED：エラーが発生しました。

    BACKUP
    JobId

    string

    キャッシュ分析タスクの ID。

    sf79-sd99-sa37-****
    Message

    string

    返されたメッセージ。

    説明

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

    Successful
    BigKeys

    object

    KeyInfo

    array<object>

    large キーに関する詳細。

    説明

    このパラメーターのサブパラメーターおよびサブパラメーターの内容は返されません。 キャッシュ分析タスクの詳細情報を照会するには、DescribeCacheAnalysisJob 操作を呼び出してください。

    object

    Type

    string

    キーのデータ型。

    hash
    Db

    integer

    データベース名。

    0
    ExpirationTimeMillis

    integer

    キーの有効期間。 単位：ミリ秒。 値が 0 の場合は、キーに有効期限がないことを示します。

    1596256542547
    Key

    string

    キーの名前。

    task_*****
    Encoding

    string

    キーのデータ型。

    hashtable
    Bytes

    integer

    キーが占有するバイト数。

    12345
    NodeId

    string

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

    r-****-db-0
    Count

    integer

    キー内の要素数。

    127
    InstanceId

    string

    インスタンス ID。

    r-bp18ff4a195d****
    NodeId

    string

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

    r-x****-db-0
    PageNo

    integer

    ページ番号。 0 より大きい整数である必要があります。 デフォルト値：1。

    1
    PageSize

    integer

    1 ページあたりのエントリ数。 デフォルト値：10。

    10
    Extra

    string

    予約済みのパラメーター。

    None
    Total

    integer

    返されたエントリの総数。

    4
    Code

    string

    返された HTTP ステータスコード。

    200
    Success

    string

    リクエストが成功したかどうかを示します。 有効な値：

    • true：リクエストは成功しました。

    • false：リクエストは失敗しました。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "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 ステータスコード

    エラーコード

    エラーメッセージ

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

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

    変更履歴

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