本文へジャンプします。

ニフティクラウド APIリファレンス

CopyInstances

処理概要

指定したサーバーのコピーを作成します。

停止中もしくは起動中のサーバーのみ指定ができます。コピー後のサーバー名は、指定したコピー後のサーバー名の後ろに「-連番」が付加された名称になります。

サーバーを指定するためには、サーバー名が必要です。 処理中のサーバーを指定した、管理外のサーバーを指定したなど、無効なサーバーを指定した場合は、エラーが返されます。
ディスクが接続しているサーバーのコピーは、指定したサーバーと同一ゾーンでのみ実行可能です。

APIのパラメータに「CopyInstance.IpType」を指定して、かつ「NetworkInterface.n.NetworkId」に共通グローバルを指定した場合、エラーが返されます。

指定するパラメーター

パラメーター 説明 必須 サンプル値
InstanceId コピー元サーバーのサーバー名
Type : String
server01
CopyInstance.InstanceName コピー後のサーバー名
Type : String
copyserver
CopyInstance.InstanceType サーバータイプ
Type : String
値 : e-mini | mini | e-small | small | e-small2 | small2 | e-small4 | small4 | e-small8 | small8 | e-small16 | small16 | e-medium | medium | e-medium4 | medium4 | e-medium8 | medium8 | e-medium16 | medium16 | e-medium24 | medium24 | e-large | large | 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
Default : mini
   
CopyInstance.AccountingType 利用料金タイプ
Type : String
値 : 1(月額課金) | 2(従量課金)
Default : 2
   
CopyInstance.IpType コピー先サーバーのIPアドレスのタイプ
Type : String
値 : static (固定化) | none(グローバルIPなし)
Default : static (NetworkInterfaceの定義が指定されていれば、NetworkInterfaceの定義を適用)
   
CopyInstance.LoadBalancers.n.LoadBalancerName ロードバランサー名
Type : String
   
CopyInstance.LoadBalancers.n.LoadBalancerPort 待ち受けポート
Type : Integer
   
CopyInstance.LoadBalancers.n.InstancePort 宛先ポート
Type : Integer
   
CopyInstance.SecurityGroup.n 適用するファイアウォールグループ名
※ファイアウォール機能を提供 していない環境の場合、指定不可(エラーが返ります)
Type : String
   
CopyCount コピー台数
Type : Integer
値 : 1 - 作成可能な台数(上限数 - 既存サーバーの台数)
Default : 1
  2
CopyInstance.Placement.RegionName リージョン情報
Type : String
Default : リクエスト先エンドポイントのリージョン
   
CopyInstance.Placement.AvailabilityZone ゾーン情報
Type : String
Default : サーバーのゾーン(リージョン指定なし)またはリージョン内のゾーンからニフティクラウドが決定(リージョン指定あり)
   
NetworkInterface.n.DeviceIndex ※指定不可
Type: Integer
   
NetworkInterface.n.SecurityGroupId.n ※指定不可
Type: String
   
NetworkInterface.n.NetworkId ネットワークID
Type: String
値 : net-COMMON_GLOBAL (共通グローバル) | net-COMMON_PRIVATE (共通プライベート) | プライベートLANのネットワークID
○(ネットワーク名といずれか)  
NetworkInterface.n.NetworkName ネットワーク名(共通グローバルと共通プライベートは、ネットワークIDを指定)
Type: String
○(ネットワークIDといずれか)  
NetworkInterface.n.IpAddress

IPアドレス
Type: String

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

応答フィールド

フィールド(項目) 説明 サンプル値
CopyInstancesResponse CopyInstances レスポンス
Type : CopyInstancesResponseType
Ancestor : なし
Children : requestId, copyInstanceSet
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : CopyInstancesResponse
Children : なし
96d5ae94-0215-4b2e-84af-ef1e43cbd6e2
copyInstanceSet コピー後のサーバー設定情報
Type : copyInstanceSets
Ancestor : CopyInstancesResponse
Children : item
 
item コピー後のサーバー設定情報のセット
Type : copyInstanceSet
Ancestor : copyInstanceSets
Children : instanceId, instanceUniqueId, instanceState
 
instanceId コピー後のサーバー名
Type : xsd:string
Ancestor : item
Children : なし
copyserver-01
instanceUniqueId コピー後のサーバーユニークID
Type : xsd:string
Ancestor : item
Children : なし
i-abfd1234
instanceState コピー後のサーバーのステータス
Type : xsd:string
値 : creating(コピー中) | waiting(コピー待ち)
Ancestor : item
Children : なし
waiting

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=CopyInstances&InstanceId=server01
&CopyInstance.InstanceName=copyserver&CopyCount=2&CommonParams

応答サンプル

<CopyInstancesResponse xmlns="https://cp.cloud.nifty.com/api/">
 <requestId>96d5ae94-0215-4b2e-84af-ef1e43cbd6e2</requestId>
 <copyInstanceSet>
  <item>
   <instanceId>copyserver-01</instanceId>
   <instanceUniqueId>i-abfd1234</instanceUniqueId>
   <instanceState>waiting</instanceState>
  </item>
  <item>
   <instanceId>copyserver-02</instanceId>
   <instanceUniqueId>i-abfd5678</instanceUniqueId>
   <instanceState>waiting</instanceState>
  </item>
 </copyInstanceSet>
</CopyInstancesResponse>

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

APIメニュー

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

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