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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

polardb:DescribePendingMaintenanceAction

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Region	string	必須	未処理イベントのリージョン ID。 DescribeRegions 操作を呼び出して、PolarDB でサポートされているリージョンとゾーンを照会できます。説明このパラメーターを all に設定すると、アカウント内のすべての未処理イベントを表示できます。 `Region` を all に設定する場合は、`TaskType` も all に設定する必要があります。	all
TaskType	string	必須	未処理イベントのタスクタイプ。有効な値： DatabaseSoftwareUpgrading：データベースソフトウェアのアップグレード DatabaseHardwareMaintenance：ハードウェアのメンテナンスとアップグレード DatabaseStorageUpgrading：データベースストレージのアップグレード DatabaseProxyUpgrading：プロキシのマイナーバージョンアップグレード all：上記のすべてのタイプの未処理イベントの詳細を照会します。説明 `Region` パラメーターを all に設定する場合、`TaskType` パラメーターも all に設定する必要があります。	all
IsHistory	integer	任意	履歴タスクを返すかどうかを指定します。有効な値： 0：現在のタスクを返します。 1：履歴タスクを返します。デフォルト値： 0。	0
PageSize	integer	任意	1ページあたりのエントリ数。有効な値： 30、50、100。デフォルト値： 30。	30
PageNumber	integer	任意	返すページ番号。 INTEGER データ型の最大値を超えない正の整数を指定します。デフォルト値： 1。	1
ResourceGroupId	string	任意	リソースグループの ID。	rg-************

レスポンスフィールド

フィールド	型	説明	例
	object
TotalRecordCount	integer	返されたエントリの総数。	1
RequestId	string	リクエストの ID。	2F029645-FED9-4FE8-A6D3-488954******
PageSize	integer	1ページあたりのエントリ数。	30
PageNumber	integer	ページ番号。	1
Items	array<object>	タスクの詳細。
	object
Status	integer	保留中のタスクのステータス。 `IsHistory` パラメーターを 0 に設定すると、保留中のタスクのステータスが返されます。有効な値： 2：タスクの開始時刻が指定されていません。 3：タスクは保留中です。 4：タスクは実行中です。この場合、実行時間を変更することはできません。 `IsHistory` パラメーターを 1 に設定すると、履歴タスクの詳細が返されます。有効な値： 5：タスクは完了し、実行されました。 6：タスクは完了しましたが、実行に失敗しました。 7：タスクはキャンセルされました。	3
PrepareInterval	string	未処理イベントが切り替えられる前に必要な準備時間。時間は `HH:mm:ss` 形式に従います。	04:00:00
Deadline	string	タスクを実行できる期限。時刻は `yyyy-MM-ddTHH:mm:ssZ` 形式です。時刻は UTC で表示されます。	2020-06-11T15:59:59Z
DBType	string	データベースエンジンのタイプ。有効な値： MySQL PostgreSQL Oracle	MySQL
TaskType	string	未処理イベントのタイプ。	DatabaseSoftwareUpgrading
StartTime	string	タスクがバックグラウンドで実行された時刻。時刻は `yyyy-MM-ddTHH:mm:ssZ` 形式です。時刻は UTC で表示されます。	2020-06-09T18:00:00Z
DBVersion	string	データベースエンジンのバージョン。 MySQL データベースエンジンの有効な値： 5.6 5.7 8.0 PostgreSQL データベースエンジンの有効な値： 11 14 Oracle データベースエンジンの有効な値： 11	8.0
ModifiedTime	string	パラメーターが変更された時刻。時刻は `yyyy-MM-ddTHH:mm:ssZ` 形式です。時刻は UTC で表示されます。	2020-06-09T22:00:42Z
DBClusterId	string	クラスターの ID。	pc-************
Region	string	未処理イベントのリージョン ID。	cn-hangzhou
ResultInfo	string	タスクの実行結果。有効な値： manualCancel：タスクは手動でキャンセルされました。 paramCheckNotPass：タスクはパラメーターチェックに合格しませんでした。説明このパラメーターは、`Status` パラメーターの値が 6 または 7 の場合にのみ返されます。値 6 はタスクが完了したが実行に失敗したことを示し、値 7 はタスクがキャンセルされたことを示します。	manualCancel
CreatedTime	string	タスクが作成された時刻。時刻は `yyyy-MM-ddTHH:mm:ssZ` 形式です。時刻は UTC で表示されます。	2020-06-09T22:00:42Z
Id	integer	タスクの ID。	111111
SwitchTime	string	未処理イベントが切り替えられた時刻。時刻は `yyyy-MM-ddTHH:mm:ssZ` 形式です。時刻は UTC で表示されます。	2020-06-09T22:00:00Z

例

成功レスポンス

JSONJSON

{
  "TotalRecordCount": 1,
  "RequestId": "2F029645-FED9-4FE8-A6D3-488954******",
  "PageSize": 30,
  "PageNumber": 1,
  "Items": [
    {
      "Status": 3,
      "PrepareInterval": "04:00:00",
      "Deadline": "2020-06-11T15:59:59Z",
      "DBType": "MySQL",
      "TaskType": "DatabaseSoftwareUpgrading",
      "StartTime": "2020-06-09T18:00:00Z",
      "DBVersion": "8.0",
      "ModifiedTime": "2020-06-09T22:00:42Z",
      "DBClusterId": "pc-************",
      "Region": "cn-hangzhou",
      "ResultInfo": "manualCancel",
      "CreatedTime": "2020-06-09T22:00:42Z",
      "Id": 111111,
      "SwitchTime": "2020-06-09T22:00:00Z"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	RequiredParam.NotFound	Required input param is not found.

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

変更履歴

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