updateIdleDisableSetting

Prev Next

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

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

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

장기간 사용하지 않은 서브 계정을 자동으로 비활성화하는 테넌트 정책을 교체하고, 수정된 설정을 반환합니다. 미사용 비활성화를 활성화하면 미사용 기간(일)을 입력해야 합니다. 같은 자원에 대한 수정 요청이 동시에 발생하면 마지막 요청이 적용됩니다.

요청

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

메서드 URI
PUT /tenant-settings/idle-disable-setting

요청 헤더

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

요청 바디

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

필드 타입 필수 여부 설명
idleDisableEnabled Boolean Required 장기 미사용 비활성화 정책 사용 여부
  • true | false
    • true: idleDisableDays 동안 사용하지 않은 서브 계정을 비활성화
    • false: 장기 미사용 서브 계정을 비활성화하지 않음
  • <예시> true
idleDisableDays Integer (int32) Optional 서브 계정이 비활성화되기까지의 미사용 일수
  • 90 | 180 | 365
  • <예시> 90

요청 예시

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

curl --location --request PUT 'https://subaccount.apigw.gov-ntruss.com/api/v2/tenant-settings/idle-disable-setting' \
--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 '{
  "idleDisableEnabled": true
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
idleDisableEnabled Boolean - 장기 미사용 비활성화 정책 사용 여부
  • true | false
    • true: idleDisableDays 동안 사용하지 않은 서브 계정을 비활성화
    • false: 장기 미사용 서브 계정을 비활성화하지 않음
  • <예시> true
idleDisableDays Integer (int32) - 서브 계정이 비활성화되기까지의 미사용 일수
  • <예시> 90

응답 상태 코드

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. 요청한 자원(또는 상위 자원)에 대한 접근 권한 없음. 자원의 존재 여부와 무관하게 우선 반환

응답 예시

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

{
  "idleDisableEnabled": true,
  "idleDisableDays": 90
}