활성화¶
POST /api/v1/self_built_checker/enable
개요¶
자체 구축 점검을 활성화합니다.
호출 전 및 사용 단계¶
일치하는 삭제되지 않은 자체 구축 점검의 status를 0으로 설정합니다. 연관 함수를 즉시 실행하지 않고, 새 스케줄을 생성하지 않으며, 외부 비즈니스 통합의 작업이 이미 일시 중지/시작되었음을 보장하지 않습니다. 통합 측에서 실제 실행 상태를 확인해야 합니다.
이 워크스페이스의 이 모듈 목록에 있는 UUID만 사용할 수 있습니다. refKey를 제공하면 UUID와 함께 필터링되며, 독립적인 일괄 지정 방식이 아닙니다. true를 반환하며 항목별 일치/변경 수는 제공하지 않습니다. 빈 배열이거나 일치 항목이 없어도 성공할 수 있으므로 상태/연관 정보는 다시 읽어 확인해야 합니다. 오류/타임아웃 시 먼저 현재 설정 상태를 확인하세요. 삭제/제출 후 비동기 전달이 실패했더라도 이미 저장되었을 수 있습니다.
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Body 요청 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| ruleUUIDs[*] | string | 비어 있지 않은 문자열을 권장하며, 함수 ID나 기타 규칙 식별자가 아닙니다. 예시: rul_self_example가져오기 또는 입력 방법: 확인된 단일 자체 구축 점검 UUID입니다. |
|
| refKey | string | 선택적 추가 필터 조건으로, 각 UUID와 동시에 일치해야 합니다. UUID를 대체하는 파라미터가 아니며 refKey만으로 집합을 조작할 수 없습니다. null 허용: False 예시: custom-healthcheck-production가져오기 또는 입력 방법: 동일한 비즈니스 연관 키를 추가로 확인해야 할 때 입력합니다. |
|
| ruleUUIDs | array | 선택 사항으로 선언되었지만 실제로는 배열을 반드시 제공해야 합니다. 생략하면 in_(None)으로 인해 500이 발생할 수 있으며 refKey가 배열을 대체할 수 없습니다. 비어 있지 않은 값을 권장하며, 다른 유형의 규칙이나 다른 워크스페이스의 UUID를 섞지 마세요. null 허용: False 예시: ["rul_self_example"]가져오기 또는 입력 방법: 이 모듈 목록에서 이 워크스페이스의 자체 구축 점검 uuid를 항목별로 확인합니다. |
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/self_built_checker/enable' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"ruleUUIDs":["rul_self_example"]}'
응답¶
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을 수정합니다. |
| 500 | ft.InternalServerError | 대상 미선택, 필드 형태 또는 길이 오류, 데이터베이스/제출 후 비동기 작업 전달 실패 등 | 내부 오류 | 먼저 현재 규칙을 다시 읽어 저장 여부를 확인하고, 이 워크스페이스의 명확한 ruleUUID로 재시도하며 traceId를 제공합니다. |