Network > Service Gateway > API v2 Guide

To use the API, API endpoint and token are required. Refer to API Usage Preparations to prepare the information required to use the API.

For Service Gateway APIs, the network type endpoint is used. For more details, see serviceCatalog from the response of token issuance.

Type Region Endpoint
network Korea (Pangyo) Region
Korea (Pyeongchon) Region		 https://kr1-api-network-infrastructure.nhncloudservice.com
https://kr2-api-network-infrastructure.nhncloudservice.com

In each API response, you may find fields that are not specified within this guide. Those fields are for NHN Cloud internal usage, so refrain from using them because they may be changed without prior notice.

Service Gateway

Get a List of Service Gateways

GET /v2.0/gateways/servicegateways
X-Auth-Token: {tokenId}

Request

This API does not require a request body.

Name Type Format Required Description
tokenId Header String O Token ID
id Query UUID - The ID of the service gateway to retrieve
name Query String - The name of the service gateway to retrieve
service_endpoint_id Query UUID - The service endpoint ID of the service gateway to retrieve
network_id Query UUID - The VPC ID of the service gateway to retrieve
subnet_id Query UUID - The subnet ID of the service gateway to retrieve
port_id Query UUID - The port ID of the service gateway to retrieve
fixed_ip Query String - The IP address of the service gateway to retrieve

Response

Name Type Format Description
servicegateways Body Array A list of service gateway information objects
servicegateways.id Body UUID The ID of the service gateway
servicegateways.name Body String The name of the service gateway
servicegateways.port_id Body UUID Port ID
servicegateways.tenant_id Body String Tenant ID
servicegateways.network_id Body UUID VPC ID
servicegateways.subnet_id Body UUID Subnet ID
servicegateways.fixed_ip Body String The IP address of the service gateway
servicegateways.service_endpoint_id Body UUID Service endpoint ID
servicegateways.description Body String The description for the service gateway
Example 
{
  "servicegateways": [
    {
      "status": "AVAILABLE",
      "description": "",
      "network_id": "55529e1d-c6ee-4be8-baa9-2b6546667e6d",
      "tenant_id": "302406c4a1d44b2cb2bc07a652c0b202",
      "fixed_ip": "192.168.0.82",
      "subnet_id": "72d9d6e0-3ee2-4287-bcf9-be45a8422ff1",
      "service_endpoint_id": "7ba5b6e7-d871-43d3-90d2-7e2beecaaae5",
      "create_time": "2023-08-31 02:11:09",
      "project_id": "302406c4a1d44b2cb2bc07a652c0b202",
      "port_id": "182a31be-9e29-400d-983b-f701cf9b4bbc",
      "id": "d383a4a3-dae7-4609-b2db-ecdf5859fac5",
      "name": "sgw_test"
    }
  ]
}

Get a Service Gateway

GET /v2.0/gateways/servicegateways/{serviceGatewayId}
X-Auth-Token: {tokenId}

Request

This API does not require a request body.

Name Type Format Required Description
tokenId Header String O Token ID
serviceGatewayId URL UUID O The ID of the service gateway

Response

Name Type Format Description
servicegateway Body Object Service gateway information object
servicegateway.id Body UUID The ID of the service gateway
servicegateway.name Body String The name of the service gateway
servicegateway.port_id Body UUID Port ID
servicegateway.tenant_id Body String Tenant ID
servicegateway.network_id Body UUID VPC ID
servicegateway.subnet_id Body UUID Subnet ID
servicegateway.fixed_ip Body String The IP address of the service gateway
servicegateway.service_endpoint_id Body UUID Service endpoint ID
servicegateway.api_endpoints Body Array List of API endpoint information objects
servicegateway.api_endpoints.domain_name Body String API endpoint domain
servicegateway.description Body String The description for the service gateway
Example 
{
  "servicegateway": {
    "status": "AVAILABLE",
    "description": "",
    "network_id": "55529e1d-c6ee-4be8-baa9-2b6546667e6d",
    "tenant_id": "302406c4a1d44b2cb2bc07a652c0b202",
    "fixed_ip": "192.168.0.82",
    "subnet_id": "72d9d6e0-3ee2-4287-bcf9-be45a8422ff1",
    "api_endpoints": [
      {
        "domain_name": "test.test.com"
      }
    ],
    "service_endpoint_id": "7ba5b6e7-d871-43d3-90d2-7e2beecaaae5",
    "create_time": "2023-08-31 02:11:09",
    "project_id": "302406c4a1d44b2cb2bc07a652c0b202",
    "port_id": "182a31be-9e29-400d-983b-f701cf9b4bbc",
    "id": "d383a4a3-dae7-4609-b2db-ecdf5859fac5",
    "name": "sgw_test"
  }
}

Create a Service Gateway

POST /v2.0/gateways/servicegateways
X-Auth-Token: {tokenId}

Request

Name Type Format Required Description
tokenId Header String O Token ID
servicegateway Body Object O Service gateway information object
servicegateway.name Body String - The name of the service gateway
servicegateway.description Body String - The description for the service gateway
servicegateway.network_id Body UUID O VPC ID
servicegateway.subnet_id Body UUID O Subnet ID
servicegateway.service_endpoint_id Body UUID O Service endpoint ID
Example 
{
  "servicegateway": {
    "network_id": "55529e1d-c6ee-4be8-baa9-2b6546667e6d",
    "subnet_id": "72d9d6e0-3ee2-4287-bcf9-be45a8422ff1",
    "service_endpoint_id": "7ba5b6e7-d871-43d3-90d2-7e2beecaaae5",
    "name": "sgw_test",
    "description": "test"
  }
}

Response

