RemoveTerminals API による RTC チャンネルユーザーの削除 - LIVE

操作説明

この操作を呼び出すことで、チャンネルから 1 人以上のユーザーを削除できます。

QPS 制限

1 アカウントあたり毎秒 100 回までこの操作を呼び出すことができます。この制限を超えたリクエストはドロップされ、サービスが中断されます。この操作を呼び出す際は、この制限に注意することを推奨します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

live:RemoveTerminals

none

*Rtc

acs:live:*:{#accountId}:rtc/{#AppId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AppId	string	必須	アプリケーションの ID。各リクエストで指定できるアプリケーション ID は 1 つだけです。	aec****
ChannelId	string	必須	チャネルの ID。各リクエストで指定できるチャネル ID は 1 つだけです。	testId
TerminalIds	array	必須	削除するユーザーの ID。
	string	任意	削除するユーザーの ID。 N の有効な値：1～30。フォーマット： `TerminalIds.1=** TerminalIds.2=** ......`	1811****

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID。	16A96B9A-F203-4EC5-8E43-CB92E68F4AF8
Terminals	array<object>	ユーザーに関する情報。
	object
Code	integer	返される状態コード。値が 0 の場合は、リクエストが成功したことを示します。リクエストが失敗した場合、エラーメッセージが返されます。	0
Message	string	指定されたユーザーをチャンネルから削除した結果。有効な値： Success Failed	Success
Id	string	ユーザーの ID。	1811****

例

成功レスポンス

JSONJSON

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4AF8",
  "Terminals": [
    {
      "Code": 0,
      "Message": "Success",
      "Id": "1811****"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InputInvalid	%s.
500	ServerError	%s.
403	NoAuth	%s.
404	ResourceNotExist	%s.

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

変更履歴

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