削除¶
POST /api/v1/channel/{channel_uuid}/delete
概要¶
指定したチャンネルを削除し、サブスクリプションとエスカレーショントリガー設定をクリーンアップします。
呼び出し前の確認と使用手順¶
まずチャンネル簡易リストで削除する UUID を確認します。成功するとチャンネルはリストから削除され、サブスクリプションと関連参照、エスカレーショントリガー設定もクリーンアップされます。デフォルトチャンネルは削除できません。存在しないチャンネルを重複して削除しても、成功として true が返る場合があります。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| channel_uuid | string | Y | 現在のワークスペースのチャンネル UUID。 例: chan_example取得または入力方法: チャンネル簡易リスト の content[].uuid から取得します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
パラメータの補足説明¶
この POST にはリクエストボディは不要です。呼び出しがタイムアウトした場合は、まずリストを確認して対象がまだ存在するかどうかを確認してください。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/channel/chan_example/delete' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content | boolean | 削除処理が成功した場合は true。 |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーの詳細は共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 400 | ft.ForbidDeleteDefaultChannel | デフォルトチャンネル default を削除しようとした場合 | デフォルトチャンネルは削除できません | デフォルトチャンネルは保持し、実際に削除するカスタムチャンネルを選択してください。 |