Server (VPC)の概要

Prev Next

VPC環境で利用できます。

Serverは、クラウド環境でサーバを作成・拡張したり、運用・管理することをサポートする NAVERクラウドプラットフォームのサービスです。Serverは、サーバ、ストレージ、スナップショット、グローバル IPアドレス、Init Script、ネットワークインターフェース(Network Interface)、ACG(Access Control Group)機能関連 APIを RESTful形式で提供します。

Serverの共通設定

Server APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。

リクエスト

共通リクエスト形式を説明します。

API URL

リクエスト API URLは次の通りです。

https://ncloud.apigw.ntruss.com

リクエストヘッダ

リクエストヘッダの説明は次の通りです。

フィールド 必須の有無 説明
x-ncp-apigw-timestamp Required 1970年1月1日00:00:00協定世界時(UTC)からの経過時間(ミリ秒)
  • API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす
  • Unix Timestamp形式
x-ncp-iam-access-key Required NAVERクラウドプラットフォームから発行された Access Key
x-ncp-apigw-signature-v2 Required NAVERクラウドプラットフォームから発行された Access Keyとマッピングする Secret Keyと HMAC暗号化アルゴリズム(HmacSHA256)でリクエスト情報を暗号化した後、Base64でエンコードした署名

レスポンス

共通レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

responseError
responseErrorは API呼び出し失敗情報を定義します。responseErrorの説明は次の通りです。

フィールド タイプ 必須の有無 説明
returnCode String Required エラーコード
returnMessage String Required エラーメッセージ

レスポンスステータスコード

Server APIは NAVERクラウドプラットフォームの共通レスポンスステータスコードを使用します。NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

Server API

Serverサービスが提供する APIの説明は次の通りです。

Login Key

Login Key関連 APIの説明は次の通りです。

API 説明
createLoginKey 認証キーを作成
importLoginKey ユーザーが直接作成した ssh-keygen公開鍵で認証キーを作成
getLoginKeyList 認証キーリストの照会
deleteLoginKeys 認証キーの削除

Placement Group

Placement Group関連 APIの説明は次の通りです。

API 説明
createPlacementGroup 物理配置グループを作成
getPlacementGroupDetail 物理配置グループの詳細情報を照会
getPlacementGroupList 物理配置グループリストを照会
addPlacementGroupServerInstance 物理配置グループにサーバを追加
removePlacementGroupServerInstance 物理配置グループからサーバを削除
deletePlacementGroup 物理配置グループを削除

Server Instance

Server Instance関連 APIの説明は次の通りです。

API 説明
createServerInstances サーバインスタンスを作成
getRootPassword 管理者パスワードを照会
getRootPasswordServerInstanceList 管理者パスワードリストを照会
getServerInstanceDetail サーバインスタンスの詳細を照会
getServerInstanceList サーバインスタンスリストを照会
changeServerInstanceSpec サーバインスタンスのスペックを変更
interruptServerInstance 異常動作するサーバインスタンスを診断するために診断の割り込みを実行
rebootServerInstances サーバインスタンスを再起動
setProtectServerTermination サーバ返却保護設定
startServerInstances サーバインスタンスを開始
stopServerInstances サーバインスタンスを停止
terminateServerInstances サーバインスタンスを返却

Server Image

Server Image関連 APIの説明は次の通りです。

API 説明
createServerImage サーバイメージを作成
createServerImageFromSnapshot スナップショットでサーバイメージを作成
getServerImageDetail サーバイメージの詳細を照会
getServerImageList サーバイメージリストを照会
addServerImageSharingPermission サーバイメージ共有権限を追加
removeServerImageSharingPermission サーバイメージ共有権限を削除
deleteServerImageInstances サーバイメージインスタンスを削除
createMemberServerImageInstance マイサーバイメージインスタンスを作成
getMemberServerImageInstanceDetail マイサーバイメージインスタンスの詳細を照会
getMemberServerImageInstanceList マイサーバイメージインスタンスリストを照会
addMemberServerImageSharingPermission マイサーバイメージ共有権限を追加
setMemberServerImageSharingPermission マイサーバイメージ共有権限を設定
removeMemberServerImageSharingPermission マイサーバイメージ共有権限を削除
deleteMemberServerImageInstances マイサーバイメージインスタンスを削除

Storage

Storage関連 APIの説明は次の通りです。

