コンテンツへスキップ
API リファレンス
/
/
/
グループのリストを取得する

グループのリストを取得する

Request

プロファイルグループをページ単位で一覧します。

  • 副作用：なし。読み取り専用。バックオフを入れれば安全にリトライできます。
  • 補足：チームがグループ単位でアクセスを認可している場合、グループの付与が一切ないメンバーにはエラーではなく空のページが返ります。
Bodyapplication/json
groupNamestring(グループ名（部分一致）)required
pageNointeger(現在のページ)required
pageSizeinteger(1 ページあたりの件数)required
POST
/api/envgroup/page
curl -i -X POST \
  http://127.0.0.1:40000/api/envgroup/page \
  -H 'Content-Type: application/json' \
  -d '{
    "groupName": "132-kernel",
    "pageNo": 1,
    "pageSize": 10
  }'

Responses

成功。data.dataList は要求されたページのレコードで、一致するものがない場合は空配列です。data.total、data.current、data.pages はページング情報を示します。

Headers
any
Bodyapplication/json
codeintegerrequired

戻り結果コード0：正常。その他のコードは例外です。

msgstring or nullrequired

エラーメッセージ

dataobjectrequired
requestIdstringrequired

操作リクエストID

Response
{
  "code": 0,
  "msg": "",
  "data": {
    "current": "0",
    "dataList": [ … ],
    "pages": "0",
    "total": "0"
  },
  "requestId": ""
}