コンテンツへスキップ

グループを削除

Request

1 つ以上のプロファイルグループを削除します。

  • 前提条件:少なくとも 1 つの ID がチーム内で解決でき、呼び出し元がそれに対する権限を持つこと。解決できない ID は黙って無視されます。
  • 副作用:グループとそのメンバーアクセス権を削除します。そこに属していたブラウザープロファイルとクラウドフォンは未グループになるため、宙に浮いたグループ参照は残りません。環境も削除するフラグを立てた場合は、権限のあるプロファイルを追加でゴミ箱へ移動します — それらは破棄されず、またこのフラグはクラウドフォンには一切影響しません。
  • 完了シグナル:同期的ですが原子的ではありません。グループが先に削除され、後続のステップは依然失敗し得ます。例えばプロファイルが起動中または移管中の場合、グループは消えたのにプロファイルは移動していない状態になります。
  • リトライ:リトライ前に /envgroup/page とプロファイル一覧で確認してください。

文書化されたビジネスエラー: 19064。 各コードの意味は Error Codes を参照してください。どの操作でも共通コードが返る場合があります。

Bodyapplication/jsonrequired
idsArray of stringsrequired

更新対象グループの一意な ID

isDeleteAllEnvboolean

グループ内の環境を削除しますか?false:削除しない、true:削除する

POST
/api/envgroup/delete
curl -i -X POST \
  http://127.0.0.1:40000/api/envgroup/delete \
  -H 'Content-Type: application/json' \
  -d '{
    "ids": [
      "string"
    ]
  }'

Responses

成功。data は単一の boolean 値です。

Headers
any
Bodyapplication/json
codeintegerrequired

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

msgstring or nullrequired

エラーメッセージ

databooleanrequired
requestIdstringrequired

操作リクエストID

Response
{ "code": 0, "msg": "", "data": true, "requestId": "" }