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

update

*dbcluster

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスターの ID。	pc-**************
TargetDBNodeId	string	任意	プライマリノードに昇格させる読み取り専用ノードの ID。 DescribeDBClusters 操作を呼び出して、ノード ID などのノード情報をクエリできます。説明このパラメーターを空のままにした場合、システムはフェールオーバーの優先度が最も高い 1 つ以上の利用可能な読み取り専用ノードを候補のプライマリノードとして選択します。ネットワークの問題、レプリケーションステータスの異常、またはその他の理由で最初の読み取り専用ノードへのフェールオーバーが失敗した場合、システムはフェールオーバーが成功するまで、次の読み取り専用ノードへのアプリケーションのフェールオーバーを試みます。このパラメーターは、PolarDB for Oracle および PolarDB for PostgreSQL クラスターでは必須です。 PolarDB for MySQL クラスターではオプションです。	pi-***********
RollBackForDisaster	boolean	任意	元のプライマリゾーンが回復したときに、サービスを元のプライマリゾーンに切り替えるかどうかを指定します。 true false	false
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアントを使用して値を生成できますが、異なるリクエスト間で一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。トークンでは大文字と小文字が区別されます。	6000170000591aed949d0f54a343f1a4233c1e7d1c5******
TargetZoneType	string	任意	プライマリアベイラビリティゾーン内でのプライマリ/スタンバイ切り替えであるかどうかを指定します。値は次のとおりです： 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.
400	InvalidDBType.Malformed	The Specified DBType is not valid.
400	UnsupportHighFrequenceSwitchOver	The instance has switch over too frequent within ten minutes.
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.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.

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

変更履歴

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