DescribeHistoryTasksStat - 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:DescribeHistoryTasksStat

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	対象となる未処理イベントのリージョン ID です。最新のリージョン一覧を照会するには、DescribeRegions 操作を呼び出してください。	cn-beijing
Status	string	任意	タスクの状態です。有効な値は以下のとおりです。 Scheduled Running Succeed Failed Cancelling Canceled Waiting 説明このパラメーターはデフォルトで空欄です。これは、すべての状態のタスクを照会することを意味します。複数の状態を指定する場合は、カンマ (,) で区切ってください。	Scheduled
InstanceId	string	任意	インスタンス ID です。	r-bp1zxszhcgatnx****
TaskId	string	任意	タスク ID です。このパラメーターを指定すると、特定のタスクを照会できます。デフォルトでは空欄であり、すべてのタスクを照会することを意味します。複数のタスク ID を指定する場合は、カンマ (,) で区切ってください。最大 30 個まで指定可能です。	t-0mq1yyhm3ffl2bxxxx
TaskType	string	任意	タスクの種類です。	all
FromStartTime	string	必須	照会対象の期間の開始時刻です。時間は協定世界時 (UTC) で指定し、yyyy-MM-ddThh:mmZ の形式で記述してください。	2022-01-02T11:31:03Z
ToStartTime	string	必須	照会対象の期間の終了時刻です。時間は協定世界時 (UTC) で指定し、yyyy-MM-ddThh:mmZ の形式で記述してください。	2022-02-02T11:31:03Z
FromExecTime	integer	任意	タスクの最小実行時間です。このパラメーターを使用して、実行時間が最小実行時間を超えるタスクをフィルター処理します。単位は秒です。デフォルト値は 0 です。この値は、最小実行時間に制限がないことを意味します。	0
ToExecTime	integer	任意	タスクの最大実行時間です。このパラメーターを使用して、実行時間が最大実行時間以下であるタスクをフィルター処理します。単位は秒です。デフォルト値は 0 です。この値は、最小実行時間に制限がないことを意味します。	0

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマです。
RequestId	string	リクエスト ID です。	ABAF95F6-35C1-4177-AF3A-70969EBD****
Items	array<object>	タスクの一覧です。
	object	タスクです。
Status	string	タスクの状態です。 Scheduled Running Succeed Failed Cancelling Canceled Waiting	Scheduled
TotalCount	integer	タスクの合計数です。	10

例

成功レスポンス

JSONJSON

{
  "RequestId": "ABAF95F6-35C1-4177-AF3A-70969EBD****",
  "Items": [
    {
      "Status": "Scheduled",
      "TotalCount": 10
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	Param.Invalid	Param invalid
400	Param.Invalid.TimeEndBeforeStart	Param invalid. End time before start time

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

変更履歴

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