VPC環境で利用できます。
サーバインスタンス(VM)を作成します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
GET | POST | /vserver/v2/createServerInstances |
参考
ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。
リクエストヘッダ
Server APIで共通して使用されるヘッダの詳細は、Serverのリクエストヘッダをご参照ください。
リクエストクエリパラメータ
リクエストクエリパラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
regionCode |
String | Optional | リージョンコード
|
memberServerImageInstanceNo |
String | Conditional | サーバイメージインスタンス番号
|
serverImageNo |
String | Conditional | サーバイメージ番号
|
serverImageProductCode |
String | Conditional | サーバイメージ商品コード
|
serverSpecCode |
String | Conditional | サーバスペックコード
|
serverProductCode |
String | Optional | サーバ商品コード
|
vpcNo |
String | Required | VPC番号
|
subnetNo |
String | Required | Subnet番号
|
isEncryptedBaseBlockStorageVolume |
Boolean | Optional | 基本ブロックストレージボリュームを暗号化するか
|
feeSystemTypeCode |
String | Optional | 料金プランのタイプコード
|
serverCreateCount |
Integer | Optional | サーバ作成数
|
serverCreateStartNo |
Integer | Optional | サーバ作成開始番号
|
serverName |
String | Optional | サーバ名
|
networkInterfaceList.N.networkInterfaceOrder |
Integer | Required | ネットワークインターフェースの順序
|
networkInterfaceList.N.networkInterfaceNo |
String | Conditional | ネットワークインターフェース番号
|
networkInterfaceList.N.subnetNo |
String | Conditional | ネットワークインターフェースの Subnet番号
|
networkInterfaceList.N.ip |
String | Optional | ネットワークインターフェースの IPアドレス
|
networkInterfaceList.N.accessControlGroupNoList.N |
Array | Conditional | ネットワークインターフェースの ACG番号リスト
|
placementGroupNo |
String | Optional | 物理配置グループ番号
|
isProtectServerTermination |
Boolean | Optional | 返却保護にするか
|
serverDescription |
String | Optional | サーバの説明(Byte)
|
initScriptNo |
String | Optional | 初期化スクリプト番号
|
loginKeyName |
String | Optional | 認証キー名
|
associateWithPublicIp |
Boolean | Optional | 新規グローバル IPアドレスの作成・割り当て
|
raidTypeName |
String | Conditional | RAIDタイプ名
|
blockDevicePartitionList.N.mountPoint |
String | Optional | マウントポイント
|
blockDevicePartitionList.N.partitionSize |
String | Optional | パーティション容量
|
blockStorageMappingList.N.order |
Integer | Optional | 作成ストレージの順序
|
blockStorageMappingList.N.snapshotInstanceNo |
String | Optional | 作成ストレージスナップショット番号
|
blockStorageMappingList.N.blockStorageSize |
String | Optional | 作成ストレージの容量
|
blockStorageMappingList.N.blockStorageName |
String | Optional | 作成ストレージ名
|
blockStorageMappingList.N.blockStorageVolumeTypeCode |
String | Optional | 作成ストレージのボリュームタイプコード
|
blockStorageMappingList.N.encrypted |
String | Optional | 作成ストレージを暗号化するか
|
fabricClusterPoolNo |
String | Optional | GPU Fabric Cluster Poolを指定
|
responseFormatType |
String | Optional | レスポンスデータの形式
|
参考
リクエストクエリパラメータの入力時、下記の内容をご確認ください。
- 新規サーバイメージでサーバを作成する場合、作成するサーバのハイパーバイザタイプによって使用可能なフィールドが次のように異なります。
- KVM:
serverImageNo
とserverSpecCode
を使用 - XEN:
serverImageNo
とserverSpecCode
またはserverImageProductCode
とserverProductCode
を使用 - RHV:
serverImageNo
とserverSpecCode
またはserverImageProductCode
とserverProductCode
を使用
- KVM:
associateWithPublicIp
: グローバル IPアドレスの割り当て後は料金が発生しますので、使用しない場合は返却してください。blockDevicePartitionList.N.mountPoint
: 作成するサーバスペックによってはパーティションをサポートしない場合があります。
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/createServerInstances
?regionCode=KR
&serverImageProductCode=SW.VSVR.OS.LNX64.UBNTU.SVR2004.B050
&vpcNo=***75
&subnetNo=***36
&serverProductCode=SVR.VSVR.STAND.C002.M008.NET.SSD.B050.G002
&feeSystemTypeCode=MTRAT
&serverCreateCount=1
&serverName=test-***
&networkInterfaceList.1.networkInterfaceOrder=0
&networkInterfaceList.1.accessControlGroupNoList.1=***43
&isProtectServerTermination=false
&loginKeyName=test-***
&associateWithPublicIp=true
&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}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
createServerInstancesResponse |
Object | - | レスポンス結果 |
createServerInstancesResponse.requestId |
String | - | リクエスト ID
|
createServerInstancesResponse.returnCode |
String | - | レスポンスコード |
createServerInstancesResponse.returnMessage |
String | - | レスポンスメッセージ |
レスポンスステータスコード
Server APIで共通して使用されるレスポンスステータスコードの詳細は、Serverのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"createServerInstancesResponse": {
"totalRows": 1,
"serverInstanceList": [
{
"serverInstanceNo": "*****9212",
"serverName": "test-***",
"serverDescription": "",
"cpuCount": 2,
"memorySize": 8589934592,
"platformType": {
"code": "UBS64",
"codeName": "Ubuntu Server 64 Bit"
},
"loginKeyName": "test-***",
"publicIpInstanceNo": "",
"publicIp": "",
"serverInstanceStatus": {
"code": "INIT",
"codeName": "サーバ INIT状態"
},
"serverInstanceOperation": {
"code": "NULL",
"codeName": "サーバ NULL OP"
},
"serverInstanceStatusName": "init",
"createDate": "2025-06-13T17:01:34+0900",
"uptime": "2025-06-13T17:01:33+0900",
"serverImageProductCode": "SW.VSVR.OS.LNX64.UBNTU.SVR2004.B050",
"serverProductCode": "SVR.VSVR.STAND.C002.M008.NET.SSD.B050.G002",
"isProtectServerTermination": false,
"zoneCode": "KR-1",
"regionCode": "KR",
"vpcNo": "",
"subnetNo": "",
"networkInterfaceNoList": [],
"initScriptNo": "",
"serverInstanceType": {
"code": "STAND",
"codeName": "Standard"
},
"baseBlockStorageDiskType": {
"code": "NET",
"codeName": "ネットワークストレージ"
},
"baseBlockStorageDiskDetailType": {
"code": "SSD",
"codeName": "SSD"
},
"placementGroupNo": "",
"placementGroupName": "",
"memberServerImageInstanceNo": "",
"hypervisorType": {
"code": "XEN",
"codeName": "XEN"
},
"serverImageNo": "16187005",
"serverSpecCode": "s2-g2-s50",
"eventList": []
}
],
"requestId": "e4a3ca5e-9b81-4b3b-8011-ad0f0e2bf71a",
"returnCode": "0",
"returnMessage": "success",
}
}