本文へジャンプします。

ニフクラ ユーザーガイド

クラウド トップ>API> コンピューティング> CopyFromBackupInstance
本ページは2023/9/5をもって、新ページhttps://docs.nifcloud.com/cp/api/CopyFromBackupInstance.htmへ移行しました。 今後は新ページをご参照ください。

CopyFromBackupInstance

処理概要

増分バックアップで作成されたバックアップサーバーからコピーを作成します。

コピーを行うためには、バックアップサーバーユニークIDが必要です。
コピーで作成されたサーバーは、停止状態で作成されます。

指定するパラメーター

パラメーター 型 説明 必須
BackupInstanceUniqueId string バックアップサーバーユニークID
 ○
InstanceId string コピーするサーバー名
Default: 英数8文字 (システム発行)
InstanceType string サーバータイプ
値:
  • e-mini
  • h2-mini
  • mini
  • c-small
  • e-small
  • h2-small
  • small
  • c-small2
  • e-small2
  • h2-small2
  • small2
  • c-small4
  • e-small4
  • h2-small4
  • small4
  • e-small8
  • h2-small8
  • small8
  • e-small16
  • h2-small16
  • small16
  • c-medium
  • e-medium
  • h2-medium
  • medium
  • c-medium4
  • e-medium4
  • h2-medium4
  • medium4
  • c-medium8
  • e-medium8
  • h2-medium8
  • medium8
  • e-medium16
  • h2-medium16
  • medium16
  • e-medium24
  • h2-medium24
  • medium24
  • c-large
  • e-large
  • h2-large
  • large
  • c-large8
  • e-large8
  • h2-large8
  • large8
  • e-large16
  • h2-large16
  • large16
  • e-large24
  • h2-large24
  • large24
  • e-large32
  • h2-large32
  • large32
  • e-extra-large8
  • h2-extra-large8
  • extra-large8
  • e-extra-large16
  • h2-extra-large16
  • extra-large16
  • e-extra-large24
  • h2-extra-large24
  • extra-large24
  • e-extra-large32
  • h2-extra-large32
  • extra-large32
  • e-extra-large48
  • h2-extra-large48
  • extra-large48
  • e-double-large16
  • h2-double-large16
  • double-large16
  • e-double-large24
  • h2-double-large24
  • double-large24
  • e-double-large32
  • h2-double-large32
  • double-large32
  • e-double-large48
  • h2-double-large48
  • double-large48
  • e-double-large64
  • h2-double-large64
  • double-large64
  • e-double-large96
  • h2-double-large96
  • double-large96
  • h2-triple-large32
  • triple-large32
  • h2-triple-large48
  • triple-large48
  • h2-triple-large64
  • triple-large64
  • h2-triple-large96
  • triple-large96
  • h2-triple-large128
  • triple-large128
  • h2-quad-large64
  • quad-large64
  • h2-quad-large96
  • quad-large96
  • h2-quad-large128
  • quad-large128
  • h2-septa-large128
  • septa-large128
Default: mini
AccountingType string 利用料金タイプ
値:
  • 1 (月額課金)
  • 2 (従量課金)
Default: 2 (従量課金)
SecurityGroup.n string 適用するファイアウォールグループ名 ※「SecurityGroup.1」のみ有効(複数指定不可)
DisableApiTermination boolean APIからのサーバー削除の可否
値:
  • true (削除不可)
  • false (削除可)
Default: true (削除不可)
NetworkInterface.n.NetworkId string ネットワークID
使用可能文字: net-COMMON_GLOBAL(共通グローバル)、net-COMMON_PRIVATE(共通プライベート)、プライベートLAN のネットワークID
 ○ (ネットワーク名といずれか)
NetworkInterface.n.NetworkName string ネットワーク名（共通グローバルと共通プライベートはネットワークIDを指定）
 ○ (ネットワークIDといずれか)
NetworkInterface.n.IpAddress string

IPアドレス

1) 指定されたネットワークが共通グローバル 値 : 付替グローバルIPアドレス
Default : DHCPによるIPアドレス自動発行
2）指定されたネットワークが共通プライベート 値 : 付替プライベートIPアドレス
Default : DHCPによるIPアドレス自動発行
3）指定されたネットワークがプライベートLANでDHCPが有効化されている 値 : IPアドレス | static(手動化)
Default : DHCPによるIPアドレス自動発行
4）指定されたネットワークがプライベートLANでDHCPが無効化されている 値 : static(手動化)

Description string メモ情報

