createInitScript

VPC環境で利用できます。

初期化スクリプト(Init Script)を作成します。初期化スクリプトは、予め作成しておいたスクリプトをサーバ作成時に自動的に実行させる機能であり、同じ用途のサーバを一括作成したり、定期的に作成することができます。

リクエスト

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

メソッド	URI
GET \| POST	/vserver/v2/createInitScript

参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

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

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	リージョンコード getRegionListを参照照会結果の最初のリージョン(デフォルト)
`initScriptContent`	String	Required	初期化スクリプトの内容(KB) 0~1024 英字のみ入力可能 Linux: Python、Perl、Shellなどのスクリプトを使用可能 1行目にスクリプトのパスを指定 <例> #!/usr/bin/env python、#!/bin/perl、#!/bin/bash Windows: Visual Basicスクリプトを使用可能
`initScriptName`	String	Optional	初期化スクリプト名英数字、記号の「-」を組み合わせて3~30文字以内で入力文字列の先頭文字は英字、末尾文字は英字または数字のみ使用入力しないと自動作成 (デフォルト)
`initScriptDescription`	String	Optional	初期化スクリプトの説明(Byte) 0~1000
`osTypeCode`	String	Optional	OSタイプコード `LNX` (デフォルト) \| `WND` `LNX`: Linux `WND`: Windows
`responseFormatType`	String	Optional	レスポンスデータの形式 `xml`(デフォルト) \| `json`

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/createInitScript
?regionCode=KR
&initScriptContent=%23!%2Fbin%2Fbash%20echo%20%5B1%2F5%5D%20Setting%20system%20locale%20to%20en_US.UTF-8...%20sudo%20locale-gen%20en_US.UTF-8%20sudo%20update-locale%20LANG%3Den_US.UTF-8
&initScriptName=init2
&initScriptDescription=%EC%96%B8%EC%96%B4%20%EC%84%A4%EC%A0%95%20%EC%8A%A4%ED%81%AC%EB%A6%BD%ED%8A%B8
&osTypeCode=LNX
&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`createInitScriptResponse`	Object	-	レスポンス結果 InitScriptListを参照
`createInitScriptResponse.requestId`	String	-	リクエスト ID UUID形式
`createInitScriptResponse.returnCode`	String	-	レスポンスコード
`createInitScriptResponse.returnMessage`	String	-	レスポンスメッセージ

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

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

レスポンス例

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

{
  "createInitScriptResponse": {
    "totalRows": 1,
    "initScriptList": [
      {
        "initScriptNo": "2***6",
        "initScriptName": "init2",
        "createDate": "2025-06-20T09:40:05+0900",
        "initScriptDescription": "言語設定スクリプト",
        "initScriptContent": "#!/bin/bash echo [1/5] Setting system locale to en_US.UTF-8... sudo locale-gen en_US.UTF-8 sudo update-locale LANG=en_US.UTF-8",
        "osType": {
          "code": "LNX",
          "codeName": "LINUX"
        }
      }
    ],
    "requestId": "2ccd6246-****-****-****-8ab2725ed23e",
    "returnCode": "0",
    "returnMessage": "success"
  }
}