API 説明
createBlockStorageInstance ブロックストレージインスタンスを作成
getBlockStorageInstanceDetail ブロックストレージインスタンスの詳細情報を照会
getBlockStorageInstanceList ブロックストレージインスタンスリストを照会
getBlockStorageVolumeTypeList ブロックストレージボリュームタイプリストを照会
attachBlockStorageInstance ブロックストレージインスタンスをサーバインスタンスに割り当て
changeBlockStorageInstance ブロックストレージインスタンスの属性を変更
changeBlockStorageVolumeSize ブロックストレージボリュームサイズを変更
detachBlockStorageInstances ブロックストレージインスタンスをサーバインスタンスから割り当て解除
setBlockStorageReturnProtection ブロックストレージを返却保護するかどうかを設定
deleteBlockStorageInstances ブロックストレージインスタンスを削除

Snapshot

Snapshot関連 APIの説明は次の通りです。

API 説明
createBlockStorageSnapshotInstance ブロックストレージのスナップショットインスタンスを作成
getBlockStorageSnapshotInstanceDetail ブロックストレージスナップショットインスタンスリストの詳細情報を照会
getBlockStorageSnapshotInstanceList ブロックストレージスナップショットインスタンスリストを照会
deleteBlockStorageSnapshotInstances ブロックストレージスナップショットインスタンスを削除

Public IP

Public IPアドレス関連 APIの説明は次の通りです。

API 説明
createPublicIpInstance グローバル IPインスタンスを作成
getPublicIpInstanceDetail グローバル IPアドレスの詳細情報を照会
getPublicIpInstanceList グローバル IPアドレスインスタンスリストを照会
getPublicIpTargetServerInstanceList グローバル IPアドレスインスタンスを割り当て可能なサーバインスタンスリストを照会
associatePublicIpWithServerInstance グローバル IPアドレスインスタンスをサーバインスタンスに割り当て
disassociatePublicIpFromServerInstance グローバル IPアドレスインスタンスをサーバインスタンスで割り当て解除
deletePublicIpInstance グローバル IPアドレスインスタンスを削除

Init Script

Init Script関連 APIの説明は次の通りです。

API 説明
createInitScript 初期化スクリプトを作成
getInitScriptList 初期化スクリプトリストを照会
getInitScriptDetail 初期化スクリプトの詳細情報を照会
deleteInitScripts 初期化スクリプトリストを削除

Network Interface

Network Interface関連 APIの説明は次の通りです。

API 説明
createNetworkInterface ネットワークインターフェースを作成
getNetworkInterfaceDetail ネットワークインターフェースの詳細情報を照会
getNetworkInterfaceList ネットワークインターフェースリストを照会
attachNetworkInterface サーバインスタンスにネットワークインターフェースを割り当て
detachNetworkInterface サーバインスタンスに割り当てられたネットワークインターフェースを解除
deleteNetworkInterface ネットワークインターフェースを削除
addNetworkInterfaceAccessControlGroup ネットワークインターフェースに適用する ACGを追加
removeNetworkInterfaceAccessControlGroup ネットワークインターフェースに適用した ACGを削除
assignSecondaryIps ネットワークインターフェースにセカンダリ IPアドレスを割り当て
unassignSecondaryIps ネットワークインターフェースに割り当てられたセカンダリ IPアドレスを解除
getFlowLogConfigurationList FlowLog設定情報を照会
disableFlowLog FlowLogを無効化
enableFlowLog FlowLogを有効化

ACG

ACG関連 APIの説明は次の通りです。

API 説明
createAccessControlGroup ACGを作成
getAccessControlGroupDetail ACGの詳細情報を照会
getAccessControlGroupList ACGリストを照会
getAccessControlGroupRuleList ACGルールリストを照会
addAccessControlGroupInboundRule ACGの Inboundルールを追加
addAccessControlGroupOutboundRule ACGの Outboundルールを追加
removeAccessControlGroupInboundRule ACGの Inboundルールを削除
removeAccessControlGroupOutboundRule ACGの Outboundルールを削除
deleteAccessControlGroup ACGを削除

Common

Common関連 APIの説明は次の通りです。

API 説明
getFabricClusterPoolList 使用可能な GPU Fabric Cluster Poolを照会
getHypervisorTypeList ハイパーバイザタイプリストを照会
getRaidList 使用可能な RAIDリストを照会
getRegionList リージョンリストを照会
getServerImageProductList サーバイメージ商品リストを照会
getServerProductList サーバスペック商品リストを照会
getServerSpecDetail サーバスペックの詳細を照会
getServerSpecList サーバスペックリストを照会
getZoneList ゾーンリストを照会

Server関連リソース

Server APIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。