updateConsoleAccessRule

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

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

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

지정한 서브 계정의 콘솔 접근 소스 규칙을 교체하고, 수정된 접근 규칙을 반환합니다. 콘솔 접근을 IP로 제한할지 여부와 허용 주소 전체 목록을 설정합니다. 요청에 포함되지 않은 기존 허용 IP는 모두 제거되므로 유지할 IP를 포함한 전체 목록을 항상 전송해야 하며, IP 제한을 사용하면서 현재 접속 중인 IP를 목록에서 누락하면 콘솔 접근이 차단될 수 있습니다. 같은 자원에 대한 수정 요청이 동시에 발생하면 마지막 요청이 적용됩니다.

요청

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

메서드	URI
PUT	/sub-accounts/{subAccountId}/console-access-rule

요청 헤더

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

요청 경로 파라미터

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

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

요청 바디

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

필드	타입	필수 여부	설명
`consolePermitIpEnabled`	Boolean	Required	콘솔 접근 IP 대역 제한 사용 여부 `true` \| `false` `true`: consolePermitIpAddresses에 지정한 IP 대역에서만 콘솔 접근 가능 `false`: IP 대역을 제한하지 않음 <예시> false
`consolePermitIpAddresses`	List<String>	Optional	콘솔 접근을 허용할 IP 대역 전체 목록. 각 항목은 IPv4·IPv6 주소 또는 CIDR 대역 형식으로 입력. 전송한 목록으로 기존 목록이 전체 교체. consolePermitIpEnabled가 true이면 필수입니다 — 생략하면 허용 IP가 없어져 콘솔 접근이 차단되므로 요청을 거부. consolePermitIpEnabled가 false이면 제한을 사용하지 않으므로 생략 가능 항목 수: 0 ~ 100 <예시> `["10.0.0.0/8"]`

요청 예시

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

curl --location --request PUT '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}' \
--header 'Content-Type: application/json' \
--data '{
  "consolePermitIpEnabled": false
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`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.	유효하지 않은 요청. 필수 필드 누락, 형식 오류 등 입력값 검증 실패
403	Forbidden	You do not have sufficient permissions to perform this action.	요청한 자원(또는 상위 자원)에 대한 접근 권한 없음. 자원의 존재 여부와 무관하게 우선 반환
404	SubAccountNotFound	The specified sub account could not be found.	지정한 서브 계정이 존재하지 않음

응답 예시

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

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