VPC環境で利用できます。
概要
NAVERクラウドプラットフォームは、NAVERの最新コンピューティング技術や運用ノウハウが蓄積されたクラウドサービスです。
NAVERクラウドプラットフォームが提供するサービスとソリューションを活用できるようにサポートするアプリケーションインターフェース(API)を、NAVERクラウドプラットフォーム APIといいます。
NAVERクラウドプラットフォーム APIは RESTfulの形式で提供され、HTTP方式の GET/POSTメソッド呼び出しにより実行されます。
VPCの共通設定
VPC APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。
リクエスト
共通リクエスト形式を説明します。
API URL
リクエスト API URLは次の通りです。
https://ncloud.apigw.ntruss.com
参考
ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。
リクエストヘッダ
リクエストヘッダの説明は次の通りです。
| フィールド | 必須の有無 | 説明 |
|---|---|---|
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でエンコードした署名 |
レスポンス
共通レスポンス形式を説明します。
レスポンスステータスコード
VPC APIは NAVERクラウドプラットフォームの共通レスポンスステータスコードを使用します。NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。
オペレーション
VPC Management
| API名 | 説明 |
|---|---|
| getVpcList | VPCリストを照会 |
| getVpcDetail | VPC番号を利用してVPCの詳細情報を照会 |
| createVpc | VPCを作成 |
| deleteVpc | VPCを削除 |
Subnet Management
| API名 | 説明 |
|---|---|
| getSubnetList | Subnetリストを照会 |
| getSubnetDetail | Subnet番号を利用して Subnetの詳細情報を照会 |
| createSubnet | Subnetを作成 |
| deleteSubnet | Subnetを削除 |
Network ACL
| API名 | 説明 |
|---|---|
| getNetworkAclList | Network ACLリストを照会 |
| getNetworkAclDetail | Network ACL番号を利用して Network ACLの詳細情報を照会 |
| createNetworkAcl | Network ACLを作成 |
| deleteNetworkAcl | Network ACLを削除 |
| setSubnetNetworkAcl | Subnetの Network ACLを設定 |
| getNetworkAclRuleList | Network ACL番号を利用して Network ACLのルールリストを照会 |
| addNetworkAclInboundRule | Network ACLのインバウンドルールリストを追加 |
| addNetworkAclOutboundRule | Network ACLのアウトバウンドルールリストを追加 |
| removeNetworkAclInboundRule | Network ACLのインバウンドルールリストを削除 |
| removeNetworkAclOutboundRule | Network ACLのアウトバウンドルールリストを削除 |
| setNetworkAclDescription | Network ACLの説明を修正 |
| getNetworkAclDenyAllowGroupList | Network ACL Deny-Allowグループリストを照会 |
| getNetworkAclDenyAllowGroupDetail | Deny-Allowグループ番号を利用して、Network ACL Deny-Allowグループの詳細情報を照会 |
| createNetworkAclDenyAllowGroup | Network ACL Deny-Allowグループを作成 |
| deleteNetworkAclDenyAllowGroup | Network ACL Deny-Allowグループを削除 |
| setNetworkAclDenyAllowGroupIpList | Network ACL Deny-AllowグループのIPリストを設定 |
| setNetworkAclDenyAllowGroupDescription | Network ACL Deny-Allowグループの説明を修正 |
NAT Gateway
| API名 | 説明 |
|---|---|
| getNatGatewayInstanceList | NAT Gatewayインスタンスリストを照会 |
| getNatGatewayInstanceDetail | NAT Gatewayインスタンス番号を利用して、NAT Gatewayインスタンスの詳細情報を照会 |
| createNatGatewayInstance | NAT Gatewayインスタンスを作成 |
| deleteNatGatewayInstance | NAT Gatewayインスタンスを削除 |
| setNatGatewayDescription | NAT Gatewayの説明を修正 |
VPC Peering
| API名 | 説明 |
|---|---|
| getVpcPeeringInstanceList | VPC Peeringインスタンスリストを照会 |
| getVpcPeeringInstanceDetail | VPC Peeringインスタンス番号を利用して、VPC Peeringインスタンスの詳細情報を照会 |
| createVpcPeeringInstance | PeeringリクエストでVPC Peeringインスタンスを作成 |
| deleteVpcPeeringInstance | VPC Peeringインスタンスを削除 |
| acceptOrRejectVpcPeering | VPC Peeringリクエストを承認するか、拒否する |
| setVpcPeeringDescription | VPC Peeringの説明を修正 |
Route Table
| API名 | 説明 |
|---|---|
| getRouteTableList | ルートテーブルリストを照会 |
| getRouteTableDetail | ルートテーブル番号を利用して、ルートテーブルの詳細情報を照会 |
| createRouteTable | ルートテーブルを作成 |
| deleteRouteTable | ルートテーブルを削除 |
| getRouteList | ルートテーブルに設定されたルートリストを照会 |
| addRoute | ルートテーブルにルートリストを追加 |
| removeRoute | ルートテーブルに設定されたルートリストを削除 基本に設定されているルートは削除不可 |
| getRouteTableSubnetList | ルートテーブルに設定された、関連付けられた Subnetリストを照会 |
| addRouteTableSubnet | ルートテーブルに関連付けるサブ Subnetを追加 |
| removeRouteTableSubnet | ルートテーブルに関連付けられた Subnetリストを削除 |
| setRouteTableDescription | ルートテーブルの説明を修正 |