MEC Gateway API Reference (2.4.0)

Download OpenAPI specification:Download

Introduction

API Reference for Manipulating MEC Gateway Resources.

Authentication

apiToken

Please refer to https://sdpf.ntt.com/about-sss/api-references/first-step/ for instructions on obtaining the authentication token.

Security Scheme Type	API Key
Header parameter name:	X-Auth-Token

MEC Service

List MEC Services

Authorizations:

apiToken

query Parameters

description	string Description of the MEC Service resource
id	string <uuid> Unique ID of the MEC Service resource
name	string Name of the MEC Service resource
zone	string Name of zone

Responses

200

400

Bad Request (400)

401

Unauthorized (401)

404

Not Found (404)

500

Internal Server Error (500)

get/v2.0/mec_services

JP1 Region

https://network-jp1-ecl.api.ntt.com/v2.0/mec_services

JP2 Region

https://network-jp2-ecl.api.ntt.com/v2.0/mec_services

JP3 Region

https://network-jp3-ecl.api.ntt.com/v2.0/mec_services

JP4 Region

https://network-jp4-ecl.api.ntt.com/v2.0/mec_services

JP5 Region

https://network-jp5-ecl.api.ntt.com/v2.0/mec_services

JP6 Region

https://network-jp6-ecl.api.ntt.com/v2.0/mec_services

JP7 Region

https://network-jp7-ecl.api.ntt.com/v2.0/mec_services

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"mec_services": 
[
{"description": "MEC Service Provider 01",
"id": "d4006e79-9f60-4b72-9f86-5f6ef8b4e9e9",
"name": "MEC-Service-Provider-01",
"zone": "Lab5"
}
]
}

Show MEC Service

Authorizations:

apiToken

path Parameters

mec_service_id

required

string <uuid>

Responses

200

400

Bad Request (400)

401

Unauthorized (401)

404

Not Found (404)

500

Internal Server Error (500)

get/v2.0/mec_services/{mec_service_id}

JP1 Region

https://network-jp1-ecl.api.ntt.com/v2.0/mec_services/{mec_service_id}

JP2 Region

https://network-jp2-ecl.api.ntt.com/v2.0/mec_services/{mec_service_id}

JP3 Region

https://network-jp3-ecl.api.ntt.com/v2.0/mec_services/{mec_service_id}

JP4 Region

https://network-jp4-ecl.api.ntt.com/v2.0/mec_services/{mec_service_id}

JP5 Region

https://network-jp5-ecl.api.ntt.com/v2.0/mec_services/{mec_service_id}

JP6 Region

https://network-jp6-ecl.api.ntt.com/v2.0/mec_services/{mec_service_id}

JP7 Region

https://network-jp7-ecl.api.ntt.com/v2.0/mec_services/{mec_service_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"mec_service": 
{"description": "MEC Service Provider 01",
"id": "d4006e79-9f60-4b72-9f86-5f6ef8b4e9e9",
"name": "MEC-Service-Provider-01",
"zone": "Lab5"
}
}

MEC Gateway

List MEC Gateways

Authorizations:

apiToken

query Parameters

description	string Description of the MEC Gateway resource
mec_service_id	string <uuid> MEC Service instantiated by this Gateway
id	string Unique ID of the MEC Gateway resource
name	string Name of the MEC Gateway resource
qos_option_id	string <uuid> Quality of Service options selected for this Gateway
status	string Enum: "ACTIVE" "DOWN" "PENDING_CREATE" "PENDING_UPDATE" "PENDING_DELETE" "MONITORING_UNAVAILABLE" "ERROR" The MEC Gateway status.
tenant_id	string <uuid> Tenant ID of the owner (UUID)

Responses

200

400

Bad Request (400)

401

Unauthorized (401)

404

Not Found (404)

500

Internal Server Error (500)

get/v2.0/mec_gateways

JP1 Region

https://network-jp1-ecl.api.ntt.com/v2.0/mec_gateways

JP2 Region

https://network-jp2-ecl.api.ntt.com/v2.0/mec_gateways

JP3 Region

https://network-jp3-ecl.api.ntt.com/v2.0/mec_gateways

JP4 Region

https://network-jp4-ecl.api.ntt.com/v2.0/mec_gateways

JP5 Region

https://network-jp5-ecl.api.ntt.com/v2.0/mec_gateways

JP6 Region

https://network-jp6-ecl.api.ntt.com/v2.0/mec_gateways

JP7 Region

https://network-jp7-ecl.api.ntt.com/v2.0/mec_gateways

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"mec_gateways": 
[
{"description": "string",
"id": "string",
"mec_service_id": "string",
"name": "jp7-test-member-user-mec-gateway",
"qos_option_id": "string",
"status": "ACTIVE",
"tenant_id": "string"
}
]
}

