getAddressGroup
    • PDF

    getAddressGroup

    • PDF

    기사 요약

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

    Address Group 중 특정 그룹의 정보를 조회합니다.

    요청

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

    메서드URI
    POST/{type}/{zone}/getAddressGroup

    요청 헤더

    Secure Zone API에서 공통으로 사용하는 헤더에 대한 자세한 내용은 Secure Zone 요청 헤더를 참조해 주십시오.

    요청 경로 파라미터

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

    필드타입필수 여부설명
    typeStringRequiredSecure Zone에서 제공하는 방화벽 유형
    • szfw | psfw
      • szfw: Secure Zone Standard
      • psfw: Secure Zone Advanced
    zoneStringRequiredSecure Zone을 구성한 존
    • kr1 | kr2
      • kr1: KR-1 존
      • kr2: KR-2 존

    요청 바디

    요청 바디에 대한 설명은 다음과 같습니다.

    필드타입필수 여부설명
    addressGroupNameStringConditionalAddress Group 이름
    • getAddressGroupList를 통해 확인
    • addressGroupNo가 지정되지 않은 경우 필수
    • 둘 다 지정되지 않은 경우, 기본값은 null로 설정
    addressGroupNoIntegerConditionalAddress Group에 부여된 고유 번호
    • getAddressGroupList를 통해 확인
    • addressGroupName이 지정되지 않은 경우 필수
    • 둘 다 지정되지 않은 경우, 기본값은 null로 설정
    countPerPageIntegerOptional페이지당 항목 수
    • 20 (기본값)
    pageIntegerOptional페이지 인덱스
    • 1 (기본값)

    요청 예시

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

    curl --location --request POST 'https://securezonefirewall.apigw.ntruss.com/api/v2/szfw/kr2/getAddressGroup'
    --header 'x-ncp-apigw-timestamp: {Timestamp}' \
    --header 'x-ncp-iam-access-key: {Access Key}' \
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
    --header 'x-ncp-mbr_no: {User number}' \
    --header 'Content-Type: application/json' \
    --data '{
      "addressGroupName": "grp111",
      "addressGroupNo": 0,
      "countPerPage": 0,
      "page": 0
    }'
    

    응답

    응답 형식을 설명합니다.

    응답 바디

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

    필드타입필수 여부설명
    actionString-요청 유형
    returnCodeInteger-응답 코드
    returnMessageString-응답 메시지
    addressGroupList<String>-조회하는 Address Group 정보
    addressGroup.addressGroupNoInteger-Address Group에 부여된 고유 번호
    addressGroup.addressGroupNameString-Address Group 이름
    addressGroup.descriptionString-Address Group에 대한 설명
    addressGroup.memberNoString-사용자의 네이버 클라우드 플랫폼 회원 번호
    addressGroup.instanceNoString-인스턴스 생성 시 부여된 계약 번호
    addressGroup.addressList[]Array-Address Group에 속한 Address 정보
    addressGroup.addressList[].addressNoInteger-Address에 부여된 고유 번호
    addressGroup.addressList[].memberNoString-사용자의 네이버 클라우드 플랫폼 회원 번호
    addressGroup.addressList[].instanceNoString-인스턴스 생성 시 부여된 계약 번호
    addressGroup.addressList[].nameString-Address의 이름
    addressGroup.addressList[].ipString-IP 주소
    addressGroup.addressList[].portInteger-포트 번호
    • addressZonedb이고 typefqdn인 경우 표시
    addressGroup.addressList[].typeString-Address 유형 정보
    • ipmask | fqdn
      • ipmask: IP 주소와 서브넷 마스크로 정의된 주소
      • fqdn: Fully qualified domain name (전체 도메인 이름)
    addressGroup.addressList[].addressZoneString-Address가 속한 존에 대한 정보
    • sz | os | vm | db | vpn | lb | kr1
      • sz: Secure Zone
      • os: Object Storage
      • vm: VM
      • db: Cloud DB
      • vpn: SSL VPN 또는 IPsec VPN
      • lb: Load Balancer
      • kr1: KR-1 존
    addressGroup.addressList[].fqdnString-전체 도메인 이름 (FQDN)
    • typefqdn인 경우 표시
    addressGroup.addressList[].dbAddressZoneBoolean-DB Address Zone 여부
    addressGroup.addressList[].maskBitInteger-서브넷 마스크 비트 값
    • Secure Zone Advanced 타입인 경우 표시
    addressGroup.addressZoneString-Address가 속한 존에 대한 정보
    • sz | os | vm | db | vpn | lb | kr1
      • sz: Secure Zone
      • os: Object Storage
      • vm: VM
      • db: Cloud DB
      • vpn: SSL VPN 또는 IPsec VPN
      • lb: Load Balancer
      • kr1: KR-1 존
    addressGroup.associatedPoliciesCountInteger-미사용
    addressGroup.objectStorageBoolean-Object Storage 사용 여부
    • true | false
      • true: Object Storage를 사용함
      • false: Object Storage를 사용하지 않음

    응답 상태 코드

    네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 Ncloud API 응답 상태 코드를 참조해 주십시오.

    응답 예시

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

    {
        "action": "getAddressGroup",
        "returnCode": 0,
        "returnMessage": "success",
        "addressGroup": {
            "addressGroupNo": 5452,
            "addressGroupName": "dbgroup",
            "description": "",
            "memberNo": "27***85",
            "instanceNo": "25****11",
            "addressList": [
                {
                    "addressNo": 3646,
                    "memberNo": "27***85",
                    "instanceNo": "25****11",
                    "name": "test-db-001",
                    "ip": "***.***.***.***",
                    "port": "3306",
                    "type": "fqdn",
                    "addressZone": "db",
                    "fqdn": "db-****.cdb.ntruss.com"
                }
            ],
            "addressZone": "db",
            "associatedPoliciesCount": 0,
            "objectStorage": false
        }
    }
    

    이 문서가 도움이 되었습니까?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.