グループを一覧表示します。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
POST /v2/group/list HTTP/1.1
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| domain_id |
string |
必須 |
||
| body |
object |
任意 |
リクエストボディです。 |
|
| limit |
integer |
任意 |
返されるリソースの最大数です。デフォルト値は 100、最大値は 100 です。 |
100 |
| marker |
string |
任意 |
クエリの開始点を指定するページネーショントークンです。結果は、マーカーに続くアイテムからアルファベット順に返されます。このパラメーターを指定しない場合、クエリはコレクションの先頭から開始されます。 |
NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスボディです。 |
||
| items |
array |
グループオブジェクトのリストです。 |
|
| Group |
グループオブジェクトです。 |
||
| next_marker |
string |
次のページの結果を取得するために使用できるトークンです。すべての結果が取得された場合、このパラメーターは返されません。 |
NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg |
例
成功レスポンス
JSONJSON
{
"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": "NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg"
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。