Show MEC Gateway

Authorizations:

apiToken

path Parameters

mec_gateway_id

required

string <uuid>

Responses

200

400

Bad Request (400)

401

Unauthorized (401)

404

Not Found (404)

500

Internal Server Error (500)

get/v2.0/mec_gateways/{mec_gateway_id}

JP1 Region

https://network-jp1-ecl.api.ntt.com/v2.0/mec_gateways/{mec_gateway_id}

JP2 Region

https://network-jp2-ecl.api.ntt.com/v2.0/mec_gateways/{mec_gateway_id}

JP3 Region

https://network-jp3-ecl.api.ntt.com/v2.0/mec_gateways/{mec_gateway_id}

JP4 Region

https://network-jp4-ecl.api.ntt.com/v2.0/mec_gateways/{mec_gateway_id}

JP5 Region

https://network-jp5-ecl.api.ntt.com/v2.0/mec_gateways/{mec_gateway_id}

JP6 Region

https://network-jp6-ecl.api.ntt.com/v2.0/mec_gateways/{mec_gateway_id}

JP7 Region

https://network-jp7-ecl.api.ntt.com/v2.0/mec_gateways/{mec_gateway_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"mec_gateway": 
{"description": "string",
"id": "string",
"mec_service_id": "string",
"name": "jp7-test-member-user-mec-gateway",
"qos_option_id": "string",
"status": "ACTIVE",
"tenant_id": "string"
}
}

MEC Interface

List MEC Interfaces

Authorizations:

apiToken

query Parameters

description	string Description of the MEC Interface resource
mec_gw_id	string <uuid> MEC Gateway to which this interface is connected
id	string Unique ID of the MEC Interface resource
name	string Name of the MEC Interface resource
status	string The MEC Interface status.
tenant_id	string Tenant ID of the owner (UUID)

Responses

200

400

Bad Request (400)

401

Unauthorized (401)

404

Not Found (404)

500

Internal Server Error (500)

get/v2.0/mec_interfaces

JP1 Region

https://network-jp1-ecl.api.ntt.com/v2.0/mec_interfaces

JP2 Region

https://network-jp2-ecl.api.ntt.com/v2.0/mec_interfaces

JP3 Region

https://network-jp3-ecl.api.ntt.com/v2.0/mec_interfaces

JP4 Region

https://network-jp4-ecl.api.ntt.com/v2.0/mec_interfaces

JP5 Region

https://network-jp5-ecl.api.ntt.com/v2.0/mec_interfaces

JP6 Region

https://network-jp6-ecl.api.ntt.com/v2.0/mec_interfaces

JP7 Region

https://network-jp7-ecl.api.ntt.com/v2.0/mec_interfaces

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"mec_interfaces": 
[
{"description": "string",
"id": "string",
"mec_gw_id": "string",
"name": "string",
"primary": 
{"bgp_peer_ip": "192.168.0.1",
"bgp_router_id": null,
"ip_address": "string"
},
"secondary": 
{"bgp_peer_ip": "192.168.0.1",
"bgp_router_id": null,
"ip_address": "string"
},
"status": "ACTIVE",
"tenant_id": "string"
}
]
}

Show MEC Interface

Authorizations:

apiToken

path Parameters

mec_interface_id

required

string <uuid>

Responses

200

400

Bad Request (400)

401

Unauthorized (401)

404

Not Found (404)

409

Conflict (409)

500

Internal Server Error (500)

get/v2.0/mec_interfaces/{mec_interface_id}

JP1 Region

https://network-jp1-ecl.api.ntt.com/v2.0/mec_interfaces/{mec_interface_id}

JP2 Region

https://network-jp2-ecl.api.ntt.com/v2.0/mec_interfaces/{mec_interface_id}

JP3 Region

https://network-jp3-ecl.api.ntt.com/v2.0/mec_interfaces/{mec_interface_id}

JP4 Region

https://network-jp4-ecl.api.ntt.com/v2.0/mec_interfaces/{mec_interface_id}

JP5 Region

https://network-jp5-ecl.api.ntt.com/v2.0/mec_interfaces/{mec_interface_id}

JP6 Region

https://network-jp6-ecl.api.ntt.com/v2.0/mec_interfaces/{mec_interface_id}

JP7 Region

