삭제¶
POST /api/v1/service_manage/delete
개요¶
지정한 서비스 목록 설정을 일괄 삭제합니다.
호출 전 및 사용 단계¶
API Key에는 서비스 관리 권한(trace.serviceManage)이 있어야 합니다. 먼저 서비스 목록을 호출하여 UUID와 이름을 항목별로 확인합니다. 요청의 serviceUUIDs는 반드시 확인된 비어 있지 않은 목록이어야 합니다. 현재 인터페이스는 빈 배열을 받으면 이 워크스페이스의 모든 활성 서비스 목록을 삭제하므로, 클라이언트는 전송 전에 빈 배열을 차단해야 합니다. 삭제는 일치하는 서비스 목록을 소프트 삭제하고 해당 UUID에 연결된 태그 연관을 정리합니다. 호출 전에 상세 정보를 백업으로 저장하고, 결과가 불명확하면 먼저 설정을 다시 나열한 후 다음 단계를 결정합니다.
요청 헤더¶
| 파라미터 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Body 요청 파라미터¶
| 파라미터 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
| serviceUUIDs[*] | string | 배열 내의 개별 서비스 목록 UUID 문자열입니다. 예시: sman_example획득 또는 입력 방법: 서비스 목록의 content.data[].uuid에서 복사합니다. |
|
| serviceUUIDs | array | Y | 삭제할 서비스 목록 UUID 배열입니다. 클라이언트는 빈 배열을 금지해야 하며, 현재 빈 배열은 워크스페이스 전체의 활성 서비스 목록을 삭제할 수 있습니다. null 허용: False 예시: ["sman_example"]획득 또는 입력 방법: 서비스 목록의 content.data[].uuid에서 실제로 삭제해야 하는 서비스를 선택합니다. 전송 전에 배열이 비어 있지 않은지 확인하고 각 항목의 이름을 대조합니다. |
파라미터 추가 설명¶
삭제해도 서비스 수집이 중단되거나 이미 수집된 트레이스 데이터가 삭제되지는 않습니다. 자동 검색이 계속 실행 중이면 이후에 해당 서비스 목록이 다시 나타날 수 있습니다.
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/service_manage/delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"serviceUUIDs":["sman_example"]}'
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 타입 | 설명 |
|---|---|---|
| content | boolean | 성공 시 true입니다. 존재하지 않거나 현재 워크스페이스에 속하지 않는 UUID는 무시되므로, 이를 근거로 모든 UUID가 삭제되었다고 판단할 수 없습니다. |
{
"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을 수정하십시오. |
| 400 | ft.JsonFormatError | JSON 최상위가 객체가 아님 | 일부 json 파일 형식 오류 | 요청 본문을 JSON 객체로 구성하십시오. |