getConsoleAccessRule

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

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

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

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

요청

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

메서드	URI
GET	/sub-accounts/{subAccountId}/console-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/console-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}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`subAccountId`	String (uuid)	-	서브 계정의 식별자 <예시> 4e066e50-9c3a-11e7-8a66-1e5021fa7c80
`consolePermitIpEnabled`	Boolean	-	콘솔 접근 IP 대역 제한 사용 여부 `true` \| `false` `true`: consolePermitIpAddresses에 지정한 IP 대역에서만 콘솔 접근 가능 `false`: IP 대역을 제한하지 않음 <예시> false
`consolePermitIpAddresses`	List<String>	-	콘솔 접근을 허용한 IP 대역 목록 <예시> `["10.0.0.0/8"]`

응답 상태 코드

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

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

HTTP 상태 코드	코드	메시지	설명
200	-	-	서브 계정의 콘솔 접근 규칙을 반환
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	NotFound	One or more of the resources in the request does not exist in the system.	지정한 서브 계정이 존재하지 않음

응답 예시

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

{
  "subAccountId": "4e066e50-9c3a-11e7-8a66-1e5021fa7c80",
  "consolePermitIpEnabled": false,
  "consolePermitIpAddresses": [
    "10.0.0.0/8"
  ]
}