KickOutClients API を使用して SAG アプリクライアント接続を閉じる - SAG

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

smartag:KickOutClients

*SmartAccessGateway

acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	SAG アプリインスタンスがデプロイされているリージョン。	cn-shanghai
SmartAGId	string	必須	SAG アプリインスタンスの ID。	sag-ehjfb*******
Username	string	必須	クライアントアカウントのユーザー名。同じ SAG アプリインスタンスに追加されたクライアントアカウントのユーザー名は一意である必要があります。クライアントアカウントの場合、ユーザー名を指定する場合は、パスワードも指定する必要があります。	doctest

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID。	76FD7E08-6AA1-4B1B-99FB-8B3CA6C99A8E

例

成功レスポンス

JSONJSON

{
  "RequestId": "76FD7E08-6AA1-4B1B-99FB-8B3CA6C99A8E"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	ClientUser.NameEmpty	You must specify UserName.
400	SAG.InstanceNoFound	The specified SAG instance does not exist.

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

変更履歴

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