Enterprise Cloud API

Overview

The API function described below enables Enterprise Cloud (ECL hereafter) Customers to utilize Enterprise CLoud API via the API Gateway.

Resource URL

"Globally Common Domain (Global Load Balance)" or "Individual Region Domain (Region)" should be utilized. When using the globally common domain, a connection will be made to the nearest API Gateway according to the Customer's usage details.

1. API Gateway Endpoint FQDN (Global Load Balance)

Data Center API Gateway End Point FQDN
UK Hemel Hempstead2 Data Center api1-hemel-hempstead2-dc-uk.api.ntt.com
Germany Frankfurt 2 Data Center api1-frankfurt2-dc-de.api.ntt.com
France Paris 2 Data Center api1-paris2-dc-fr.api.ntt.com
Hong Kong Tai Po Data Center api1-taipo-dc-hk.api.ntt.com
Australia Sydney 1 Data Center api1-sydney1-dc-au.api.ntt.com

2. API Gateway Endpoint FQDN (Region)

Data Center API Gateway End Point FQDN
UK Hemel Hempstead2 Data Center [API Gateway Region]-api1-hemel-hempstead2-dc-uk.api.ntt.com
Germany Frankfurt 2 Data Center [API Gateway Region]-api1-frankfurt2-dc-de.api.ntt.com
France Paris 2 Data Center [API Gateway Region]-api1-paris2-dc-fr.api.ntt.com
Hong Kong Tai Po Data Center [API Gateway Region]-api1-taipo-dc-hk.api.ntt.com
Australia Sydney 1 Data Center [API Gateway Region]-api1-sydney1-dc-au.api.ntt.com
  • The API Gateway region can be selected from JP, US, or UK.
  • Available regions for selection are planned to be expanded.
API Gateway Endpoint FQDN URL (Sample)
  • Sample 1

    • API Gateway: Global Common Domain (Global Load Balance)
    • ECL: UK
    • API Gateway Endpoint URL: https://api1-hemel-hempstead2-dc-uk.api.ntt.com/
  • Sample 2

    • API Gateway: UK Individual Region Domain (Region)
    • ECL: UK
    • API Gateway Endpoint URL: https://uk-api1-hemel-hempstead2-dc-uk.api.ntt.com/
  • Sample 3

    • API Gateway: US Individual Region Domain (Region)
    • ECL: UK
    • API Gateway Endpoint URL: https://us-api1-hemel-hempstead2-dc-uk.api.ntt.com/

Activating the API Gateway, and Account Registration of Enterprise Cloud API

In order to utilize the API Gateway, it is necessary to register Enterprise Cloud API account information below after creating an API Gateway account through the Business Portal. For details on creating Enterprise Cloud API account, please refer to the API User Guide and Functional Description, which are distributed for Enterprise Cloud contracted customers.

Parameter Description
1 Organization ID The name of the organization to which the Enterprise Cloud API account belongs.
2 API User Name The user ID of the Enterprise Cloud API account.
3 Password The password for the Enterprise Cloud API account.

Through this, the API Gateway account (Business Portal account) and Enterprise Cloud API account will be linked, and Enterprise Cloud API functions will be executable via the API Gateway.

Enterpsise Cloud API User Guide / Functional Description

Enterprise Cloud API provisions the following functions. Please note that currently as of Aug. 1st 2015, Enterprise Cloud Unique Extension API is not applicable to API Gateway (support scheduled for Sep. 2015 or later).
* vCloud Native API (Please refer to the API User Guide for supported API functions.)
As a note, please refer to the following documents for Enterpise Cloud contracted Customers regarding usage workflows, Enterprise Cloud API user management, prerequisite conditions, restriction conditions, and a list of available API functions for utilization of Enterprise Cloud API.

  • API User Guide

  • Functional Description

List of API-available Data Centers

The following is a list of data centers available for API usage currently as of Aug. 1st 2015 (planning to expand).

Country/Region Data Center
United Kingdom UK Hemel Hempstead 2 Data Center
Germany Germany Frankfurt 2 Data Center
France France Paris 2 Data Center
Hong Kong Hong Kong Tai Po Data Center
Australia Australia Sydney 1 Data Center

Restrictions and Precautions

  • As of the release in Dec. 1st 2015 , the API function below is not supported for operation via the API Gateway. Customers need Enterprise Cloud End Point FQDN to execute this opearation via Enterprise Cloud API. For more details on Enterprise Cloud FQDN, please see Customer Portal of Ennterprise Cloud.

    • Not Available API: https://{API Gateway End Point FQDN/transfer/{id}
    • Workaround: https://{Enterprise Cloud API End Point FQDN/transfer/{id}
  • When utilizing the API Gateway, there may be cases where third party tools such as VMware OVF Tool cannot be utilized.

  • In case of accessing the Enterprise Cloud API without the API Gateway, API log function that the API Gateway provides is not applicable.