すべてのプロダクト
Search

このプロダクト

    :DescribeHotKeys

    ドキュメントセンター

    :DescribeHotKeys

    最終更新日:Dec 25, 2025

    DescribeHotKeys 操作を呼び出して、Redis インスタンスのホットキーをクエリします。

    操作説明

    この操作を呼び出す前に、次の要件が満たされていることを確認してください。

    • Alibaba Cloud SDK を使用する場合は、`aliyun-sdk-core` のバージョンが 4.3.3 以降であることを確認してください。 最新バージョンを使用することを推奨します。

    • Database Autonomy Service (DAS) SDK のバージョンは 1.0.2 以降である必要があります。

    • SDK を使用して DAS サービスを呼び出す場合は、リージョンを `cn-shanghai` に設定する必要があります。

    • この操作は、次の要件を満たす Redis インスタンスにのみ適用されます。

      • インスタンスは Redis Community Edition インスタンスまたは Tair (Enterprise Edition) メモリ最適化インスタンスです。

      • インスタンスが最新のマイナーバージョンに更新されていること。

    今すぐお試しください

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

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    InstanceId

    string

    必須

    Redis インスタンスの ID。

    r-bp18ff4a195d****
    NodeId

    string

    任意

    Redis インスタンスのデータシャード ID。

    r-x****-db-0

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Message

    string

    返されるメッセージ。

    説明

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

    Successful
    RequestId

    string

    リクエスト ID。

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

    object

    HotKey

    array<object>

    ホットキーの詳細。

    object

    結果セット。

    Key

    string

    ホットキー。

    abc:def:eng
    Db

    integer

    キーが格納されているデータベース。

    0
    Hot

    string

    キーのアクセス頻度 (1 秒あたりのアクセス数)。

    5500~6000
    KeyType

    string

    キーのタイプ。

    zset
    Size

    integer

    キー内の要素の数。

    2
    InBytes

    integer

    インバウンドトラフィック。 単位：バイト。

    85766
    OutBytes

    integer

    アウトバウンドトラフィック。 単位：バイト。

    1054688
    NodeId

    string

    ノード ID。

    r-x****-db-0
    Category

    string

    ホットキーのカテゴリ。 有効な値：

    • qps：ホットキーは、クエリ/秒 (QPS) に基づいて識別されます。

    • traffic：ホットキーは、トラフィックに基づいて識別されます。

    qps
    Code

    string

    HTTP ステータスコード。

    200
    Success

    string

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

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

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

    true

    例

    成功レスポンス

    JSONJSON

    {
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Data": {
    "HotKey": [
      {
        "Key": "abc:def:eng",
        "Db": 0,
        "Hot": "5500~6000",
        "KeyType": "zset",
        "Size": 2,
        "InBytes": 85766,
        "OutBytes": 1054688,
        "NodeId": "r-x****-db-0",
        "Category": "qps"
      }
    ]
  },
  "Code": "200",
  "Success": "true"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

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

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

    変更履歴

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