DescribeHALogs - PolarDB - Alibaba Cloud ドキュメントセンター

インスタンスの高可用性 (HA) ログを照会します。

操作説明

説明

Only PolarDB for MySQL supports this operation.

今すぐお試しください

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

get

*All Resource

*

なし

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスター ID。	pc-****************
DBNodeId	string	任意	ノード ID。指定した場合、指定されたノードの高可用性 (HA) スイッチオーバー Record をクエリします。 DescribeDBClusters 操作を呼び出して、アカウント配下のすべてのクラスターの詳細情報（ノード ID を含む）をクエリできます。	pi-****************
PageNumber	integer	任意	ページ番号。	1
PageSize	integer	任意	各ページで返すエントリの数。有効な値: 5～50。デフォルト値: 10。	30
StartTime	string	任意	クエリする時間範囲の開始時刻。時間は `YYYY-MM-DDThh:mm:ssZ` フォーマット（協定世界時 (UTC)）に従います。	2020-05-01T00:00Z
EndTime	string	任意	クエリする時間範囲の終了時刻。終了時刻は開始時刻より後である必要があります。時間は `YYYY-MM-DDThh:mm:ssZ` フォーマット（協定世界時 (UTC)）に従います。	2020-09-23T01:01:00Z
LogType	string	必須	ログタイプ。	HaSwitchLogList

レスポンスフィールド

フィールド	型	説明	例
	object
TotalRecords	integer	The total number of records.	160
ItemsNumbers	integer	The number of items in the log list on the current page.	10
PageNumber	integer	The page number. The value is greater than 0 and does not exceed the maximum value of the Integer data type. Default value: 1.	1
DBInstanceName	string	The instance ID.	pc-a*************
DBInstanceType	string	The instance type. Valid values: polardb_mysql_rw: read-write instance. polardb_mysql_ro: read-only instance. polardb_mysql_standby: standby instance.	polardb_mysql_rw
HaStatus	integer	Indicates whether primary/secondary switchover records exist. Valid values: 1: No 0: Yes	1
HaLogItems	array<object>	The list of primary/secondary 这里 AI 机翻使用了 failover，但代码里用了 switch，建议保持一致，都改为 swichover logs.
	object	The list of primary/secondary switchover logs.
SwitchId	string	The ID of the primary/secondary switchover log.	e571f897-9b3c-4012-9470-88333832dec4
SwitchCauseCode	string	The cause code of the switchover.	Platform.Ha.AuroraService.ManualOperations
SwitchCauseDetail	string	The cause of the switchover.	Platform.Ha.ManuallyTriggered
SwitchStartTime	string	The start time of the switchover.	2025-05-20T03:09:45Z
SwitchFinishTime	string	The end time of the switchover.	2025-05-20T03:09:56Z
RequestId	string	The request ID.	6BD9CDE4-5E7B-4BF3-9BB8-83C73E******
PageSize	integer	The number of entries returned per page. Valid values: 30 to 100. Default value: 30.	30

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.

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

変更履歴

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