https://network-jp7-ecl.api.ntt.com/v2.0/mec_interfaces/{mec_interface_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"mec_interface": 
{"description": "string",
"id": "string",
"mec_gw_id": "string",
"name": "string",
"primary": 
{"bgp_peer_ip": "192.168.0.1",
"bgp_router_id": null,
"ip_address": "string"
},
"secondary": 
{"bgp_peer_ip": "192.168.0.1",
"bgp_router_id": null,
"ip_address": "string"
},
"status": "ACTIVE",
"tenant_id": "string"
}
}

QoS Option

List all visible qos_options

Authorizations:

apiToken

query Parameters

aws_service_id	string <uuid> AWS Service for which this QoS option is available
azure_service_id	string <uuid> Azure Service for which this QoS option is available
bandwidth	string Bandwidth assigned with this QoS Option
description	string Description of the QoS Policy
fic_service_id	string <uuid> FIC Service for which this QoS option is available
gcp_service_id	string <uuid> GCP Service for which this QoS option is available
id	string <uuid> Unique ID of the QoS Policy
interdc_service_id	string <uuid> Inter DC Service for which this QoS option is available
internet_service_id	string <uuid> Internet Service this policy is available from
name	string Name of the QoS Policy
mec_service_id	string <uuid> MEC Service for which this QoS option is available
qos_type	string Enum: "besteffort" "guarantee" Type of QoS Option
service_type	string Enum: "aws" "azure" "fic" "gcp" "vpn" "internet" "interdc" "mec" Service type for this option
status	string Enum: "ACTIVE" "DOWN" "PENDING_CREATE" "PENDING_UPDATE" "PENDING_DELETE" "MONITORING_UNAVAILABLE" "ERROR" QoS Option status.
vpn_service_id	string <uuid> VPN Service for which this QoS option is available

Responses

200

400

Bad Request (400)

401

Unauthorized (401)

404

Not Found (404)

500

Internal Server Error (500)

get/v2.0/qos_options

JP1 Region

https://network-jp1-ecl.api.ntt.com/v2.0/qos_options

JP2 Region

https://network-jp2-ecl.api.ntt.com/v2.0/qos_options

JP3 Region

https://network-jp3-ecl.api.ntt.com/v2.0/qos_options

JP4 Region

https://network-jp4-ecl.api.ntt.com/v2.0/qos_options

JP5 Region

https://network-jp5-ecl.api.ntt.com/v2.0/qos_options

JP6 Region

https://network-jp6-ecl.api.ntt.com/v2.0/qos_options

JP7 Region

https://network-jp7-ecl.api.ntt.com/v2.0/qos_options

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"qos_options": 
[
{"aws_service_id": "3cc310ae-e517-46c0-adfe-d89d9469cc46",
"azure_service_id": null,
"bandwidth": "string",
"description": "string",
"fic_service_id": null,
"gcp_service_id": null,
"id": "string",
"interdc_service_id": null,
"internet_service_id": null,
"name": "string",
"mec_service_id": null,
"qos_type": "besteffort",
"service_type": "aws",
"status": "ACTIVE",
"vpn_service_id": null
}
]
}

Show details for qos_option

Authorizations:

apiToken

path Parameters

qos_option_id

required

string <uuid>

Responses

200

400

Bad Request (400)

401

Unauthorized (401)

404

Not Found (404)

500

Internal Server Error (500)

get/v2.0/qos_options/{qos_option_id}

JP1 Region

https://network-jp1-ecl.api.ntt.com/v2.0/qos_options/{qos_option_id}

JP2 Region

https://network-jp2-ecl.api.ntt.com/v2.0/qos_options/{qos_option_id}

JP3 Region

https://network-jp3-ecl.api.ntt.com/v2.0/qos_options/{qos_option_id}

JP4 Region

https://network-jp4-ecl.api.ntt.com/v2.0/qos_options/{qos_option_id}

JP5 Region

https://network-jp5-ecl.api.ntt.com/v2.0/qos_options/{qos_option_id}

JP6 Region

https://network-jp6-ecl.api.ntt.com/v2.0/qos_options/{qos_option_id}

JP7 Region

https://network-jp7-ecl.api.ntt.com/v2.0/qos_options/{qos_option_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"qos_option": 
{"aws_service_id": "3cc310ae-e517-46c0-adfe-d89d9469cc46",
"azure_service_id": null,
"bandwidth": "string",
"description": "string",
"fic_service_id": null,
"gcp_service_id": null,
"id": "string",
"interdc_service_id": null,
"internet_service_id": null,
"name": "string",
"mec_service_id": null,
"qos_type": "besteffort",
"service_type": "aws",
"status": "ACTIVE",
"vpn_service_id": null
}
}

Static Route

List all visible static_routes

Authorizations:

apiToken

query Parameters

