指定された ApsaraDB for Redis インスタンスのホットキーを照会します。

この操作を呼び出す前に、以下の条件が満たされていることを確認します。

  • 照会したいインスタンスでは、Redis データベースエンジンが動作しています。
  • Alibaba Cloud SDK を使用している場合は、aliyun-sdk-core のバージョンが V4.3.3 以降であることを確認します。 最新バージョンの使用を推奨します。
  • Database Autonomy Service (DAS) の SDK バージョンは V1.0.2 以降である必要があります。
  • SDK を使用して DAS サービスを呼び出す場合は、リージョンを cn-shanghai に設定する必要があります。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
Action String 任意 DescribeHotKeys

実行したい操作。 値を DescribeHotKeys に設定します。

InstanceId String 任意 r-bp18ff4a195d****

Redis インスタンスの ID。 ID を照会するために DescribeInstances 操作を呼び出すことができます。

NodeId String 任意 r-x****-db-0

Redis ノードの ID。 DescribeRoleZoneInfo 操作を呼び出して、InsName レスポンスパラメーターを表示できます。

レスポンスパラメーター

パラメーター データ型 例 説明
Code String 200

返された状態コード。

Data HotKey の配列

詳細情報のリスト。

HotKey
Db Integer 0

データベースインスタンス。

Hot String 5500~6000

アクセス頻度。

Key String BACKUP

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

KeyType String zset

キーのタイプ。

Size Long 12345

キーに含まれる要素の数。

Message String Successful

リクエストに対して返されるメッセージ。

注 リクエストが成功した場合、Successful が返されます。 リクエストが失敗した場合、エラーコードなどのリクエスト例外メッセージが返されます。
RequestId String B6D17591-B48B-4D31-9CD6-9B9796B2****

リクエストの ID。

Success String true

リクエストが成功したかどうかを示します。

  • true: リクエストは成功です。
  • false: リクエストは失敗です。

例

リクエストの例

http(s)://https://das.cn-shanghai.aliyuncs.com/?Action=DescribeHotKeys
&InstanceId=r-bp18ff4a195d****
&NodeId=r-x****-db-0
&<Common request parameters>

成功レスポンスの例

XML 形式 

<DescribeHotKeysReponse>
  <RequestId> B6D17591-B48B-4D31-9CD6-9B9796B2270A</RequestId>
  <Message>Successful</Message>
  <Data>
        <HotKey>
              <KeyType>zset</KeyType>
              <Hot>5500~6000</Hot>
              <Size>12345</Size>
              <Key>BACKUP</Key>
              <Db>0</Db>
        </HotKey>
  </Data>
  <Code>200</Code>
  <Success>true</Success>
</DescribeHotKeysReponse>

JSON 形式 

{"RequestId":" B6D17591-B48B-4D31-9CD6-9B9796B2270A",
"Message":"Successful",
"Data":{
    "HotKey":[{
        "KeyType":"zset",
        "Hot":"5500~6000",
        "Size":"12345",
        "Key":"BACKUP",
        "Db":"0"}]},
        "Code":"200",
        "Success":"true"}

エラーコード

エラーコードリストについては、「API エラーセンター」をご参照ください。