指定されたキャッシュ分析タスクの詳細を照会します。

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

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

リクエストパラメーター

パラメータ データ型 必須/任意 例 説明
Action string 必須 DescribeCacheAnalysisJob

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

InstanceId String 任意 r-bp18ff4a195d****

インスタンスの ID。

JobId String 任意 sf79-sd99-sa37-****

キャッシュ分析タスクの ID。 キャッシュ分析タスクの ID を照会するには、CreateCacheAnalysisJob の操作を呼び出します。 レスポンスパラメーター JobId は指定されたタスクの ID を示します。

レスポンスパラメーター

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

返された状態コード。

Data Struct

詳細情報のリスト。

BigKeys KeyInfo の配列

ビッグキーの詳細。

KeyInfo
Bytes Long 12345

キーが占めているバイト数。

Count Long 127

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

Db Integer 0

データベースの名前。

Encoding String hashtable

キーのデータの型。

ExpirationTimeMillis Long 1596256542547

キーの有効期限。 この値はミリ秒単位の UNIX タイムスタンプです。 値 0 はキーの有効期限切れがないことを示します。

Key String task_x****

キーの名前。

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

指定されたタスクが実行されるデータベースノードの ID。

Type String hash

Redis データ構造のタイプ。

InstanceId String r-bp18ff4a195d****

インスタンスの ID。

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

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

KeyPrefixes プレフィックスの配列

キープレフィックスのリスト。

Prefix
Bytes Long 3652000

プレフィックスが占めるバイト数。

Count Long 1596256

プレフィックスが付いた要素の数。

KeyNum Long 123

プレフィックスが付いたキーの数。

Prefix String task_

キーのプレフィックス。

Type String hash

Redis データ構造のタイプ。

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: リクエストは失敗です。

コーディング例

リクエストの例

https://das.cn-shanghai.aliyuncs.com/?Action=DescribeCacheAnalysisJob
&InstanceId=r-bp18ff4a195d****
&JobId=sf79-sd99-sa37-****
&<Common request parameters>

成功レスポンスの例

XML 形式

</DescribeCacheAnalysisJobReponse>
<RequestId> B6D17591-B48B-4D31-9CD6-9B9796B2270A</RequestId>
<Message>Successful</Message>
<Data>
    <KeyPrefixes>
        <Prefix>
            <Bytes>3652000</Bytes>
            <Type>hash</Type>
            <Count>1596256</Count>
            <Prefix>task_</Prefix>
            <KeyNum>123</KeyNum>
        </Prefix>
    </KeyPrefixes>
    <BigKeys>
        <KeyInfo>
            <Bytes>12345</Bytes>
            <Type>hash</Type>
            <NodeId>r-xxxx-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-xxxxxx</InstanceId>
    <NodeId>r-xxxxx-db-0</NodeId>
    <TaskState>BACKUP</TaskState>
    <JobId>xxxx-xxxx-xxxx-xxxx</JobId>
</Data>
<Code>200</Code>
<Success>true</Success>
</DescribeCacheAnalysisJobReponse>

JSON 形式

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

Error codes

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