주소 그룹 목록 조회

사용 가능한 주소 그룹 목록을 조회합니다.

HTTP 요청

GET /api/sonar/address-groups
cURL 예시
curl -H "Authorization: Bearer <API_KEY>" \
     "https://HOSTNAME/api/sonar/address-groups?offset=0&limit=20"
요청 매개변수
필수타입설명비고
offsetX32비트 정수건너뛸 갯수기본값 0
limitX32비트 정수최대 갯수기본값 2147483647
keywordsX문자열검색 키워드name, description 대상으로 검색

정상 응답

{
  "total_count": 1,
  "address_groups": [
    {
      "guid": "4dc14f3d-ebf8-4032-8a7a-ef9ec6cd3dd2",
      "company_guid": "6fbe27b7-f1ae-4d7a-a1a5-76d8fa9aa311",
      "company_name": "로그프레소",
      "name": "방화벽 차단 IP",
      "description": "차단 연동용 IP 블랙리스트",
      "count": 1,
      "version": 7,
      "created": "2022-10-05 15:34:59+0900",
      "updated": "2022-10-06 00:46:35+0900"
    }
  ]
}
  • total_count (32비트 정수): 검색 조건과 일치하는 전체 주소 그룹 수
  • address_groups (배열): 검색 조건과 일치하는 페이징된 주소 그룹 목록
    • guid (문자열): 주소 그룹 고유 식별자
    • company_guid (문자열): 주소 그룹이 속한 회사의 고유 식별자
    • company_name (문자열): 주소 그룹이 속한 회사의 이름
    • name (문자열): 주소 그룹 이름
    • description (문자열): 주소 그룹 설명
    • count (32비트 정수): 주소 그룹에 속한 주소 갯수
    • version (32비트 정수): 단조 증가하는 버전
    • 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."
}