콘텐츠로 이동

스코프 영향 미리보기



POST /api/v1/tag/{tag_uuid}/scope/preview

개요

태그 스코프 변경으로 정리될 리소스와 모니터 구성을 미리 확인합니다.

호출 전 및 사용 단계

이 API는 태그나 리소스를 수정하지 않고 영향만 계산하며, 600초 동안 유효한 자격 증명을 캐시합니다. scene/monitor/dialing/security 스코프를 제거하면 해당 엔터티 참조가 정리될 수 있으며, monitor를 제거하면 규칙 extend.incidentsTags에서 해당 이름도 제거됩니다. 인프라/통합 카탈로그의 이름 바인딩은 이 정리 대상에 포함되지 않으며, 알림 조건, 리소스 권한 또는 이미 저장된 데이터도 변경하지 않습니다.

data는 비즈니스 리소스 기준으로 중복 제거되며, summary/affectedResourceCount는 전체 수량이고, pageInfo는 data만 제어합니다. 미리보기에 고아 참조가 있으면 총 관계 수가 표시 리소스 수보다 클 수 있습니다. 호출할 때마다 새 token이 생성되며, 동일한 token이 이후 변경 사항에 적합하다고 보장되지 않습니다. 페이지 조회는 모두 이번에 제출할 scope에 해당하는 token으로 수행해야 하며, 제출 전에 영향을 다시 확인하십시오.

라우팅 파라미터

파라미터명 유형 필수 설명
tag_uuid string Y 이 워크스페이스의 태그 UUID이며, 태그 이름, 목록의 숫자 페이지 번호 또는 리소스 UUID가 아닙니다.
예: tag_example
가져오기 또는 입력 방법: 태그 목록content.data[].uuid에서 가져옵니다.

요청 헤더

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

Body 요청 파라미터

파라미터명 유형 필수 설명
scope[*] string 배열 멤버이며 all과 구체적인 값을 혼합하지 않습니다.
예: monitor
가져오기 또는 입력 방법: 상위 열거형에서 단일 스코프를 선택합니다.
pageIndex integer 선택 사항이며 기본값은 1입니다.
$minValue: 1
예: 1
가져오기 또는 입력 방법: 1부터 영향 리소스 상세를 확인합니다.
pageSize integer 선택 사항이며 기본값은 50, 최대 1000입니다.
$maxValue: 1000
$minValue: 1
예: 50
가져오기 또는 입력 방법: 페이지당 1..1000입니다.
scope any Y 비어 있지 않은 스코프 배열이며, all은 전역, scene은 시나리오, monitor는 모니터링, dialing은 신서틱 테스트, security는 보안, infrastructure는 인프라, catalog는 통합 카탈로그를 나타냅니다. 기존 단일 값 문자열과 호환됩니다. all은 다른 값과 혼합할 수 없으며, 중복 값은 중복 제거되어 고정된 열거형 순서로 반환됩니다. []/null/알 수 없는 값은 허용되지 않습니다. 추가/가져오기 시 생략하면 기본값은 ["all"]이며, 수정 시 생략하면 이전 값을 유지합니다. scope는 태그 적용 범위만 제한하며 리소스 권한을 부여하지 않습니다. 인프라/통합 카탈로그의 이름 바인딩은 여기의 엔터티 참조 정리로 인해 다시 작성되지 않습니다.
null 허용: False
예: ["scene", "monitor"]
가져오기 또는 입력 방법: 태그를 바인딩할 리소스 비즈니스 유형을 필요에 따라 선택합니다.

요청 예시

curl --request POST 'https://openapi.guance.com/api/v1/tag/tag_example/scope/preview' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"scope":["scene"],"pageIndex":1,"pageSize":50}'

응답

HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.

