DeleteStopGateway による停止したデータベースゲートウェイのメタデータ削除 - DAS

操作説明

この API を呼び出して、CreateCloudBenchTasks 操作によって作成されたストレステスト中に生成された、非アクティブなデータベースゲートウェイインスタンスのメタデータを削除します。

SDK を使用して DAS サービスを呼び出す場合、リージョンとして cn-shanghai を指定する必要があります。

説明

データベースゲートウェイは、DAS サービスに 20 秒以上ハートビートを送信していない場合、「停止済み」と見なされます。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

hdm:DeleteStopGateway

delete

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
GatewayId	string	必須	データベースゲートウェイの一意の ID。注：この ID は、DescribeCloudbenchTask API のレスポンスに含まれる `ClientGatewayId` フィールドから取得できます。	22938c83fcfbced4b4869b9695e3****

レスポンスフィールド

フィールド	型	説明	例
	object
Code	string	返されるステータスコード。	200
Message	string	返されるメッセージ。説明リクエストが成功した場合、このパラメーターは Successful を返します。リクエストが失敗した場合、このパラメーターはエラーコードなどの例外情報を返します。	Successful
Data	string	削除結果を示すステータスコード： 0：成功。メタデータは削除されました。 -1：システムエラーが発生しました。 -2：指定されたデータベースゲートウェイは存在しません。 -3：データベースゲートウェイはまだアクティブ (停止していない) であり、そのメタデータは削除できません。 -4：メタデータの削除に失敗しました。	0
RequestId	string	リクエスト ID。	FC6C0929-29E1-59FD-8DFE-70D9D41E****
Success	string	リクエストが成功したかどうかを示します： true：操作は成功です。 false：操作は失敗です。	true

例

成功レスポンス

JSONJSON

{
  "Code": "200",
  "Message": "Successful",
  "Data": "0",
  "RequestId": "FC6C0929-29E1-59FD-8DFE-70D9D41E****",
  "Success": "true"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

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

変更履歴

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