応答フィールド

フィールド (項目) 型 説明
CopyFromBackupInstanceResponse - CopyFromBackupInstanceレスポンス
␣requestId string リクエスト識別子
␣return boolean 処理結果
␣reservationId string ※空を返却
␣ownerId string ※空を返却
␣groupSet - ファイアウォールグループ情報
␣␣item -
␣␣␣groupId string ファイアウォールグループ名
␣instance - サーバーの情報
␣␣instanceId string サーバー名
␣␣instanceUniqueId string サーバーユニークID
␣␣imageId string OSイメージID
␣␣instanceState - サーバーの現在のステータス
␣␣␣code integer 現在のステータスコード
備考: 返却値 0 (pending),16 (running),80 (stopped)
␣␣␣name string 現在のステータス名
値:
  • pending (処理中)
  • running (起動済み)
  • stopped (停止済み)
␣␣privateDnsName string プライベートIPアドレス
␣␣dnsName string グローバルIPアドレス
␣␣reason string 異常時のエラーコード
␣␣keyName string SSHキー名
␣␣admin string 管理者アカウント
␣␣amiLaunchIndex string ※空を返却
␣␣productCodes - ※空を返却
␣␣␣item -
␣␣␣␣productCode string ※空を返却
␣␣instanceType string サーバータイプ
値:
  • e-mini
  • h2-mini
  • mini
  • c-small
  • e-small
  • h2-small
  • small
  • c-small2
  • e-small2
  • h2-small2
  • small2
  • c-small4
  • e-small4
  • h2-small4
  • small4
  • e-small8
  • h2-small8
  • small8
  • e-small16
  • h2-small16
  • small16
  • c-medium
  • e-medium
  • h2-medium
  • medium
  • c-medium4
  • e-medium4
  • h2-medium4
  • medium4
  • c-medium8
  • e-medium8
  • h2-medium8
  • medium8
  • e-medium16
  • h2-medium16
  • medium16
  • e-medium24
  • h2-medium24
  • medium24
  • c-large
  • e-large
  • h2-large
  • large
  • c-large8
  • e-large8
  • h2-large8
  • large8
  • e-large16
  • h2-large16
  • large16
  • e-large24
  • h2-large24
  • large24
  • e-large32
  • h2-large32
  • large32
  • e-extra-large8
  • h2-extra-large8
  • extra-large8
  • e-extra-large16
  • h2-extra-large16
  • extra-large16
  • e-extra-large24
  • h2-extra-large24
  • extra-large24
  • e-extra-large32
  • h2-extra-large32
  • extra-large32
  • e-extra-large48
  • h2-extra-large48
  • extra-large48
  • e-double-large16
  • h2-double-large16
  • double-large16
  • e-double-large24
  • h2-double-large24
  • double-large24
  • e-double-large32
  • h2-double-large32
  • double-large32
  • e-double-large48
  • h2-double-large48
  • double-large48
  • e-double-large64
  • h2-double-large64
  • double-large64
  • e-double-large96
  • h2-double-large96
  • double-large96
  • h2-triple-large32
  • triple-large32
  • h2-triple-large48
  • triple-large48
  • h2-triple-large64
  • triple-large64
  • h2-triple-large96
  • triple-large96
  • h2-triple-large128
  • triple-large128
  • h2-quad-large64
  • quad-large64
  • h2-quad-large96
  • quad-large96
  • h2-quad-large128
  • quad-large128
  • h2-septa-large128
  • septa-large128
␣␣launchTime string サーバーの作成日時
␣␣placement - ゾーン情報
␣␣␣availabilityZone string ゾーン情報
␣␣kernelId string ※空を返却
␣␣ramdiskId string ※空を返却
␣␣platform string OS情報
␣␣monitoring - 監視情報
␣␣␣state string 監視ステータス
値:
  • monitoring-disabled (無効)
␣␣subnetId string ※空を返却
␣␣vpcId string ※空を返却
␣␣privateIpAddress string プライベートIPアドレス
␣␣ipAddress string グローバルIPアドレス
␣␣privateIpAddressV6 string プライベートIPアドレス（IPv6）
␣␣ipAddressV6 string グローバルIPアドレス（IPv6）
␣␣stateReason - ※空を返却
␣␣␣code string ※空を返却
␣␣␣message string ※空を返却
␣␣architecture string OSイメージのアーキテクチャ
値:
  • i386
  • x86_64
␣␣rootDeviceType string ディスクの種類
値:
  • disk