aws_gw_id	string <uuid> AWS Gateway on which this static route will be set
azure_gw_id	string <uuid> Azure Gateway on which this static route will be set
description	string Description of the Static Route resource
destination	string <cidr> CIDR this static route points to
fic_gw_id	string <uuid> FIC Gateway on which this static route will be set
gcp_gw_id	string <uuid> GCP Gateway on which this static route will be set
id	string <uuid> Unique ID of the Static Route resource
interdc_gw_id	string <uuid> Inter DC Gateway on which this static route will be set
internet_gw_id	string <uuid> Internet Gateway on which this static route will be set
name	string Name of the Static Route resource
nexthop	string <ipv4> Next Hop address for specified CIDR
mec_gw_id	string <uuid> MEC Gateway on which this static route will be set
service_type	string Enum: "aws" "azure" "fic" "gcp" "vpn" "internet" "interdc" "mec" Service type for this route
status	string Enum: "ACTIVE" "DOWN" "PENDING_CREATE" "PENDING_UPDATE" "PENDING_DELETE" "MONITORING_UNAVAILABLE" "ERROR" Static Route status.
tenant_id	string Tenant ID of the owner (non hyph UUID)
vpn_gw_id	string <uuid> VPN Gateway on which this static route will be set

Responses

200

400

Bad Request (400)

401

Unauthorized (401)

404

Not Found (404)

500

Internal Server Error (500)

get/v2.0/static_routes

JP1 Region

https://network-jp1-ecl.api.ntt.com/v2.0/static_routes

JP2 Region

https://network-jp2-ecl.api.ntt.com/v2.0/static_routes

JP3 Region

https://network-jp3-ecl.api.ntt.com/v2.0/static_routes

JP4 Region

https://network-jp4-ecl.api.ntt.com/v2.0/static_routes

JP5 Region

https://network-jp5-ecl.api.ntt.com/v2.0/static_routes

JP6 Region

https://network-jp6-ecl.api.ntt.com/v2.0/static_routes

JP7 Region

https://network-jp7-ecl.api.ntt.com/v2.0/static_routes

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"static_routes": 
[
{"aws_gw_id": "string",
"azure_gw_id": null,
"description": "string",
"destination": "string",
"fic_gw_id": null,
"gcp_gw_id": null,
"id": "string",
"interdc_gw_id": null,
"internet_gw_id": null,
"mec_gw_id": null,
"name": "string",
"nexthop": "192.168.0.1",
"service_type": "string",
"status": "ACTIVE",
"tenant_id": "string",
"vpn_gw_id": null
}
]
}

Create static_route

Authorizations:

apiToken

Request Body schema: application/json

static_route

object (StaticRouteCreate)

Responses

201

Created

400

Bad Request (400)

401

Unauthorized (401)

404

Not Found (404)

409

Conflict (409)

500

Internal Server Error (500)

post/v2.0/static_routes

JP1 Region

https://network-jp1-ecl.api.ntt.com/v2.0/static_routes

JP2 Region

https://network-jp2-ecl.api.ntt.com/v2.0/static_routes

JP3 Region

https://network-jp3-ecl.api.ntt.com/v2.0/static_routes

JP4 Region

https://network-jp4-ecl.api.ntt.com/v2.0/static_routes

JP5 Region

https://network-jp5-ecl.api.ntt.com/v2.0/static_routes

JP6 Region

https://network-jp6-ecl.api.ntt.com/v2.0/static_routes

JP7 Region

https://network-jp7-ecl.api.ntt.com/v2.0/static_routes

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"static_route": 
{"description": "string",
"destination": "string",
"mec_gw_id": "68a707a2-dfe8-1f29-bfbc-33b7c5aef747",
"name": "string",
"nexthop": "192.168.0.1",
"service_type": "mec",
"tenant_id": "string"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"static_route": 
{"description": "string",
"destination": "string",
"id": "string",
"mec_gw_id": "68a707a2-dfe8-1f29-bfbc-33b7c5aef747",
"name": "string",
"nexthop": "192.168.0.1",
"service_type": "mec",
"status": "ACTIVE",
"tenant_id": "string"
}
}

Show details for static_route

Authorizations:

apiToken

path Parameters

static_route_id

required

string <uuid>

Responses

200

400

Bad Request (400)

401

Unauthorized (401)

404

Not Found (404)

500

Internal Server Error (500)

get/v2.0/static_routes/{static_route_id}

JP1 Region

https://network-jp1-ecl.api.ntt.com/v2.0/static_routes/{static_route_id}

JP2 Region

https://network-jp2-ecl.api.ntt.com/v2.0/static_routes/{static_route_id}

JP3 Region