Name Type Format Description
servicegateway Body Object A list of service gateway information objects
servicegateway.id Body UUID The ID of the service gateway
servicegateway.name Body String The name of the service gateway
servicegateway.port_id Body UUID Port ID
servicegateway.tenant_id Body String Tenant ID
servicegateway.network_id Body UUID VPC ID
servicegateway.subnet_id Body UUID Subnet ID
servicegateway.fixed_ip Body String The IP address of the service gateway
servicegateway.service_endpoint_id Body UUID Service endpoint ID
servicegateway.api_endpoints Body Array List of API endpoint information objects
servicegateway.api_endpoints.domain_name Body String API endpoint domain
servicegateway.description Body String The description for the service gateway
Example 
{
  "servicegateway": {
    "status": "AVAILABLE",
    "description": "",
    "network_id": "55529e1d-c6ee-4be8-baa9-2b6546667e6d",
    "tenant_id": "302406c4a1d44b2cb2bc07a652c0b202",
    "fixed_ip": "192.168.0.82",
    "subnet_id": "72d9d6e0-3ee2-4287-bcf9-be45a8422ff1",
    "api_endpoints": [
      {
        "domain_name": "test.test.com"
      }
    ],
    "service_endpoint_id": "7ba5b6e7-d871-43d3-90d2-7e2beecaaae5",
    "create_time": "2023-08-31 02:11:09",
    "project_id": "302406c4a1d44b2cb2bc07a652c0b202",
    "port_id": "182a31be-9e29-400d-983b-f701cf9b4bbc",
    "id": "d383a4a3-dae7-4609-b2db-ecdf5859fac5",
    "name": "sgw_test"
  }
}

Modify a Service Gateway

PUT /v2.0/gateways/servicegateways/{serviceGatewayId}
X-Auth-Token: {tokenId}

Request

Name Type Format Required Description
tokenId Header String O Token ID
serviceGatewayId URL UUID O The ID of the service gateway
servicegateway Body Object O Service gateway information object
servicegateway.name Body String - The name of the service gateway
servicegateway.description Body String - The description for the service gateway
Example 
{
  "servicegateway": {
    "name": "sgw_test1",
    "description": "test1"
  }
}

Response

Name Type Format Description
servicegateway Body Object Service gateway information object
servicegateway.id Body UUID The ID of the service gateway
servicegateway.name Body String The name of the service gateway
servicegateway.port_id Body UUID Port ID
servicegateway.tenant_id Body String Tenant ID
servicegateway.network_id Body UUID VPC ID
servicegateway.subnet_id Body UUID Subnet ID
servicegateway.fixed_ip Body String The IP address of the service gateway
servicegateway.service_endpoint_id Body UUID Service endpoint ID
servicegateway.api_endpoints Body Array List of API endpoint information objects
servicegateway.api_endpoints.domain_name Body String API endpoint domain
servicegateway.description Body String The description for the service gateway
Example 
{
  "servicegateway": {
    "status": "AVAILABLE",
    "description": "test1",
    "network_id": "55529e1d-c6ee-4be8-baa9-2b6546667e6d",
    "tenant_id": "302406c4a1d44b2cb2bc07a652c0b202",
    "fixed_ip": "192.168.0.82",
    "subnet_id": "72d9d6e0-3ee2-4287-bcf9-be45a8422ff1",
    "api_endpoints": [
      {
        "domain_name": "test.test.com"
      }
    ],
    "service_endpoint_id": "7ba5b6e7-d871-43d3-90d2-7e2beecaaae5",
    "create_time": "2023-08-31 02:11:09",
    "project_id": "302406c4a1d44b2cb2bc07a652c0b202",
    "port_id": "182a31be-9e29-400d-983b-f701cf9b4bbc",
    "id": "d383a4a3-dae7-4609-b2db-ecdf5859fac5",
    "name": "sgw_test1"
  }
}

Delete a Service Gateway

DELETE /v2.0/gateways/servicegateways/{serviceGatewayId}
X-Auth-Token: {tokenId}

Request

This API does not require a request body.

Name Type Format Required Description
tokenId Header String O Token ID
serviceGatewayId URL UUID O The ID of the service gateway

Response

Stops the specified node group.

Service Endpoint

Get a Service Endpoint

GET /v2.0/gateways/serviceendpoints/
X-Auth-Token: {tokenId}

Request

This API does not require a request body.

Name Type Format Required Description
tokenId Header String O Token ID
id Query UUID - The ID of the service endpoint to retrieve
display_name Query UUID - The name of the service endpoint to retrieve

Response

Name Type Format Description
serviceendpoints Body Array List of service endpoint information objects
serviceendpoints.id Body UUID Service endpoint ID
serviceendpoints.display_name Body String The name of the service endpoint to appear in the console
serviceendpoints.description Body String The description for the service endpoint
Example 
{
  "serviceendpoints": [
    {
      "display_name": "Object Storage",
      "description": "",
      "name": "OBS",
      "id": "7ba5b6e7-d871-43d3-90d2-7e2beecaaae5"
    }
  ]
}

Get a Service Endpoint

GET /v2.0/gateways/serviceendpoints/{seerviceEndpointId}
X-Auth-Token: {tokenId}

Request

This API does not require a request body.

Name Type Format Required Description
tokenId Header String O Token ID
serviceEndpointId URL UUID O Service endpoint ID

Response

Name Type Format Description
serviceendpoint Body Object Service endpoint information object
serviceendpoint.id Body UUID Service endpoint ID
serviceendpoint.display_name Body String The name of the service endpoint to appear in the console
serviceendpoint.description Body String The description for the service endpoint
Example 
{
  "serviceendpoint": {
      "display_name": "Object Storage",
      "description": "",
      "name": "OBS",
      "id": "7ba5b6e7-d871-43d3-90d2-7e2beecaaae5"
  }
}
Table of Contents
TOP