すべてのプロダクト
Search
ドキュメントセンター

PolarDB:DescribeHistoryTasksStat

最終更新日:Sep 19, 2025

Task Hub のタスク統計をクエリします。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

polardb:DescribeHistoryTasksStat

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionId

string

必須

リージョン ID。

cn-beijing

Status

string

任意

タスクのステータス。有効値:

  • Scheduled: タスクは実行を待っています。

  • Running: タスクは実行中です。

  • Succeed: タスクは成功しました。

  • Cancelling: タスクはキャンセル中です。

  • Canceled: タスクはキャンセルされました。

  • Waiting: タスクはスケジュールされた時刻を待っています。

複数のステータスのタスクをクエリするには、ステータスをコンマ (,) で区切ります。このパラメーターを空のままにすると、すべてのステータスのタスクがクエリされます。

Running

InstanceId

string

任意

インスタンス ID。これは ins_name パラメーターに対応します。最大 30 個のインスタンス ID を指定できます。複数の ID はコンマ (,) で区切ります。

pc-2zed3m89cw***

TaskId

string

任意

タスク ID。最大 30 個のタスク ID を指定できます。複数の ID はコンマ (,) で区切ります。このパラメーターを空のままにすると、このパラメーターはフィルターとして使用されません。

ec8c4723-eac5-4f12-becb-01ac08******

TaskType

string

任意

タスクのタイプ。このパラメーターは、特定のタイプのタスクをクエリするために使用されます。最大 30 個のタスクタイプを指定できます。複数のタイプはコンマ (,) で区切ります。このパラメーターを空のままにすると、このパラメーターはフィルターとして使用されません。

DatabaseProxyUpgrading

FromStartTime

string

必須

クエリする時間範囲の開始時刻。時間は yyyy-MM-ddTHH:mm:ssZ フォーマットで指定します。時間は UTC である必要があります。

2025-01-02T11:31:03Z

ToStartTime

string

必須

クエリする時間範囲の終了時刻。時間は yyyy-MM-ddTHH:mm:ssZ フォーマットで指定します。時間は UTC である必要があります。

2025-01-03T12:31:03Z

FromExecTime

integer

任意

最小実行時間。クエリは、この値より大きい実行時間のタスクを返します。単位: 秒。

0

ToExecTime

integer

任意

最大実行時間。クエリは、この値以下の実行時間のタスクを返します。単位: 秒。

10

ResourceGroupId

string

任意

リソースグループ ID。

rg-************

レスポンスフィールド

フィールド

説明

object

応答スキーマ。

RequestId

string

リクエスト ID。

45D24263-7E3A-4140-9472-************

Items

array<object>

タスクのリスト。

object

タスクの詳細。

Status

string

タスクのステータス。

  • Scheduled: タスクは実行を待っています。

  • Running: タスクは実行中です。

  • Succeed: タスクは成功しました。

  • Failed: タスクは失敗しました。

  • Cancelling: タスクはキャンセル中です。

  • Canceled: タスクはキャンセルされました。

  • Waiting: タスクはスケジュールされた時刻を待っています。

Running

TotalCount

integer

レコードの総数。

13

成功レスポンス

JSONJSON

{
  "RequestId": "45D24263-7E3A-4140-9472-************",
  "Items": [
    {
      "Status": "Running",
      "TotalCount": 13
    }
  ]
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 Param.Invalid The parameter is invalid.
400 Param.Invalid.TimeEndBeforeStart Param Invalid.End time before start time.

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

変更履歴

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