프로시저 목록

검색 조건과 일치하는 프로시저 목록을 조회합니다.

HTTP 요청

cURL 예시

curl -H "Authorization: Bearer <API_KEY>" \
     https://HOSTNAME/api/sonar/procedures

요청 매개변수

정상 응답

{
    "total_count": 1,
    "procedures": [
        {
            "guid": "5ad13151-dbc1-41c0-92a7-dfeb5f534f4c",
            "name": "test",
            "description": null,
            "parameters": [
                {
                    "name": "테이블",
                    "description": "검색 대상 테이블 이름",
                    "type": "string",
                    "key": "table"
                }
            ],
            "query": "system tables | search table == $(\"table\")",
            "owner_guid": "13437402-81ed-4b6c-8a6f-7893c7c958b1",
            "owner_name": "데모",
            "owner_login_name": "demo",
            "company_public": false,
            "created": "2023-10-03 12:38:13+0900",
            "updated": "2023-10-03 22:14:28+0900"
        }
    ]
}

프로시저 목록 조회는 계정 및 그룹 권한 부여 상태를 반환하지 않습니다.

• total_count (32비트 정수): 검색 조건과 일치하는 프로시저 개수
• procedures (배열): 프로시저 목록
  • guid (문자열): 프로시저 식별자
  • name (문자열): 프로시저 이름
  • description (문자열): 프로시저 설명
  • parameters (배열): 매개변수 목록
    • name (문자열): 매개변수 화면 표시 이름
    • description (문자열): 매개변수 설명
    • type (문자열): 매개변수 타입. string, int, double, bool, datetime, date, ip 중 하나.
    • key (문자열): 매개변수 이름
  • query (문자열): 쿼리 문자열
  • owner_guid (문자열): 소유자 식별자
  • owner_name (문자열): 소유자 성명
  • owner_login_name (문자열): 소유자 로그인 계정
  • company_public (불리언): 전체 공유 여부
  • created (문자열): 생성일시 (yyyy-MM-dd HH:mm:ssZ 형식)
  • updated (문자열): 수정일시 (yyyy-MM-dd HH:mm:ssZ 형식)

오류 응답

offset, limit 값이 정수가 아닌 경우

HTTP 상태 코드 400 응답

{
    "error_code": "invalid-argument",
    "error_msg": "'offset' parameter should be int type"
}

offset, limit 값이 음수인 경우

HTTP 상태 코드 400 응답

{
    "error_code": "invalid-argument",
    "error_msg": "'offset' must be greater than or equal to 0."
}