キャッシュ分析のタスクを照会します。
この操作を呼び出す前に、以下の条件が満たされていることを確認します。
- 照会したいインスタンスでは、Redis データベースエンジンが動作しています。
- Alibaba Cloud SDK を使用している場合は、aliyun-sdk-core のバージョンが V4.3.3 以降であることを確認します。 最新バージョンの使用を推奨します。
- Database Autonomy Service (DAS) の SDK バージョンは V1.0.2 以降である必要があります。
- SDK を使用して DAS サービスを呼び出す場合は、リージョンを cn-shanghai に設定する必要があります。
リクエストパラメーター
| パラメーター | データ型 | 必須／任意 | 例 | 説明 |
|---|---|---|---|---|
| Action | String | 任意 | DescribeCacheAnalysisJobs |
実行したい操作。 値を DescribeCacheAnalysisJobs に設定します。 |
| InstanceId | String | 任意 | r-bp18ff4a195d**** |
インスタンスの ID。 |
| StartTime | String | 任意 | 1596177993000 |
照会する期間の開始時刻。 UNIX タイムスタンプをミリ秒単位で指定します。 |
| EndTime | String | 任意 | 1596177993000 |
照会する期間の終了時刻。 UNIX タイムスタンプをミリ秒単位で指定します。 注 終了時刻は開始時刻よりも後の時刻にする必要があります。
|
| PageNo | String | 任意 | 1 |
返されるページ数を設定します。 |
| PageSize | String | 任意 | 10 |
返される各ページのエントリ数。 |
RegionId を cn-shanghai に設定します。
レスポンスパラメーター
| パラメーター | データ型 | 例 | 説明 |
|---|---|---|---|
| Code | String | 200 |
返された状態コード。 |
| Data | Struct |
情報リスト。 |
|
| Extra | String | None |
非表示のパラメーター。 |
| List | CacheAnalysisJob の配列 |
詳細情報。 |
|
| CacheAnalysisJob | |||
| BigKeys | KeyInfo の配列 |
ビッグキーの詳細。 |
|
| KeyInfo | |||
| Bytes | Long | 12345 |
キーが占めているバイト数。 |
| Count | Long | 127 |
キーに含まれる要素の数。 |
| Db | Integer | 0 |
データベースの名前。 |
| Encoding | String | hashtable |
キーのデータの型。 |
| ExpirationTimeMillis | Long | 1596256542547 |
キーの有効期限。 この値はミリ秒単位の UNIX タイムスタンプです。 値 0 はキーの有効期限切れがないことを示します。 |
| Key | String | task_xxxxx |
キーの名前。 |
| NodeId | String | r-xxxx-db-0 |
タスクが実行されるデータノードの ID。 |
| Type | String | hash |
Redis データ構造のタイプ。 |
| InstanceId | String | r-bp18ff4a195d**** |
インスタンスの ID。 |
| JobId | String | sf79-sd99-sa37-**** |
キャッシュ分析タスクの ID。 |
| Message | String | Successful |
リクエストに対して返されるメッセージ。 注 リクエストが成功した場合、Successful が返されます。 リクエストが失敗した場合、エラーコードなどのリクエスト例外メッセージが返されます。
|
| NodeId | String | r-x****-db-0 |
タスクが実行されるデータノードの ID。 |
| TaskState | String | BACKUP |
キャッシュ分析タスクのステータス。 有効値：
|
| PageNo | Long | 1 |
返されたページ数。 |
| PageSize | Long | 10 |
返される 1 ページあたりのエントリ数です。 |
| Total | Long | 2 |
返されたエントリの総数です。 |
| Message | String | Successful |
リクエストに対して返されるメッセージ。 注 リクエストが成功した場合、Successful が返されます。 リクエストが失敗した場合、エラーコードなどのリクエスト例外メッセージが返されます。
|
| RequestId | String | B6D17591-B48B-4D31-9CD6-9B9796B2**** |
リクエストの ID。 |
| Success | String | true |
リクエストが成功したかどうかを示します。
|
例
リクエストの例
http(s)://das.cn-shanghai.aliyuncs.com/?Action=DescribeCacheAnalysisJobs
&InstanceId=r-bp18ff4a195d****
&Region=cn-shanghai
&StartTime=1596177993000
&EndTime=1596177993000
&PageNo=1
&PageSize=10
&<Common request parameters>成功レスポンスの例
XML 形式
<DescribeCacheAnalysisJobsReponse>
<RequestId> B6D17591-B48B-4D31-9CD6-9B9796B2xxxx</RequestId>
<Message>Successful</Message>
<Data>
<Extra>None</Extra>
<PageSize>10</PageSize>
<Total>2</Total>
<PageNo>1</PageNo>
<List>
<CacheAnalysisJob>
<NodeId>r-xxxxx-db-0</NodeId>
<Message>Successful</Message>
<InstanceId>r-bp18ff4a195dxxxx</InstanceId>
<TaskState>BACKUP</TaskState>
<JobId>xxxx-xxxx-xxxx-xxxx</JobId>
</CacheAnalysisJob>
<CacheAnalysisJob>
<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>
</CacheAnalysisJob>
</List>
</Data>
<Code>200</Code>
<Success>true</Success>
</DescribeCacheAnalysisJobsReponse>JSON 形式
{"RequestId":" B6D17591-B48B-4D31-9CD6-9B9796B2xxxx","Message":"Successful","Data":{"Extra":"None","PageSize":"10","Total":"2","PageNo":"1","List":{"CacheAnalysisJob":[{"NodeId":"r-xxxxx-db-0",
"Message":"Successful",
"InstanceId":"r-bp18ff4a195dxxxx",
"TaskState":"BACKUP",
"JobId":"xxxx-xxxx-xxxx-xxxx"},{
"BigKeys":{
"KeyInfo":[{
"Bytes":"12345",
"Type": "hash",
"NodeId":"r-xxxx-db-0",
"ExpirationTimeMillis":"1596256542547",
"Encoding":"hashtable",
"Count":"127",
"Key":"task_xxxxx",
"Db":"0"}]}}]}},
"Code":"200",
"Success":"true"}エラーコード
エラーコードリストについては、「API エラーセンター」をご参照ください。