콘텐츠로 이동

삭제



POST /api/v1/tag/delete

개요

태그를 일괄 소프트 삭제하고 현재 워크스페이스의 관련 엔터티 참조 및 태그 권한을 정리합니다.

호출 전 및 사용 단계

목록에서 tagUUIDs 배열을 가져옵니다. 현재 워크스페이스에서 status=0인 일치 태그만 소프트 삭제하고, 현재 워크스페이스의 대상 참조 및 TagPermission을 정리합니다. 리소스, 원시 데이터를 삭제하거나 다른 설정/인프라/통합 카탈로그에 이름으로 저장된 모든 데이터를 자동으로 지우지는 않습니다. scope 변경과 달리 이 삭제 경로는 규칙 extend.incidentsTags를 별도로 정리하거나 신서틱 테스트 설정 새로 고침을 실행하지 않으므로, 작업 후 연결된 설정의 실제 표시를 확인해야 합니다. 빈 배열이거나 유효한 일치 항목이 없어도 true를 반환할 수 있으며, 이는 모든 입력이 실제로 삭제되었음을 의미하지는 않습니다.

요청 헤더

매개변수명 유형 필수 설명
DF-API-KEY string Y 워크스페이스의 OpenAPI 인증 자격 증명입니다.
예: <DF-API-KEY>
가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다.

Body 요청 매개변수

매개변수명 유형 필수 설명
tagUUIDs[*] string 이름은 사용할 수 없습니다.
예: tag_example
가져오기 또는 입력 방법: 단일 tag 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를 제공하세요.

문서 평가

이 페이지가 도움이 되었나요?