콘텐츠로 이동

비활성화/활성화



POST /api/v1/aggs_to_metric/set_disable

개요

현재 워크스페이스의 메트릭 생성 주기 작업을 일괄 비활성화하거나 활성화합니다.

호출 전 및 사용 단계

이 모듈 목록에서 각 aggs UUID를 확인한 후 isDisable과 전체 배열을 제출합니다. true는 비활성화로 status=2를 설정하고, false는 활성화로 0을 설정합니다. 서버는 일치하는 규칙 및 스케줄 스위치를 동기적으로 업데이트합니다. 일치하는 항목이 없어도([] 포함) 여전히 true를 반환할 수 있으며, 항목별 결과는 제공하지 않습니다. 현재 워크스페이스의 삭제되지 않은 항목만 업데이트하며, 이미 삭제된 규칙은 복구되지 않습니다.

이러한 진입점은 공통 규칙 처리를 공유하며, 일부 대상 쿼리에는 type=aggs가 추가로 제한되어 있지 않습니다. 이 모듈 목록에서 반환된 UUID만 사용하여 다른 규칙을 잘못 읽거나 변경하지 않도록 하십시오.

활성화해도 즉시 재실행되거나 과거 데이터가 반환되지는 않으며, 비활성화해도 이미 생성된 메트릭을 삭제하지 않습니다. 실행 중인 작업의 취소는 보장되지 않습니다. 스케줄링과 데이터베이스는 동일한 원자적 트랜잭션이 아니므로, 실패 후에는 양쪽 상태를 먼저 확인한 후 재시도하십시오.

요청 헤더

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

Body 요청 파라미터

파라미터명 유형 필수 설명
ruleUUIDs[*] string 단일 전체 UUID이며, 공백은 자동으로 제거되지 않습니다.
예: rul_aggs_example
획득 또는 입력 방법: 메트릭 생성 규칙 목록에서 단일 aggs 규칙 uuid를 가져옵니다.
isDisable boolean Y 필수 JSON 불리언 값이며, 문자열 "true"를 사용할 수 없습니다.
null 허용: False
예: true
획득 또는 입력 방법: true이면 후속 주기 작업을 일시 중지하고, false이면 주기 작업을 복구합니다.
ruleUUIDs array Y 필수 문자열 배열이며, 비어 있지 않은 것을 권장하고, 쉼표로 구분된 문자열이 아닙니다. 이 모듈 목록의 aggs UUID만 사용하고, 동일한 rul_ 접두사로 유형을 판단하지 마십시오.
null 허용: False
예: ["rul_aggs_example"]
획득 또는 입력 방법: 메트릭 생성 규칙 목록에서 각 규칙 UUID를 가져옵니다.

요청 예시

curl --request POST 'https://openapi.guance.com/api/v1/aggs_to_metric/set_disable' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"ruleUUIDs":["rul_aggs_example"],"isDisable":true}'

응답

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

필드 유형 설명
content boolean 성공 시 true이며, 모든 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 객체를 제출하십시오.
403 ft.Forbidden 인터페이스 작업 권한이 없거나 일치하는 규칙이 현재 자격 증명의 작업을 허용하지 않음 작업 권한이 없습니다 API Key 권한 및 대상 규칙을 확인하십시오.
400 ft.OuterFuncFailed 일괄 스케줄 스위치 호출 실패 외부 함수 호출 실패 실제 규칙 상태와 스케줄 상태를 다시 읽은 후 재시도하십시오.
400 ft.SameSetTraggerExists 스케줄 서비스가 중복 구성 비즈니스 오류를 반환함 동일한 구성의 트리거가 이미 존재합니다 기존 스케줄을 먼저 확인하고, 계속 실패하면 traceId를 제공하십시오.
500 ft.InternalServerError 다운스트림 시간 초과/일반 5xx, 데이터베이스 또는 후속 메타데이터 처리 실패 내부 오류 규칙 및 해당 상태, 출력 메트릭, 현재 스케줄 상태를 먼저 읽은 후 재시도 여부를 결정하십시오. traceId를 제공하십시오.

문서 평가

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