機能の概要
このAPIは、読み取り専用レプリカインスタンスを削除するために使用されます。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理をご参照ください。
リクエストパス
DELETE /api/v2/instances/{instanceId}/readonlyInstance
リクエストパラメータ
Path
名前 |
型 |
必須 |
説明 |
例 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBaseクラスタID | obcluster-***** |
Query
名前 |
型 |
必須 |
説明 |
例 |
|---|---|---|---|---|
| requestId | String | はい | リクエストID。追跡に使用されます | dc302d76-66b5-48d8-ab53-a035******** |
Header
名前 |
型 |
必須 |
説明 |
例 |
|---|---|---|---|---|
| X-Ob-Project-Id | String | はい | プロジェクトID | hxq3ztx3377nby3v87ry**** |
Body
名前 |
型 |
必須 |
説明 |
例 |
|---|---|---|---|---|
| readonlyInstanceId | String | はい | 読み取り専用レプリカインスタンスID | obroxxx |
| dryRun | Boolean | いいえ | プリチェックの有無 | false |
戻り値
名前 |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| success | boolean | リクエストが成功したかどうか。 | true/false |
| requestId | String | trace | dc302d76-66b5-48d8-ab53-a035********（64ビット） |
例
リクエスト例
curl --digest -u '<Your AK:SK>' \
-X DELETE \
-H 'X-Ob-Project-Id: {projectId}' \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/readonlyInstance?requestId={requestId}' \
--data '{
"readonlyInstanceId": "obroxxx",
"dryRun": false
}'
レスポンス例
リクエスト成功時のレスポンス例：
{
"data":{},
"success" : true,
"requestId": "dc302d76-66b5-48d8-ab53-a035********"
}
リクエスト失敗時のレスポンス例：
{
"errorCode": "Params.InstanceName.Invalid",
"errorMessage": "クラスタ名の検証に失敗しました",
"requestId": "cb32942e-bdf2-4d85-a26f-6bf8********",
"success": false
}