メンテナンス API

Overview

本APIは、NTT Com各種サービスのメンテナンス情報を管理するAPIです。

Resource URL

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

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

1.Base Path(Global Load Balance)

https://api.ntt.com/v1/business-process/maintenances

2.Base Path(Region)

https://{region}.api.ntt.com/v1/business-process/maintenances
  • region is jp|us|fr|sg
  • e.g. https://us.api.ntt.com/v1/business-process/maintenances
  • 指定できるregionは、将来拡充予定

Resource Information

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

メンテナンス状況参照

GET /v1/business-process/maintenances

Request Parameters

Name Description type mandatory
serviceName サービス名称を指定#1 query argument Yes
  • #1 bdp-e,mss

Example Request

 GET /v1/business-process/maintenances?serviceName=mss

Response Parameters

Name Description type mandatory
contractId サービスの契約ID String Yes
distinguishName サービス識別子 String Yes
endDate メンテナンス終了日時 String Yes
maintenanceId メンテナンスID String Yes
maintenanceName メンテナンス String Yes
serviceName サービス名　　　　 String Yes
startDate メンテナンス開始日時　　 String Yes

Example Result

{
     "items": [
        {
        "contractId": "N*********", 
        "distinguishName": "-", 
        "endDate": "2014-12-21T17:00:00Z", 
        "maintenanceId": "M*********", 
        "maintenanceName": "タイプ1定期稼動確認工事", 
        "serviceName": "Bizデスクトップ Pro Enterprise（タイプ1）", 
        "startDate": "2014-12-20T17:00:00Z"
        }
    ], 
   "resultCount": 1
   }