조회¶
GET /api/v1/self_built_checker/get
개요¶
UUID 또는 비즈니스 refKey로 저장된 점검 정의를 조회합니다.
호출 전 및 사용 단계¶
비어 있지 않은 ruleUUID 또는 refKey를 하나 이상 전달해야 합니다. 둘 다 제공하면 ruleUUID를 우선하며, refKey는 이 get의 결합 매칭에 참여하지 않습니다. 이 공유 읽기 쿼리는 자체 구축 점검 유형을 추가로 제한하지 않으므로, 이 모듈 목록에서 반환된 UUID/refKey만 사용하고 content.type=self_built_trigger를 확인하여 다른 규칙을 잘못 읽지 않도록 해야 합니다. 목록의 monitorName, alertPolicyInfos 또는 ID 요약은 포함하지 않습니다.
이 API는 점검 메타 정보와 알림 정책 연결을 등록/수정하며, 연결된 함수를 실행하지 않고 점검 결과를 생성하지 않으며 자체 구축 점검을 위한 주기 트리거 작업도 생성하지 않습니다. 실제 스케줄링과 이벤트 생성은 비즈니스 통합/함수 측에서 담당합니다. 성공 후에는 목록/get으로 설정과 상태를 확인하십시오.
요청 헤더¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예: <DF-API-KEY>획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 획득합니다. |
Query 요청 파라미터¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| refKey | string | 생성 선언 시 필수이며 이후에는 수정할 수 없습니다. 비어 있지 않고 48자 이하인 것을 권장합니다. 생성 시 이 워크스페이스의 모든 삭제되지 않은 Rule의 refKey와 중복을 검사하며, 자체 구축 점검만 대상으로 하지 않습니다. get에서는 refKey를 단독으로 사용할 수 있습니다. modify는 먼저 get으로 ruleUUID를 얻은 후 제출해야 하며, refKey는 추가 확인 조건으로만 사용할 수 있습니다. refKey만으로는 정책 참조/캐시/음소거 범위와 중복 이름 검증을 안정적으로 유지할 수 없습니다. null 허용: False 예: custom-healthcheck-production획득 또는 입력 방법: 함수/비즈니스 통합을 위한 안정적이고 고유한 키를 생성합니다. 예를 들어 동일 비즈니스 시스템의 점검 인스턴스 식별자입니다. |
|
| ruleUUID | string | 작업 대상 식별자입니다. 수정 시에는 먼저 get으로 명확한 ruleUUID를 얻어야 하며, 특히 정책/제목을 변경할 때 그러합니다. get에서 refKey도 함께 제공하면 ruleUUID만 사용하고, modify에서 둘 다 제공하면 두 조건이 모두 일치해야 합니다. 함수 funcId 또는 연결 키가 아닙니다. null 허용: False 예: rul_self_example획득 또는 입력 방법: 자체 구축 점검 목록의 content.data[].uuid에서 이 워크스페이스의 자체 구축 점검 UUID를 획득합니다. |
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/self_built_checker/get' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode ruleUUID=rul_self_example
응답¶
HTTP 200, application/json입니다. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content.id | integer 또는 null | 레코드 번호입니다. 생성 제출 전 스냅샷에서는 null일 수 있으며, uuid로 작업합니다. |
| content.uuid | string | rul_규칙 UUID입니다. |
| content.workspaceUUID | string | 소속 워크스페이스입니다. |
| content.monitorUUID | string | 연결된 모니터 그룹 UUID입니다. 공개 생성에서는 선언되지 않으며 일반적으로 빈 문자열입니다. |
| content.type | string | 자체 구축 점검은 self_built_trigger로 고정됩니다. get은 유형을 추가로 제한하지 않으며 이 모듈 목록의 UUID만 사용합니다. |
| content.refKey | string | 고정 비즈니스 연결 키입니다. |
| content.secret | string 또는 null | 공유 엔터티 호환 필드입니다. 자체 구축 점검에서는 일반적으로 비어 있으며, 생성 스냅샷에서는 null일 수 있고 호출 자격 증명으로 사용되지 않습니다. |
| content.jsonScript | object | 저장된 자체 구축 점검 정의입니다. Rule.type과 구분됩니다. |
| content.jsonScript.type | string | selfBuiltCheck로 고정됩니다. |
| content.jsonScript.title | string | 루트 비즈니스 제목입니다. |
| content.jsonScript.name | string | 생략할 수 있습니다. 생성 시 title이 비어 있으면 생성되지 않으며, title이 비어 있지 않으면 name으로 복사됩니다. 수정 시 title이 비어 있으면 기존 name이 유지됩니다. |
| content.jsonScript.refFuncInfo | object | 연결된 함수 정보입니다. |
| content.jsonScript.refFuncInfo.funcId | string | 생성 시에만 필수이며 수정 시에는 선언하지 않습니다. 서버 측 등록은 함수가 실제로 존재하거나 호출 가능함을 보장하지 않습니다. |
| content.jsonScript.refFuncInfo.description | string | 선택적 문자열이며 비어 있을 수 있습니다. 수정 시 명시적 빈 문자열로 지웁니다. |
| content.jsonScript.refFuncInfo.definition | string | 선택적 시그니처 표시 문자열이며, 이 API에서 실행되는 소스 코드가 아닙니다. |
| content.jsonScript.refFuncInfo.category | string | 선택적 메타 정보입니다. 고정된 열거형이 아니며 Rule.type을 변경하지 않습니다. |
| content.jsonScript.refFuncInfo.args | array | 선택적 배열입니다. 함수 플랫폼의 원래 메타 정보 규칙에 따라 저장되며, 서버는 파라미터 바인딩을 수행하거나 함수 시그니처를 검증하지 않습니다. 수정 시 전체 배열을 교체합니다. |
| content.jsonScript.refFuncInfo.kwargs | json | 선택적 동적 JSON 메타 정보입니다. 하위 값은 해당 함수 정의에 따라 해석됩니다. 이 API에서 사용할 수 있는 최상위 callKwargs 파라미터가 아니며 함수를 즉시 호출하지 않습니다. 수정 시 전체 kwargs를 교체합니다. |
| content.jsonScript.refFuncInfo.args[] | JSON | 임의의 JSON 파라미터 메타 정보입니다. 서버는 통일된 하위 항목 스키마를 제공하지 않으며 원래 정의를 유지합니다. |
| content.jsonScript.refFuncInfo.kwargs.파라미터명 | any | 동적 키-값입니다. 모든 함수에 공통인 필수 파라미터는 없습니다. 자격 증명을 예시/로그에 전달하지 마십시오. |
| content.jsonScript.callKwargs | object | 과거/기타 진입점에서 저장했을 수 있는 실행 파라미터입니다. 공개 create/modify에서는 선언되지 않으므로 새로 추가해 다시 전달할 수 없습니다. |
| content.jsonScript.callKwargs.파라미터명 | JSON | 구체적 실행 파라미터는 원래 함수 정의에 따라 해석되며 존재를 보장하지 않습니다. |
| content.crontabInfo | object | 자체 구축 점검은 이 진입점에서 주기 트리거 설정을 생성하지 않으며 일반적으로 {}입니다. |
| content.crontabInfo.과거 필드 | JSON | 과거 레코드에는 스케줄 정보가 남아 있을 수 있으며, 이 API에서 쓸 수 있는 설정이 아닙니다. |
| content.extend | object | 확장 메타 정보입니다. 공개 Body에서 선언되지 않으며 생성 시 일반적으로 {}입니다. |
| content.extend.과거 필드 | JSON | 과거에 저장된 확장 필드입니다. 이 진입점에서는 다시 전달하여 수정하는 것을 지원하지 않습니다. |
| content.createdWay | string | 일반적으로 manual입니다. 과거 import/template/빈 값일 수도 있습니다. |
| content.isLocked | integer 또는 boolean | 잠금 표시입니다. |
| content.openPermissionSet | boolean | 사용자 정의 작업 권한 스위치입니다. 생성 시 false이며, modify 공유 작업 업데이트 시 false로 복원됩니다. |
| content.permissionSet | array<string> |
작업 권한 주체입니다. 생성 시 []이며, modify 공유 업데이트 시 []로 복원됩니다. |
| content.permissionSet[] | string | 과거 계정/팀/역할 식별자입니다. |
| content.status | integer | 0은 활성화, 2는 비활성화, 3은 삭제입니다. 최근 점검 결과와 같지 않습니다. |
| content.creator | string | 생성자 ID입니다. |
| content.updator | string | 수정자 ID입니다. 초기에는 비어 있을 수 있습니다. |
| content.createAt | integer | 생성 Unix 초입니다. |
| content.updateAt | integer | 업데이트 Unix 초이며, 업데이트되지 않은 경우 -1입니다. |
| content.deleteAt | integer | 삭제 Unix 초이며, 삭제되지 않은 경우 -1입니다. |
| content.declaration | object | 공통 선언입니다. |
{
"code": 200,
"content": {
"id": 100,
"uuid": "rul_self_example",
"workspaceUUID": "wksp_example",
"monitorUUID": "",
"type": "self_built_trigger",
"refKey": "custom-healthcheck-production",
"secret": "",
"jsonScript": {
"type": "selfBuiltCheck",
"title": "生产服务健康检查",
"name": "生产服务健康检查",
"refFuncInfo": {
"funcId": "healthcheck.main",
"description": "生产服务健康检查函数。",
"definition": "main(service)",
"category": "custom",
"args": [
"service"
],
"kwargs": {
"service": "production"
}
}
},
"crontabInfo": {},
"extend": {},
"createdWay": "manual",
"isLocked": 0,
"openPermissionSet": false,
"permissionSet": [],
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참고하십시오.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 선언되지 않은 Query 파라미터를 사용하거나 파라미터가 규칙을 위반함 | 파라미터 파싱 실패 | Query 파라미터 표와 예시를 확인하십시오. |
| 406 | ft.CheckerSignUnspecified | ruleUUID/refKey가 모두 비어 있거나 제공되지 않음 | 모니터 식별자가 지정되지 않음 | 이 모듈 목록에서 명확한 식별자를 선택하십시오. |
| 404 | ft.NotFoundRule | UUID 또는 refKey로 이 워크스페이스의 삭제되지 않은 규칙을 찾을 수 없음 | 비즈니스 규칙을 찾을 수 없음 | 목록을 새로 고쳐 올바른 식별자를 가져오십시오. |
| 500 | ft.InternalServerError | 규칙, 참조 또는 ID 정보 읽기/포맷팅 실패 | 내부 오류 | 워크스페이스와 유효한 식별자를 확인한 후 다시 시도하십시오. 계속 실패하면 traceId를 제공하십시오. |