契約情報 API

Overview

本APIは、NTT Com各種サービスの契約情報を管理するAPIです。

Resource URL

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

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

1.Base Path(Global Load Balance)

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

2.Base Path(Region)

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

Resource Information

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

契約情報参照

GET /v1/business-process/contracts

Request Parameters

Name Description type mandatory
serviceName サービス名称を指定#1 query argument Yes
  • #1 uno,cloudn,bhec,ucaas,sip-trunking,bizmail,mss,gmone,050plusbiz,ip-voice,smart-pbx,accs,bdp-e

Example Request

 GET /v1/business-process/contracts?serviceName=uno

Response Parameters

Name Description type mandatory
accountId アカウントID String
cRef Enterprise Cloud内部識別ID String
contractId サービスの契約ID String
distinguishName サービス識別名 String
internalContractId 内部契約ID String
optionType オプションタイプ String
serviceName サービス名 String
serviceStatus サービステータス1:正常 2:異常 3:警告 9:非監視 Int
site サイト String
vpnGroupId VPNグループID String
resultCount レスポンス件数 Int

Example Result

{
"items": [
    {
        "accountId": null, 
        "cRef": null, 
        "contractId": "N*********", 
        "distinguishName": "【１Ｇ】大手町Aビル", 
        "internalContractId": null, 
        "optionType": null, 
        "serviceName": "L2 ギャランティアクセス　イーサタイプ(NTT Com光アクセス利用) 1000BASE-SX", 
        "serviceStatus": 1, 
        "site": null, 
        "vpnGroupId": "V********"
    }, 
    {
        "accountId": null, 
        "cRef": null, 
        "contractId": "W*********", 
        "distinguishName": null, 
        "internalContractId": null, 
        "optionType": null, 
        "serviceName": "Constant Rate (Ethernet)", 
        "serviceStatus": 1, 
        "site": null, 
        "vpnGroupId": "V********"
    }
], 
"resultCount": 2
}