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

操作説明

この操作は、ApsaraDB RDS for MySQL および PolarDB for MySQL インスタンスにのみ適用されます。
Alibaba Cloud または DAS SDK を使用する場合は、最新バージョンを使用してください。
SDK を使用して DAS を呼び出す場合は、リージョンを 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

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	インスタンスの ID。	rm-2ze8g2am97624****
NodeId	string	任意	ノードの ID。説明 PolarDB for MySQL インスタンスの場合は、ノードの ID を指定してください。ノードの ID が指定されておらず、KillAllSessions リクエストパラメーターが true (すべてのセッションを終了) にセットされている場合、システムは PolarDB for MySQL インスタンスのすべてのノードを走査し、各ノードで進行中のセッションを終了します。	pi-bp1v203xzzh0a****
DbUser	string	必須	セッションの終了権限を持つデータベースアカウント。	testUser
DbUserPassword	string	必須	データベースアカウントのパスワード。	testPassword
IgnoredUsers	string	任意	セッションを終了しないアカウントのリスト。説明データは JSONArray フォーマットです (例: ['DatabaseAccount1','DatabaseAccount2'])。複数のデータベースアカウントはコンマ (,) で区切ります。	['db_user1','db_user2']
KillAllSessions	boolean	必須	すべてのセッションを終了するかどうかを指定します。 true: はい。 false: いいえ。説明このパラメーターが true にセットされている場合、IgnoredUsers リクエストパラメーターで指定されたアカウントのセッション、Alibaba Cloud 内部操作アカウントのセッション、および Binlog Dump セッションは終了されません。	true
SessionIds	string	任意	終了するセッション ID のリスト。説明データは JSONArray フォーマットです (例: [SessionID1,SessionID2])。複数のセッション ID はコンマ (,) で区切ります。KillAllSessions リクエストパラメーターが true (すべてのセッションを終了) にセットされている場合、このリストは無視されます。	[10805639,10805623,10805645,10805553,10805566,10805616]

レスポンスフィールド

フィールド	型	説明	例
	object
Code	integer	返される状態コード。	200
Message	string	返されるメッセージ。説明リクエストが成功した場合、Successful が返されます。リクエストが失敗した場合、エラーコードなどのエラーメッセージが返されます。	Successful
Data	string	セッションを終了するためのタスク ID。説明 NodeId リクエストパラメーターを空 (ノード ID 未指定) のままにし、KillAllSessions リクエストパラメーターを true (すべてのセッションを終了) にセットして PolarDB for MySQL インスタンスに対してこの API オペレーションを呼び出すと、ノード数に基づいてタスク 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.	この操作を実行する権限がありません。

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

変更履歴

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