https://network-jp3-ecl.api.ntt.com/v2.0/static_routes/{static_route_id}

JP4 Region

https://network-jp4-ecl.api.ntt.com/v2.0/static_routes/{static_route_id}

JP5 Region

https://network-jp5-ecl.api.ntt.com/v2.0/static_routes/{static_route_id}

JP6 Region

https://network-jp6-ecl.api.ntt.com/v2.0/static_routes/{static_route_id}

JP7 Region

https://network-jp7-ecl.api.ntt.com/v2.0/static_routes/{static_route_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"static_route": 
{"aws_gw_id": "string",
"azure_gw_id": null,
"description": "string",
"destination": "string",
"fic_gw_id": null,
"gcp_gw_id": null,
"id": "string",
"interdc_gw_id": null,
"internet_gw_id": null,
"mec_gw_id": null,
"name": "string",
"nexthop": "192.168.0.1",
"service_type": "string",
"status": "ACTIVE",
"tenant_id": "string",
"vpn_gw_id": null
}
}

Update static_route

Authorizations:

apiToken

path Parameters

static_route_id

required

string <uuid>

Request Body schema: application/json

static_route

required

object (StaticRouteUpdate)

Responses

200

400

Bad Request (400)

401

Unauthorized (401)

404

Not Found (404)

409

Conflict (409)

500

Internal Server Error (500)

put/v2.0/static_routes/{static_route_id}

JP1 Region

https://network-jp1-ecl.api.ntt.com/v2.0/static_routes/{static_route_id}

JP2 Region

https://network-jp2-ecl.api.ntt.com/v2.0/static_routes/{static_route_id}

JP3 Region

https://network-jp3-ecl.api.ntt.com/v2.0/static_routes/{static_route_id}

JP4 Region

https://network-jp4-ecl.api.ntt.com/v2.0/static_routes/{static_route_id}

JP5 Region

https://network-jp5-ecl.api.ntt.com/v2.0/static_routes/{static_route_id}

JP6 Region

https://network-jp6-ecl.api.ntt.com/v2.0/static_routes/{static_route_id}

JP7 Region

https://network-jp7-ecl.api.ntt.com/v2.0/static_routes/{static_route_id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"static_route": 
{"description": "string",
"name": "string"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"static_route": 
{"aws_gw_id": "string",
"azure_gw_id": null,
"description": "string",
"destination": "string",
"fic_gw_id": null,
"gcp_gw_id": null,
"id": "string",
"interdc_gw_id": null,
"internet_gw_id": null,
"mec_gw_id": null,
"name": "string",
"nexthop": "192.168.0.1",
"service_type": "string",
"status": "ACTIVE",
"tenant_id": "string",
"vpn_gw_id": null
}
}

Delete static_route

Authorizations:

apiToken

path Parameters

static_route_id

required

string <uuid>

Responses

204

No Content (204)

400

Bad Request (400)

401

Unauthorized (401)

404

Not Found (404)

409

Conflict (409)

500

Internal Server Error (500)

delete/v2.0/static_routes/{static_route_id}

JP1 Region

https://network-jp1-ecl.api.ntt.com/v2.0/static_routes/{static_route_id}

JP2 Region

https://network-jp2-ecl.api.ntt.com/v2.0/static_routes/{static_route_id}

JP3 Region

https://network-jp3-ecl.api.ntt.com/v2.0/static_routes/{static_route_id}

JP4 Region

https://network-jp4-ecl.api.ntt.com/v2.0/static_routes/{static_route_id}

JP5 Region

https://network-jp5-ecl.api.ntt.com/v2.0/static_routes/{static_route_id}

JP6 Region

https://network-jp6-ecl.api.ntt.com/v2.0/static_routes/{static_route_id}

JP7 Region

https://network-jp7-ecl.api.ntt.com/v2.0/static_routes/{static_route_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"error": "string"
}

Gateway Interface

List Gateway Interfaces

Authorizations:

apiToken

query Parameters

