콘텐츠로 이동

목록 조회



GET /api/v1/self_built_checker/list

개요

현재 워크스페이스의 자체 구축 점검 구성과 연결된 알림 정책을 페이지 단위로 나열합니다.

호출 전 및 사용 단계

self_built_trigger만 대상으로 하며 삭제되지 않은 항목을 포함하고, 비활성화된 항목도 포함하며 Rule.id 내림차순으로 정렬합니다. 현재 OpenAPI는 Front의 최종 이벤트 상태를 가져오지 않고 lastEventInfo를 반환하지 않으며, 내부 scriptType 또는 확장 필터도 허용하지 않습니다. 빈 페이지이거나 필터가 조기에 종료되면 content.data=[]이고 pageInfo={}이므로, 고정된 totalCount에 의존해 워크스페이스에 규칙이 있는지 판단할 수 없습니다.

인터페이스는 점검 메타 정보와 알림 정책 연결을 등록/수정하며, 연결된 함수를 실행하지 않고, 한 번의 점검 결과도 생성하지 않으며, 자체 구축 점검을 위한 주기 트리거 작업도 생성하지 않습니다. 실제 스케줄링과 이벤트 생성은 비즈니스 통합/함수 측에서 담당합니다. 성공 후에는 목록/get으로 구성과 상태를 확인하십시오.

요청 헤더

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

Query 요청 파라미터

파라미터 이름 유형 필수 설명
alertPolicyUUID commaArray 선택 사항, 여러 개는 쉼표로 구분, 다른 필터와 AND, 연결된 항목이 없으면 빈 값을 반환합니다.
null 허용: False
예: altpl_example
가져오기 또는 입력 방법: 알림 정책 목록에서 uuid를 가져옵니다.
checkerUUID commaArray 선택 사항, 복수 지정 시 쉼표로 구분하며 함수 ID가 아닙니다.
null 허용: False
예: rul_self_example
가져오기 또는 입력 방법: 이 모듈 목록에서 자체 구축 규칙 uuid를 가져옵니다.
monitorUUID commaArray 선택 사항, 여러 개는 영문 쉼표로 구분, 공개 create에서는 그룹 생성을 지원하지 않습니다.
null 허용: False
예: monitor_example
가져오기 또는 입력 방법: 실제 모니터 그룹 목록 또는 기존 기록의 monitorUUID에서 가져옵니다.
pageIndex integer 선택 사항, 기본값 1, 최소 1.
null 허용: False
$minValue: 1
예: 1
가져오기 또는 입력 방법: 1부터 시작하여 pageInfo에 따라 진행합니다.
pageSize integer 선택 사항, 기본값 100, 최대 100.
null 허용: False
$maxValue: 100
$minValue: 1
예: 100
가져오기 또는 입력 방법: 페이지당 1..100.
refKey commaArray 선택 사항, 여러 개는 영문 쉼표로 구분, 전체 키로 일치합니다.
null 허용: False
예: custom-healthcheck-production
가져오기 또는 입력 방법: 생성 시 저장한 비즈니스 키입니다.
search string 선택 사항, 실제로는 jsonScript.refFuncInfo.title만 일치하며 루트 title/name과는 일치하지 않습니다. 현재 공개 refFuncInfo는 title을 선언하지 않으므로 새로 생성한 항목은 이름 search 검색에 의존해서는 안 되며 checkerUUID/refKey 사용을 권장합니다.
null 허용: False
예: 健康检查
가져오기 또는 입력 방법: 기록에 있는 refFuncInfo.title의 키워드에만 사용됩니다.

요청 예시

curl --get 'https://openapi.guance.com/api/v1/self_built_checker/list' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode pageIndex=1 \
  --data-urlencode pageSize=100

응답

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

