Available in VPC
Overview
NAVER Cloud Platform is a cloud service built with NAVER's latest computing technology and operational know-how.
The application program interface (API) that supports the use of services and solutions provided by NAVER Cloud Platform is called NAVER Cloud Platform API.
NAVER Cloud Platform API is provided in the RESTful format, and is run by GET/POS method calls in the HTTP method.
Common VPC settings
The following describes commonly used request and response formats in VPC APIs.
Request
The following describes the common request format.
API URL
The request API URL is as follows:
https://ncloud.apigw.ntruss.com
Note
This guide is based on the GET method. POST method call tests can be performed through Swagger in the API Gateway service of the NAVER Cloud Platform console.
Request headers
The following describes the request headers.
| Field | Required | Description |
|---|---|---|
x-ncp-apigw-timestamp |
Required | This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
|
x-ncp-iam-access-key |
Required | Access key issued on NAVER Cloud Platform
|
x-ncp-apigw-signature-v2 |
Required | Base64-encoded signature that encrypts the request information with a secret key that maps to the access key issued on NAVER Cloud Platform, using the HMAC encryption algorithm (HmacSHA256)
|
Response
The following describes the common response format.
Response status codes
VPC APIs use NAVER Cloud Platform's common response status codes. For information about the HTTP status codes common to NAVER Cloud Platform, see Ncloud API response status codes.
Operation
VPC Management
| API name | Description |
|---|---|
| getVpcList | Get VPC list. |
| getVpcDetail | Get VPC details by using the VPC number. |
| createVpc | Create VPC. |
| deleteVpc | Delete VPC. |
Subnet Management
| API name | Description |
|---|---|
| getSubnetList | Get the list of subnets. |
| getSubnetDetail | Get the subnet details using the subnet number. |
| createSubnet | Create subnet. |
| deleteSubnet | Delete subnet. |
Network ACL
| API name | Description |
|---|---|
| getNetworkAclList | Get the network ACL list. |
| getNetworkAclDetail | Get the network ACL details using the network ACL number. |
| createNetworkAcl | Create network ACL. |
| deleteNetworkAcl | Delete network ACL. |
| setSubnetNetworkAcl | Set subnet's network ACL. |
| getNetworkAclRuleList | Get the network ACL rule list using the network ACL number. |
| addNetworkAclInboundRule | Add rules to the network ACL inbound rule list. |
| addNetworkAclOutboundRule | Add rules to the network ACL outbound rule list. |
| removeNetworkAclInboundRule | Remove rules from the network ACL inbound rule list. |
| removeNetworkAclOutboundRule | Remove rules from the network ACL outbound rule list. |
| setNetworkAclDescription | Edit the network ACL description. |
| getNetworkAclDenyAllowGroupList | Get the network ACL's Deny-Allow group list. |
| getNetworkAclDenyAllowGroupDetail | Get the network ACL's Deny-Allow group details using the Deny-Allow group number. |
| createNetworkAclDenyAllowGroup | Create network ACL's Deny-Allow groups. |
| deleteNetworkAclDenyAllowGroup | Delete network ACL's Deny-Allow groups. |
| setNetworkAclDenyAllowGroupIpList | Set the IP list of network ACL's Deny-Allow groups. |
| setNetworkAclDenyAllowGroupDescription | Edit the description of network ACL's Deny-Allow groups. |
NAT Gateway
| API name | Description |
|---|---|
| getNatGatewayInstanceList | Get NAT Gateway instance list |
| getNatGatewayInstanceDetail | Get NAT Gateway instance details using the NAT Gateway instance number. |
| createNatGatewayInstance | Create NAT Gateway instances. |
| deleteNatGatewayInstance | Delete NAT Gateway instance. |
| setNatGatewayDescription | Edit NAT Gateway description. |
VPC Peering
| API name | Description |
|---|---|
| getVpcPeeringInstanceList | Get VPC peering instance list. |
| getVpcPeeringInstanceDetail | Get VPC peering instance details using the VPC peering instance number. |
| createVpcPeeringInstance | Create VPC peering instances through peering requests. |
| deleteVpcPeeringInstance | Delete VPC peering instance. |
| acceptOrRejectVpcPeering | Accept or reject VPC peering request. |
| setVpcPeeringDescription | Edit VPC peering description. |
Route Table
| API name | Description |
|---|---|
| getRouteTableList | Get routing table list. |
| getRouteTableDetail | Get routing table details using the routing table number. |
| createRouteTable | Create routing tables. |
| deleteRouteTable | Delete routing tables. |
| getRouteList | Get route list set in routing tables. |
| addRoute | Add route list to a routing table. |
| removeRoute | Remove route list set in a routing table. The route set as default can't be removed. |
| getRouteTableSubnetList | Get related subnet list set in routing tables. |
| addRouteTableSubnet | Add related subnet list to routing tables. |
| removeRouteTableSubnet | Remove related subnet list from routing tables. |
| setRouteTableDescription | Edit routing table description. |