PolarDB 管理タスク履歴の DescribeHistoryTasks API 概要 - PolarDB - Alibaba Cloud - PolarDB

PolarDB for MySQL の履歴タスクリストを照会します。

今すぐお試しください

この 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:DescribeHistoryTasks

get

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョン ID。説明 DescribeRegions 操作を呼び出してリージョン情報を照会できます。	cn-beijing
PageSize	integer	任意	1 ページあたりのエントリ数。有効な値: 10 ~ 100。デフォルト値: 10。	10
PageNumber	integer	任意	クエリ結果のページ番号。有効な値: 正の整数。デフォルト値: 1。	1
InstanceType	string	任意	現在、Instance のみがサポートされています。	Instance
Status	string	任意	タスクのステータス。有効な値: Scheduled: 実行待ち。 Running: 実行中。 Succeed: 成功。 Cancelling: キャンセル中。 Canceled: キャンセル済み。 Waiting: スケジュール時刻の待ち。複数のステータスを指定する場合は、コンマ (,) で区切ります。デフォルト値: 空 (すべてのステータスを示します)。	Running
InstanceId	string	任意	リソース ID。このパラメーターを指定して、対応するリソースのタスクをクエリします。複数の ID を指定する場合は、コンマ (,) で区切ります。最大 30 個の ID がサポートされています。デフォルト値: 空 (制限なしを示します)。説明現在、クラスター ID のみがサポートされています。	pc-2zed3m89cw***
TaskId	string	任意	タスク ID。複数のタスク ID を指定する場合は、コンマ (,) で区切ります。最大 30 個の ID がサポートされています。デフォルト値: 空 (制限なしを示します)。	t-0mqi38ho0cgjv***
TaskType	string	任意	タスクタイプ。このパラメーターを指定して、特定のタイプのタスクをクエリします。複数のタイプを指定する場合は、コンマ (,) で区切ります。最大 30 個のタイプがサポートされています。デフォルト値: 空 (制限なしを示します)。	ChangeVariable
FromStartTime	string	必須	タスクの開始時刻の時間範囲の開始時刻。開始時刻がこの時刻より後のタスクがクエリされます。時刻は ISO 8601 規格の `yyyy-MM-ddTHH:mm:ssZ` フォーマットで指定します。時刻は `協定世界時 (UTC)+0` である必要があります。サポートされる最も早い時刻は、現在の呼び出し時刻の 30 日前です。30 日より前の値は、自動的に現在の呼び出し時刻の 30 日前に変換されます。	2025-01-02T11:31:03Z
ToStartTime	string	必須	タスクの開始時刻の時間範囲の終了時刻。開始時刻がこの時刻より前のタスクがクエリされます。時刻は ISO 8601 規格の `yyyy-MM-ddTHH:mm:ssZ` フォーマットで指定します。時刻は `協定世界時 (UTC)+0` である必要があります。	2025-01-03T11:31:03Z
FromExecTime	integer	任意	実行時間の最小値。実行時間がこの値より大きいタスクをフィルター処理します。単位: 秒。デフォルト値: 0 (制限なしを示します)。	0
ToExecTime	integer	任意	実行時間の最大値。実行時間がこの値以上のタスクをフィルター処理します。単位: 秒。デフォルト値: 0 (制限なしを示します)。	0
ResourceGroupId	string	任意	リソースグループ ID。	rg-************

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
PageNumber	integer	クエリ結果のページ番号。	1
RequestId	string	リクエスト ID。	F90D7C14-2D1C-5B88-9CD1-23AB2CF89***
PageSize	integer	1 ページあたりのエントリ数。	10
TotalCount	string	ページネーションに関係なく、フィルター条件を満たすタスクの総数。	2
Items	array<object>	タスクリスト。
	object	タスクオブジェクト。
Status	string	タスクのステータス。 Scheduled: 実行待ち。 Running: 実行中。 Succeed: 成功。 Failed: 失敗した。 Cancelling: キャンセル中。 Canceled: キャンセル済み。 Waiting: スケジュール時刻の待ち。	Succeed
TaskId	string	タスク ID。	t-0mqt8qhnw04ipz0***
CurrentStepName	string	現在実行中のステップの名前。空の値は、タスクが開始されていないことを示します。	タスクの完了
StartTime	string	タスクの開始時刻。時刻は ISO 8601 規格の YYYY-MM-DDTHH:mm:ssZ フォーマットです。時刻は協定世界時 (UTC) で表示されます。	2025-03-03T07:25:16Z
EndTime	string	タスクの終了時刻。時刻は ISO 8601 規格の YYYY-MM-DDTHH:mm:ssZ フォーマットです。時刻は協定世界時 (UTC) で表示されます。	2025-03-03T07:30:57Z
TaskType	string	タスクタイプ。	ChangeVariable
RemainTime	integer	推定残り実行時間。単位: 秒。説明この値はリファレンス用です。実際の実行時間は異なる場合があります。	0
Progress	number	現在の進捗状況。	100.0
RegionId	string	リージョン ID。	cn-beijing
InstanceType	string	リソースタイプ。	Instance
InstanceId	string	リソース ID。	pc-2zed3m89cw***
InstanceName	string	リソース名。	pc-2zed3m89cw***
DbType	string	データベースタイプ。	polardb_mysql
Product	string	プロダクト。	polardb
TaskDetail	string	タスク詳細。	{"steps":[{"step_name":"ステップ1: タスクの初期化"},{"step_name":"ステップ2: タスクの実行"},{"step_name":"ステップ3: タスクの完了"}]}
ReasonCode	string	現在のタスクが開始された理由。	""
ActionInfo	string	許可された操作情報。説明この特徴はサポートされていません。	{}
Uid	string	リソースが属するユーザーの ID。	1816563541899***
CallerSource	string	リクエストソース。有効な値: System: システム。 User: ユーザー。	User
CallerUid	string	リクエストユーザーの ID。CallerSource が User に設定されている場合、この値はユーザー UID を表します。	1816563541899***

例

成功レスポンス

JSONJSON

{
  "PageNumber": 1,
  "RequestId": "F90D7C14-2D1C-5B88-9CD1-23AB2CF89***",
  "PageSize": 10,
  "TotalCount": "2",
  "Items": [
    {
      "Status": "Succeed",
      "TaskId": "t-0mqt8qhnw04ipz0***",
      "CurrentStepName": "finish_task",
      "StartTime": "2025-03-03T07:25:16Z",
      "EndTime": "2025-03-03T07:30:57Z",
      "TaskType": "ChangeVariable",
      "RemainTime": 0,
      "Progress": 100,
      "RegionId": "cn-beijing",
      "InstanceType": "Instance",
      "InstanceId": "pc-2zed3m89cw***",
      "InstanceName": "pc-2zed3m89cw***",
      "DbType": "polardb_mysql",
      "Product": "polardb",
      "TaskDetail": "{\\\"steps\\\":[{\\\"step_name\\\":\\\"init_task\\\"},{\\\"step_name\\\":\\\"exec_task\\\"},{\\\"step_name\\\":\\\"finish_task\\\"}]}",
      "ReasonCode": "\"\"",
      "ActionInfo": "{}",
      "Uid": "1816563541899***",
      "CallerSource": "User",
      "CallerUid": "1816563541899***"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	Param.Invalid	The parameter is invalid.	パラメーターが無効です。

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

変更履歴

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