キャッシュ分析タスクを作成します。

この操作を呼び出す前に、次の条件を満たしておいてください。

  • この操作は ApsaraDB for Redis Community Edition と ApsaraDB for Redis Enhanced Edition (Tair) にのみ適用されます。
  • Alibaba Cloud SDKを使用する際は、aliyun-sdk-coreを V4.3.3 より新しいバージョンにしておいてください。 最新バージョンを使用することが推奨されます。
  • Database Autonomy Service (DAS) の SDK バージョンは V1.0.3 以降である必要があります。
  • SDK を呼び出して DAS サービスを呼び出す場合は、リージョンに cn-shanghai を指定する必要があります。

リクエストパラメーター

パラメータ 型 必須／任意 例 説明
操作 string 必須 CreateCacheAnalysisJob

実行する操作。 値を CreateCacheAnalysisJob に設定します。

InstanceId String 必須 r-bp18ff4a195d****

ApsaraDB for Redis インスタンスの ID。

NodeId String 必須 r-x****-db-0

インスタンスの専用ホストの ID。 このパラメーターは、指定のノードに関する監視情報をクエリするのに使用できます。

注 BackupSetId パラメーターを指定すると、システムでは NodeId パラメーターが無視されます。 ノード ID をクエリするには、DescribeLogicInstanceTopology 操作を呼び出します。
BackupSetId String 任意 12345

バックアップファイルのID。 この値をクエリするには、DescribeBackups 操作を呼び出します。

注
  • このパラメーターは、Redis インスタンスがクラスターインスタンスか読み取り/書き込み分散インスタンスである場合に必要です。 バックアップファイル ID を複数指定する必要がある場合は、12345,67890 のようにコンマ (,) で区切ります。
  • Redis インスタンスが標準インスタンスであり、このパラメーターを指定しない場合、システムで自動的にバックアップが実行されてから、バックアップファイルに対してキャッシュ分析が実行されます。

レスポンスパラメーター

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

返される状態コード。

Data Struct

詳細情報のリスト。

BigKeys KeyInfo の配列

大きなキーの詳細。

KeyInfo
Bytes Long 12345

キーが占有しているバイトの数。

Count Long 127

キーにある要素の数。

Db Integer 0

データベースの名前。

Encoding String hashtable

キーのデータ型。

ExpirationTimeMillis Long 1596256542547

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

Key String task_x****

キーの名前。

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

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

Type String hash

Redis データ構造のタイプ。

InstanceId String r-bp18ff4a195d****

インスタンスの ID。

JobId String sf79-sd99-sa37-****

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

注 このパラメーターは、キャッシュ分析タスクをクエリするのに使用できます。 この操作を呼び出す際、キャッシュ分析タスクの作成に時間がかかります。 このため、分析結果はすぐには返されません。 分析結果を取得するには、このパラメータを API 操作 DescribeCacheAnalysisJob と併用する必要があります。
Message String Successful

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

注 リクエストが成功すると、Successful が返されます。 リクエストが失敗すると、エラーコードを含む例外メッセージが返されます。
NodeId String r-x****-db-0

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

TaskState String BACKUP

キャッシュ分析タスクのステータス。 有効値：

  • BACKUP： データはバックアップ中です。
  • ANALYZING： タスクは分析フェーズに入っています。
  • FINISHED： 分析は完了しています。
  • FAILED： エラーが発生しました。
Message String Successful

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

注 リクエストが成功すると、Successful が返されます。 リクエストが失敗すると、エラーコードを含む例外メッセージが返されます。
RequestId String B6D17591-B48B-4D31-9CD6-9B9796B2****

リクエストの ID。

Success String true

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

  • true： リクエストが成功しました。
  • false： リクエストが失敗しました。

コーディング例

リクエストの例

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

成功レスポンスの例

XML 形式 

<CreateCacheAnalysisJobReponse>
  <RequestId> B6D17591-B48B-4D31-9CD6-9B9796B2270A</RequestId>
  <Message>Successful</Message>
  <Data>
        <BigKeys>
              <KeyInfo>
                    <Bytes>12345</Bytes>
                    <Type>hash</Type>
                    <NodeId>r-xxxxx-db-0</NodeId>
                    <ExpirationTimeMillis>1596256542547</ExpirationTimeMillis>
                    <Encoding>hashtable</Encoding>
                    <Count>127</Count>
                    <Key>task_xxxxx</Key>
                    <Db>0</Db>
              </KeyInfo>
        </BigKeys>
        <Message>Successful</Message>
        <InstanceId>r-bp18ff4a195dxxxx</InstanceId>
        <NodeId>r-xxxxx-db-0</NodeId>
        <TaskState>BACKUP</TaskState>
        <JobId>xxxx-xxxx-xxxx-xxxx</JobId>
  </Data>
  <Code>200</Code>
  <Success>true</Success>
</CreateCacheAnalysisJobReponse>

JSON 形式 

{"RequestId":" B6D17591-B48B-4D31-9CD6-9B9796B2270A",
"Message":"Successful",
"data":{
    "BigKeys":{
        "KeyInfo":[{
            "Bytes":"12345",
            "Type":"hash",
            "NodeId":"r-xxxxx-db-0",
            "ExpirationTimeMillis":"1596256542547",
            "Encoding":"hashtable",
            "Count":"127",
            "Key":"task_xxxxx",
            "Db":"0"}]},
            "Message":"Successful",
            "InstanceId":"r-bp18ff4a195dxxxx",
            "NodeId":"r-xxxxx-db-0",
            "TaskState":"BACKUP",
            "JobId":"xxxx-xxxx-xxxx-xxxx"},
            "Code":"200",
            "Success":"true"}

Error codes

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