VPC環境で利用できます。
概要
NAVERクラウドプラットフォームは、NAVERの最新コンピューティング技術や運用ノウハウが蓄積されたクラウドサービスです。
NAVERクラウドプラットフォームが提供するサービスとソリューションを活用できるようにサポートするアプリケーションインターフェース(API)を、NAVERクラウドプラットフォーム APIといいます。
NAVERクラウドプラットフォーム APIは RESTful形式で提供され、HTTP方式の GET/POSTメソッドの呼び出しを介して行われます。
共通設定
API URL
GET or POST
https://ncloud.apigw.ntruss.com/vserver/v2/
リクエストヘッダ
| ヘッダ名 | 説明 |
|---|---|
| x-ncp-apigw-timestamp | 1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表す API Gatewayサーバとの時間差が5分以上の場合は、無効なリクエストとみなす |
| x-ncp-iam-access-key | NAVERクラウドプラットフォームから発行された API Keyまたは IAMから発行された AccessKey |
| x-ncp-apigw-signature-v2 | 上記ユースケースの Bodyを AccessKeyとマッピングする SecretKeyで暗号化した署名 HMAC暗号化アルゴリズムは HmacSHA256を使用 |
オペレーション
Common
| API名 | 説明 |
|---|---|
| getRegionList | リージョンリストを照会 |
| getZoneList | ZONEリストを照会 |
| getServerImageProductList | NAVERクラウドプラットフォームで提供するサーバイメージのサービスリストを照会 |
| getServerProductList | サーバイメージのサービスコードを利用して、NAVERクラウドプラットフォームで提供するサーバスペックのサービスリストを照会 |
| getRaidList | 使用可能な RAIDリストを照会 |
Login Key
| API名 | 説明 |
|---|---|
| getLoginKeyList | サーバインスタンス(VM)アクセス用のログインキーを利用してパスワードを暗号化・復号するキーを照会 |
| createLoginKey | サーバインスタンス(VM)アクセス用のログインキーを利用してパスワードを暗号化・復号するキーを作成 |
| deleteLoginKeys | サーバインスタンス(VM)アクセス用のログインキーを利用してパスワードを暗号化・復号するキーを削除 |
| importLoginKey | サーバインスタンス(VM)アクセス用のログインキーを利用してパスワードを暗号化・復号するキーを作成 ユーザーが直接 ssh-keygenで作成した公開鍵を importする |
Placement Group
| API名 | 説明 |
|---|---|
| getPlacementGroupList | サーバインスタンス(VM)が属する物理配置グループリストを照会 |
| getPlacementGroupDetail | 物理配置グループ番号を利用して物理配置グループの詳細情報を照会 |
| createPlacementGroup | サーバインスタンス(VM)が属する物理配置グループを作成 |
| deletePlacementGroup | 物理配置グループを削除 |
| addPlacementGroupServerInstance | 物理配置グループにサーバインスタンスを追加 |
| removePlacementGroupServerInstance | 物理配置グループからサーバインスタンスを削除 |
Server
| API名 | 説明 |
|---|---|
| getServerInstanceList | サーバインスタンス(VM)リストを照会 |
| getServerInstanceDetail | サーバインスタンス番号を利用してサーバインスタンスの詳細情報を照会 |
| createServerInstances | サーバインスタンス(VM)を作成 |
| startServerInstances | 停止状態のサーバインスタンス(VM)を起動 |
| stopServerInstances | 実行中状態のサーバインスタンス(VM)を停止 |
| rebootServerInstances | 実行中状態のサーバインスタンス(VM)を再起動 |
| terminateServerInstances | 停止状態のサーバインスタンス(VM)を返却 |
| changeServerInstanceSpec | 停止状態のサーバインスタンス(VM)のスペックを変更 |
| getRootPassword | サーバインスタンス(VM)のログインキーを利用して rootアカウントのパスワードを照会 privateKeyを入力しないと、そのサーバインスタンスの暗号化されたパスワードを照会 |
| getRootPasswordServerInstanceList | サーバインスタンス(VM)のログインキーを利用して rootアカウントのパスワードをリストで照会 privateKeyを入力しないと、そのサーバインスタンスの暗号化されたパスワードを照会 |
| setProtectServerTermination | サーバを返却保護するかどうかを設定 |
Server Image
| API名 | 説明 |
|---|---|
| getMemberServerImageInstanceList | 会員サーバイメージのインスタンスリストを照会 |
| getMemberServerImageInstanceDetail | 会員サーバイメージのインスタンス番号を利用して、会員サーバイメージインスタンスの詳細情報を照会 |
| createMemberServerImageInstance | 停止/実行中状態のサーバインスタンスから会員サーバイメージインスタンスを作成 |
| deleteMemberServerImageInstances | 会員サーバイメージインスタンスリストを削除 |
| setMemberServerImageSharingPermission | 会員サーバイメージの共有権限設定 |
| addMemberServerImageSharingPermission | 会員サーバイメージ共有権限を追加 |
| removeMemberServerImageSharingPermission | 会員サーバイメージ共有権限を削除 |
Storage
| API名 | 説明 |
|---|---|
| getBlockStorageInstanceList | ブロックストレージインスタンスリストを照会 |
| getBlockStorageInstanceDetail | ブロックストレージインスタンス番号を利用して、ブロックストレージインスタンスの詳細情報を照会 |
| createBlockStorageInstance | ブロックストレージインスタンスを作成 |
| deleteBlockStorageInstances | ブロックストレージインスタンスリストを削除 |
| attachBlockStorageInstance | ブロックストレージインスタンスをサーバインスタンスに割り当て |
| detachBlockStorageInstances | ブロックストレージインスタンスリストをサーバインスタンスで割り当て解除 |
| changeBlockStorageVolumeSize | ブロックストレージボリュームサイズを変更 |
| setBlockStorageReturnProtection | ブロックストレージを返却保護するかどうかを設定 |
Snapshot
| API名 | 説明 |
|---|---|
| getBlockStorageSnapshotInstanceList | ブロックストレージのスナップショットインスタンスリストを照会 |
| getBlockStorageSnapshotInstanceDetail | ブロックストレージのスナップショットインスタンス番号を利用して、ブロックストレージのスナップショットインスタンスの詳細情報を照会 |
| createBlockStorageSnapshotInstance | ブロックストレージのスナップショットインスタンスを作成 |
| deleteBlockStorageSnapshotInstances | ブロックストレージのスナップショットインスタンスリストを削除 |
Public IP
| API名 | 説明 |
|---|---|
| getPublicIpInstanceList | グローバル IPアドレスのインスタンスリストを照会 |
| getPublicIpInstanceDetail | グローバル IPアドレスのインスタンス番号を利用して、グローバル IPアドレスインスタンスの詳細情報を照会 |
| createPublicIpInstance | グローバル IPアドレスのインスタンスを作成 |
| deletePublicIpInstance | グローバル IPアドレスのインスタンスを削除 |
| getPublicIpTargetServerInstanceList | グローバル IPアドレスのインスタンスを割り当てできるサーバインスタンスリストを照会 |
| associatePublicIpWithServerInstance | グローバル IPアドレスのインスタンスをサーバインスタンスに割り当て |
| disassociatePublicIpFromServerInstance | グローバル IPアドレスのインスタンスをサーバインスタンスで割り当て解除 |
Init Script
| API名 | 説明 |
|---|---|
| getInitScriptList | ユーザーが作成した初期化スクリプトリストを照会 |
| getInitScriptDetail | 初期化スクリプト番号を利用して、初期化スクリプトの詳細情報を照会 |
| createInitScript | 初期化スクリプトを作成 |
| deleteInitScripts | 初期化スクリプトリストを削除 |
Network Interface
| API名 | 説明 |
|---|---|
| getNetworkInterfaceList | ネットワークインターフェースリストを照会 |
| getNetworkInterfaceDetail | ネットワークインターフェース番号を利用して、ネットワークインターフェースの詳細情報を照会 |
| createNetworkInterface | ネットワークインターフェースを作成 |
| deleteNetworkInterface | ネットワークインターフェースを削除 |
| attachNetworkInterface | サーバインスタンスにネットワークインターフェースを割り当て サーバインスタンスの基本ネットワークインターフェースを含め、最大3個のネットワークインターフェースを割り当てできる |
| detachNetworkInterface | サーバインスタンスに割り当てられたネットワークインターフェースを解除 サーバインスタンスの基本ネットワークインターフェースは解除不可 |
| addNetworkInterfaceAccessControlGroup | ネットワークインターフェースに適用される ACGリストを追加 ネットワークインターフェースごとに、最大3個の ACGを適用可能 |
| removeNetworkInterfaceAccessControlGroup | ネットワークインターフェースに適用された ACGリストを削除 ネットワークインターフェースごとに、最小1個の ACGを適用する必要がある |
| assignSecondaryIps | ネットワークインターフェースにセカンダリ IPアドレスを割り当て |
| unassignSecondaryIps | ネットワークインターフェースに割り当てられたセカンダリ IPアドレスを解除 |
| enableFlowLog | FlowLogを有効化 |
| disableFlowLog | FlowLogを無効化 |
| getFlowLogConfigurationList | FlowLogの設定情報を照会 |
ACG
| API名 | 説明 |
|---|---|
| getAccessControlGroupList | ACGリストを照会 ACGは、ネットワークインターフェースに設定してアクセス制御可能 |
| getAccessControlGroupDetail | ACG番号を利用して ACGの詳細情報を照会 |
| createAccessControlGroup | ACGの作成 |
| deleteAccessControlGroup | ACG削除 |
| getAccessControlGroupRuleList | ACG番号を利用して ACGの Ruleリストを照会 |
| addAccessControlGroupInboundRule | ACGの Inbound Ruleリストを追加 |
| addAccessControlGroupOutboundRule | ACGの Outbound Ruleリストを追加 |
| removeAccessControlGroupInboundRule | ACGの Inbound Ruleリストを削除 |
| removeAccessControlGroupOutboundRule | ACGの Outbound Ruleリストを削除 |