aws_gw_id	string <uuid> AWS Gateway to which this port is connected
azure_gw_id	string <uuid> Azure Gateway to which this port is connected
description	string Description of the Gateway Interface resource
fic_gw_id	string <uuid> FIC Gateway to which this port is connected
gcp_gw_id	string <uuid> GCP Gateway to which this port is connected
mec_gw_id	string <uuid> MEC Gateway to which this port is connected
gw_vipv4	string <ipv4> IP version 4 address to be assigned virtual router on VRRP
gw_vipv6	string <ipv6> IP version 6 address to be assigned virtual router on VRRP
id	string <uuid> Unique ID of the Gateway Interface resource
interdc_gw_id	string <uuid> Inter DC Gateway to which this port is connected
internet_gw_id	string <uuid> Internet GW to which this port is connected
name	string Name of the Gateway Interface resource
netmask	integer Example: netmask=29 Netmask for IPv4 addresses
network_id	string <uuid> Network connected to this interface
primary_ipv4	string <ipv4> IP version 4 address to be assigned to primary device on VRRP
primary_ipv6	string <ipv6> IP version 6 address to be assigned to primary device on VRRP
secondary_ipv4	string <ipv4> IP version 4 address to be assigned to secondary device on VRRP
secondary_ipv6	string <ipv6> IP version 6 address to be assigned to secondary device on VRRP
service_type	string Enum: "aws" "azure" "fic" "gcp" "vpn" "internet" "interdc" "mec" Service type for this interface
status	string Enum: "ACTIVE" "DOWN" "PENDING_CREATE" "PENDING_UPDATE" "PENDING_DELETE" "MONITORING_UNAVAILABLE" "ERROR" The Gateway Interface status.
tenant_id	string Tenant ID of the owner (non-hyph UUID)
vpn_gw_id	string <uuid> VPN Gateway to which this port is connected
vrid	integer Example: vrid=1 VRRP Group ID for this GW Interface

Responses

200

400

Bad Request (400)

401

Unauthorized (401)

404

Not Found (404)

500

Internal Server Error (500)

get/v2.0/gw_interfaces

JP1 Region

https://network-jp1-ecl.api.ntt.com/v2.0/gw_interfaces

JP2 Region

https://network-jp2-ecl.api.ntt.com/v2.0/gw_interfaces

JP3 Region

https://network-jp3-ecl.api.ntt.com/v2.0/gw_interfaces

JP4 Region

https://network-jp4-ecl.api.ntt.com/v2.0/gw_interfaces

JP5 Region

https://network-jp5-ecl.api.ntt.com/v2.0/gw_interfaces

JP6 Region

https://network-jp6-ecl.api.ntt.com/v2.0/gw_interfaces

JP7 Region

https://network-jp7-ecl.api.ntt.com/v2.0/gw_interfaces

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"gw_interfaces": 
[
{"aws_gw_id": "string",
"azure_gw_id": null,
"description": "string",
"fic_gw_id": null,
"gcp_gw_id": null,
"gw_vipv4": "192.168.0.1",
"gw_vipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
"id": "string",
"interdc_gw_id": null,
"internet_gw_id": null,
"mec_gw_id": null,
"name": "string",
"netmask": 29,
"network_id": "string",
"primary_ipv4": "192.168.0.1",
"primary_ipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
"secondary_ipv4": "192.168.0.1",
"secondary_ipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
"service_type": "string",
"status": "ACTIVE",
"tenant_id": "string",
"vpn_gw_id": null,
"vrid": 1
}
]
}

Create Gateway Interface

Authorizations:

apiToken

Request Body schema: application/json

gw_interface

object (GwInterfaceCreate)

Responses

201

Created

400

Bad Request (400)

401

Unauthorized (401)

404

Not Found (404)

409

Conflict (409)

500

Internal Server Error (500)

post/v2.0/gw_interfaces

JP1 Region

https://network-jp1-ecl.api.ntt.com/v2.0/gw_interfaces

JP2 Region

https://network-jp2-ecl.api.ntt.com/v2.0/gw_interfaces

JP3 Region

https://network-jp3-ecl.api.ntt.com/v2.0/gw_interfaces

JP4 Region

https://network-jp4-ecl.api.ntt.com/v2.0/gw_interfaces

JP5 Region

https://network-jp5-ecl.api.ntt.com/v2.0/gw_interfaces

JP6 Region

https://network-jp6-ecl.api.ntt.com/v2.0/gw_interfaces

JP7 Region

https://network-jp7-ecl.api.ntt.com/v2.0/gw_interfaces

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"gw_interface": 
{"description": "string",
"gw_vipv4": "192.168.0.1",
"mec_gw_id": "68a707a2-dfe8-1f29-bfbc-33b7c5aef747",
"name": "string",
"netmask": 29,
"network_id": "string",
"primary_ipv4": "192.168.0.1",
"secondary_ipv4": "192.168.0.1",
"service_type": "mec",
"tenant_id": "string",
"vrid": 1
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"gw_interface": 
{"description": "string",
"gw_vipv4": "192.168.0.1",
"id": "string",
"mec_gw_id": "68a707a2-dfe8-1f29-bfbc-33b7c5aef747",
"name": "string",
"netmask": 29,
"network_id": "string",
"primary_ipv4": "192.168.0.1",
"secondary_ipv4": "192.168.0.1",
"service_type": "mec",
"status": "ACTIVE",
"tenant_id": "string",
"vrid": 1
}
}

