VPC環境で利用できます。
Serverは、クラウド環境でサーバを作成・拡張したり、運用・管理することをサポートする NAVERクラウドプラットフォームのサービスです。Serverは、サーバ、ストレージ、スナップショット、パブリック IPアドレス、Init Script、ネットワークインターフェース(Network Interface)、Access Control Group(ACG)、Fabric Cluster機能関連 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)からの経過時間(ミリ秒)
|
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
認証キー関連 APIの説明は次の通りです。
| API | 説明 |
|---|---|
| createLoginKey | 認証キーを作成 |
| importLoginKey | ユーザーが直接作成した公開鍵を認証キーとしてインポート |
| getLoginKeyList | 認証キーリストを照会 |
| deleteLoginKeys | 認証キーを削除 |
ACG
Access Control Group(ACG)関連 APIの説明は次の通りです。
| API | 説明 |
|---|---|
| createAccessControlGroup | ACGを作成 |
| getAccessControlGroupList | ACGリストを照会 |
| getAccessControlGroupDetail | ACGの詳細情報を照会 |
| getAccessControlGroupRuleList | ACGルールリストを照会 |
| addAccessControlGroupInboundRule | ACGにインバウンドルールを追加 |
| removeAccessControlGroupInboundRule | ACGからインバウンドルールを削除 |
| addAccessControlGroupOutboundRule | ACGにアウトバウンドルールを追加 |
| removeAccessControlGroupOutboundRule | ACGからアウトバウンドルールを削除 |
| deleteAccessControlGroup | ACGを削除 |
Init Script
初期化スクリプト関連 APIの説明は次の通りです。
| API | 説明 |
|---|---|
| createInitScript | 初期化スクリプトを作成 |
| getInitScriptList | 初期化スクリプトリストを照会 |
| getInitScriptDetail | 初期化スクリプトの詳細情報を照会 |
| deleteInitScripts | 初期化スクリプトを削除 |
Placement Group
物理配置グループ関連 APIの説明は次の通りです。
| API | 説明 |
|---|---|
| createPlacementGroup | サーバインスタンスが属する物理配置グループを作成 |
| getPlacementGroupList | 物理配置グループリストを照会 |
| getPlacementGroupDetail | 物理配置グループの詳細情報を照会 |
| addPlacementGroupServerInstance | 物理配置グループにサーバインスタンスを追加 |
| removePlacementGroupServerInstance | 物理配置グループからサーバインスタンスを削除 |
| deletePlacementGroup | 物理配置グループを削除 |
Server Image
サーバイメージ関連 APIの説明は次の通りです。
| API | 説明 |
|---|---|
| createServerImage | サーバインスタンスでサーバイメージを作成 |
| createServerImageFromSnapshot | スナップショットでサーバイメージを作成 |
| getServerImageList | サーバイメージリストを照会 |
| getServerImageDetail | サーバイメージの詳細情報を照会 |
| addServerImageSharingPermission | サーバイメージに共有権限を追加 |
| removeServerImageSharingPermission | サーバイメージから共有権限を削除 |
| deleteServerImage | サーバイメージを削除 |
| createMemberServerImageInstance | サーバインスタンスで会員サーバイメージを作成 |
| getMemberServerImageInstanceList | 会員サーバイメージリストを照会 |
| getMemberServerImageInstanceDetail | 会員サーバイメージの詳細情報を照会 |
| addMemberServerImageSharingPermission | 会員サーバイメージに共有権限を追加 |
| setMemberServerImageSharingPermission | 会員サーバイメージの共有権限を設定 |
| removeMemberServerImageSharingPermission | 会員サーバイメージから共有権限を削除 |
| deleteMemberServerImageInstances | 会員サーバイメージを削除 |
Server Instance
サーバインスタンス関連 APIの説明は次の通りです。
| API | 説明 |
|---|---|
| createServerInstances | サーバインスタンスを作成 |
| getServerInstanceList | サーバインスタンスリストを照会 |
| getServerInstanceDetail | サーバインスタンスの詳細情報を照会 |
| getRootPasswordServerInstanceList | サーバインスタンスの認証キーを使用して管理者パスワードリストを照会 |
| getRootPassword | サーバインスタンスの認証キーを使用して管理者パスワードを照会 |
| changeServerInstanceName | サーバインスタンスの名前を変更 |
| changeServerInstanceSpec | サーバインスタンスのスペックを変更 |
| setProtectServerTermination | サーバインスタンスを返却保護するかどうかを設定 |
| startServerInstances | 停止状態のサーバインスタンスを起動 |
| stopServerInstances | 運用中状態のサーバインスタンスを停止 |
| rebootServerInstances | 運用中状態のサーバインスタンスを再起動 |
| interruptServerInstance | サーバインスタンスの状態を分析するために、診断の割り込みを実行 |
| terminateServerInstances | 停止状態のサーバインスタンスを返却 |
Network Interface
ネットワークインターフェース関連 APIの説明は次の通りです。
| API | 説明 |
|---|---|
| createNetworkInterface | ネットワークインターフェースを作成 |
| getNetworkInterfaceList | ネットワークインターフェースリストを照会 |
| getNetworkInterfaceDetail | ネットワークインターフェースの詳細情報を照会 |
| attachNetworkInterface | ネットワークインターフェースをサーバインスタンスに割り当て |
| detachNetworkInterface | サーバインスタンスに割り当てられたネットワークインターフェースを解除 |
| addNetworkInterfaceAccessControlGroup | ネットワークインターフェースに ACGを追加 |
| removeNetworkInterfaceAccessControlGroup | ネットワークインターフェースから ACGを削除 |
| assignSecondaryIps | ネットワークインターフェースにセカンダリ IPアドレスを割り当て |
| unassignSecondaryIps | ネットワークインターフェースからセカンダリ IPアドレスを解除 |
| enableFlowLog | Flow Logを有効化 |
| getFlowLogConfigurationList | Flow Log設定情報を照会 |
| disableFlowLog | Flow Logを無効化 |
| deleteNetworkInterface | ネットワークインターフェースを削除 |
Public IP
パブリック IPアドレス関連 APIの説明は次の通りです。
| API | 説明 |
|---|---|
| createPublicIpInstance | パブリック IPアドレスインスタンスを作成 |
| getPublicIpInstanceList | パブリック IPアドレスインスタンスリストを照会 |
| getPublicIpInstanceDetail | パブリック IPアドレスの詳細情報を照会 |
| getPublicIpTargetServerInstanceList | パブリック IPアドレスインスタンスを割り当て可能なサーバインスタンスリストを照会 |
| associatePublicIpWithServerInstance | パブリック IPアドレスインスタンスをサーバインスタンスに割り当て |
| disassociatePublicIpFromServerInstance | パブリック IPアドレスインスタンスをサーバインスタンスで割り当て解除 |
| deletePublicIpInstance | パブリック IPアドレスインスタンスを削除 |
Storage
ストレージ関連 APIの説明は次の通りです。
| API | 説明 |
|---|---|
| createBlockStorageInstance | ブロックストレージインスタンスを作成 |
| getBlockStorageInstanceList | ブロックストレージインスタンスリストを照会 |
| getBlockStorageInstanceDetail | ブロックストレージインスタンスの詳細情報を照会 |
| getBlockStorageVolumeTypeList | ブロックストレージボリュームタイプリストを照会 |
| attachBlockStorageInstance | ブロックストレージインスタンスをサーバインスタンスに割り当て |
| detachBlockStorageInstances | サーバインスタンスに割り当てられたブロックストレージインスタンスリストを解除 |
| changeBlockStorageInstance | ブロックストレージボリュームサイズを変更 |
| changeBlockStorageVolumeSize | ブロックストレージボリュームサイズを変更 |
| setBlockStorageReturnProtection | ブロックストレージを返却保護するかどうかを設定 |
| deleteBlockStorageInstances | ブロックストレージインスタンスを削除 |
Snapshot
スナップショット関連 APIの説明は次の通りです。
| API | 説明 |
|---|---|
| createBlockStorageSnapshotInstance | ブロックストレージのスナップショットインスタンスを作成 |
| getBlockStorageSnapshotInstanceList | ブロックストレージスナップショットインスタンスリストを照会 |
| getBlockStorageSnapshotInstanceDetail | ブロックストレージスナップショットインスタンスの詳細情報を照会 |
| deleteBlockStorageSnapshotInstances | ブロックストレージスナップショットインスタンスを削除 |
Fabric Cluster
Fabric Cluster関連 APIの説明は次の通りです。
| API | 説明 |
|---|---|
| createFabricCluster | Fabric Clusterを作成 |
| getFabricClusterPoolList | Fabric Cluster Poolリストを照会 |
| getFabricClusterList | Fabric Clusterリストを照会 |
| getFabricClusterDetail | Fabric Clusterの詳細情報を照会 |
| changeFabricClusterName | Fabric Clusterの名前を変更 |
| changeFabricClusterDescription | Fabric Clusterの説明を変更 |
| changeFabricClusterServerInstances | Fabric Clusterサーバインスタンスリストを変更 |
| deleteFabricCluster | Fabric Clusterを削除 |
Common
リソース作成時に参照する共通照会 APIの説明は次の通りです。
| API | 説明 |
|---|---|
| getRegionList | リージョンリストを照会 |
| getZoneList | ゾーンリストを照会 |
| getServerImageProductList | サーバイメージ商品リストを照会 |
| getServerProductList | サーバ商品リストを照会 |
| getServerSpecList | サーバスペックリストを照会 |
| getServerSpecDetail | サーバスペックの詳細情報を照会 |
| getHypervisorTypeList | ハイパーバイザタイプリストを照会 |
| getRaidList | RAIDリストを照会 |
Server関連リソース
Server APIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。
- Server APIの使用方法
- 署名(シグネチャー)の作成: リクエストヘッダに追加する署名の作成方法
- Sub Accountご利用ガイド: リクエストヘッダに追加する Access Keyの発行方法
- Ncloudの共通レスポンスステータスコード: Serverサービスで使用される NAVERクラウドプラットフォームの共通レスポンスステータスコード情報
- Serverサービスの使用方法
- Serverご利用ガイド: NAVERクラウドプラットフォームで Serverを使用する方法
- Ncloud使用環境ガイド: VPC、Classicプラットフォームとサポートの有無に関するガイド
- 料金の紹介、特徴、詳細機能: Serverの料金体系、特徴、詳細機能のサマリー
- サービスの最新情報: Serverに関する最新情報
- よくある質問: Serverユーザーからよく寄せられる質問とその回答
- サポート: APIガイドだけでは不明な点が解消されない場合、直接問い合わせ