필드 유형 설명
content.data array<object> 이 페이지의 자체 구축 점검입니다.
content.data[].id integer 또는 null 레코드 번호, 생성 제출 전 스냅샷은 null일 수 있으며 uuid로 작업합니다.
content.data[].uuid string rul_ 규칙 UUID입니다.
content.data[].workspaceUUID string 소속 워크스페이스입니다.
content.data[].monitorUUID string 연결된 모니터 그룹 UUID, 공개 생성 시 선언되지 않으며 일반적으로 빈 문자열입니다.
content.data[].type string 자체 구축 점검은 self_built_trigger로 고정됩니다. get은 유형을 추가로 제한하지 않으며 이 모듈 목록의 UUID만 사용합니다.
content.data[].refKey string 고정 비즈니스 연결 키입니다.
content.data[].secret string 또는 null 공유 엔터티 호환 필드로, 자체 구축 점검에서는 일반적으로 비어 있습니다. 생성 스냅샷은 null일 수 있으며 호출 자격 증명으로 사용하지 않습니다.
content.data[].jsonScript object 저장된 자체 구축 점검 정의이며 Rule.type과 다릅니다.
content.data[].jsonScript.type string selfBuiltCheck로 고정됩니다.
content.data[].jsonScript.title string 루트 비즈니스 제목입니다.
content.data[].jsonScript.name string 생략할 수 있습니다. 생성 시 title이 비어 있으면 생성하지 않으며, title이 비어 있지 않으면 name으로 복사됩니다. title을 비어 있게 수정하면 기존 name이 유지됩니다.
content.data[].jsonScript.refFuncInfo object 연결된 함수 정보입니다.
content.data[].jsonScript.refFuncInfo.funcId string 생성 시에만 필수이며 수정 시 선언하지 않습니다. 서버 등록은 함수가 실제로 존재하거나 호출 가능함을 보장하지 않습니다.
content.data[].jsonScript.refFuncInfo.description string 선택 사항인 문자열로 비어 있을 수 있습니다. 수정 시 명시적으로 빈 문자열을 전달하면 지웁니다.
content.data[].jsonScript.refFuncInfo.definition string 선택 사항인 서명 표시 문자열이며 이 인터페이스에서 실행하는 소스 코드가 아닙니다.
content.data[].jsonScript.refFuncInfo.category string 선택적 메타 정보, 고정 열거형이 아니며 Rule.type을 변경하지 않습니다.
content.data[].jsonScript.refFuncInfo.args array 선택적 배열로, 함수 플랫폼의 원본 메타 정보 규약에 따라 저장됩니다. 서버는 파라미터 바인딩을 수행하거나 함수 시그니처를 검증하지 않습니다. 수정 시 전체 배열을 교체합니다.
content.data[].jsonScript.refFuncInfo.kwargs json 선택적 동적 JSON 메타 정보로, 하위 값은 해당 함수 정의에 따라 해석됩니다. 이 인터페이스에서 사용할 수 있는 최상위 callKwargs 파라미터가 아니며 함수를 즉시 호출하지 않습니다. 수정 시 전체 kwargs를 교체합니다.
content.data[].jsonScript.refFuncInfo.args[] JSON 임의의 JSON 파라미터 메타 정보로, 서버는 통합된 하위 항목 schema를 제공하지 않습니다. 원래 정의를 유지합니다.
content.data[].jsonScript.refFuncInfo.kwargs.파라미터 이름 any 동적 키-값, 모든 함수에 공통으로 필수인 파라미터는 없습니다. 자격 증명을 예시/로그에 전달하지 마십시오.
content.data[].jsonScript.callKwargs object 기록/기타 진입점에서 저장했을 수 있는 실행 파라미터이며, 공개 create/modify에서는 선언되지 않아 새로 전달할 수 없습니다.
content.data[].jsonScript.callKwargs.파라미터 이름 JSON 구체적 실행 파라미터는 원래 함수 정의에 따라 해석되며 존재를 보장하지 않습니다.
content.data[].crontabInfo object 자체 구축 점검은 이 진입점에서 주기 트리거 구성을 생성하지 않으며 일반적으로 {}입니다.
content.data[].crontabInfo.기록 필드 JSON 기록에는 스케줄 정보가 남아 있을 수 있으나 이 인터페이스에서 쓸 수 있는 구성은 아닙니다.
content.data[].extend object 확장 메타 정보, 공개 Body에 선언되지 않았으며 생성 시 일반적으로 {}입니다.
content.data[].extend.기록 필드 JSON 기록에 저장된 확장 필드, 이 진입점에서는 다시 전달하여 수정하는 것을 지원하지 않습니다.
content.data[].createdWay string 일반적으로 manual이며 기록상 import/template/빈 값일 수도 있습니다.
content.data[].isLocked integer 또는 boolean 잠금 표시입니다.
content.data[].openPermissionSet boolean 사용자 정의 작업 권한 스위치, 생성 시 false, modify 공유 작업 업데이트 시 false로 복원됩니다.
content.data[].permissionSet array<string> 작업 권한 주체, 생성 시 []; modify 공유 업데이트 시 []로 복원됩니다.
content.data[].permissionSet[] string 기록된 계정/팀/역할 식별자입니다.
content.data[].status integer 0 활성화, 2 비활성화, 3 삭제; 최근 점검 결과와 같지 않습니다.
content.data[].creator string 생성 주체입니다.
content.data[].updator string 업데이트 주체, 초기에는 비어 있을 수 있습니다.
content.data[].createAt integer 생성 Unix 초입니다.
content.data[].updateAt integer 업데이트 Unix 초, 업데이트되지 않은 경우 -1입니다.
content.data[].deleteAt integer 삭제 Unix 초, 삭제되지 않은 경우 -1입니다.
content.data[].creatorInfo object ID 요약, 찾지 못한 경우 {}입니다.
content.data[].creatorInfo.uuid string ID UUID, 생략 가능.
content.data[].creatorInfo.status integer 계정 상태, 생략 가능.
content.data[].creatorInfo.wsAccountStatus integer 워크스페이스 멤버 상태, 생략 가능.
content.data[].creatorInfo.name string 표시 이름.
content.data[].creatorInfo.username string 로그인 이름.
content.data[].creatorInfo.email string 이메일 또는 시스템 ID 식별자.
content.data[].creatorInfo.mobile string 휴대폰 번호, 비어 있을 수 있습니다.
content.data[].creatorInfo.countryCode string 국가/지역 코드, 생략 가능.
content.data[].creatorInfo.iconUrl string 아바타, 생략 가능.
content.data[].creatorInfo.acntWsNickname string 워크스페이스 닉네임, 생략 가능.
content.data[].updatorInfo object ID 요약, 찾지 못한 경우 {}입니다.
content.data[].updatorInfo.uuid string ID UUID, 생략 가능.
content.data[].updatorInfo.status integer 계정 상태, 생략 가능.
content.data[].updatorInfo.wsAccountStatus integer 워크스페이스 멤버 상태, 생략 가능.
content.data[].updatorInfo.name string 표시 이름.
content.data[].updatorInfo.username string 로그인 이름.
content.data[].updatorInfo.email string 이메일 또는 시스템 ID 식별자.
content.data[].updatorInfo.mobile string 휴대폰 번호, 비어 있을 수 있습니다.
content.data[].updatorInfo.countryCode string 국가/지역 코드, 생략 가능.
content.data[].updatorInfo.iconUrl string 아바타, 생략 가능.
content.data[].updatorInfo.acntWsNickname string 워크스페이스 닉네임, 생략 가능.
content.data[].monitorName string 현재 연결된 그룹 표시 이름, 없으면 비어 있습니다.
content.data[].alertPolicyInfos array<object> 유효하게 연결된 알림 정책 요약입니다.
content.data[].alertPolicyInfos[].uuid string 정책 UUID입니다.
content.data[].alertPolicyInfos[].name string 정책 이름입니다.
content.declaration object 공통 선언입니다.
pageInfo object 비어 있지 않은 페이지에는 페이지네이션이 있으며, 빈 페이지는 {}일 수 있습니다.
pageInfo.pageIndex integer 현재 페이지, 생략 가능.
pageInfo.pageSize integer 페이지당 수량, 생략 가능.
pageInfo.count integer 이 페이지의 항목 수, 생략 가능.
pageInfo.totalCount integer 일치하는 총 개수, 생략 가능.
{
  "code": 200,
  "content": {
    "data": [
      {
        "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,
        "monitorName": "",
        "alertPolicyInfos": [
          {
            "uuid": "altpl_example",
            "name": "生产告警"
          }
        ],
        "creatorInfo": {},
        "updatorInfo": {}
      }
    ],
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE",
  "pageInfo": {
    "pageIndex": 1,
    "pageSize": 100,
    "count": 1,
    "totalCount": 1
  }
}

오류 응답

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

HTTP 상태 errorCode 트리거 조건 메시지 또는 응답 설명 처리 방식
406 ft.ParameterValidationFailed 선언되지 않은 Query 파라미터를 사용했거나 파라미터가 규칙을 위반한 경우 파라미터 파싱 실패 Query 파라미터 표와 예시를 확인하십시오.
500 ft.InternalServerError 규칙, 참조 또는 ID 정보 읽기/포맷팅 실패 내부 오류 워크스페이스와 유효한 식별자를 확인한 후 재시도하고, 계속 실패하면 traceId를 제공하십시오.

문서 평가

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