DescribeInspectionTasks - Tair (Redis® OSS-Compatible) - Alibaba Cloud ドキュメントセンター

スマートインスペクションタスクのリストを照会します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

kvstore:DescribeInspectionTasks

get

*All resources.

*

なし

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PageNum	string	任意	ページ番号。	1
PageSize	string	任意	1 ページあたりのエントリ数。デフォルト値: 20。	10
InstanceId	string	必須	インスタンスの ID。	ta-bp1zxszhcgatnx****
Type	string	任意	タスクタイプ。 1: 手動タスク 2: 定期タスク	1

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID。	2D9F3768-EDA9-4811-943E-42C8006E****
Success	boolean	リクエストが成功したかどうかを示します。	true
Data	object	タスクデータ。
Items	array<object>	タスクのリスト。
	object	タスク詳細。
CreateTime	string	タスクが作成された時間。時間は、YYYY-MM-DDTHH:mm:ssZ フォーマットの協定世界時 (UTC) で表示されます。	2024-07-01T02:06:34Z
EndTime	string	タスクの終了時間。時間は、YYYY-MM-DDTHH:mm:ssZ フォーマットの協定世界時 (UTC) で表示されます。	2025-09-23T00:00:00Z
FinishTime	string	タスクの完了時間。時間は、YYYY-MM-DDTHH:mm:ssZ フォーマットの協定世界時 (UTC) で表示されます。	2026-01-09T02:13:01Z
InspectionItems	string	指定されたインスペクション項目。サポートされているインスペクション項目は次のとおりです。 RESOURCE_USAGE BIGKEY HOTKEY PERFORMANCE_METRICS SLOWLOG	PERFORMANCE_METRICS
InstanceIds	string	関連付けられたインスタンス ID のリスト。	r-uf6ns8txov3mp9jxxx
ScheduleId	string	定期タスクの ID。	sch-4dfb08ddf9f84855bacca35axxx
Source	string	タスクのソース。	scheduler\|
StartTime	string	タスクの開始時刻。時間は、YYYY-MM-DDTHH:mm:ssZ フォーマットの協定世界時 (UTC) で表示されます。	2026-05-30T02:11:01Z
Status	string	タスクのステータス。	SUCCEEDED
TaskId	string	タスクの ID。	tit-dca42f85c73644e0ab5c80ef641xxx
ReportLanguage	string	レポートの言語。	zh-CN
PageNum	integer	ページ番号。	1
PageSize	integer	1 ページあたりのエントリ数。	10
Total	integer	エントリの総数。	6

例

成功レスポンス

JSONJSON

{
  "RequestId": "2D9F3768-EDA9-4811-943E-42C8006E****",
  "Success": true,
  "Data": {
    "Items": [
      {
        "CreateTime": "2024-07-01T02:06:34Z",
        "EndTime": "2025-09-23T00:00:00Z",
        "FinishTime": "2026-01-09T02:13:01Z",
        "InspectionItems": "PERFORMANCE_METRICS",
        "InstanceIds": "r-uf6ns8txov3mp9jxxx",
        "ScheduleId": "sch-4dfb08ddf9f84855bacca35axxx",
        "Source": "scheduler|",
        "StartTime": "2026-05-30T02:11:01Z",
        "Status": "SUCCEEDED",
        "TaskId": "tit-dca42f85c73644e0ab5c80ef641xxx",
        "ReportLanguage": "zh-CN"
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "Total": 6
  }
}

エラーコード

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

変更履歴

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