createLaunchConfiguration

Prev Next

VPC環境で利用できます。

Launch Configurationを作成します。

リクエスト

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

メソッド URI
GET | POST /vautoscaling/v2/createLaunchConfiguration
参考

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • getRegionListを参照
    • 照会結果の最初のリージョン(デフォルト)
memberServerImageInstanceNo String Conditional サーバイメージインスタンス番号
  • ユーザーが作成したサーバイメージでサーバ作成(Scale-out)時、入力
  • memberServerImageInstanceNo、serverImageNo、serverImageProductCodeのうち、いずれか1つは必ず入力
  • getMemberServerImageInstanceListを参照
serverImageNo String Conditional サーバイメージ番号
  • 新規サーバイメージでサーバ作成(Scale-out)時、入力 (KVM、RHV、XEN)
  • memberServerImageInstanceNo、serverImageNo、serverImageProductCodeのうち、いずれか1つは必ず入力
  • getServerImageListを参照
serverImageProductCode String Conditional サーバイメージ商品コード
  • 新規サーバイメージでサーバ作成(Scale-out)時、入力 (RHV、XEN)
  • memberServerImageInstanceNo、serverImageNo、serverImageProductCodeのうち、いずれか1つは必ず入力
  • getServerImageProductListを参照
serverSpecCode String Conditional サーバスペックコード
  • serverImageProductCode使用時、サーバスペックを設定
  • デフォルト: 最小スペック(メモリ、CPU、基本ブロックストレージ容量、ディスクタイプ(NET)の順)
  • getServerSpecListを参照
serverProductCode String Conditional サーバ商品コード
  • serverImageProductCode使用時、サーバスペックを設定
  • デフォルト: 最小スペック(メモリ、CPU、基本ブロックストレージ容量、ディスクタイプ(NET)の順)
  • getServerProductListを参照
isEncryptedVolume Boolean Optional 基本ブロックストレージボリュームを暗号化するか
  • true | false (デフォルト)
    • true: 暗号化
    • false: 暗号化しない
  • RHVサーバイメージでのみ設定可能
initScriptNo String Optional 初期化スクリプト番号
  • 最初の起動時、ユーザーが設定した初期化スクリプトを実行
  • getInitScriptListを参照
launchConfigurationName String Optional Launch Configuration名
  • 英字の小文字、数字、記号の「-」を組み合わせて1~255文字以内で入力
  • 文字列の先頭文字は英字の小文字、末尾文字は英字の小文字または数字のみ使用
  • 入力しないと自動作成 (デフォルト)
loginKeyName String Optional 認証キー名
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json
参考

リクエストクエリパラメータの入力時、下記の内容をご確認ください。

  • 新規サーバイメージでサーバを作成(Scale-out)する場合、サーバイメージのハイパーバイザタイプによって使用可能なフィールドは次のように異なります。
    • KVM: serverImageNoとserverSpecCodeを使用
    • XEN: serverImageNoとserverSpecCodeまたはserverImageProductCodeとserverProductCodeを使用
    • RHV: serverImageNoとserverSpecCodeまたはserverImageProductCodeとserverProductCodeを使用

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vautoscaling/v2/createLaunchConfiguration
?regionCode=KR
&serverImageNo=100614134
&serverProductCode=SVR.VSVR.CPU.C002.M004.G003
&launchConfigurationName=launchconfigtest
&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}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
    "createLaunchConfigurationResponse": {
        "totalRows": 1,
        "launchConfigurationList": [
            {
                "regionCode": "KR",
                "launchConfigurationNo": "5994",
                "launchConfigurationName": "launchconfigtest",
                "serverImageProductCode": "SW.VSVR.OS.LNX64.UBNTU.SVR24.G003",
                "serverProductCode": "SVR.VSVR.CPU.C002.M004.G003",
                "loginKeyName": "ncp-loginkey",
                "createDate": "2025-06-12T14:15:45+0900",
                "launchConfigurationStatus": {
                    "code": "CREAT",
                    "codeName": "Created"
                },
                "initScriptNo": "",
                "isEncryptedVolume": false,
                "serverImageNo": "100614134",
                "osInformation": "ubuntu-24.04",
                "serverSpecNo": "1916",
                "serverSpecCode": "ci2-g3",
                "serverSpecDescription": "vCPU 2EA, Memory 4GB"
            }
        ],
        "requestId": "2d7f87e6-****-****-****-94b87f5f5500",
        "returnCode": "0",
        "returnMessage": "success"
    }
}