Cloud Management Platform API

Overview

クラウドマネジメントプラットームのリソース情報を提供するAPIです。

Resource URL

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

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

1.Base Path(Global Load Balance)

https://api.ntt.com/v1/cmp/{CMP Region}

2.Base Path(Region)

https://{API-GW region}.api.ntt.com/v1/cmp/{CMP Region}

• API-GW region is jp|us|uk
• e.g. https://us.api.ntt.com/v1/cmp/us

• 指定できるAPI-GW regionは、将来拡充予定

• CMP Region は、お客様が開通時に選択したCMPリージョン名を eu|jp|us|ap|au から選択してください。

Resource Information

• #1 お客さま接続単位で適切な流量制限を実施
• #2 リクエストヘッダとして、X-Cmp-Auth: Apigw {api_key}:{api_secret} を含めて下さい。
  api_keyおよびapi_secretは、CMP APIユーザ作成時に発行されます。
  APIユーザ作成については、ECL2.0あるいはECL1.0のサポートチケットでお問い合わせください。

サーバ情報取得

GET /servers/{resource_id}

Request Parameters

Example Request

 GET /servers/********-****-****-****-************

Response Parameters

• 補足情報として他のキーも含まれますがサポート対象外です。

• アカウント情報オブジェクトには、下記のkey/valueが含まれます。

  • id: アカウントID
  • name: アカウント名

Example Result

{
    "name": "Virtual Machine 1",
    "account": {
        "id": "********-****-****-****-************",
        "name": "****************"
    }
}

ネットワーク情報取得

GET /networks/{resource_id}

Request Parameters

Example Request

GET /networks/********-****-****-****-************

Response Parameters

• 補足情報として他のキーも含まれますがサポート対象外です。

• アカウント情報オブジェクトには、下記のkey/valueが含まれます。

  • id: アカウントID
  • name: アカウント名

Example Result

{
    "name": "Network 1",
    "account": {
        "id": "********-****-****-****-************",
        "name": "****************"
    }
}

ボリューム情報取得

GET /volumes/{resource_id}

Request Parameters

Example Request

GET /volumes/********-****-****-****-************

Response Parameters

• 補足情報として他のキーも含まれますがサポート対象外です。

• アカウント情報オブジェクトには、下記のkey/valueが含まれます。

  • id: アカウントID
  • name: アカウント名

Example Result

{
    "name": "Volume 1",
    "account": {
        "id": "********-****-****-****-************",
        "name": "****************"
}