createServerInstances
    • PDF

    createServerInstances

    • PDF

    Article Summary

    VPC環境で利用できます。

    概要

    サーバインスタンス(VM)を作成します。

    リクエスト

    XEN/RHV/KVM ハイパーバイザタイプのサーバインスタンス(VM)を作成するには、serverImageNoと serverSpecCodeを使用します。
    また、serverImageProductCodeと serverProductCodeを利用すると、 XEN/RHV ハイパーバイザタイプのサーバインスタンス(VM)だけを作成できます。

    リクエストパラメータ

    パラメータ名必須有無タイプ制限事項説明
    regionCodeNoString- リージョンコード
    サーバインスタンスを作成するリージョン(Region)を決定可能
    regionCodeは、getRegionListアクションを通じて取得可能
    Default: getRegionList照会結果の最初のリージョンを選択
    memberServerImageInstanceNoConditionalString- 会員サーバイメージのインスタンス番号
    直接作成したサーバイメージからサーバを作成する場合に入力する
    会員サーバイメージのインスタンス番号(memberServerImageInstanceNo)とサーバイメージサービスコード(serverImageProductCode)のうち、1つは必ず入力
    memberServerImageInstanceNoは、getMemberServerImageInstanceListアクションを通じて取得可能
    serverImageProductCodeConditionalString- サーバイメージサービスコード
    新規サーバイメージを利用してサーバ作成時に入力する
    会員サーバイメージのインスタンス番号(memberServerImageInstanceNo)とサーバイメージサービスコード(serverImageProductCode)のうち、1つは必ず入力
    serverImageProductCodeは、getServerImageProductListアクションを通じて取得可能
    serverImageNoConditionalString- サーバイメージ番号
    新規サーバイメージを利用してサーバ作成時に入力する
    会員サーバイメージのインスタンス番号(memberServerImageInstanceNo)とサーバイメージサービスコード(serverImageProductCode)と同時使用不可
    serverImageNoは、getServerImageListアクションを通じて取得可能
    vpcNoYesString- VPC番号
    サーバインスタンスを作成する VPCを決定
    vpcNoは、getVpcListアクションを通じて取得可能
    subnetNoYesString- Subnet番号
    作成するサーバインスタンスでデフォルトネットワークインターフェースの Subnetを決定する
    subnetNoは、getSubnetListアクションを通じて取得可能
    serverProductCodeNoString- サーバサービスコード
    作成するサーバのスペックを決定可能
    serverProductCodeは、getServerProductListアクションを通じて取得可能
    Default: 最小スペックが選択される。最小スペックの基準は
    1. メモリ 2. CPU 3. 基本ブロックストレージサイズ 4. ディスクタイプ(NET)の手順に決定
    serverSpecCodeConditionalString- サーバスペックコード
    作成するサーバのスペックを決定可能
    serverSpecCode getServerSpecListアクションを通じて取得可能
    serverImageNo使用時、使用可能。
    Default: 最小スペックが選択される。最小スペックの基準は
    1. メモリ 2. CPU 3. 基本ブロックストレージサイズ 4. ディスクタイプ(NET)の手順に決定
    isEncryptedBaseBlockStorageVolumeNoBoolean- 基本ブロックストレージボリューム暗号化の有無
    RHVサーバイメージサービスの場合、基本ブロックストレージ暗号化有無を決定可能
    Options : true | false
    Default : false
    feeSystemTypeCodeNoString- 料金プランタイプコード
    作成するサーバの料金プランを決定可能
    Options: MTRAT(時間制/従量制) | FXSUM(月額制/定額制)
    Default : MTRAT
    serverCreateCountNoIntegerMin: 1、Max: 10個- サーバ作成数
    作成するサーバの数を決定可能
    Default: 1台
    serverCreateStartNoNoIntegerMin : 0, Max : 999
    サーバ作成数とサーバ作成開始番号の合計が1000を超えてはいけない
    - サーバ作成開始番号
    サーバの作成数が1より大きい場合、サーバ名にシリアル番号が付く。この場合、シリアル番号の開始番号を決定可能
    Default : 1
    serverNameNoStringMin : 3, Max : 30
    英小文字、数字、記号「-」のみ入力でき、先頭は英字にする
    末尾は英数字にする
    - サーバ名
    Default: NAVERクラウドプラットフォームが自動で付与
    networkInterfaceList.N.networkInterfaceOrderYesIntegerMin : 0, Max : 2- ネットワークインターフェースの順序
    作成するサーバに割り当てられるネットワークインターフェースの順序を決定
    その順序でデバイス名(eth0、eth1など)が決定
    デフォルトネットワークインターフェースが必ず1つ存在する
    デフォルトネットワークインターフェースに設定するには0を入力する
    ネットワークインターフェースは最大3個まで割り当て可能
    networkInterfaceList.N.networkInterfaceNoConditionalString- ネットワークインターフェース番号
    ユーザーが直接作成したネットワークインターフェースを追加する場合、そのネットワークインターフェース番号を入力する
    networkInterfaceNoは、getNetworkInterfaceListアクションを通じて取得可能
    networkInterfaceList.N.subnetNoConditionalString- ネットワークインターフェースのサブネット番号
    新規作成するネットワークインターフェースのサブネットまたは追加する既存ネットワークインターフェースのサブネットを決定する
    デフォルトネットワークインターフェースの場合、自動で割り当てる
    subnetNoは、getSubnetListアクションを通じて取得可能
    networkInterfaceList.N.ipNoString- ネットワークインターフェースの IPアドレス
    新規ネットワークインターフェースを作成する場合、ネットワークインターフェースに割り当てる IPアドレスを直接入力できる
    ネットワークインターフェースが作成されるサブネットの IPアドレスの範囲に含まれなければならない
    Subnetの0~5番目、最後の IPアドレスは使用できず、Subnetの範囲で重複した IPアドレスは使用不可
    Default: 条件を満たす IPアドレスが順次割り当てられる
    networkInterfaceList.N.accessControlGroupNoList.NConditionalList<String>- ネットワークインターフェースに適用する ACG番号リスト
    ネットワークインターフェースを新規作成する場合、必ず適用する ACGを決定する
    最大3つの ACGを適用可能
    accessControlGroupNoは、getAccessControlGroupListアクションを通じて取得可能
    ex) accessControlGroupNoList.1=1234&accessControlGroupNoList.2=2345
    placementGroupNoNoString- 物理配置グループ番号
    サーバインスタンスの所属物理配置グループを決定可能
    placementGroupNoは、getPlacementGroupListアクションを通じて取得可能
    isProtectServerTerminationNoBoolean- 返却保護の有無
    サーバを作成する時に返却保護有無を設定することで、誤って返却する事故を防止可能
    Options : true | false
    Default : false
    serverDescriptionNoStringMin : 0, Max : 1000 Bytes作成するサーバの説明
    initScriptNoNoString- 初期化スクリプト番号
    サーバの最初の起動時にユーザーが設定した初期化スクリプトを実行可能
    initScriptNoは、getInitScriptListアクションを通じて取得可能
    loginKeyNameNoString- ログインキー名
    サーバインスタンスアクセス用のパスワードを暗号化・復号するキーを決定可能
    loginKeyNameは、getLoginKeyListアクションを通じて取得可能
    Default: 直近で作成されたログインキー名を使用する
    associateWithPublicIpNoBoolean- サーバの作成時にグローバル IPアドレスの割り当ての有無
    サーバの作成時に新しいグローバル IPアドレスを作成してサーバに割り当て可能
    サブネットタイプが Public Subnetの場合にのみ割り当て可能で、サーバの作成数が1台の場合にのみ有効
    サーバの作成後、「運用中」状態の場合に正常に割り当て完了
    申し込まれたグローバル IPアドレスは保有中に料金が課金されるため、使用しない時は返却することを推奨
    Options : true | false
    Default : false
    raidTypeNameConditionalString- RAIDタイプ名
    BareMetalサーバを作成するためには raidTypeNameが必修
    raidTypeNameは、getRaidListアクションを通じて取得可能
    blockDevicePartitionList.N.mountPointNoString「/」(root)パスで始まるマウントポイントを入力
    最初のマウントポイントは必ず「/」(root)パーティション
    「/」(root)のサブ名称は小文字と数字のみ入力可能で、先頭文字は小文字
    OSの種類によって /root, /bin, /devなどの特定のキーワードは、使用不可
    - マウントポイント
    Bare Metalサーバを作成する場合はパーティションを指定。
    サーバスペックによってはパーティション機能がサポートされない場合がある
    blockDevicePartitionList.N.partitionSizeNoStringMin : 50 GiB- パーティションサイズ
    マウントポイントのパーティションのサイズを決定
    パーティションサイズの合計はサーバスペックの全体容量を超えてはいけない
    最後のパーティションのサイズは残り容量が自動で割り当て
    blockStorageMappingList.N.orderNoIntegerMin : 20 GiB- 作成ストレージの順序
    作成ストレージの順序を決定。
    KVMのみ使用可能。
    blockStorageMappingList.N.snapshotInstanceNoNoString- 作成ストレージスナップショット番号
    スナップショットから作成する場合。
    KVMのみ使用可能。
    blockStorageMappingList.N.blockStorageSizeNoString- 作成ストレージのサイズ
    作成ストレージのサイズを決定。
    KVMのみ使用可能。
    blockStorageMappingList.N.blockStorageNameNoString- 作成ストレージ名
    作成ストレージ名を決定。
    KVMのみ使用可能。
    blockStorageMappingList.N.blockStorageVolumeTypeCodeNoString- 作成ストレージボリュームタイプコード
    作成ストレージボリュームタイプを決定。
    KVMのみ使用可能。
    blockStorageMappingList.N.encryptedNoString- 作成ストレージ暗号化の有無
    作成ストレージ暗号化有無を決定。
    KVMのみ使用可能。
    responseFormatTypeNoString- レスポンス結果のフォーマットタイプ
    Options : xml | json
    Default : xml

    レスポンス

    レスポンスボディ

    リクエスト例

    GET {API_URL}/createServerInstances
    ?regionCode=KR
    &serverImageProductCode=SW.VSVR.OS.LNX64.CNTOS.0703.B050
    &vpcNo=***04
    &subnetNo=***43
    &serverProductCode=SVR.VSVR.STAND.C002.M004.NET.SSD.B050.G001
    &feeSystemTypeCode=MTRAT
    &serverCreateCount=1
    &serverName=test-***
    &networkInterfaceList.1.networkInterfaceOrder=0
    &networkInterfaceList.1.accessControlGroupNoList.1=***63
    &placementGroupNo=***61
    &isProtectServerTermination=false
    &initScriptNo=***44
    &loginKeyName=test-***
    &associateWithPublicIp=true
    

    レスポンス例

    <createServerInstancesResponse>
      <requestId>63a6fdb1-5430-417f-98a8-d20cacc83581</requestId>
      <returnCode>0</returnCode>
      <returnMessage>success</returnMessage>
      <totalRows>1</totalRows>
      <serverInstanceList>
        <serverInstance>
          <serverInstanceNo>***4299</serverInstanceNo>
          <serverName>test-***</serverName>
          <serverDescription></serverDescription>
          <cpuCount>2</cpuCount>
          <memorySize>4294967296</memorySize>
          <platformType>
            <code>LNX64</code>
            <codeName>Linux 64 Bit</codeName>
          </platformType>
          <loginKeyName>test-***</loginKeyName>
          <publicIpInstanceNo></publicIpInstanceNo>
          <publicIp></publicIp>
          <serverInstanceStatus>
            <code>INIT</code>
            <codeName>Server init state</codeName>
          </serverInstanceStatus>
          <serverInstanceOperation>
            <code>NULL</code>
            <codeName>Server NULL OP</codeName>
          </serverInstanceOperation>
          <serverInstanceStatusName>init</serverInstanceStatusName>
          <createDate>2020-08-24T09:41:23+0900</createDate>
          <uptime>2020-08-24T09:41:23+0900</uptime>
          <serverImageProductCode>SW.VSVR.OS.LNX64.CNTOS.0703.B050</serverImageProductCode>
          <serverProductCode>SVR.VSVR.STAND.C002.M004.NET.SSD.B050.G001</serverProductCode>
          <isProtectServerTermination>false</isProtectServerTermination>
          <zoneCode>KR-1</zoneCode>
          <regionCode>KR</regionCode>
          <vpcNo>***04</vpcNo>
          <subnetNo>***43</subnetNo>
          <networkInterfaceNoList>
            <networkInterfaceNo>***87</networkInterfaceNo>
          </networkInterfaceNoList>
          <initScriptNo>***44</initScriptNo>
          <serverInstanceType>
            <code>STAND</code>
            <codeName>Standard</codeName>
          </serverInstanceType>
          <baseBlockStorageDiskType>
            <code>NET</code>
            <codeName>Network Storage</codeName>
          </baseBlockStorageDiskType>
          <baseBlockStorageDiskDetailType>
            <code>SSD</code>
            <codeName>SSD</codeName>
          </baseBlockStorageDiskDetailType>
          <placementGroupNo>***61</placementGroupNo>
          <placementGroupName>test-***</placementGroupName>
        </serverInstance>
      </serverInstanceList>
    </createServerInstancesResponse>
    

    この記事は役に立ちましたか?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.