長期間未使用サブアカウント無効化の設定

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.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
}