KillInstanceAllSession API による Redis インスタンスの全セッション終了 - DAS - Alibaba Cloud - Database Autonomy Service

操作説明

この操作は Redis エンジンにのみ適用されます。
Alibaba Cloud SDK を使用する場合、aliyun-sdk-core のバージョンが 4.3.3 より新しいことを確認してください。最新バージョンを使用してください。
DAS SDK のバージョンは 1.0.2 以降である必要があります。
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:KillInstanceAllSession

update

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ConsoleContext	string	任意	予約済みパラメーター。	None
InstanceId	string	必須	インスタンスの ID。	r-8vbcyr4sw0c4yc****

レスポンスフィールド

フィールド	型	説明	例
	object
Code	string	返される状態コード。	200
Message	string	返されるメッセージ。説明リクエストが成功した場合、Successful が返されます。リクエストが失敗した場合、エラーコードなどの例外メッセージが返されます。	Successful
Data	string	予約済みパラメーター。	None
RequestId	string	リクエスト ID。	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	リクエストが成功したかどうかを示します。有効な値: true: リクエストが成功しました。 false: リクエストが失敗しました。	true

例

成功レスポンス

JSONJSON

{
  "Code": "200",
  "Message": "Successful",
  "Data": "None",
  "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.	この操作を実行する権限がありません。

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

変更履歴

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