Overview
本APIは、Enterprise Cloud (以下ECL)にて公開済みのEnterprise Cloud APIを、API Gateway経由で利用できるようにします。
Resource URL
"グローバル共通ドメイン(Global Load Balance)" または"個別リージョンドメイン (Region)" をご利用ください。グローバル共通ドメインを利用する場合、お客様のご利用箇所の状況に応じて、一番近いAPI Gatewayに接続します。
1. End Point FQDN (Global Load Balance)
| Data Center | API Gateway End Point FQDN (Global) |
|---|---|
| UK Hemel Hempstead 2 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. End Point FQDN (Region)
| Data Center | API Gateway End Point FQDN (Region) |
|---|---|
| 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 |
- API Gateway regionはjp/us/ukからの選択となります。
- 指定可能なregionは、順次拡充予定です。
API Gateway Endpoint FQDN URL (Sample)
-
Sample 1
- API Gateway: グローバル共通ドメイン (Global Load Balance)
- ECL: UK拠点
- API Gateway Endpoint URL: https://api1-hemel-hempstead2-dc-uk.api.ntt.com/
-
Sample 2
- API Gateway: UK 個別リージョンドメイン (Region)
- ECL: UK拠点
- API Gateway Endpoint URL: https://uk-api1-hemel-hempstead2-dc-uk.api.ntt.com/
-
Sample 3
- API Gateway: US 個別リージョンドメイン (Region)
- ECL: UK拠点
- API Gateway Endpoint URL: https://us-api1-hemel-hempstead2-dc-uk.api.ntt.com/
API Gatewayの有効化とEnterprise Cloud APIアカウントの登録
API-GWを実際に利用するためには、ビジネスポータルを用いてAPI Gatewayアカウントを有効化した後に、Enterprise Cloud APIアカウントに関する以下の情報を登録する必要があります。この操作は、GUIもしくはAPI経由で実施できます。
| Parameter | Description | |
|---|---|---|
| 1 | Organization ID | ご契約のEnterprise Cloud APIアカウントが属するOrganizationの名前 |
| 2 | User ID | ご契約のEnterprise Cloud APIアカウントのUser ID |
| 3 | Password | ご契約のEnterprise Cloud APIアカウントのパスワード |
これにより、API Gatewayアカウント（ビジネスポータルアカウント）とEnterprise Cloud APIアカウントの紐付が行なわれ、API Gateway経由でのAPI利用が可能となります。
なお、Enterprise Cloud APIアカウントの作成における詳細については、ECLご契約のお客様向けに配布される、APIご利用ガイド (API User Guide) および機能操作説明書 (Functional Description) をご参照ください。
Enterpsise Cloud API User Guide / Functional Description
Enterprise Cloud APIでは、下記を提供しております。
- vCloud Native API (サポート済みのAPIについてはAPI User Guideを参照)
なお、Enterprise Cloud APIのご利用における、ご利用フロー、ECL APIユーザーの管理、前提条件、制約条件、利用可能なAPIリストについては、ECLご契約のお客様向けに配布される下記ドキュメントをご参照ください。
-
APIご利用ガイド (API Users Guide)
-
機能操作説明書 (Functional Description)
APIをご利用可能なデータセンター一覧
2015年8月現在、Enterprise CloudにてAPIをご利用可能なデータセンターは下記となります (順次拡大予定) 。
| 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 |
制約事項・注意事項
-
2015年12月1日時点では、下記のAPIについてAPI Gateway経由での操作が非対応となります。当該操作をAPI経由で実施する場合は、API Gateway経由でなく、Enterprise Cloud APIを直接操作いただく必要となります。Enterprise Cloud APIを直接操作する場合のEndpoint FQDNは、Enterprise Cloudカスタマーポータルをご参照ください。
-
非対応API: https://{API Gateway End Point FQDN/transfer/{id}
-
上記のワークアラウンド: https://{Enterprise Cloud API End Point FQDN/transfer/{id}
-
-
API Gatewayを利用した場合、VMware OVF Toolなどの3rd Party Toolが利用できない場合があります。
-
API Gatewayを経由せずにEnterprise Cloud APIに直接アクセスした場合は、当該通信はAPI GatewayのAPIログ機能の対象に含まれません。