필드 유형 설명
content.tagUUID string 대상 태그 UUID입니다.
content.oldScope array<string> 현재 스코프를 정규화한 배열입니다.
content.oldScope[] string 개별 이전 scope입니다.
content.newScope array<string> 대상 스코프를 정규화한 배열입니다.
content.newScope[] string 개별 새 scope입니다.
content.requiresConfirmation boolean 정리될 엔터티 참조 또는 모니터 구성이 있는지 여부입니다. 공개 modify는 여전히 token을 생략하고 직접 실행할 수 있습니다.
content.affectedResourceCount integer 비즈니스 리소스 기준으로 중복 제거한 총수이며 관계 수와 동일하지 않습니다. SLO 내부 규칙은 소속 SLO로 병합됩니다.
content.affectedRelationCount integer 정리될 것으로 예상되는 엔터티 참조 수입니다.
content.affectedConfigCount integer incidentsTags에서 정리될 것으로 예상되는 규칙 구성 수입니다.
content.orphanRelationCount integer 참조는 존재하지만 대응하는 유효 리소스가 없는 관계 수이며, 관계 영향에도 포함됩니다.
content.summary array<object> 리소스 유형별로 집계한 중복 제거 리소스 수입니다.
content.summary[].resourceType string dashboard/viewer/service/checker/smartMonitor/aiMonitor/incident/dialing/security/slo 등 실제 비즈니스 유형입니다.
content.summary[].count integer 해당 유형의 리소스 수입니다.
content.data array<object> 이 페이지의 영향 리소스 요약입니다.
content.data[].resourceType string 비즈니스 리소스 범주입니다.
content.data[].resourceUUID string 리소스 UUID입니다.
content.data[].name string 리소스 표시 이름이며, 이름이 없으면 UUID로 대체됩니다.
content.data[].scope string 해당 리소스가 속한 scope입니다.
content.previewToken string 600초 동안 유효한 미리보기 자격 증명이며, 이번 ID/워크스페이스/태그/대상 scope/영향 지문에 바인딩됩니다. 인증 Token이 아닙니다.
content.declaration object 공통 선언입니다.
pageInfo.pageIndex integer 상세 페이지 번호입니다.
pageInfo.pageSize integer 상세 페이지 크기입니다.
pageInfo.totalCount integer 중복 제거 후 영향 리소스 총수이며, 고아 항목은 포함하지 않습니다.
{
  "code": 200,
  "content": {
    "tagUUID": "tag_example",
    "oldScope": [
      "all"
    ],
    "newScope": [
      "scene"
    ],
    "requiresConfirmation": true,
    "affectedResourceCount": 1,
    "affectedRelationCount": 1,
    "affectedConfigCount": 0,
    "orphanRelationCount": 0,
    "summary": [
      {
        "resourceType": "checker",
        "count": 1
      }
    ],
    "data": [
      {
        "resourceType": "checker",
        "resourceUUID": "rul_example",
        "name": "프로덕션 모니터",
        "scope": "monitor"
      }
    ],
    "previewToken": "PREVIEW-TOKEN",
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE",
  "pageInfo": {
    "pageIndex": 1,
    "pageSize": 50,
    "totalCount": 1
  }
}

오류 응답

인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참고하십시오.

HTTP 상태 errorCode 트리거 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반했습니다. 파라미터 파싱 실패 파라미터 위치, 필드명, 유형 및 값을 확인하십시오.
400 ft.RequestJsonFormatError 요청 JSON 구문이 유효하지 않습니다. 요청 JSON 형식 오류 content.reason, line, column에 따라 JSON을 수정하십시오.
404 ft.ObjectNotExists 이 워크스페이스에 대응하는 유효한 태그가 없거나 삭제되었습니다. 지정한 객체가 존재하지 않습니다. 현재 워크스페이스 목록에서 유효한 UUID를 가져오십시오.
406 ft.ParameterValidationFailed scope가 유효하지 않거나, 페이지 조회가 범위를 벗어났거나, 정리 범위에 알 수 없는 참조 유형이 포함되어 있습니다. 파라미터 파싱 실패 허용된 scope를 사용하십시오. 알 수 없는 연관 유형은 관리자에게 확인하고 영향 검사를 우회하지 마십시오.
500 ft.InternalServerError 태그, 참조/권한 또는 ID 정보를 읽거나 응답 형식을 지정하는 데 실패했습니다. 내부 오류 워크스페이스와 조회 조건을 확인한 후 나중에 다시 시도하십시오. 계속 실패하면 traceId를 제공하십시오.

관련 문서

문서 평가

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