この API を呼び出して、ApsaraDB for POLARDB クラスターのプライマリノードとセカンダリノードを手動で切り替えます。 読み取り専用ノードを新しいプライマリノードとして指定できます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 OpenAPI Explorer を使用すると、API を簡単に設定できます。 OpenAPI Explorer は、各種 SDK 用のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
DBClusterId String 必須 pc-xxxxxxxxxxxxxxxx

ApsaraDB for POLARDB クラスターの ID を設定します。
AccessKeyId String 任意 key-test

Alibaba Cloud から提供された AccessKey ID を設定します。
Action String 任意 FailoverDBCluster

実行する API ( FailoverDBCluster) を設定します。

ClientToken String 任意 6000170000591aed949d0f54a343f1a4233c1e7d1c5ca816bf

リクエストのべき等性を保証するために使用されるクライアントトークンを設定します。 クライアントを使用してこの値を生成できますが、異なるリクエスト間で一意とする必要があります。 トークンでは大文字と小文字が区別されます。 ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。

TargetDBNodeId String 任意 pi-xxxxxxxxxx

プライマリノードに切り替えるノードの ID を設定します。 このパラメーターを指定しない場合、システムは自動的にノードを選択します。 DescribeDBClusters を呼び出して、ノード ID などのノード情報を照会できます。

注 プライマリノードの自動選択：システムは、使用可能なすべての読み取り専用ノードから、優先度が最も高い 1 つ以上のノードを選択します。 ネットワークまたはレプリケーションの障害が原因で最初のノードに障害が発生した場合、システムは次に使用可能なノードに切り替えます。

レスポンスパラメーター

パラメーター データ型 例 説明
RequestId String D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC

リクエストの ID を示します。

例

リクエストの例


http(s)://[Endpoint]/? Action=FailoverDBCluster
&DBClusterId=pc-xxxxxxxxxxxxxxxx
&<共通リクエストパラメーター>

通常のレスポンス例

XML 形式 

<FailoverDBClusterResponse>  
	    <RequestId>D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC</RequestId>
</FailoverDBClusterResponse>

JSON 形式 

{
	"RequestId":"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC"
}

エラーコード

エラーコードのリストについては、「API エラーセンター「をご参照ください。