Show Gateway Interface

Authorizations:

apiToken

path Parameters

gw_interface_id

required

string <uuid>

Unique ID of the Gateway Interface resource

Responses

200

400

Bad Request (400)

401

Unauthorized (401)

404

Not Found (404)

500

Internal Server Error (500)

get/v2.0/gw_interfaces/{gw_interface_id}

JP1 Region

https://network-jp1-ecl.api.ntt.com/v2.0/gw_interfaces/{gw_interface_id}

JP2 Region

https://network-jp2-ecl.api.ntt.com/v2.0/gw_interfaces/{gw_interface_id}

JP3 Region

https://network-jp3-ecl.api.ntt.com/v2.0/gw_interfaces/{gw_interface_id}

JP4 Region

https://network-jp4-ecl.api.ntt.com/v2.0/gw_interfaces/{gw_interface_id}

JP5 Region

https://network-jp5-ecl.api.ntt.com/v2.0/gw_interfaces/{gw_interface_id}

JP6 Region

https://network-jp6-ecl.api.ntt.com/v2.0/gw_interfaces/{gw_interface_id}

JP7 Region

https://network-jp7-ecl.api.ntt.com/v2.0/gw_interfaces/{gw_interface_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"gw_interface": 
{"aws_gw_id": "string",
"azure_gw_id": null,
"description": "string",
"fic_gw_id": null,
"gcp_gw_id": null,
"gw_vipv4": "192.168.0.1",
"gw_vipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
"id": "string",
"interdc_gw_id": null,
"internet_gw_id": null,
"mec_gw_id": null,
"name": "string",
"netmask": 29,
"network_id": "string",
"primary_ipv4": "192.168.0.1",
"primary_ipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
"secondary_ipv4": "192.168.0.1",
"secondary_ipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
"service_type": "string",
"status": "ACTIVE",
"tenant_id": "string",
"vpn_gw_id": null,
"vrid": 1
}
}

Update Gateway Interface

Authorizations:

apiToken

path Parameters

gw_interface_id

required

string <uuid>

Unique ID of the Gateway Interface resource

Request Body schema: application/json

gw_interface

required

object (GwInterfaceUpdate)

Responses

200

400

Bad Request (400)

401

Unauthorized (401)

404

Not Found (404)

409

Conflict (409)

500

Internal Server Error (500)

put/v2.0/gw_interfaces/{gw_interface_id}

JP1 Region

https://network-jp1-ecl.api.ntt.com/v2.0/gw_interfaces/{gw_interface_id}

JP2 Region

https://network-jp2-ecl.api.ntt.com/v2.0/gw_interfaces/{gw_interface_id}

JP3 Region

https://network-jp3-ecl.api.ntt.com/v2.0/gw_interfaces/{gw_interface_id}

JP4 Region

https://network-jp4-ecl.api.ntt.com/v2.0/gw_interfaces/{gw_interface_id}

JP5 Region

https://network-jp5-ecl.api.ntt.com/v2.0/gw_interfaces/{gw_interface_id}

JP6 Region

https://network-jp6-ecl.api.ntt.com/v2.0/gw_interfaces/{gw_interface_id}

JP7 Region

https://network-jp7-ecl.api.ntt.com/v2.0/gw_interfaces/{gw_interface_id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"gw_interface": 
{"description": "string",
"name": "string"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"gw_interface": 
{"aws_gw_id": "string",
"azure_gw_id": null,
"description": "string",
"fic_gw_id": null,
"gcp_gw_id": null,
"gw_vipv4": "192.168.0.1",
"gw_vipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
"id": "string",
"interdc_gw_id": null,
"internet_gw_id": null,
"mec_gw_id": null,
"name": "string",
"netmask": 29,
"network_id": "string",
"primary_ipv4": "192.168.0.1",
"primary_ipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
"secondary_ipv4": "192.168.0.1",
"secondary_ipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
"service_type": "string",
"status": "ACTIVE",
"tenant_id": "string",
"vpn_gw_id": null,
"vrid": 1
}
}

Delete Gateway Interface

Authorizations:

apiToken

path Parameters

gw_interface_id

required

string <uuid>

Unique ID of the Gateway Interface resource

Responses

204

No Content (204)

400

Bad Request (400)

401

Unauthorized (401)

404

Not Found (404)

409

Conflict (409)

500

Internal Server Error (500)

delete/v2.0/gw_interfaces/{gw_interface_id}

JP1 Region

