CreateKillInstanceSessionTask でアクティブセッションを自動的に終了 - DAS

操作説明

この操作は、ApsaraDB RDS for MySQL インスタンスと PolarDB for MySQL クラスターにのみ適用されます。
Alibaba Cloud SDK または Database Autonomy Service (DAS) SDK を使用してこの操作を呼び出す場合は、最新バージョンの SDK を使用することを推奨します。
SDK を使用して DAS の操作を呼び出す場合は、リージョン ID を cn-shanghai に設定する必要があります。

今すぐお試しください

この 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:CreateKillInstanceSessionTask

create

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	インスタンス ID。	rm-2ze8g2am97624****
NodeId	string	任意	ノード ID。説明データベースインスタンスが PolarDB for MySQL クラスターの場合、このパラメーターを指定する必要があります。ノード ID を指定せずに KillAllSessions を true に設定すると、システムは PolarDB for MySQL クラスター内のすべてのノードを走査し、各ノードのアクティブなセッションを終了します。	pi-bp1v203xzzh0a****
DbUser	string	必須	セッションを終了する権限を持つデータベースアカウント。	testUser
DbUserPassword	string	必須	データベースアカウントのパスワード。	testPassword
IgnoredUsers	string	任意	セッションを終了する必要がないアカウント。説明このパラメーターは JSON 配列に設定します。データベースアカウントはコンマ (,) で区切ります。例：['データベースアカウント 1','データベースアカウント 2']。	['db_user1','db_user2']
KillAllSessions	boolean	必須	すべてのセッションを終了するかどうかを指定します。 true false 説明このパラメーターを true に設定した場合、IgnoredUsers で指定されたアカウントのセッション、Alibaba Cloud の内部 O&M アカウントのセッション、および Binlog Dump セッションは終了されません。	true
SessionIds	string	任意	終了する必要があるセッションの ID。説明このパラメーターは JSON 配列に設定します。セッション ID はコンマ (,) で区切ります。例：['セッション ID 1','セッション ID 2']。KillAllSessions が true に設定されている場合、このパラメーターは有効になりません。	[10805639,10805623,10805645,10805553,10805566,10805616]

レスポンスフィールド

フィールド	型	説明	例
	object
Code	integer	返される HTTP ステータスコード。	200
Message	string	返されるメッセージ。説明リクエストが成功した場合、「Successful」が返されます。リクエストが失敗した場合、エラーコードなどのエラーメッセージが返されます。	Successful
Data	string	セッションを終了したタスクの ID。説明 PolarDB for MySQL クラスターのセッションが終了され、NodeId が空で、KillAllSessions が true に設定されている場合、タスク ID はノード数に基づいて返されます。例：["f77d535b45405bd462b21caa3ee8**", "e93ab549abb081eb5dcd5396a29b**"]。	f77d535b45405bd462b21caa3ee8****
RequestId	string	リクエスト ID。	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	boolean	リクエストが成功したかどうかを示します。有効な値： true false	true

例

成功レスポンス

JSONJSON

{
  "Code": 200,
  "Message": "Successful",
  "Data": "f77d535b45405bd462b21caa3ee8****",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": true
}

エラーコード

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

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

変更履歴

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