FailoverDBCluster で手動フェールオーバーを実行 - PolarDB - Alibaba Cloud - PolarDB

PolarDB クラスターの手動によるプライマリ/セカンダリスイッチオーバーを実行します。読み取り専用ノードを新しいプライマリノードとして指定できます。

今すぐお試しください

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

update

*DBクラスター。

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスター ID。	pc-**************
TargetDBNodeId	string	任意	プライマリノードに昇格させるノードの ID。このパラメーターを空のままにすると、システムが自動的にノードを選出します。 DescribeDBClusters 操作を呼び出して、ノード ID などの情報をクエリできます。説明プライマリノードの自動選出: システムは、選出の対象となるすべての読み取り専用ノードを識別します。システムは、優先度が最も高い 1 つ以上の読み取り専用ノードを選択します。ネットワークの問題や異常なレプリケーションステータスなどの理由で最初のノードへのスイッチオーバーが失敗した場合、システムはスイッチオーバーが成功するまで次のノードへの切り替えを試みます。このパラメーターは、クラスターが PolarDB for PostgreSQL (Oracle 互換) または PolarDB for PostgreSQL クラスターの場合に必須です。クラスターが PolarDB for MySQL クラスターの場合は省略可能です。	pi-***********
RollBackForDisaster	boolean	任意	フェールオーバー後に元のプライマリゾーンに切り戻すかどうかを指定します。有効な値: true: 元のプライマリゾーンに切り戻します。 false: 元のプライマリゾーンに切り戻しません。	false
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用して値を生成できます。異なるリクエスト間で値が一意であることを確認する必要があります。トークンは大文字と小文字が区別され、長さは 64 ASCII 文字以下である必要があります。	6000170000591aed949d0f54a343f1a4233c1e7d1c5******
TargetZoneType	string	任意	プライマリ/セカンダリスイッチオーバーをプライマリゾーン内で実行するかどうかを指定します。有効な値: Primary: プライマリ/セカンダリスイッチオーバーはプライマリゾーン内で実行されます。 Standby: スイッチオーバーはホットスタンバイストレージクラスターに対して実行されます。列挙値: Primary : プライマリゾーン内でのプライマリ/セカンダリスイッチオーバー。 Standby : ホットスタンバイストレージクラスターへのスイッチオーバー。	Primary

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	D0CEC6AC-7760-409A-A0D5-E6CD86******

例

成功レスポンス

JSONJSON

{
  "RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD86******"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	HaStatusNotSupport	Current DB instance HA status does not support this operation.	インスタンスの高可用性ステータスでは、この操作に対応していません。
400	InvalidDBNodeId.Malformed	The specified parameter DBNodeId is not valid.	指定された DBNodeId パラメーターは無効です。
400	InvalidDBType.Malformed	The Specified DBType is not valid.	指定されたデータベースタイプは無効です。
400	UnsupportHighFrequenceSwitchOver	The instance has switch over too frequent within ten minutes.	スイッチオーバーの頻度が高すぎます。5 分後にもう一度お試しください。
400	UnsupportWitchUnhealthyReplication	The action is unsupported with unhealthy replication.	現在のレプリケーション関係が異常です。スイッチオーバーはサポートされていません。
403	OperationDenied.DBNodeType	The operation is not permitted due to type of node.	ノードタイプでこの操作が許可されていないため、操作に失敗しました。
403	OperationDenied.ClusterCategory	The operation is not permitted due to cluster category.	このクラスターでは、このプロダクトシリーズはサポートされていません。
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	操作に失敗しました。指定されたクラスターインスタンス ID が存在しません。
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	指定された DBClusterId がレコードに存在しません。

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

変更履歴

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