getAddressGroup
- 인쇄
- PDF
getAddressGroup
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
Classic 환경에서 이용 가능합니다.
Address Group 중 특정 그룹의 정보를 조회합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
메서드 | URI |
---|---|
POST | /{type}/{zone}/getAddressGroup |
요청 헤더
Secure Zone API에서 공통으로 사용하는 헤더에 대한 자세한 내용은 Secure Zone 요청 헤더를 참조해 주십시오.
요청 경로 파라미터
파라미터에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
type | String | Required | Secure Zone에서 제공하는 방화벽 유형
|
zone | String | Required | Secure Zone을 구성한 존
|
요청 바디
요청 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
addressGroupName | String | Conditional | Address Group 이름
|
addressGroupNo | Integer | Conditional | Address Group에 부여된 고유 번호
|
countPerPage | Integer | Optional | 페이지당 항목 수
|
page | Integer | Optional | 페이지 인덱스
|
요청 예시
요청 예시는 다음과 같습니다.
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
}'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
action | String | - | 요청 유형 |
returnCode | Integer | - | 응답 코드 |
returnMessage | String | - | 응답 메시지 |
addressGroup | List<String> | - | 조회하는 Address Group 정보 |
addressGroup.addressGroupNo | Integer | - | Address Group에 부여된 고유 번호 |
addressGroup.addressGroupName | String | - | Address Group 이름 |
addressGroup.description | String | - | Address Group에 대한 설명 |
addressGroup.memberNo | String | - | 사용자의 네이버 클라우드 플랫폼 회원 번호 |
addressGroup.instanceNo | String | - | 인스턴스 생성 시 부여된 계약 번호 |
addressGroup.addressList[] | Array | - | Address Group에 속한 Address 정보 |
addressGroup.addressList[].addressNo | Integer | - | Address에 부여된 고유 번호 |
addressGroup.addressList[].memberNo | String | - | 사용자의 네이버 클라우드 플랫폼 회원 번호 |
addressGroup.addressList[].instanceNo | String | - | 인스턴스 생성 시 부여된 계약 번호 |
addressGroup.addressList[].name | String | - | Address의 이름 |
addressGroup.addressList[].ip | String | - | IP 주소 |
addressGroup.addressList[].port | Integer | - | 포트 번호
|
addressGroup.addressList[].type | String | - | Address 유형 정보
|
addressGroup.addressList[].addressZone | String | - | Address가 속한 존에 대한 정보
|
addressGroup.addressList[].fqdn | String | - | 전체 도메인 이름 (FQDN)
|
addressGroup.addressList[].dbAddressZone | Boolean | - | DB Address Zone 여부 |
addressGroup.addressList[].maskBit | Integer | - | 서브넷 마스크 비트 값
|
addressGroup.addressZone | String | - | Address가 속한 존에 대한 정보
|
addressGroup.associatedPoliciesCount | Integer | - | 미사용 |
addressGroup.objectStorage | Boolean | - | 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
}
}
이 문서가 도움이 되었습니까?