Enterprise Cloud APIアカウント紐付けAPI

Overview

本APIは、Enterprise Cloud APIアカウントをAPIゲートウェイ経由で利用可能な状態にするために、双方のアカウントを紐づけるためのAPIです。同様の操作をGUIでも行うことができます(2015年8月中旬対応予定)。

Resource URL

グローバル共通ドメインの利用、または個別リージョンドメインをご利用ください。

グローバル共通ドメインを利用する場合、お客様のご利用箇所の状況に応じて、一番近いAPIゲートウェイに接続します。1

1.Base Path(Global Load Balance)

https://api.ntt.com/v1/ec-vcd-reg/accounts

2.Base Path(Region)

https://{region}.api.ntt.com/v1/ec-vcd-reg/accounts
  • region is jp|us|uk
  • e.g. https://us.api.ntt.com/v1/ec-vcd-reg/accounts
  • 指定できるregionは、将来拡充予定

Resource Information

Key Value
レスポンス フォーマット JSON
認証(OAuth) Yes
帯域制御#1 Yes
  • #1 お客さま接続単位で適切な流量制限を実施

1. アカウント紐付け情報参照

GET /v1/ec-vcd-reg/accounts

Request Parameters

Name Description type mandatory
clientId APIゲートウェイのConsumer Key query argument Yes
clientSecret APIゲートウェイのConsumer Secret query argument Yes

Example Request

 GET /v1/ec-vcd-reg/accounts?clientId=****&clientSecret=****

Response Parameters

Name Description type mandatory
clientId APIゲートウェイのConsumer Key String
clientSecret APIゲートウェイのConsumer Secret String
created 作成日 String
ecVcdId Enterprise Cloud API UserName String
ecVcdOrg Enterprise Cloud API UserOrganization String
ecVcdPassword Enterprise Cloud API UserPassword String
path パス情報 String
modified 更新日 String
type type String
uuid 管理ID String

Example Result

{
    "entities": [
        {
            "clientId": "**********", 
            "clientSecret": "**********", 
            "created": 1436850272679, 
            "ecVcdId": "**********", 
            "ecVcdOrg": "**********", 
            "ecVcdPassword": "**********", 
            "metadata": {
                "path": "/accounts/**********"
            }, 
            "modified": 1436850272679, 
            "type": "account", 
            "uuid": "**********"
        }
    ]
}

2. アカウント紐付け情報登録

下記により、Enterprise Cloud APIとAPゲートウェイのAPIアカウントの紐づけを行います。

POST /v1/ec-vcd-reg/accounts

Request Parameters

Name Description type mandatory
clientId APIゲートウェイのConsumer Key JSON Yes
clientSecret APIゲートウェイのConsumer Secret JSON Yes
ecVcdId Enterprise Cloud API UserName JSON Yes
ecVcdOrg Enterprise Cloud API UserOrganization JSON Yes
ecVcdPassword Enterprise Cloud API UserPassword JSON Yes

Example Request

Content-Type: application/json; charset=utf-8
Host: api.ntt.com

POST /v1/ec-vcd-reg/accounts
{
   "clientId":"*************",
   "clientSecret":"*************",
   "ecVcdId":"*************",
   "ecVcdOrg":"*************",
   "ecVcdPassword":"*************"
}

Response Parameters

Name Description type mandatory
clientId APIゲートウェイのConsumer Key String
clientSecret APIゲートウェイのConsumer Secret String
created 作成日 String
ecVcdId Enterprise Cloud API UserName String
ecVcdOrg Enterprise Cloud API UserOrganization String
ecVcdPassword Enterprise Cloud API UserPassword String
path パス情報 String
modified 更新日 String
type type String
uuid 管理ID String

Example Result

{
    "entities": [
        {
            "clientId": "**********", 
            "clientSecret": "**********", 
            "created": 1436850272679, 
            "ecVcdId": "**********", 
            "ecVcdOrg": "**********", 
            "ecVcdPassword": "**********", 
            "metadata": {
                "path": "/accounts/**********"
            }, 
            "modified": 1436850272679, 
            "type": "account", 
            "uuid": "**********"
        }
    ]
}

3. アカウント紐付け情報削除

下記により、Enterprise Cloud APIとAPゲートウェイのAPIアカウントの紐づけを解除します。
DELETE /v1/ec-vcd-reg/accounts

Request Parameters

Name Description type mandatory
uuid 削除対象の管理ID JSON Yes
clientId APIゲートウェイのConsumer Key JSON Yes
clientSecret APIゲートウェイのConsumer Secret JSON Yes

Example Request

Content-Type: application/json; charset=utf-8
Host: api.ntt.com

DELETE /v1/ec-vcd-reg/accounts
{
   "uuid":"*************",
   "clientId":"*************",
   "clientSecret":"*************"
}

Response Parameters

Name Description type mandatory
clientId APIゲートウェイのConsumer Key String
clientSecret APIゲートウェイのConsumer Secret String
created 作成日 String
ecVcdId Enterprise Cloud API UserName String
ecVcdOrg Enterprise Cloud API UserOrganization String
ecVcdPassword Enterprise Cloud API UserPassword String
path パス情報 String
modified 更新日 String
type type String
uuid 管理ID String

Example Result

{
    "entities": [
        {
            "clientId": "**********", 
            "clientSecret": "**********", 
            "created": 1436850272679, 
            "ecVcdId": "**********", 
            "ecVcdOrg": "**********", 
            "ecVcdPassword": "**********", 
            "metadata": {
                "path": "/accounts/**********"
            }, 
            "modified": 1436850272679, 
            "type": "account", 
            "uuid": "**********"
        }
    ]
}

  1. 2014/12現在、DNSラウンドロビン運用。2015/04以降、お客さまの地理的に近いAPIゲートウェイに自動接続します