この API を呼び出して、MongoDB インスタンスの primary ノードと secondary ノードを切り替えることができます。
この API を呼び出す際に、インスタンスは実行中の状態にある必要があります。
注
- この API は、レプリカセットインスタンスと共有クラスタインスタンスの両方をサポートします。 SwitchDBInstanceHA は、スタンドアロンインスタンスでは実行できません。
- レプリカセットインスタンスでは、インスタンス間で切り替えが実行されます。 シャードクラスターインスタンスでは、シャード間で切り替えが実行されます。
デバッグ
OpenAPI Explorer は API の使用を簡素化します。 OpenAPI Explorer を使用して、API の取得、API の呼び出し、SDK サンプルコードの動的生成などのデバッグ操作を実行できます。
リクエストパラメータ
| パラメータ | データ型 | 必須 | 例 | 説明 |
|---|---|---|---|---|
| Action | String | はい | SwitchDBInstanceHA |
実行する操作。 値をSwitchDBInstanceHA に設定します。 |
| DBInstanceId | String | はい | dds-bpxxxxxxxx |
インスタンス ID。 |
| NodeId | String | いいえ | d-bpxxxxxxxx |
シャードクラスターインスタンス内の Shard の ID。 注 DBInstanceId に指定された値がシャードクラスターインスタンスの ID である場合、このパラメーターを指定する必要があります。 それ以外の場合、このパラメーターを無視していただいてかまいません.
|
| AccessKeyId | String | いいえ | LTAIgbTGpxxxxxx |
Alibaba Cloud から提供された AccessKey ID。 |
レスポンスパラメータ
| パラメータ | タイプ | 例 | 説明 |
|---|---|---|---|
| RequestId | String | 26BD4E5F-BDB4-47BA-B232-413AA78CFA8F |
リクエスト ID。 |
例
リクエストの例
http(s)://mongodb.aliyuncs.com/? Action=SwitchDBInstanceHA
&DBInstanceId=dds-bpxxxxxxxx
&<Common request parameters>
Successful response examples
XML 形式
<SwitchDBInstanceHAResponse>
<RequestId>26BD4E5F-BDB4-47BA-B232-413AA78CFA8F</RequestId>
</SwitchDBInstanceHAResponse>
JSON 形式
{
"RequestId":"26BD4E5F-BDB4-47BA-B232-413AA78CFA8F"
}