Skip to content

서브넷 목록 조회

서브넷 목록을 조회합니다.

HTTP 요청

http
GET https://<your-console-host>/api/v1/network/subnets

URI 매개변수

없습니다.

쿼리 매개변수

이름필수형식설명
name선택array (string)서브넷 이름 필터
id선택array (string)서브넷 ID 필터
cidr선택array (string)서브넷 CIDR 필터
gatewayIp선택array (string)게이트웨이 IP 필터
portCount선택integer 또는 null포트 수 필터. 범위 0~
createdAtGte선택string 또는 null생성 일시 시작 필터 (포함), ISO8601 YYYY-MM-DD
createdAtLte선택string 또는 null생성 일시 종료 필터 (포함), ISO8601 YYYY-MM-DD
createdAtRange선택array (string)생성 일시 구간 필터 (복수 선택 시 OR). 형식 'YYYY-MM-DD..YYYY-MM-DD' (열린 구간 'a..'/'..b' 허용). 지정 시 created_at_gte/lte 는 무시됨
page선택integer조회 페이지 번호 (0=전체). 기본값 1. 범위 0~
pageSize선택integer페이지 크기. 기본값 20. 범위 1~100
sort선택string정렬 대상 컬럼. 값: name, gatewayIp, portCount, createdAt
order선택string정렬 방향 asc/desc. 값: asc, desc
networkId선택string 또는 null필터링할 네트워크 ID

요청 헤더

인증 헤더와 파티션 헤더는 모든 API 가 같습니다. 공통 규약을 참고하십시오.

응답

상태 코드설명
200 OKSuccessful Response
422 Unprocessable EntityValidation Error

위 표는 정상 응답과 요청 검증 실패만 나열합니다. 이 API 는 그 밖에 401(인증 실패) · 403(권한 없음) · 404(리소스 없음) · 502(인프라 오류)를 반환할 수 있습니다. 조건은 오류 처리를 참고하십시오.

응답 본문 — 200

이름필수형식설명
message선택string 또는 null응답 메시지
timestamp선택string응답 생성 시간
requestId필수string요청 식별자
result필수object데이터 목록 + 페이지네이션
result.data선택array (object)데이터 목록
result.data[].id선택string 또는 null
result.data[].name선택string 또는 null
result.data[].projectId선택string 또는 null
result.data[].tenantId선택string 또는 null
result.data[].networkId선택string 또는 null
result.data[].description선택string 또는 null
result.data[].ipVersion선택integer 또는 null
result.data[].cidr선택string 또는 null
result.data[].gatewayIp선택string 또는 null
result.data[].enableDhcp선택boolean 또는 null
result.data[].dnsNameservers선택array (string)
result.data[].allocationPools선택array (object)
result.data[].allocationPools[].start필수string
result.data[].allocationPools[].end필수string
result.data[].hostRoutes선택array (object)
result.data[].hostRoutes[].destination필수string
result.data[].hostRoutes[].nexthop필수string
result.data[].serviceTypes선택array (string)
result.data[].segmentId선택string 또는 null
result.data[].subnetpoolId선택string 또는 null
result.data[].ipv6RaMode선택string 또는 null
result.data[].ipv6AddressMode선택string 또는 null
result.data[].createdAt선택string (date-time)
result.data[].updatedAt선택string (date-time)
result.data[].revisionNumber선택integer 또는 null
result.data[].portCount선택integer 또는 null서브넷에 연결된 포트 수
result.data[].networkName선택string 또는 null서브넷이 속한 네트워크 이름
result.data[].isGatewayUsed선택boolean게이트웨이 IP 사용 여부. 기본값 false
result.dataCount필수integer데이터 개수. 범위 0~
result.pagination필수object페이지네이션 정보
result.pagination.page필수integer현재 페이지 번호 (0=전체 조회). 범위 0~
result.pagination.pageSize필수integer페이지 크기. 범위 1~
result.pagination.totalCount필수integer전체 데이터 개수. 범위 0~
result.pagination.totalPages필수integer전체 페이지 개수. 범위 0~
result.pagination.hasNext필수boolean다음 페이지 존재 여부
result.pagination.hasPrev필수boolean이전 페이지 존재 여부

Thaki Cloud Aegis — 연동 개발자용 API 문서