本文へジャンプします。

ニフクラ ユーザーガイド

CopyFromBackupInstance

処理概要

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

コピーを行うためには、バックアップサーバーユニークIDが必要です。 処理中のバックアップサーバーユニークIDを指定した、管理外のバックアップサーバーユニークIDを指定したなど、無効なバックアップサーバーユニークIDを指定した場合は、エラーが返されます。

コピーで作成されたサーバーは、停止状態で作成されます。

指定するパラメーター

パラメーター 説明 必須
BackupInstanceUniqueId string バックアップサーバーユニークID
InstanceId string コピーするサーバー名
Default: 英数8文字 (システム発行)
InstanceType string サーバータイプ
値: e-mini | mini | c-small | e-small | small | c-small2 | e-small2 | small2 | c-small4 | e-small4 | small4 | e-small8 | small8 | e-small16 | small16 | c-medium | e-medium | medium | c-medium4 | e-medium4 | medium4 | c-medium8 | e-medium8 | medium8 | e-medium16 | medium16 | e-medium24 | medium24 | c-large | e-large | large | c-large8 | e-large8 | large8 | e-large16 | large16 | e-large24 | large24 | e-large32 | large32 | e-extra-large8 | extra-large8 | e-extra-large16 | extra-large16 | e-extra-large24 | extra-large24 | e-extra-large32 | extra-large32 | e-extra-large48 | extra-large48 | e-double-large16 | double-large16 | e-double-large24 | double-large24 | e-double-large32 | double-large32 | e-double-large48 | double-large48 | e-double-large64 | double-large64 | e-double-large96 | double-large96 | triple-large48 | triple-large64 | triple-large96 | triple-large128 | quad-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といずれか)
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 CopyFromBackupInstanceResponseType CopyFromBackupInstanceレスポンス
Ancestor: なし
Children: requestId | return | reservationId | ownerId | groupSet | instance
requestId string リクエスト識別子
Ancestor: CopyFromBackupInstanceResponse
Children: なし
return boolean 処理結果
Ancestor: CopyFromBackupInstanceResponse
Children: なし
reservationId string ※空を返却
Ancestor: CopyFromBackupInstanceResponse
Children: なし
ownerId string ※空を返却
Ancestor: CopyFromBackupInstanceResponse
Children: なし
groupSet GroupSetType ファイアウォールグループ情報
Ancestor: CopyFromBackupInstanceResponse
Children: item
item GroupItemType
Ancestor: groupSet
Children: groupId
groupId string ファイアウォールグループ名
Ancestor: item
Children: なし
instance InstanceType サーバーの情報
Ancestor: CopyFromBackupInstanceResponse
Children: instanceId | instanceUniqueId | imageId | instanceState | privateDnsName | dnsName | reason | keyName | admin | amiLaunchIndex | productCodes | instanceType | launchTime | placement | kernelId | ramdiskId | platform | monitoring | subnetId | vpcId | privateIpAddress | ipAddress | privateIpAddressV6 | ipAddressV6 | stateReason | architecture | rootDeviceType | rootDeviceName | blockDeviceMapping | instanceLifecycle | spotInstanceRequestId | accountingType | ipType | niftyPrivateIpType | description | networkInterfaceSet
instanceId string サーバー名
Ancestor: instance
Children: なし
instanceUniqueId string サーバーユニークID
Ancestor: instance
Children: なし
imageId string OSイメージID
Ancestor: instance
Children: なし
instanceState InstanceStateType サーバーの現在のステータス
Ancestor: instance
Children: code | name
code integer 現在のステータスコード
値: 0 (pending) | 16 (running) | 80 (stopped)
Ancestor: instanceState
Children: なし
name string 現在のステータス名
値: pending (処理中) | running (起動済み) | stopped (停止済み)
Ancestor: instanceState
Children: なし
privateDnsName string プライベートIPアドレス
Ancestor: instance
Children: なし
dnsName string グローバルIPアドレス
Ancestor: instance
Children: なし
reason string 異常時のエラーコード
Ancestor: instance
Children: なし
keyName string SSHキー名
Ancestor: instance
Children: なし
admin string 管理者アカウント
Ancestor: instance
Children: なし
amiLaunchIndex string ※空を返却
Ancestor: instance
Children: なし
productCodes ProductCodesSetType ※返却値なし
Ancestor: instance
Children: item
item ProductCodesSetItemType
Ancestor: productCodes
Children: productCode
productCode string ※返却値なし
Ancestor: item
Children: なし
instanceType string サーバータイプ
値: e-mini | mini | c-small | e-small | small | c-small2 | e-small2 | small2 | c-small4 | e-small4 | small4 | e-small8 | small8 | e-small16 | small16 | c-medium | e-medium | medium | c-medium4 | e-medium4 | medium4 | c-medium8 | e-medium8 | medium8 | e-medium16 | medium16 | e-medium24 | medium24 | c-large | e-large | large | c-large8 | e-large8 | large8 | e-large16 | large16 | e-large24 | large24 | e-large32 | large32 | e-extra-large8 | extra-large8 | e-extra-large16 | extra-large16 | e-extra-large24 | extra-large24 | e-extra-large32 | extra-large32 | e-extra-large48 | extra-large48 | e-double-large16 | double-large16 | e-double-large24 | double-large24 | e-double-large32 | double-large32 | e-double-large48 | double-large48 | e-double-large64 | double-large64 | e-double-large96 | double-large96 | triple-large48 | triple-large64 | triple-large96 | triple-large128 | quad-large128
Ancestor: instance
Children: なし
launchTime string サーバーの作成日時
Ancestor: instance
Children: なし
placement PlacementResponseType ゾーン情報
Ancestor: instance
Children: availabilityZone
availabilityZone string ゾーン情報
Ancestor: placement
Children: なし
kernelId string ※空を返却
Ancestor: instance
Children: なし
ramdiskId string ※空を返却
Ancestor: instance
Children: なし
platform string OS情報
Ancestor: instance
Children: なし
monitoring InstanceMonitoringStateType 監視情報
Ancestor: instance
Children: state
state string 監視ステータス
値: monitoring-disabled (無効)
Ancestor: monitoring
Children: なし
subnetId string ※空を返却
Ancestor: instance
Children: なし
vpcId string ※空を返却
Ancestor: instance
Children: なし
privateIpAddress string プライベートIPアドレス
Ancestor: instance
Children: なし
ipAddress string グローバルIPアドレス
Ancestor: instance
Children: なし
privateIpAddressV6 string プライベートIPアドレス(IPv6)
Ancestor: instance
Children: なし
ipAddressV6 string グローバルIPアドレス(IPv6)
Ancestor: instance
Children: なし
stateReason stateReasonType ※返却値なし
Ancestor: instance
Children: code | message
code integer ※返却値なし
Ancestor: stateReason
Children: なし
message string ※返却値なし
Ancestor: stateReason
Children: なし
architecture string OSイメージのアーキテクチャ
値: i386 | x86_64
Ancestor: instance
Children: なし
rootDeviceType string ディスクの種類
値: disk
Ancestor: instance
Children: なし
rootDeviceName string ※空を返却
Ancestor: instance
Children: なし
blockDeviceMapping InstanceBlockDeviceMappingResponseType 接続しているディスクの情報
Ancestor: instance
Children: item
item InstanceBlockDeviceMappingResponseItemType
Ancestor: blockDeviceMapping
Children: deviceName | ebs
deviceName string ディスクの接続デバイス
Ancestor: item
Children: なし
ebs EbsInstanceBlockDeviceMappingResponseType 接続しているディスクの詳細情報
Ancestor: item
Children: volumeId | status | attachTime | deleteOnTermination
volumeId string ディスク名
Ancestor: ebs
Children: なし
status string 接続ステータス
Ancestor: ebs
Children: なし
attachTime timestamp ※空を返却
Ancestor: ebs
Children: なし
deleteOnTermination boolean サーバー削除時のディスク消去
Ancestor: ebs
Children: なし
instanceLifecycle string ※空を返却
Ancestor: instance
Children: なし
spotInstanceRequestId string ※空を返却
Ancestor: instance
Children: なし
accountingType string 利用料金タイプ
値: 1 (月額課金) | 2 (従量課金)
Ancestor: instance
Children: なし
ipType string グローバルIPアドレスのタイプ
値: static (固定) | elastic (付替) | none(グローバルIPなし)
Ancestor: instance
Children: なし
niftyPrivateIpType string プライベートIPアドレスのタイプ
値: static (固定) | elastic (付替)
Ancestor: instance
Children: なし
description string メモ情報
Ancestor: instance
Children: なし
networkInterfaceSet NetworkInterfaceSetType ネットワークインターフェース情報
Ancestor: instance
Children: item
item NetworkInterfaceItemType
Ancestor: networkInterfaceSet
Children: networkInterfaceId | subnetId | vpcId | description | ownerId | niftyNetworkId | niftyNetworkName | status | macAddress | privateIpAddress | privateDnsName | sourceDestCheck | groupSet | attachment | association | privateIpAddressesSet | availabilityZone | interfaceType | ipv6AddressesSet | requesterId | requesterManaged | tagSet
networkInterfaceId string ネットワークインターフェースID
Ancestor: item
Children: なし
subnetId string ※空を返却
Ancestor: item
Children: なし
vpcId string ※空を返却
Ancestor: item
Children: なし
description string メモ情報
Ancestor: item
Children: なし
ownerId string ※空を返却
Ancestor: item
Children: なし
niftyNetworkId string ネットワークユニークID
Ancestor: item
Children: なし
niftyNetworkName string ネットワーク名
Ancestor: item
Children: なし
status string ネットワークインタフェースのステータス
値: available(利用可能) | in-use(使用中) | processing (処理中)
Ancestor: item
Children: なし
macAddress string MACアドレス
Ancestor: item
Children: なし
privateIpAddress string プライベートIPアドレス(v4)
Ancestor: item
Children: なし
privateDnsName string ※空を返却
Ancestor: item
Children: なし
sourceDestCheck string ※空を返却
Ancestor: item
Children: なし
groupSet GroupSetType セキュリティグループ
Ancestor: item
Children: item
item GroupItemType
Ancestor: groupSet
Children: groupId
groupId string ※空を返却
Ancestor: item
Children: なし
attachment AttachmentType サーバへの割り当て情報
Ancestor: item
Children: attachmentId | deviceIndex | status | attachTime | deleteOnTermination | instanceId | instanceOwnerId
attachmentId string ※空を返却
Ancestor: attachment
Children: なし
deviceIndex integer デバイス番号
Ancestor: attachment
Children: なし
status string 接続ステータス
値: attached (接続済)
Ancestor: attachment
Children: なし
attachTime string ※空を返却
Ancestor: attachment
Children: なし
deleteOnTermination boolean サーバー削除時のディスク消去
値: true (消去) | false (消去しない)
Ancestor: attachment
Children: なし
instanceId string ※返却値なし
Ancestor: attachment
Children: なし
instanceOwnerId string ※返却値なし
Ancestor: attachment
Children: なし
association AssociationType 付替IPアドレスとしての情報
Ancestor: item
Children: allocationId | associationId | ipOwnerId | publicDnsName | publicIp | publicIpV6
allocationId string ※空を返却
Ancestor: association
Children: なし
associationId string ※空を返却
Ancestor: association
Children: なし
ipOwnerId string ※空を返却
Ancestor: association
Children: なし
publicDnsName string ※空を返却
Ancestor: association
Children: なし
publicIp string グローバルIPアドレスまたはグローバル付替IPアドレス
Ancestor: association
Children: なし
publicIpV6 string グローバルIPアドレス(IPv6)
Ancestor: association
Children: なし
privateIpAddressesSet PrivateIpAddressesSetType プライベートIPアドレス(v4)セット
Ancestor: item
Children: item
item PrivateIpAddressesItemType
Ancestor: privateIpAddressesSet
Children: association | primary | privateDnsName | privateIpAddress
association AssociationType 付替IPアドレスとしての情報
Ancestor: item
Children: allocationId | associationId | ipOwnerId | publicDnsName | publicIp | publicIpV6
allocationId string ※空を返却
Ancestor: association
Children: なし
associationId string ※空を返却
Ancestor: association
Children: なし
ipOwnerId string ※空を返却
Ancestor: association
Children: なし
publicDnsName string ※空を返却
Ancestor: association
Children: なし
publicIp string グローバルIPアドレスまたはグローバル付替IPアドレス
Ancestor: association
Children: なし
publicIpV6 string グローバルIPアドレス(IPv6)
Ancestor: association
Children: なし
primary boolean ※空を返却
Ancestor: item
Children: なし
privateDnsName string ※空を返却
Ancestor: item
Children: なし
privateIpAddress string ※空を返却
Ancestor: item
Children: なし
availabilityZone string ゾーン
Ancestor: item
Children: なし
interfaceType string ※返却値なし
Ancestor: item
Children: なし
ipv6AddressesSet Ipv6AddressesSetType IPアドレス(v6)セット
Ancestor: item
Children: item
item Ipv6AddressesItemType
Ancestor: ipv6AddressesSet
Children: ipv6Address
ipv6Address string ※返却値なし
Ancestor: item
Children: なし
requesterId string ※返却値なし
Ancestor: item
Children: なし
requesterManaged boolean ※返却値なし
Ancestor: item
Children: なし
tagSet ResourceTagSetType リソースに設定されているタグ情報セット
Ancestor: item
Children: item
item ResourceTagSetItemType
Ancestor: tagSet
Children: key | value
key string ※返却値なし
Ancestor: item
Children: なし
value string ※返却値なし
Ancestor: item
Children: なし

リクエストサンプル

    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://cp.cloud.nifty.com/api/3.0/">
  <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>メモ</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/>
            </association>
            <primary/>
            <privateDnsName/>
            <privateIpAddress/>
          </item>
        </privateIpAddressesSet>
      </item>
    </networkInterfaceSet>
  </instance>
</CopyFromBackupInstanceResponse>

  

ニフティクラウド サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ

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