IP ACL 목록 조회

Classic/VPC 환경에서 이용 가능합니다.

IP ACL 목록을 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET	/api/v1/ip-acls

요청 헤더

Ncloud Single Sign-On API에서 공통으로 사용하는 헤더에 대한 정보는 Ncloud Single Sign-On 요청 헤더를 참조해 주십시오.

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`searchWord`	String	Optional	검색 키워드 검색 컬럼 옵션(`ipAclName`, `nrn`)과 전체 또는 부분 일치하지 않는 값을 입력한 경우, 응답 시 `items`가 빈 값 `[]`으로 표시 `searchColumn` 없이 요청하는 경우, 전체 목록 표시
`searchColumn`	String	Conditional	검색 컬럼 `ipAclName` \| `nrn` `ipAclName`: IP ACL 이름 `nrn`: IP ACL에 대한 네이버 클라우드 플랫폼 리소스 식별 값
`page`	Integer	Optional	페이지 번호 0~N (기본값: 0)
`size`	Integer	Optional	페이지 출력 수 1~N (기본값: 20)

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://sso.apigw.gov-ntruss.com/api/v1/ip-acls' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`page`	Number	-	페이지 번호
`totalPages`	Number	-	전체 페이지 수
`totalItems`	Number	-	응답 결과 수
`isFirst`	Boolean	-	첫 페이지 여부 `true` \| `false` `true`: 첫 페이지 `false`: 첫 페이지 아님
`isLast`	Boolean	-	마지막 페이지 여부 `true` \| `false` `true`: 마지막 페이지 `false`: 마지막 페이지 아님
`hasPrevious`	Boolean	-	이전 페이지 존재 여부 `true` \| `false` `true`: 존재 `false`: 존재 안 함
`hasNext`	Boolean	-	다음 페이지 존재 여부 `true` \| `false` `true`: 존재 `false`: 존재 안 함
`items`	Array	-	IP ACL 목록

`items`

items에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`ipAclId`	String	-	IP ACL 아이디
`ipAclName`	String	-	IP ACL 이름
`description`	String	-	IP ACL 설명
`nrn`	String	-	IP ACL에 대한 네이버 클라우드 플랫폼 리소스 식별 값
`accessIps`	Array	-	접근 대상 IP 주소 목록
`createdAt`	String	-	IP ACL 생성 일시 ISO 8601 형식
`updatedAt`	String	-	IP ACL 수정 일시 ISO 8601 형식

응답 상태 코드

Ncloud Single Sign-On API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud Single Sign-On 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "page": 0,
    "totalPages": 1,
    "totalItems": 1,
    "isFirst": true,
    "isLast": true,
    "hasPrevious": false,
    "hasNext": false,
    "items": [
        {
            "ipAclId": "5bf4cad0-****-****-****-cd51bba3fe23",
            "ipAclName": "ipacl000",
            "description": "ipacl000 description",
            "nrn": "nrn:PUB:SSO::*******:IPACL/5bf4cad0-****-****-****-cd51bba3fe23",
            "accessIps": [
                "***.***.***.***"
            ],
            "createdAt": "2025-01-13T06:33:19Z",
            "updatedAt": "2025-01-13T06:33:19Z"
        }
    ]
}