コンテンツへスキップ

グループを追加

Request

プロファイルグループを作成します。

  • 前提条件:名前は空でなく、100 文字以内で、チーム内の既存グループと重複しないこと。1 チームあたり 1000 グループまでです。
  • 副作用:グループを作成します。チームがグループ単位でアクセスを認可しており、呼び出し元がオーナーでない場合、呼び出し元にも新しいグループへのアクセス権が付与されます。
  • 完了シグナル:同期的です。data に新しいグループ ID が入ります。
  • リトライ:名前の重複は既存グループの再利用ではなく拒否として扱われます。したがって「実際は成功したがレスポンスを受け取れなかった」後のリトライは重複名エラーになり、それが 1 回目が成功した証拠になります。/envgroup/page で確認してください。
Bodyapplication/json
groupNamestringrequired

グループ名

POST
/api/envgroup/create
curl -i -X POST \
  http://127.0.0.1:40000/api/envgroup/create \
  -H 'Content-Type: application/json' \
  -d '{
    "groupName": "Group-333"
  }'

Responses

成功。dataidgroupName のフィールドを持つオブジェクトです。

Headers
any
Bodyapplication/json
codeintegerrequired

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

msgstring or nullrequired

エラーメッセージ

dataobjectrequired

操作によって返されたデータ

requestIdstringrequired

操作リクエストID

Response
{ "code": 0, "msg": null, "data": { "id": "1673823102599682", "groupName": "example-name" }, "requestId": "0d8b6f1c-9f4e-4d02-9d1a-7c3f5a1b2c3d" }