https://network-jp1-ecl.api.ntt.com/v2.0/gw_interfaces/{gw_interface_id}

JP2 Region

https://network-jp2-ecl.api.ntt.com/v2.0/gw_interfaces/{gw_interface_id}

JP3 Region

https://network-jp3-ecl.api.ntt.com/v2.0/gw_interfaces/{gw_interface_id}

JP4 Region

https://network-jp4-ecl.api.ntt.com/v2.0/gw_interfaces/{gw_interface_id}

JP5 Region

https://network-jp5-ecl.api.ntt.com/v2.0/gw_interfaces/{gw_interface_id}

JP6 Region

https://network-jp6-ecl.api.ntt.com/v2.0/gw_interfaces/{gw_interface_id}

JP7 Region

https://network-jp7-ecl.api.ntt.com/v2.0/gw_interfaces/{gw_interface_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"error": "string"
}

Quotas

List all visible quotas

Authorizations:

apiToken

query Parameters

aws_gateway	integer AWS gateway quota.
azure_gateway	integer Azure gateway quota.
colocation_logical_link	integer Colocation Logical Link quota.
common_function_gateway	integer Common Function gateway quota.
fic_gateway	integer FIC gateway quota.
firewall	integer Firewall quota.
gcp_gateway	integer GCP gateway quota.
id	string Quota Id which should be equal to tenant_id.
interdc_gateway	integer Inter DC gateway quota.
internet_gateway	integer Internet gateway quota.
load_balancer	integer Load Balancer quota.
mec_gateway	integer MEC gateway quota.
network	integer Network quota
port	integer Port quota.
public_ip	integer Public IP quota.
subnet	integer Subnet quota.
tenant_id	string The owner of quota.
vpn_gateway	integer VPN gateway quota.

Responses

200

400

Bad Request (400)

401

Unauthorized (401)

404

Not Found (404)

500

Internal Server Error (500)

get/v2.0/quotas

JP1 Region

https://network-jp1-ecl.api.ntt.com/v2.0/quotas

JP2 Region

https://network-jp2-ecl.api.ntt.com/v2.0/quotas

JP3 Region

https://network-jp3-ecl.api.ntt.com/v2.0/quotas

JP4 Region

https://network-jp4-ecl.api.ntt.com/v2.0/quotas

JP5 Region

https://network-jp5-ecl.api.ntt.com/v2.0/quotas

JP6 Region

https://network-jp6-ecl.api.ntt.com/v2.0/quotas

JP7 Region

https://network-jp7-ecl.api.ntt.com/v2.0/quotas

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"quotas": 
[
{"aws_gateway": 0,
"azure_gateway": 0,
"colocation_logical_link": 0,
"common_function_gateway": 0,
"fic_gateway": 0,
"firewall": 0,
"gcp_gateway": 0,
"id": "string",
"interdc_gateway": 0,
"internet_gateway": 0,
"load_balancer": 0,
"mec_gateway": 0,
"network": 0,
"port": 0,
"public_ip": 0,
"subnet": 0,
"tenant_id": "string",
"vpn_gateway": 0
}
]
}

Show details for quota

Authorizations:

apiToken

path Parameters

quota_id

required

string <uuid>

Responses

200

400

Bad Request (400)

401

Unauthorized (401)

404

Not Found (404)

500

Internal Server Error (500)

get/v2.0/quotas/{quota_id}

JP1 Region

https://network-jp1-ecl.api.ntt.com/v2.0/quotas/{quota_id}

JP2 Region

https://network-jp2-ecl.api.ntt.com/v2.0/quotas/{quota_id}

JP3 Region

https://network-jp3-ecl.api.ntt.com/v2.0/quotas/{quota_id}

JP4 Region

https://network-jp4-ecl.api.ntt.com/v2.0/quotas/{quota_id}

JP5 Region

https://network-jp5-ecl.api.ntt.com/v2.0/quotas/{quota_id}

JP6 Region

https://network-jp6-ecl.api.ntt.com/v2.0/quotas/{quota_id}

JP7 Region

https://network-jp7-ecl.api.ntt.com/v2.0/quotas/{quota_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"quota": 
{"aws_gateway": 0,
"azure_gateway": 0,
"colocation_logical_link": 0,
"common_function_gateway": 0,
"fic_gateway": 0,
"firewall": 0,
"gcp_gateway": 0,
"id": "string",
"interdc_gateway": 0,
"internet_gateway": 0,
"load_balancer": 0,
"mec_gateway": 0,
"network": 0,
"port": 0,
"public_ip": 0,
"subnet": 0,
"tenant_id": "string",
"vpn_gateway": 0
}
}