従量課金 API

Overview

本APIは、NTT Com各種サービスの従量課金情報1を管理するAPIです。

Resource URL

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

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

1.Base Path(Global Load Balance)

https://api.ntt.com/v1/business-process/pay-per-use

2.Base Path(Region)

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

Resource Information

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

従量課金情報参照

GET /v1/business-process/pay-per-use/{contractId}

Request Parameters

Name Description type mandatory
contractId サービスの契約IDを指定 path Yes
serviceName サービス名称を指定#1 query argument Yes
chargeYearmonth 利用年月(YYYYMM)を指定#2 query argument
  • #1 ell-flexible 他のサービスは順次拡充予定。(2016/4 現在)
  • #2 利用年月を指定を指定しない場合、当月分と前月分の2ヶ月分の従量課金情報を返却

Example Request

 GET /v1/business-process/pay-per-use/N*********?serviceName=ell-flexible

Response Parameters

No Name Description type type
1 result 処理結果#1 String 6
2 chargeItemAmountInfo 利用料金情報#2 Array -
2-1 row データ行 Object -
2-1-1 billContractId 物理回線N番 String 64
2-1-2 useYearmonth 利用年月#3 String 6
2-1-3 accessLineKind アクセスライン種別(000160:NTTCom光アクセス/000282:ハウジング) String 10
2-1-4 billItem 料金科目(0:基本額/1:加算額) String 1
2-1-5 useBandwidth 利用品目#4 String 64
2-1-6 addBandwidth 増速帯域幅#5 String 64
2-1-7 effectiveDate 利用開始日#6 String 4
2-1-8 terminationDate 利用終了日#6 String 4
2-1-9 chargeItemAmount 金額 String 64
3 chargeAmountInfo 利用料金合計情報#2 Array -
3-1 row データ行 Object -
3-1-1 billContractId 物理回線N番 String 64
3-1-2 useYearmonth 利用年月#3 String 6
3-1-3 chargeAmount 合計金額 String 64
  • #1 下記コードを設定。

    Code Name Description
    000000 正常 処理が正常に完了した。
    100000 該当データ無し 処理対象のデータが存在しなかった。(準正常)
    111000 業務規制 業務規制中を検出した。(準正常)
    910000 パラメータエラー パラメータフォーマットエラーを検出した。(異常)
    920000 リソースエラー DBなどリソースアクセス時にエラーが発生した。(異常)
    930000 内部矛盾エラー 内部処理矛盾が発生した。(異常)
    990000 その他エラー 上記以外の例外エラー発生。(異常)

  • #2 処理結果正常時のみ本パラメータが設定される。

  • #3 YYYYMM(6桁)形式で設定。
  • #4 当該利用期間に使用した帯域をMbps単位で設定。
  • #5 当該利用期間に使用した帯域と基準品目との差をMbps単位で設定。
  • #6 MMDD(4桁)形式で設定。

Example Result

{
    "chargeAmountInfo": [
        {
            "row": {
                "billContractId": "N*********", 
                "chargeAmount": "19354", 
                "useYearmonth": "201603"
            }
        }
    ], 
    "chargeItemAmountInfo": [
        {
            "row": {
                "accessLineKind": "000160", 
                "addBandwidth": "0", 
                "billContractId": "N*********", 
                "billItem": "0", 
                "chargeItemAmount": "19354", 
                "effectiveDate": "0314", 
                "terminationDate": "0317", 
                "useBandwidth": "500", 
                "useYearmonth": "201603"
            }
        }
    ], 
    "result": "000000"
}

  1. 2016/2 現在、国内の該当サービスのみ対応です。 

  2. 2014/12 現在、DNSラウンドロビン運用。準備出来次第、お客さまの地理的に近いAPIゲートウェイに自動接続予定です。別途アナウンスします。