機能説明
分離タスクを送信し、プライマリインスタンスとスタンバイインスタンス間の災害復旧関係を解除します。タスクは非同期で実行されます。タスクまたはインスタンスの状態で、分離が完了したかどうかを確認してください。
呼び出し方法
認証要件
このインターフェースを呼び出すには、AccessKey IDとAccessKey Secretを使用した認証が必要です。キーを取得する手順については、AccessKey管理を参照してください。
リクエストパス
POST /api/v2/instances/{instanceId}/disconnectStandbyInstance
リクエストパラメータ
Path
パラメータ |
タイプ |
必須 |
説明 |
値の例 |
|---|---|---|---|---|
| instanceId | String | はい | 権限チェックに使用されるプライマリインスタンスID。 | obcluster-source |
Body
パラメータ |
タイプ |
必須 |
説明 |
値の例 |
|---|---|---|---|---|
| instanceId | String | はい | プライマリインスタンスID。パス内のinstanceIdと一致している必要があります。 |
obcluster-source |
| targetInstanceId | String | はい | 分離対象のスタンバイインスタンスID。 | obcluster-target |
| UID | String | いいえ | ユーザーID。 | 20000600**** |
| User_ID | String | いいえ | ユーザーID。 | 20000600**** |
| requestId | String | いいえ | 追跡用のリクエストID。 | dc302d76-66b5-48d8-ab53-a035******** |
| callerType | String | いいえ | 呼び出し元のタイプ。 | sub |
| accessKeyId | String | いいえ | アクセスキーID。 | ak-xxxxx**** |
| securityToken | String | いいえ | セキュリティトークン。 | sts-token-xxxxxxxx |
| callerUid | String | いいえ | 呼び出し元のUID。 | 20000600**** |
| callerBid | String | いいえ | 呼び出し元のBID。 | xxxxxx |
| stsTokenCallerUid | String | いいえ | STSトークン呼び出し元UID。 | 20000600**** |
| stsTokenCallerBid | String | いいえ | STSトークン呼び出し元BID。 | xxxxxx |
| acceptLanguage | String | いいえ | リクエストまたはレスポンスで使用する言語。 | zh-CN |
| pageNumber | Integer | いいえ | ページ番号。 | 1 |
| pageSize | Integer | いいえ | ページサイズ。 | 10 |
| mergedCallerBid | String | いいえ | 統合後の呼び出し元の業務ID。 | xxxxxx |
戻り値
フィールド |
タイプ |
説明 |
値の例 |
|---|---|---|---|
| success | Boolean | インターフェース呼び出しが成功したかどうか。 | true |
| errorCode | String | エラーコード。 | INVALID_PARAMETER |
| errorMessage | String | エラーメッセージ。 | Invalid parameter |
| data | Object | 分離操作の結果。 | なし |
| cost | Number | 所要時間。 | 1.0 |
| server | String | サーバーアドレス。通常はOBServerノードのIPアドレスです。 | 10.0.0.10 |
| requestId | String | リクエストID。 | d04eabba**** |
| totalCount | Number | 総レコード数。 | 100.0 |
| extra | Object | 拡張情報。 | {} |
dataオブジェクトのフィールド
フィールド |
タイプ |
説明 |
値の例 |
|---|---|---|---|
| Success | Boolean | 分離リクエストが正常に送信されたかどうか。 | true |
| Message | String | 返されるメッセージ。分離リクエストが正常に送信された場合は空文字列です。 | "" |
例
リクエスト例
以下の例では、インスタンス obcluster-source からリクエストを発行し、スタンバイインスタンス obcluster-target との災害復旧関係を解除します。例中のキーとインスタンスIDを実際の値に置き換えてください。
curl --digest -u '<AccessKey ID>:<AccessKey Secret>' -X POST \
'https://api-cloud.oceanbase.com/api/v2/instances/obcluster-source/disconnectStandbyInstance' \
-H 'Content-Type: application/json' \
-d '{
"instanceId": "obcluster-source",
"targetInstanceId": "obcluster-target"
}'
レスポンス例
JSON形式
{
"success": true,
"data": {
"Success": true,
"Message": ""
},
"requestId": "d04eabba-acef-4f4b-96f1-c657876ca6f1",
"extra": {}
}