DescribeDBInstanceSwitchLog を使用した主備切り替えログのクエリ - MongoDB

ApsaraDB for MongoDB インスタンスのプライマリ/セカンダリのスイッチオーバーログを照会します。

操作説明

この操作を呼び出す前に、ApsaraDB for MongoDB インスタンスが次の要件を満たしていることを確認してください：

インスタンスはレプリカセットインスタンスまたはシャードクラスターインスタンスであること。
インスタンスは、データの保存にローカル物理ディスクを使用していること。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dds:DescribeDBInstanceSwitchLog

list

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
StartTime	string	任意	照会する時間範囲の開始時刻。時間は ISO 8601 標準に準拠した yyyy-mm-ddThh:mmZ 形式で指定する必要があります。時刻は UTC である必要があります。	2023-05-27T02:46Z
EndTime	string	任意	照会する時間範囲の終了時刻。時間は ISO 8601 標準に準拠した yyyy-mm-ddThh:mmZ 形式で指定する必要があります。時刻は UTC である必要があります。終了時刻は開始時刻より後である必要があります。	2023-05-28T02:00Z
PageNumber	integer	任意	返すページ番号。値は 0 より大きく、integer データ型でサポートされる最大値以下の整数である必要があります。デフォルト値：1。	1
PageSize	integer	任意	各ページに返すエントリ数。有効な値：30、50、100。デフォルト値：30。	30
DBInstanceId	string	任意	インスタンス ID。	dds-uf68f1b5a57exxxx

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
RequestId	string	リクエスト ID。	ECBCA991-XXXX-XXXX-834C-B3E8007F33AA
DBInstanceId	string	インスタンス ID。	dds-uf68f1b5a57exxxx
TotalCount	integer	プライマリ/セカンダリのスイッチオーバーエントリの数。	1
PageSize	integer	各ページで返されるエントリ数。	30
PageNumber	integer	返されたページ番号。	1
LogItems	array<object>	プライマリ/セカンダリのスイッチオーバーログ。
	object
SwitchStatus	string	スイッチオーバーのステータス。有効な値：1 および 0。値 1 はプライマリ/セカンダリのスイッチオーバーが成功したことを示し、値 0 はプライマリ/セカンダリのスイッチオーバーが失敗したことを示します。	1
SwitchTime	string	プライマリ/セカンダリのスイッチオーバーが実行された時点。時刻は ISO 8601 標準に準拠した yyyy-mm-ddThh:mm:ssZ 形式で、UTC で表示されます。	2023-02-07T18:00:00Z
SwitchCode	string	プライマリ/セカンダリのスイッチオーバーの理由を示すコード。有効な値： USER_CONSOLE_OPERATION：スイッチオーバーは手動で実行されます。 OPERATION_AND_MAINTENANCE：潜在的なリスクが存在します。 MACHINE_DOWNTIME：ホストがオフラインです。 PRIMARY_UNHEALTHY：インスタンスのプライマリノードで例外が発生しました。 SECONDARY_UNHEALTHY：インスタンスのセカンダリノードで例外が発生しました。 MULTIPLE_NODE_FAILURES：インスタンスの複数のノードで例外が発生しました。	USER_CONSOLE_OPERATION
NodeId	string	レプリカセットインスタンスの ID、またはプライマリ/セカンダリのスイッチオーバーが実行されたノードの ID。	当实例为副本集实例：dds-uf68f1b5a57exxxx。当实例为分片集实例：d-uf652b73f554xxxx

例

成功レスポンス

JSONJSON

{
  "RequestId": "ECBCA991-XXXX-XXXX-834C-B3E8007F33AA",
  "DBInstanceId": "dds-uf68f1b5a57exxxx",
  "TotalCount": 1,
  "PageSize": 30,
  "PageNumber": 1,
  "LogItems": [
    {
      "SwitchStatus": "1",
      "SwitchTime": "2023-02-07T18:00:00Z",
      "SwitchCode": "USER_CONSOLE_OPERATION",
      "NodeId": "当实例为副本集实例：dds-uf68f1b5a57exxxx。\n当实例为分片集实例：d-uf652b73f554xxxx"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParameterCombination	The end time must be greater than the start time

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

変更履歴

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