장기 미사용 서브계정 비활성화 설정

Prev Next

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

서브 계정의 장기 미사용 서브계정 비활성화 기간을 설정합니다. 서브 계정 미사용 일수가 설정한 비활성화 기간을 초과하는 경우 서브계정은 비활성화 처리 됩니다.

요청

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

메서드 URI
POST /api/v1/tenant-settings/idle-disable-settings

요청 헤더

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

요청 바디

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

필드 타입 필수 여부 설명
useIdleDisable Boolean Required 미사용 서브계정 비활성화 설정 여부
  • true | false
    • true: 설정
    • false: 설정 안 함
idleDisableDays Integer Conditional 미사용 서브계정 기간 설정(일)
  • 90 | 180 | 365
  • useIdleDisabletrue인 경우, 필수 입력

요청 예시

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

curl --location --request POST 'https://subaccount.apigw.gov-ntruss.com/api/v1/tenant-settings/idle-disable-settings' \
--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' \
--header 'Content-Type: application/json' \
--data '{
    "useIdleDisable": true,
    "idleDisableDays": 90
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
success Boolean - API 호출 성공 여부
  • true | false
    • true: 성공
    • false: 실패

응답 상태 코드

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

응답 예시

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

{
    "success": true
}