API 접근 규칙 조회

Prev Next

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

서브 계정 API 접근 규칙을 조회합니다.

요청

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

메서드 URI
GET /api/v1/sub-accounts/{subAccountId}/access-rules/api

요청 헤더

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

요청 경로 파라미터

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

필드 타입 필수 여부 설명
subAccountId String Required 서브 계정 아이디

요청 예시

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

curl --location --request GET 'https://subaccount.apigw.gov-ntruss.com/api/v1/sub-accounts/2b141960-****-****-****-246e9659184c/access-rules/api' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Accept: application/json'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
useApiAllowSource Boolean - API 접근 가능 소스 제한 여부
  • true | false
    • true: 지정한 소스에서만 접근 가능
    • false: 모든 소스에서 접근 가능
apiAllowSources Array - API 접근 가능 소스 목록

apiAllowSources

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

필드 타입 필수 여부 설명
type String - 접근 소스 유형
  • IP | VPC | VPC_SERVER
    • IP: 서버 단일 IP 또는 서브넷을 포함한 IP 대역
    • VPC: 사용 중인 VPC
    • VPC_SERVER: 사용 중인 VPC 환경의 서버
source String - 접근 가능한 소스 정보

응답 상태 코드

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

응답 예시

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

{
    "useApiAllowSource": true,
    "apiAllowSources": [
        {
            "type": "IP",
            "source": "***.***.***.***"
        }
    ]
}