DescribeLiveMessageGroupBand によるグループミュート状態の確認 - LIVE

操作説明

この操作を呼び出す前に、CreateLiveMessageGroup 操作を呼び出してインタラクティブメッセージンググループを作成済みであることを確認してください。

QPS 制限

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

今すぐお試しください

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

get

*Rtc

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AppId	string	必須	アプリケーション ID。	demo
GroupId	string	必須	インタラクティブメッセージンググループの ID。	grouptest
DataCenter	string	任意	データセンター。 CreateLiveMessageApp 操作を呼び出してインタラクティブメッセージングアプリケーションを作成する際に指定したデータセンターと同じである必要があります。有効な値：`cn-shanghai` および `ap-southeast-1` (シンガポール)。	cn-shanghai

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
RequestId	string	リクエスト ID。	021D1FE7-2E87-16AC-9364-4E7EA47C****
GroupId	string	グループ ID。	grouptest
BannedUserList	array	グループ全体がミュートされているのではなく、個別にミュートされたユーザーのリスト。
	string	ユーザーの ID。	["uid1","uid2"]
UnbannedUserList	array	グループ全体がミュートされた際に、ミュートされなかったユーザーのリスト。
	string	ユーザーの ID。	["uid3"]
IsbannedAll	boolean	インタラクティブメッセージンググループ内のすべてのユーザーがミュートされているかどうかを示します。	false

例

成功レスポンス

JSONJSON

{
  "RequestId": "021D1FE7-2E87-16AC-9364-4E7EA47C****",
  "GroupId": "grouptest",
  "BannedUserList": [
    "[\"uid1\",\"uid2\"]"
  ],
  "UnbannedUserList": [
    "[\"uid3\"]"
  ],
  "IsbannedAll": false
}

エラーコード

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

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

変更履歴

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