ServerInstance

Prev Next

Classic環境で利用できます。

サーバインスタンス情報です。

構文

構文は次の通りです。

private String serverInstanceNo;
private String serverName;
private String serverDescription;
private Integer cpuCount;
private Long memorySize;
private Long baseBlockStorageSize;
private CommonCode platformType;
private String loginKeyName;
private Boolean isFeeChargingMonitoring;
private String publicIp;
private String privateIp;
private String serverImageName;
private CommonCode serverInstanceStatus;
private CommonCode serverInstanceOperation;
private String serverInstanceStatusName;
private Date createDate;
private Date uptime;
private String serverImageProductCode;
private String serverProductCode;
private Boolean isProtectServerTermination;
private String portForwardingPublicIp;
private Integer portForwardingExternalPort;
private Integer portForwardingInternalPort;
private Zone zone;
private Region region;
private CommonCode baseBlockStorageDiskType;
private CommonCode baseBlockStroageDiskDetailType;
private CommonCode serverInstanceType;
private String userData;
private List<AccessControlGroup> accessControlGroupList;
private List<BlockDevicePartition> blockDevicePartitionList;

フィールド

フィールドの詳細は次の通りです。

フィールド タイプ 必須の有無 説明
serverInstanceNo String Required サーバインスタンス番号
  • サーバインスタンス(VM)を識別するための NAVERクラウドプラットフォームの識別子
serverName String Required サーバ名
serverDescription String Required サーバの説明
cpuCount Integer Required Virtual CPU数
memorySize Long Required メモリ容量(Byte)
baseBlockStorageSize Long Required 基本ブロックストレージ容量(Byte)
platformType CommonCode Required サーバにインストールされたイメージのプラットフォーム区分
  • LNX32 | WIN64
loginKeyName String Required サーバのパスワードを発行した公開鍵で暗号化したログインキー名
isFeeChargingMonitoring Boolean Required 有料モニタリングかどうか
  • true | false
publicIp String Optional サーバに割り当てられているグローバル IPアドレス
privateIp String Required サーバに割り当てられているプライベート IPアドレス
serverImageName String Required サーバイメージの名前
serverInstanceStatus CommonCode Required サーバインスタンスの状態
  • INIT | CREAT | RUN | NSTOP | TERMT | FSTOP | SD_FL | RS_FL | ST_FL
    • INIT: サーバ INIT状態
    • CREAT: サーバ CREATED状態
    • RUN: サーバ RUN状態
    • NSTOP: サーバ NORMAL STOPPED状態
    • TERMT: サーバ TERMINATED状態
    • FSTOP: サーバ FAILURE STOPPED状態
    • SD_FL: サーバ Shutdown失敗状態
    • RS_FL: サーバ Restart失敗状態
    • ST_FL: サーバ Start失敗状態
serverInstanceOperation CommonCode Required サーバインスタンスの運用状態
  • START | SHTDN | RESTA | TERMT | NULL | MIGRA | COPY | SETUP | HREST | HSHTD | CHNG | CREAT
    • START: Start
    • SHTDN: Shutdown
    • RESTA: Restart
    • TERMT: Terminate
    • NULL: Null
    • MIGRA: マイグレーション
    • COPY: 現在 Copy対象
    • SETUP: 現在 Setup状態
    • HREST: 強制 Restart
    • HSHTD: サーバ強制 Shutdown
    • CHNG: サーバ Spec Change
    • CREAT: Create
serverInstanceStatusName String Required サーバインスタンスの状態名
  • サーバインスタンスの状態とサーバインスタンスの運用状態を組み合わせて現在のサーバインスタンスの状態名を渡す
  • init | creating | booting | setting up | running | rebooting | hard rebooting | shutting down | hard shutting down | terminating | changingSpec | copying | repairing
createDate Date Required 作成日時(YYYY-MM-DDThh:mm:ssZ)
uptime Date Required アップタイム(YYYY-MM-DDThh:mm:ssZ)
serverImageProductCode String Required サーバイメージ商品コード
  • NAVERクラウドプラットフォームで管理するサーバイメージ商品に該当する商品コード
serverProductCode String Required サーバ商品コード
  • NAVERクラウドプラットフォームで管理するサーバ商品に該当する商品コード
isProtectServerTermination Boolean Required 返却保護かどうか
  • true | false
  • サーバ返却保護かどうかのカラム値がtrueの場合、返却時に返却されない
portForwardingPublicIp String Optional ポートフォワードグローバル IPアドレス
  • ポートフォワードグローバル IPアドレスが設定されている場合にのみ渡す
portForwardingExternalPort Integer Optional ポートフォワードのグローバル外部ポート
  • ポートフォワードが設定されている場合にのみ渡す
portForwardingInternalPort Integer Optional ポートフォワードのグローバル内部ポート
  • ポートフォワードが設定されている場合にのみ渡す
zone Zone Required サーバが位置するゾーン
region Region Required サーバが位置するリージョン
baseBlockStorageDiskType CommonCode Required 基本ブロックストレージディスクタイプ
  • LOCAL | NET
    • LOCAL: Local
    • NET: Network
baseBlockStorageDiskDetailType CommonCode Required 基本ブロックストレージディスクの詳細タイプ
  • HDD | SSD
serverInstanceType CommonCode Required サーバインスタンスタイプ
  • MICRO | COMPT | STAND | GPU | LDISK | CHADP | BM | VDS
    • MICRO: Micro
    • COMPT: Compact
    • STAND: Standard
    • GPU: GPU
    • LDISK: Local Disk
    • CHADP: Cloud Hadoop
    • BM: Bare Metal
    • VDS: Virtual Dedicated Server
userData String Required ユーザーデータ
  • ユーザーが実行可能なスクリプトを渡すことが可能。このスクリプトが渡されると、サーバの初回起動時にこのスクリプトが実行される
  • この値は個別照会の場合にのみ渡す
accessControlGroupList List<AccessControlGroup> Required ACGリスト
blockDevicePartitionList List<BlockDevicePartition> Optional ブロックデバイスパーティションリスト
  • ベアメタルサーバの場合、ユーザー定義パーティション情報を渡す