␣␣rootDeviceName string ※空を返却
␣␣blockDeviceMapping - 接続しているディスクの情報
␣␣␣item -
␣␣␣␣deviceName string ディスクの接続デバイス
␣␣␣␣ebs - 接続しているディスクの詳細情報
␣␣␣␣␣volumeId string ディスク名
␣␣␣␣␣volumeUniqueId string ディスクユニークID
␣␣␣␣␣status string 接続ステータス
␣␣␣␣␣attachTime string ※空を返却
␣␣␣␣␣deleteOnTermination string サーバー削除時のディスク消去
␣␣instanceLifecycle string ※空を返却
␣␣spotInstanceRequestId string ※空を返却
␣␣accountingType string 利用料金タイプ
値:
  • 1 (月額課金)
  • 2 (従量課金)
␣␣ipType string グローバルIPアドレスのタイプ
値:
  • static (固定)
  • elastic (付替)
  • none (グローバルIPなし)
␣␣niftyPrivateIpType string プライベートIPアドレスのタイプ
値:
  • static (固定)
  • elastic (付替)
␣␣description string メモ情報(CDATA付)
␣␣networkInterfaceSet - ネットワークインターフェース情報
␣␣␣item -
␣␣␣␣networkInterfaceId string ネットワークインターフェースID
␣␣␣␣subnetId string ※空を返却
␣␣␣␣vpcId string ※空を返却
␣␣␣␣description string メモ情報(CDATA付)
␣␣␣␣ownerId string ※空を返却
␣␣␣␣niftyNetworkId string ネットワークユニークID
␣␣␣␣niftyNetworkName string ネットワーク名
␣␣␣␣status string ネットワークインタフェースのステータス
値:
  • available (利用可能)
  • in-use (使用中)
  • processing (処理中)
␣␣␣␣macAddress string MACアドレス
␣␣␣␣privateIpAddress string プライベートIPアドレス(v4)
␣␣␣␣privateDnsName string ※空を返却
␣␣␣␣sourceDestCheck string ※空を返却
␣␣␣␣groupSet - セキュリティグループ
␣␣␣␣␣item -
␣␣␣␣␣␣groupId string ※空を返却
␣␣␣␣attachment - サーバへの割り当て情報
␣␣␣␣␣attachmentId string ※空を返却
␣␣␣␣␣deviceIndex string デバイス番号
␣␣␣␣␣status string 接続ステータス
値:
  • attached (接続済)
␣␣␣␣␣attachTime string ※空を返却
␣␣␣␣␣deleteOnTermination string サーバー削除時のディスク消去
値:
  • true (消去)
  • false (消去しない)
␣␣␣␣␣instanceId string ※空を返却
␣␣␣␣␣instanceOwnerId string ※空を返却
␣␣␣␣association - 付替IPアドレスとしての情報
␣␣␣␣␣allocationId string ※空を返却
␣␣␣␣␣associationId string ※空を返却
␣␣␣␣␣ipOwnerId string ※空を返却
␣␣␣␣␣publicDnsName string ※空を返却
␣␣␣␣␣publicIp string グローバルIPアドレスまたはグローバル付替IPアドレス
␣␣␣␣␣publicIpV6 string グローバルIPアドレス（IPv6）
␣␣␣␣privateIpAddressesSet - プライベートIPアドレス(v4)セット
␣␣␣␣␣item -
␣␣␣␣␣␣association - 付替IPアドレスとしての情報
␣␣␣␣␣␣␣allocationId string ※空を返却
␣␣␣␣␣␣␣associationId string ※空を返却
␣␣␣␣␣␣␣ipOwnerId string ※空を返却
␣␣␣␣␣␣␣publicDnsName string ※空を返却
␣␣␣␣␣␣␣publicIp string グローバルIPアドレスまたはグローバル付替IPアドレス
␣␣␣␣␣␣␣publicIpV6 string グローバルIPアドレス（IPv6）
␣␣␣␣␣␣primary string ※空を返却
␣␣␣␣␣␣privateDnsName string ※空を返却
␣␣␣␣␣␣privateIpAddress string ※空を返却

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/?
Action=CopyFromBackupInstance
&BackupInstanceUniqueId=bi-0123abcd
&InstanceId=server04
&NetworkInterface.1.NetworkId=net-COMMON_GLOBAL
&NetworkInterface.2.NetworkId=net-COMMON_PRIVATE
&SecurityGroup.1=firewall
&CommonParams

