DescribeTopHotKeys によるトップホットキーの取得 - DAS - Alibaba Cloud - Database Autonomy Service

指定された期間内のトップ 100 のホットキーをクエリします。

操作説明

QPS が 3,000 を超えるキーはホットキーとして識別されます。

Alibaba Cloud SDK を使用する場合、aliyun-sdk-core のバージョンが 4.3.3 以降であることを確認してください。最新バージョンの使用を推奨します。
DAS SDK のバージョンは 1.0.2 以降である必要があります。
SDK を使用して DAS サービスを呼び出す場合、リージョンを中国 (上海) に設定してください。
この操作は、次の Redis インスタンスにのみ適用されます：
- インスタンスは、オープンソースの Redis インスタンス、または 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:DescribeTopHotKeys

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ConsoleContext	string	任意	予約済みのパラメーターです。	None
InstanceId	string	必須	Redis インスタンスの ID。	r-bp18ff4a195d****
NodeId	string	任意	Redis インスタンスのデータシャードの ID。	r-****-db-0
StartTime	string	必須	クエリ期間の開始時刻。ミリ秒単位の UNIX タイムスタンプで指定します。	1596177993000
EndTime	string	必須	クエリ期間の終了時刻。ミリ秒単位の UNIX タイムスタンプで指定します。説明終了時刻は開始時刻より後である必要があります。過去 4 日以内のデータをクエリできます。 StartTime と EndTime の間の最大時間間隔は 3 時間です。	1596177993001

レスポンスフィールド

フィールド	型	説明	例
	object
Message	string	応答メッセージ。	Successful
RequestId	string	リクエスト ID。	B6D17591-B48B-4D31-9CD6-9B9796B2****
Data	object
HotKey	array<object>	ホットキーのリスト。
	object	ホットキーの詳細。
Db	integer	キーが格納されているデータベース。	0
Key	string	キーの名前。	abc:def:eng
Hot	string	キーのアクセス周波数。単位は 1 秒あたりのアクセス数です。	5500~6000
KeyType	string	キーのタイプ。	zset
Lfu	integer	キーの LFU (最小使用頻度) カウンターの値。	253
NodeId	string	Redis インスタンスのデータシャードの ID。	r-x****-db-0
InBytes	integer	インバウンドトラフィック (バイト単位)。このパラメーターは、traffic カテゴリのホットキーの場合にのみ返されます。	4502693
OutBytes	integer	アウトバウンドトラフィック (バイト単位)。このパラメーターは、traffic カテゴリのホットキーの場合にのみ返されます。	1291659
Category	string	ホットキーのカテゴリ。有効な値： qps: QPS に基づいてホットキーとして識別されたキー。 traffic: トラフィックに基づいてホットキーとして識別されたキー。	qps
Code	string	応答コード。	200
Success	string	リクエストが成功したかどうかを示します。有効な値： true: リクエストは成功しました。 false: リクエストは失敗しました。	true

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

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

変更履歴

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