Cloud Management Platform API

Overview

This API provides resource information of Cloud Management Platform.

Resource URL

Please use the global common domain or API-GW regional domain.

If you use the global common domain, you will be served by the nearest API-GW.

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 regions will be added in the future.

  • Please specify CMP Region you provisioned by choosing one of CMP region name: eu|jp|us|ap|au.

Resource Information

Key Value
Response Format JSON
Authentication(OAuth) Yes
Rate Limiting #1 Yes
CMP Additional Authentication Header #2 Yes
  • #1 Rate limiting is applied per customer.
  • #2 Include an additional request header X-Cmp-Auth: Apigw {api_key}:{api_secret}
    api_key and api_secret will be issued when the CMP API user has been cretaed.
    Please contact to NTTCom for API user creation via either ECL2.0 or ECL1.0 customer support ticket.

Get Server Information

GET /servers/{resource_id}

Request Parameters

Name Description type mandatory
resource_id Resource ID query argument Yes

Example Request

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

Response Parameters

Name Description type mandatory
name Resource name String
account Account Object

  • Account object contains the following keys and values:
    ** id: Account ID
    ** name: Account Name

  • Other keys may be included in the API response but they are not supported.

Example Result

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

Get Network Information

GET /networks/{resource_id}

Request Parameters

Name Description type mandatory
resource_id Resource ID query argument Yes

Example Request

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

Response Parameters

Name Description type mandatory
name Resource Name String
account Account Object

  • Account object contains the following keys and values:
    ** id: Account ID
    ** name: Account Name

  • Other keys may be included in the API response but they are not supported.

Example Result

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

Get Volume Information

GET /volumes/{resource_id}

Request Parameters

Name Description type mandatory
resource_id Resource ID query argument Yes

Example Request

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

Response Parameters

Name Description type mandatory
name Resource Name String
account Account Object

  • Account object contains the following keys and values:
    ** id: Account ID
    ** name: Account Name

  • Other keys may be included in the API response but they are not supported.

Example Result

{
    "name": "Volume 1",
    "account": {
      "id": "********-****-****-****-************",
      "name": "****************"
    }
}
  • Other keys may be included in the API response but they are not supported.