応答サンプル

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CopyFromBackupInstanceResponse xmlns="https://computing.api.nifcloud.com/api/">
  <requestId>dd1c39b0-a251-4596-a058-4f4c35069b9d</requestId>
  <return>true</return>
  <reservationId/>
  <ownerId/>
  <groupSet>
    <item>
      <groupId>firewall</groupId>
    </item>
  </groupSet>
  <instance>
    <instanceId>server04</instanceId>
    <instanceUniqueId>i-0123abcd</instanceUniqueId>
    <imageId>56</imageId>
    <instanceState>
      <code>0</code>
      <name>pending</name>
    </instanceState>
    <privateDnsName/>
    <dnsName/>
    <reason/>
    <keyName/>
    <admin/>
    <amiLaunchIndex/>
    <productCodes>
      <item>
        <productCode/>
      </item>
    </productCodes>
    <instanceType>mini</instanceType>
    <launchTime/>
    <placement>
      <availabilityZone>east-11</availabilityZone>
    </placement>
    <kernelId/>
    <ramdiskId/>
    <platform>centos</platform>
    <monitoring>
      <state>monitoring-disabled</state>
    </monitoring>
    <subnetId/>
    <vpcId/>
    <privateIpAddress/>
    <ipAddress/>
    <privateIpAddressV6/>
    <ipAddressV6/>
    <stateReason>
      <code/>
      <message/>
    </stateReason>
    <architecture>x86_64</architecture>
    <rootDeviceType>disk</rootDeviceType>
    <rootDeviceName/>
    <blockDeviceMapping/>
    <instanceLifecycle/>
    <spotInstanceRequestId/>
    <accountingType>2</accountingType>
    <ipType>static</ipType>
    <niftyPrivateIpType>static</niftyPrivateIpType>
    <description><![CDATA[メモ]]></description>
    <networkInterfaceSet>
      <item>
        <networkInterfaceId/>
        <subnetId/>
        <vpcId/>
        <description></description>
        <ownerId/>
        <niftyNetworkId>net-COMMON_GLOBAL</niftyNetworkId>
        <niftyNetworkName/>
        <status>processing</status>
        <macAddress/>
        <privateIpAddress/>
        <privateIpAddressV6/>
        <privateDnsName/>
        <sourceDestCheck/>
        <groupSet>
          <item>
            <groupId/>
          </item>
        </groupSet>
        <attachment>
          <attachmentId/>
          <deviceIndex>0</deviceIndex>
          <status>attached</status>
          <attachTime/>
          <deleteOnTermination>true</deleteOnTermination>
        </attachment>
        <association>
          <allocationId/>
          <associationId/>
          <ipOwnerId/>
          <publicDnsName/>
          <publicIp/>
        </association>
        <privateIpAddressesSet>
          <item>
            <association>
              <allocationId/>
              <associationId/>
              <ipOwnerId/>
              <publicDnsName/>
              <publicIp/>
            </association>
            <primary/>
            <privateDnsName/>
            <privateIpAddress/>
          </item>
        </privateIpAddressesSet>
      </item>
      <item>
        <networkInterfaceId/>
        <subnetId/>
        <vpcId/>
        <description></description>
        <ownerId/>
        <niftyNetworkId>net-COMMON_PRIVATE</niftyNetworkId>
        <niftyNetworkName/>
        <status>processing</status>
        <macAddress/>
        <privateIpAddress/>
        <privateIpAddressV6/>
        <privateDnsName/>
        <sourceDestCheck/>
        <groupSet>
          <item>
            <groupId/>
          </item>
        </groupSet>
        <attachment>
          <attachmentId/>
          <deviceIndex>0</deviceIndex>
          <status>attached</status>
          <attachTime/>
          <deleteOnTermination>true</deleteOnTermination>
        </attachment>
        <association>
          <allocationId/>
          <associationId/>
          <ipOwnerId/>
          <publicDnsName/>
          <publicIp/>
        </association>
        <privateIpAddressesSet>
          <item>
            <association>
              <allocationId/>
              <associationId/>
              <ipOwnerId/>
              <publicDnsName/>
              <publicIp/>
              <publicIpV6/>
            </association>
            <primary/>
            <privateDnsName/>
            <privateIpAddress/>
          </item>
        </privateIpAddressesSet>
      </item>
    </networkInterfaceSet>
  </instance>
</CopyFromBackupInstanceResponse>

ニフクラ サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2023年9月05日時点の情報です。

推奨画面サイズ　1024×768 以上

ページの先頭へ