グループメンバーを一覧表示します。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
POST /v2/group/list_member HTTP/1.1
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| domain_id |
string |
任意 |
ドメインの ID。 |
|
| body |
object |
任意 |
リクエストボディ。 |
|
| group_id |
string |
必須 |
グループの ID。 |
3e5***2c2 |
| member_type |
string |
任意 |
一覧表示するメンバータイプ。このパラメーターを指定しない場合、API はユーザーとグループの両方を返します。
注:グループは、他の 1 つのグループのメンバーにしかなれません。 ユーザーは、複数のグループのメンバーになることができます。 |
user |
| limit |
integer |
任意 |
返される結果の最大数。値は 1 から 100 までの整数である必要があります。API は、指定された制限よりも少ない結果を返すことがあります。 |
50 |
| marker |
string |
任意 |
ページネーションマーカー。API は、マーカーの次のエントリから、結果をアルファベット順に返します。このパラメーターを指定しない場合、API はコレクションの先頭から結果を返します。 |
NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスオブジェクト。 |
||
| user_items |
array |
ユーザーのリスト。 |
|
| User |
ユーザー情報。 |
||
| group_items |
array |
グループのリスト。 |
|
| Group |
グループ情報。 |
||
| next_marker |
string |
次の結果ページを取得するためのマーカー。これ以上結果がない場合、このパラメーターは空になります。 |
NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhM1 |
例
成功レスポンス
JSONJSON
{
"user_items": [
{
"domain_id": "bj1",
"user_id": "c9b7a5aa04d14ae3867fdc886fa01da4",
"avatar": "http://aa.com/1.jpg",
"created_at": 1639762579768,
"updated_at": 1639762579768,
"email": "a@aliyunpds.com",
"nick_name": "001",
"phone": "13900001111",
"role": "user",
"status": "enabled",
"user_name": "pds",
"description": "vipuser",
"default_drive_id": "1",
"creator": "user1",
"last_login_time": 0,
"last_refresh_token_time": 0,
"user_data": {
"key": ""
}
}
],
"group_items": [
{
"domain_id": "bj1",
"group_id": "b45c0c0c373c41ec9ebb5c85a025a08f",
"group_name": "test group",
"description": "created by system",
"created_at": 1670573504600,
"updated_at": 1670573504600,
"creator": "c9b7a5aa04d14ae3867fdc886fa01da4"
}
],
"next_marker": "NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhM1"
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。