削除¶
POST /api/v1/tag/delete
概要¶
タグを一括でソフト削除し、このワークスペースに関連するエンティティの参照とタグ権限をクリーンアップします。
呼び出し前の確認と使用手順¶
リストから tagUUIDs 配列を取得します。現在のワークスペースで status=0 に一致するタグのみをソフト削除し、このワークスペース内の対象参照および TagPermission をクリーンアップします。リソースや元データは削除せず、他の設定/インフラストラクチャ/統合カタログで名前によって保存されているすべてのデータを自動的に消去することもありません。scope の変更とは異なり、この削除パスではルールの extend.incidentsTags を特別にクリーンアップしたり、Synthetic テスト設定の更新を実行したりしません。操作後は、関連設定の実際の表示を確認する必要があります。空の配列または有効な一致がない場合でも true を返すことがあり、入力したすべてが実際に削除されたことを意味するものではありません。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作の権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| tagUUIDs[*] | string | 名前は使用できません。 例: tag_example取得または入力方法: 単一のタグ UUID。 |
|
| tagUUIDs | array | Y | 必須の配列。空でないことを推奨します。このワークスペースで有効なタグ UUID です。 null の許可: False 例: ["tag_example"]取得または入力方法: タグリストから uuid の集合を取得します。 |
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/tag/delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"tagUUIDs":["tag_example"]}'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content | boolean | 成功時は true。項目ごとの結果や削除件数はありません。 |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーについては、共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反 | パラメータの解析に失敗しました | パラメータの位置、フィールド名、型、および値を確認してください。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正してください。 |
| 500 | ft.InternalServerError | データベース、タグ/権限構造、キャッシュ、またはレスポンスのフォーマットに失敗 | 内部エラー | リクエストを確認した後でタグの現在の状態を読み戻してください。書き込みがすでにコミットされている可能性があるため、盲目的な再実行を避け、失敗が継続する場合は traceId を提供してください。 |