getApiAccessRule

이 가이드는 API 명세를 기반으로 자동 생성했습니다.

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

Ncloud API 표준 규격을 적용한 API입니다.

지정한 서브 계정의 API 접근 소스 규칙을 반환합니다. API 접근을 소스로 제한하는지 여부와 허용된 소스 목록을 함께 제공합니다.

요청

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

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

요청 헤더

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

요청 경로 파라미터

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

필드	타입	필수 여부	설명
`subAccountId`	String (uuid)	Required	대상 서브 계정의 식별자 <예시> 4e066e50-9c3a-11e7-8a66-1e5021fa7c80

요청 예시

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

curl --location --request GET 'https://subaccount.apigw.gov-ntruss.com/api/v2/sub-accounts/4e066e50-9c3a-11e7-8a66-1e5021fa7c80/api-access-rule' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`apiAllowSourceEnabled`	Boolean	-	액세스 키 접근 소스 제한 사용 여부 `true` \| `false` `true`: apiAllowSources에 지정한 소스에서만 액세스 키로 API 접근 가능 `false`: 접근 소스를 제한하지 않음 <예시> false
`apiAllowSources`	List<AllowSource>	-	Access Key 접근이 허용된 소스 목록

AllowSource

접근을 허용할 소스 정보

필드	타입	필수 여부	설명
`type`	String	-	허용 소스의 유형 `IP` \| `VPC` \| `VPC_SERVER` `IP`: IP 주소 또는 CIDR 대역 단위로 접근을 허용 `VPC`: VPC 단위로 접근을 허용 `VPC_SERVER`: VPC 서버 인스턴스 단위로 접근을 허용 <예시> IP
`source`	String	-	type에 따른 허용 소스 값. IP 유형은 IP 주소 또는 CIDR(예: 10.0.0.0/8), VPC 유형은 VPC 번호, VPC_SERVER 유형은 서버 인스턴스 번호를 지정 <예시> 10.0.0.0/8

응답 상태 코드

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

이 API에만 해당하는 응답 상태 코드는 다음과 같습니다.

HTTP 상태 코드	코드	메시지	설명
200	-	-	서브 계정의 API 접근 규칙을 반환
400	BadRequest	The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.	유효하지 않은 요청. subAccountId 값의 형식·허용 범위 검증에 실패
403	Forbidden	You do not have sufficient permissions to perform this action.	요청한 자원(또는 상위 자원)에 대한 접근 권한 없음. 자원의 존재 여부와 무관하게 우선 반환
404	SubAccountNotFound	The specified sub account could not be found.	지정한 서브 계정이 존재하지 않음

응답 예시

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

{
  "apiAllowSourceEnabled": false,
  "apiAllowSources": [
    {
      "type": "IP",
      "source": "10.0.0.0/8"
    }
  ]
}