DeleteInstances - ApsaraDB for OceanBase (Deprecated) - Alibaba Cloud ドキュメントセンター

操作説明

この API を呼び出す前に、次の要件が満たされていることを確認してください。

クラスターが Running 状態であること。
クラスターがプライマリークラスターであり、課金方法が従量課金であること。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

oceanbase:DeleteInstances

delete

*Instance

acs:oceanbase:{#regionId}:{#accountId}:instance/{#instanceId}/*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceIds	string	必須	削除するクラスターの ID。値は JSON フォーマットの文字列です。	["ob317v4uif**","ob627v4uif**"]
BackupRetainMode	string	任意	クラスター削除時のバックアップ保持戦略。有効な値： receive_all：すべてのバックアップセットを保持します。 delete_all：すべてのバックアップセットを削除します。 receive_last：最後のバックアップセットを保持します。説明デフォルト値： delete_all。	delete_all
DryRun	boolean	任意	リクエストに対してドライランのみを実行するかどうかを指定します。デフォルト値： false。有効な値： true：ドライランリクエストのみが送信され、インスタンスは削除されません。ドライランが成功すると、DryRunResult=true が返されます。ドライランが失敗すると、エラーコードが返されます。 false：実際のリクエストが送信され、ドライランは実行されません。要件が満たされている場合、インスタンスが削除されます。DryRun を false に設定した場合、DryRunResult パラメーターにはデフォルトで false が返されます。	false

レスポンスフィールド

フィールド	型	説明	例
	object	リクエストの戻り結果。
RequestId	string	リクエストの ID。	EE205C00-30E4-**-**-87E3A8A2AA0C
Data	object	レスポンスデータ。
DryRunResult	boolean	ドライランリクエストの結果。 DryRun パラメーターが true に設定され、ドライランが成功した場合、DryRunResult パラメーターは true を返します。それ以外の場合は、エラーコードが返されます。 DryRun パラメーターが false に設定されている場合、ドライランは実行されず、DryRunResult パラメーターは false を返します。	false

例

成功レスポンス

JSONJSON

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Data": {
    "DryRunResult": false
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	BadRequest	BadRequest
500	InternalServerError	InternalServerError
404	InstanceStatus.Invalid	InstanceStatus.Invalid
404	StandbyInstance.StillOnline	StandbyInstance.StillOnline
404	UnknownError	UnknownError
404	Tenant.StillOnline	Tenant.StillOnline
404	ServiceTemporarilyUnavailable	ServiceTemporarilyUnavailable
404	NotFound	NotFound

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

変更履歴

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