setLifetime

VPC環境で利用できます。

Data Forestアプリの稼働時間(Lifetime)を変更します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
POST	/api/v2/apps/setLifetime

リクエストヘッダ

Data Forest APIで共通して使用されるヘッダの詳細は、Data Forestのリクエストヘッダをご参照ください。

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`id`	String	Required	アプリ固有 ID 0~22文字 UUIDを Base62に変換した形式 getListを参照
`lifetime`	Integer	Optional	アプリ稼働時間(秒) 300~604800(デフォルト: 604800)

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://df.apigw.ntruss.com/api/v2/apps/setLifetime' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "id": "***ziexhg0FcWx5eGUA***",
    "lifetime": 400
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`success`	Boolean	-	API処理結果 `true` \| `false` `true`: 成功 `false`: 失敗
`message`	String	-	結果メッセージ `success`が`false`の場合、表示
`id`	String	-	アプリ固有 ID UUIDを Base62に変換した形式

レスポンスステータスコード

Data Forest APIで共通して使用されるレスポンスステータスコードの詳細は、Data Forestのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "success": true,
    "id": "***ziexhg0FcWx5eGUA***"
}