Introduction

Prerequisites

To use the Network API and perform the following steps, you must subscribe to the Smart Data Platform from the Business Portal.
Network API enable you to create, manage, and control the resources of following services.

  • L2 Network Service

  • Internet Gateway Service

  • VPN Service

  • Firewall Service

  • Common Function Service

  • Load balancer Service

  • InterDC Service

  • 10G Colocation Service

  • AWS, Azure, GCP Service

  • Tenant Connection Service

  • FIC Service

  • Security Group Service

This guide shows you how to execute some of the basic use cases for these resources in the API.

Authentication

To use the Network API, you must obtain an authentication token from Keystone through the API.
Use the following page to obtain an authentication token.
https://sdpf.ntt.com/docs/about-sss/api-references/rsts/First_Step.html

Network API

From this chapter onward, the following expressions are used as examples of the use of the Network API, but please replace them with values suitable for your environment and make API calls.

  • {TOKEN}：Authentication Token obtained with Authentication

  • {api_endpoint}：URL to access the Network API (Please refer from the API References )

This document also specifies a JSON file to send Network API requests. Make API calls by replacing the name of the JSON file that describes the request for the resource you want to create.
You can also send requests in ways other JSON files, but see About Smart Data Platform SSS API for more information.

Status

Network API to get Response.
Within this Response is a parameter called status, which represents the status of the specified resource when using the Network API.
There are 8 status values: ACTIVE, DOWN, PENDING_XXX (CREATE, UPDATE, DELETE), MONITORING_UNAVAILABLE, ERROR .

You may continue to create resources later in this chapter, but make sure that the status value of the resource you created is other than PENDING_XXX before you proceed to create the next resource.