DescribeGroupUser - App Streaming - Alibaba Cloud ドキュメントセンター

グループメンバーをクエリします。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ecd:DescribeGroupUser

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
GroupId	string	任意	ユーザーグループの ID。	ug-12341234****
BizType	string	任意	説明このパラメーターは公開されていません。	ENTERPRISE
SolutionId	string	任意	説明このパラメーターは公開されていません。	co-0esnf80jab***
MaxResults	integer	任意	1 ページあたりに返すエントリ数。	10
NextToken	string	任意	次のクエリのトークン。この操作を前回呼び出した際のレスポンスから取得できます。	AAAAAV3MpHK****
Filter	string	任意	一般ユーザーのユーザー名 (EndUserId) とメールアドレス (Email) に一致するあいまい検索文字列。	user
BusinessChannel	string	任意	チャネル	ENTERPRISE

レスポンスフィールド

フィールド	型	説明	例
	object	返された結果。
RequestId	string	リクエスト ID。	AA8D67CB-345D-5CDA-986E-FFAC7D0****
Groups	array<object>	説明このフィールドは非推奨です。
	object	ユーザーグループに関する情報。
GroupName	string	ユーザーグループの名前。	开发组
GroupId	string	ユーザーグループ ID。	ug-91mvbosdjsdfh****
UserCount	string	ユーザーグループのメンバー数。	1
Users	array<object>	メンバー。
	object	メンバーに関する情報。
EndUserId	string	ユーザー名。	alex****
Avatar	string	説明このフィールドは非推奨です。	https://avatar.****.com
Address	string	説明このフィールドは非推奨です。	xx-xx-xx
Phone	string	携帯電話番号。	138****1111
Email	string	メールアドレス。	alex****@example.com
NickName	string	表示名。	alex
JobNumber	string	説明このフィールドは非推奨です。	123
GmtJoinGroup	string	ユーザーがユーザーグループに追加された時刻。	2024-08-26T02:59:22.000+00:00
GmtCreated	string	ユーザーが作成された時刻。	2024-08-26T02:59:22.000+00:00
Remark	string	ユーザーに関する備考。	remark
NextToken	string	次のクエリのトークン。このパラメーターが空の場合、すべての結果が返されたことを示します。	AAAAAV3MpHK****

例

成功レスポンス

JSONJSON

{
  "RequestId": "AA8D67CB-345D-5CDA-986E-FFAC7D0****",
  "Groups": [
    {
      "GroupName": "开发组",
      "GroupId": "ug-91mvbosdjsdfh****",
      "UserCount": "1"
    }
  ],
  "Users": [
    {
      "EndUserId": "alex****",
      "Avatar": "https://avatar.****.com",
      "Address": "xx-xx-xx",
      "Phone": "138****1111",
      "Email": "alex****@example.com",
      "NickName": "alex",
      "JobNumber": "123",
      "GmtJoinGroup": "2024-08-26T02:59:22.000+00:00",
      "GmtCreated": "2024-08-26T02:59:22.000+00:00",
      "Remark": "remark"
    }
  ],
  "NextToken": "AAAAAV3MpHK****"
}

エラーコード

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

変更履歴

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