Overview
本APIは、NTT Com各種サービスの料金表情報1を管理するAPIです。
Resource URL
グローバル共通ドメインの利用、または個別リージョンドメインをご利用ください。
グローバル共通ドメインを利用する場合、お客様のご利用箇所の状況に応じて、一番近いAPIゲートウェイに接続します。
1.Base Path(Global Load Balance)
https://api.ntt.com/v1/business-process/prices
2.Base Path(Region)
https://{region}.api.ntt.com/v1/business-process/prices
- region is jp|us|fr|sg
- e.g. https://us.api.ntt.com/v1/business-process/prices
- 指定できるregionは、将来拡充予定
Resource Information
Key | Value |
---|---|
レスポンス フォーマット | JSON |
認証(OAuth) | Yes |
帯域制御#1 | Yes |
- #1 お客さま接続単位で適切な流量制限を実施
料金表情報参照
GET /v1/business-process/prices/{contractId}
Request Parameters
Name | Description | type | mandatory |
---|---|---|---|
contractId | サービスの契約IDを指定 | path | Yes |
serviceName | サービス名称を指定#1 | query argument | Yes |
- #1 ell-flexible 他のサービスは順次拡充予定。(2016/4 現在)
Example Request
GET /v1/business-process/prices/N*********?serviceName=ell-flexible
Response Parameters
No | Name | Description | Type | Length |
---|---|---|---|---|
1 | result | 処理結果#1 | String | 6 |
2 | contractBillInfo | 契約金額情報#2 | Object | - |
2-1 | billContractId | 物理回線N番 | String | 64 |
2-2 | baseBandwidth | 基準品目#3 | String | 64 |
2-3 | baseBill | 基本額 | String | 64 |
2-4 | addBill100m | 100Mbps加算額 | String | 64 |
2-5 | addBill1g | 1Gbps加算額 | String | 64 |
-
#1 下記コードを設定。
Code Name Description 000000 正常 処理が正常に完了した。 100000 該当データ無し 処理対象のデータが存在しなかった。(準正常) 111000 業務規制 業務規制中を検出した。(準正常) 910000 パラメータエラー パラメータフォーマットエラーを検出した。(異常) 920000 リソースエラー DBなどリソースアクセス時にエラーが発生した。(異常) 930000 内部矛盾エラー 内部処理矛盾が発生した。(異常) 990000 その他エラー 上記以外の例外エラー発生。(異常) -
#2 処理結果正常時のみ本パラメータが設定される。
- #3 料金計算の基準となる帯域をMbps単位で設定。
Example Result
{
"contractBillInfo": {
"addBill100m": "15000",
"addBill1g": "150000",
"baseBandwidth": "500",
"baseBill": "150000",
"billContractId": "N*********"
},
"result": "000000"
}
-
2016/2 現在、国内の該当サービスのみ対応です。 ↩