Arcstar Universal Oneフレキシブルイーサ API

Overview

本APIでは、Arcstar Universal One フレキシブルイーサの帯域変更および経路変更のお申込が可能です。
本APIは、ご契約回線開通後にご利用可能となります。
「Arcstar Universal One フレキシブルイーサ」サービスについては、サービス紹介サイト(ギャランティアクセス、イーサネット専用線)をご参照ください。

Arcstar Universal Oneフレキシブルイーサは、以下のAPIを提供します。

ギャランティアクセス

API Description
契約情報取得 ギャランティアクセスの契約情報を取得します。
帯域変更お申込情報一覧取得 指定月のお申込情報を一覧取得します。
帯域変更お申込情報取得 申込受付IDに紐づく特定のお申込情報を取得します。
帯域変更お申込(新規) 帯域変更を新規でお申込みます。
帯域変更お申込(変更) 帯域変更のお申込内容を変更します。
帯域変更お申込(取消) 帯域変更のお申込を取消します。

イーサネット専用線

API Description
契約情報取得 イーサネット専用線の契約情報を取得します。
帯域変更お申込情報一覧取得 指定月のお申込情報を一覧取得します。
帯域変更お申込情報取得 申込受付IDに紐づく特定のお申込情報を取得します。
帯域変更お申込(新規) 帯域変更を新規でお申込みます。
帯域変更お申込(変更) 帯域変更のお申込内容を変更します。
帯域変更お申込(取消) 帯域変更のお申込を取消します。
経路情報取得 ご利用中の経路および設定可能な経路の情報を取得します。
経路変更設計 経路変更の設計を実施します。
※設計後は、変更設定または変更取消まで、次のお申込みを受付られません。
経路変更設定 経路変更設計済みの回線に対して経路変更を実施します。
経路変更設計取消 経路変更の設計を取消します。
経路変更状態参照 経路変更のお申込状況を取得します。

Resource URL

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

1.Base Path(Global Load Balance)

https://api.ntt.com/v1/flexible

2.Base Path(Region)

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

ギャランティアクセスAPI

契約情報取得

ギャランティアクセスの契約情報を取得するためのAPIです。

GET /v1/flexible/vpn/contracts/{contractNumber}
Name Description
contractNumber 契約回線番号(N番)  

Response Parameters

Name Description Type
startdate 提供開始日 string #1
service サービス名 string  
access アクセス回線種別 string  
bandwidth 基準品目 string  
location 設置場所事業所名 string  
parentContractNumber 代表N番号 string  
vpnNumber VPN番号 string  
customerId お客様番号 string  
contractNumber 契約回線番号(N番) string  
customerName お客様名 string  
  • #1 yyyymmdd

Example Result

{  
    "startdate": "20150510",
    "service": "Ｌ３フレキシブルイーサ",
    "access": "イーサタイプ（ＮＴＴＣｏｍ光アクセス）",
    "bandwidth": "１００Ｍ",
    "location": "設置場****",
    "parentContractNumber": "N1500*****",
    "vpnNumber": "V15001616",
    "customerId": "C0050******",
    "contractNumber": "N1500*****",
    "customerName": "日本株***"
}

帯域変更お申込情報一覧取得

指定月のお申込情報を一覧取得するためのAPIです。

GET /v1/flexible/vpn/bandwidth/reservations?contractNumber={contractNumber}&yyyymm={yyyymm}

Query Parameters

Name Description Mandatory
contractNumber 契約回線番号(N番) No  
yyyymm 検索年月 No #1
  • #1 指定なしの場合、検索実行年月で検索する
    ＜値の例＞201606

Response Parameters

Name Description Type
receptionDatetime お申込受付日時 string #1
bandwidth 変更後帯域(Mbps) string #2
status ステータス string #3
commitPlanDatetime お申込実行日時 string #4
customerId お客様番号 string  
reservationId 申込受付ID string #5
parentContractNumber 代表契約番号 string  
contractNumber 契約回線番号(N番) string  
commitDatetime 工事完了日時 string #6
cancelDatetime お申込取消日時 string #7
immediate 即時フラグ boolean #8
  • #1 YYYY-MM-DDThh:mm:ss+09:00(UTC+09:00)
    ＜値の例＞2016-12-01T10:05:48+09:00
  • #2 ＜候補値＞
    100, 200, 300, 400, 500, 600, 700, 800, 900, 1000
  • #3 ＜候補値とその説明＞
    waiting:受付中, processing:処理中, complete:正常終了, error:設定失敗, cancelled:予約キャンセル,
    deemed_complete:成功（現在使用中の帯域と同一値で帯域変更を実施し、成功した場合）
  • #4 YYYY-MM-DDThh:mm:ss+09:00(UTC+09:00)
    ＜値の例＞2016-12-01T10:05:48+09:00
  • #5 02xx-xxxx:L2ギャランティ, 03xx-xxxx:L3ギャランティ
  • #6 YYYY-MM-DDThh:mm:ss+09:00(UTC+09:00)
    ＜値の例＞2016-12-01T10:05:48+09:00
  • #7 帯域変更予約がキャンセルされた時間
    YYYYY-MM-DDThh:mm:ss+09:00(UTC+09:00)
    ＜値の例＞2016-12-01T10:05:48+09:00
  • #8 trueは即時変更のお申込、falseは予約変更のお申込を示す

Example Result

{
    "status": "complete",
    "receptionDatetime": "2016-12-01T10:05:48+09:00",
    "immediate": true,
    "bandwidth": "900",
    "commitPlanDatetime": "2016-12-01T10:05:44+09:00",
    "cancelDatetime": null,
    "parentContractNumber": "N1500*****",
    "customerId": "C0050******",
    "reservationId": "0300-0000",
    "contractNumber": "N1500*****",
    "commitDatetime": "2016-12-01T10:05:52+09:00"
},
{
    "status": "complete",
    "receptionDatetime": "2016-12-01T10:08:45+09:00",
    "immediate": true,
    "bandwidth": "900",
    "commitPlanDatetime": "2016-12-01T10:08:41+09:00",
    "cancelDatetime": null,
    "parentContractNumber": "N1500*****",
    "customerId": "C0050******",
    "reservationId": "0300-0001",
    "contractNumber": "N1500*****",
    "commitDatetime": "2016-12-01T10:09:04+09:00"
}

帯域変更お申込情報取得

申込受付IDに紐づく特定のお申込内容を取得するためのAPIです。

GET /v1/flexible/vpn/bandwidth/reservations/{reservationId}
Name Description
reservationId 申込受付ID #1
  • #1 02xx-xxxx:L2ギャランティ, 03xx-xxxx:L3ギャランティ

Response Parameters

Name Description Type
receptionDatetime お申込受付日時 string #1
bandwidth 変更後帯域(Mbps) string #2
status ステータス string #3
commitPlanDatetime お申込実行日時 string #4
customerId お客様番号 string  
reservationId 申込受付ID string #5
parentContractNumber 代表契約番号 string  
contractNumber 契約回線番号(N番) string  
commitDatetime 工事完了日時 string #6
cancelDatetime お申込取消日時 string #7
immediate 即時フラグ boolean #8
  • #1 YYYY-MM-DDThh:mm:ss+09:00(UTC+09:00)
    ＜値の例＞2016-12-01T10:05:48+09:00
  • #2 ＜候補値＞
    100, 200, 300, 400, 500, 600, 700, 800, 900, 1000
  • #3 ＜候補値とその説明＞
    waiting:受付中, processing:処理中, complete:正常終了, error:設定失敗, cancelled:予約キャンセル,
    deemed_complete:成功（現在使用中の帯域と同一値で帯域変更を実施し、成功した場合）
  • #4 YYYY-MM-DDThh:mm:ss+09:00(UTC+09:00)
    ＜値の例＞2016-12-01T10:05:48+09:00
  • #5 02xx-xxxx:L2ギャランティ, 03xx-xxxx:L3ギャランティ
  • #6 YYYY-MM-DDThh:mm:ss+09:00(UTC+09:00)
    ＜値の例＞2016-12-01T10:05:48+09:00
  • #7 帯域変更予約がキャンセルされた時間
    YYYY-MM-DDThh:mm:ss+09:00(UTC+09:00)
    ＜値の例＞2016-12-01T10:05:48+09:00
  • #8 trueは即時変更のお申込、falseは予約変更のお申込を示す

Example Result

{
    "status": "complete",
    "receptionDatetime": "2016-09-15T12:49:23+09:00",
    "immediate": true,
    "bandwidth": "900",
    "commitPlanDatetime": "2016-09-15T12:49:23+09:00",
    "cancelDatetime": null,
    "parentContractNumber": "N1500*****",
    "customerId": "C0050******",
    "reservationId": "0300-0001",
    "contractNumber": "N1500*****",
    "commitDatetime": "2016-09-15T12:51:38+09:00"
}

帯域変更お申込(新規)

帯域変更を新規でお申込むためのAPIです。

POST /v1/flexible/vpn/bandwidth/reservations

Request Parameters

Name Description Type Mandatory
parentContractNumber 代表契約番号 string Yes  
contractNumber 契約回線番号(N番) string Yes  
commitPlanDatetime 工事予定時刻 string No #1
bandwidth 変更後帯域(Mbps) string Yes  
  • #1 指定なしの場合、即時で帯域変更を実施する
    YYYY-MM-DDThh:mm:ss+09:00(UTC+09:00)

Example Request

{
    "contractNumber": "N1500*****",
    "commitPlanDatetime": "2016-12-11T11:30:00+09:00",
    "bandwidth": "900",
    "parentContractNumber": "N1500*****"
}

Response Parameters

Name Description Type
reservationId 申込受付ID string #1
parentContractNumber 代表契約番号 string  
contractNumber 契約回線番号(N番) string  
bandwidth 変更後帯域(Mbps) string  
commitPlanDatetime 工事予約時刻 string #2
receptionDatetime 受付時刻 string #3
customerId お客様番号 string  
immediate 即時フラグ boolean #4
  • #1 02xx-xxxx:L2ギャランティ, 03xx-xxxx:L3ギャランティ
  • #2 YYYY-MM-DDThh:mm:ss+09:00(UTC+09:00)
  • #3 YYYY-MM-DDThh:mm:ss+09:00(UTC+09:00)
  • #4 trueは即時変更のお申込、falseは予約変更のお申込を示す

Example Result

{
    "bandwidth": "900",
    "receptionDatetime": "2016-12-01T18:46:36+09:00",
    "commitPlanDatetime": "2016-12-11T11:30:00+09:00",
    "parentContractNumber": "N1500*****",
    "customerId": "C0050******",
    "reservationId": "0300-0002",
    "contractNumber": "N1500*****",
    "immediate": false
}

帯域変更お申込(変更)

帯域変更のお申込内容を変更するためのAPIです。

PUT /v1/flexible/vpn/bandwidth/reservations/{reservationId}
Name Description
reservationId 申込受付ID #1
  • #1 02xx-xxxx:L2ギャランティ, 03xx-xxxx:L3ギャランティ

Request Parameters

Name Description Type Mandatory
bandwidth 変更後帯域(Mbps) string Yes #1
commitPlanDatetime お申込実行日時 string Yes #2
  • #1 ＜候補値＞
    100, 200, 300, 400, 500, 600, 700, 800, 900, 1000
  • #2 YYYY-MM-DDThh:mm:ss+09:00(UTC+09:00)
    ＜値の例＞2016-12-01T10:05:48+09:00

Example Request

{
    "bandwidth": "900",
    "commitPlanDatetime": "2016-12-13T21:30:00+09:00"
}

Response Parameters

Name Description Type
reservationId 申込受付ID string #1
parentContractNumber 代表契約番号 string  
contractNumber 契約回線番号(N番) string  
commitPlanDatetime 工事予定時刻 string #2
bandwidth 変更後帯域(Mbps) string  
receptionDatetime お申込受付日時 string #3
customerId お客様番号 string  
immediate 即時フラグ boolean #4
  • #1 02xx-xxxx:L2ギャランティ, 03xx-xxxx:L3ギャランティ
  • #2 YYYY-MM-DDThh:mm:ss+09:00(UTC+09:00)
    ＜値の例＞2016-12-01T10:05:48+09:00
  • #3 YYYY-MM-DDThh:mm:ss+09:00(UTC+09:00)
    ＜値の例＞2016-12-01T10:05:48+09:00
  • #4 trueは即時変更のお申込、falseは予約変更のお申込を示す

Example Result

{
    "bandwidth": "900",
    "receptionDatetime": "2016-12-01T19:29:32+09:00",
    "commitPlanDatetime": "2016-12-13T21:30:00+09:00",
    "parentContractNumber": "N1500*****",
    "customerId": "C0050******",
    "reservationId": "0300-0002",
    "contractNumber": "N1500*****",
    "immediate": false
}

帯域変更お申込(取消)

帯域変更のお申込を取消すためのAPIです。

DELETE /v1/flexible/vpn/bandwidth/reservations/{reservationId}
Name Description
reservationId 申込受付ID #1
  • #1 02xx-xxxx:L2ギャランティ, 03xx-xxxx:L3ギャランティ

イーサネット専用線API

契約情報取得

イーサネット専用線の契約情報を取得するためのAPIです。

GET /v1/flexible/leasedline/contracts/{multiContractNumber}
Name Description
multiContractNumber 契約回線番号  

Response Parameters

Name Description Type
contracts array #1
   startdate 提供開始日 string #2
   contractNumber 契約回線番号(論理回線N番) string #3
   vlan VLAN-ID string  
   service サービス名 string  
   access アクセス回線種別 string  
   bandwidth 基準品目 string  
   location 設置場所事業所名 string  
   multiContractNumber 契約回線番号(物理回線N番) string #4
   vpnNumber VPN番号 string  
customerId お客様番号 string  
customerName お客様名 string  
  • #1 対抗拠点の契約情報をセットで返却する
  • #2 yyyymmdd
  • #3 多重回線の場合、論理回線のN番
  • #4 非多重回線の場合、null固定。多重回線の場合、物理回線のN番。

Example Result

{
    "contracts": {
        "startdate": "20160515",
        "contractNumber": "N1600*****",
        "vlan": "200",
        "service": "Ｌ２ギャランティアクセス（イーサ専用）",
        "access": "イーサタイプ（ハウジング）",
        "bandwidth": "３Ｇ",
        "location": "仙台センタ******",
        "multiContractNumber": "N1600*****",
        "vpnNumber": "V16050053"
    },
    {
        "startdate": "20160515",
        "contractNumber": "N1600*****",
        "vlan": "200",
        "service": "Ｌ２ギャランティアクセス（イーサ専用）",
        "access": "イーサタイプ（ハウジング）",
        "bandwidth": "３Ｇ",
        "location": "東京センタ******",
        "multiContractNumber": "N1600*****",
        "vpnNumber": "V16050053"
    },
    "customerId": "C0050******",
    "customerName": "日本株***"
},
{
    "contracts": {
        "startdate": "20160515",
        "contractNumber": "N1600*****",
        "vlan": "100",
        "service": "Ｌ２ギャランティアクセス（イーサ専用）",
        "access": "イーサタイプ（ハウジング）",
        "bandwidth": "２Ｇ",
        "location": "仙台センタ*****",
        "multiContractNumber": "N1600*****",
        "vpnNumber": "V16050052"
    },
    {
        "startdate": "20160515",
        "contractNumber": "N1600*****",
        "vlan": "100",
        "service": "Ｌ２ギャランティアクセス（イーサ専用）",
        "access": "イーサタイプ（ハウジング）",
        "bandwidth": "２Ｇ",
        "location": "東京センタ*****",
        "multiContractNumber": "N1600*****",
        "vpnNumber": "V16050052"
    },
    "customerId": "C0050******",
    "customerName": "日本株***"
}

帯域変更お申込情報一覧取得

指定月のお申込情報を一覧取得するためのAPIです。

GET /v1/flexible/leasedline/bandwidth/reservations?contractNumber={contractNumber}&yyyymm={yyyymm}

Query Parameters

Name Description Mandatory
contractNumber 契約回線番号(論理回線N番) No #1
yyyymm 検索年月 No #2
  • #1 多重回線の場合、論理回線のN番
  • #2 指定なしの場合、検索実行年月で検索する
    ＜値の例＞201606

Response Parameters

Name Description Type
receptionDatetime お申込受付日時 string #1
bandwidth 変更後帯域(Mbps) string #2
status ステータス string #3
commitPlanDatetime お申込実行日時 string #4
reservationId 申込受付ID string #5
contractNumber 契約回線番号(論理回線N番) string #6
commitDatetime 工事完了日時 string #7
customerId お客様番号 string  
immediate 即時フラグ boolean  
cancelDatetime お申込取消日時 string #8
pairContractNumber 対抗拠点の契約回線番号(論理回線N番) string  
  • #1 YYYY-MM-DDThh:mm:ss+09:00(UTC+09:00)
    ＜値の例＞2016-12-01T10:05:48+09:00
  • #2 ＜候補値＞
    1G-IF:100, 200, 300, 400, 500, 600, 700, 800, 900, 1000
    10G-IF:100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 2000, 3000, 4000, 5000, 6000, 7000, 8000, 9000, 10000
  • #3 ＜候補値とその説明＞
    waiting:受付中, processing:処理中, complete:正常終了, error:設定失敗, cancelled:予約キャンセル,
    deemed_complete:成功（現在使用中の帯域と同一値で帯域変更を実施し、成功した場合）
  • #4 YYYY-MM-DDThh:mm:ss+09:00(UTC+09:00)
    ＜値の例＞2016-12-01T10:05:48+09:00
  • #5 01xx-xxxx:イーサ専用
  • #6 多重回線の場合、論理回線のN番
  • #7 YYYY-MM-DDThh:mm:ss+09:00(UTC+09:00)
    ＜値の例＞2016-12-01T10:05:48+09:00
  • #8 YYYY-MM-DDThh:mm:ss+09:00(UTC+09:00)
    ＜値の例＞2016-12-01T10:05:48+09:00

Example Result

{
    "status": "deemed_complete",
    "receptionDatetime": "2016-12-01T16:42:09+09:00",
    "immediate": true,
    "bandwidth": "1000",
    "commitPlanDatetime": "2016-12-01T16:42:09+09:00",
    "cancelDatetime": null,
    "customerId": "C0050******",
    "reservationId": "0100-0000",
    "contractNumber": "N1600*****",
    "pairContractNumber": "N1600*****",
    "commitDatetime": "2016-12-01T16:42:09+09:00"
},
{
    "status": "waiting",
    "receptionDatetime": "2016-12-01T16:42:09+09:00",
    "immediate": false,
    "bandwidth": "1000",
    "commitPlanDatetime": "2016-12-01T16:42:09+09:00",
    "cancelDatetime": null,
    "customerId": "C0050******",
    "reservationId": "0100-0001",
    "contractNumber": "N1600*****",
    "pairContractNumber": "N1600*****",
    "commitDatetime": null
}

帯域変更お申込情報取得

申込受付IDに紐づく特定のお申込情報を取得するためのAPIです。

GET /v1/flexible/leasedline/bandwidth/reservations/{reservationId}
Name Description
reservationId 申込受付ID #1
  • #1 01xx-xxxx:イーサ専用

Response Parameters

Name Description Type
receptionDatetime お申込受付日時 string #1
bandwidth 変更後帯域(Mbps) string #2
status ステータス string #3
commitPlanDatetime お申込実行日時 string #4
reservationId 申込受付ID string #5
contractNumber 契約回線番号(論理回線N番) string #6
commitDatetime 工事完了日時 string #7
customerId お客様番号 string  
immediate 即時フラグ boolean  
cancelDatetime お申込取消日時 string #8
pairContractNumber 対抗拠点の契約回線番号 string  
  • #1 YYYY-MM-DDThh:mm:ss+09:00(UTC+09:00)
    ＜値の例＞2016-12-01T10:05:48+09:00
  • #2 ＜候補値＞
    1G-IF:100, 200, 300, 400, 500, 600, 700, 800, 900, 1000
    10G-IF:100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 2000, 3000, 4000, 5000, 6000, 7000, 8000, 9000, 10000
  • #3 ＜候補値とその説明＞
    waiting:受付中, processing:処理中, complete:正常終了, error:設定失敗, cancelled:予約キャンセル,
    deemed_complete:成功（現在使用中の帯域と同一値で帯域変更を実施し、成功した場合）
  • #4 YYYY-MM-DDThh:mm:ss+09:00(UTC+09:00)
    ＜値の例＞2016-12-01T10:05:48+09:00
  • #5 01xx-xxxx:イーサ専用
  • #6 多重回線の場合、論理回線のN番
  • #7 YYYY-MM-DDThh:mm:ss+09:00(UTC+09:00)
    ＜値の例＞2016-12-01T10:05:48+09:00
  • #8 YYYY-MM-DDThh:mm:ss+09:00(UTC+09:00)
    ＜値の例＞2016-12-01T10:05:48+09:00

Example Result

{
    "status": "deemed_complete",
    "receptionDatetime": "2016-12-01T16:42:09+09:00",
    "immediate": true,
    "bandwidth": "1000",
    "commitPlanDatetime": "2016-12-29T12:30:00+09:00",
    "cancelDatetime": null,
    "customerId": "C0050******",
    "pairContractNumber": "N160050546",
    "reservationId": "0100-0000",
    "contractNumber": "N1600*****",
    "commitDatetime": "2016-12-29T12:35:00+09:00"
}

帯域変更お申込(新規)

帯域変更を新規でお申込むためのAPIです。

POST /v1/flexible/leasedline/bandwidth/reservations

Request Parameters

Name Description Type Mandatory
contractNumber 契約回線番号(論理回線N番) string Yes #1
commitPlanDatetime 工事予定時刻 string No #2
bandwidth 変更後帯域(Mbps) string Yes  
  • #1 多重回線の場合、論理回線のN番
  • #2 指定なしの場合、即時で帯域変更を実施する
    YYYY-MM-DDThh:mm:ss+09:00(UTC+09:00)
    ＜値の例＞2016-12-01T10:05:48+09:00

Example Request

{
    "contractNumber": "N1600*****",
    "commitPlanDatetime": "2016-12-31T12:30:00+09:00",
    "bandwidth": "1000"
}

Response Parameters

Name Description Type
reservationId 申込受付ID string #1
contractNumber 契約回線番号(論理回線N番) string #2
commitPlanDatetime 工事予定時刻 string #3
bandwidth 変更後帯域(Mbps) string  
receptionDatetime お申込受付日時 string #4
customerId お客様番号 string  
immediate 即時フラグ boolean #5
  • #1 01xx-xxxx:イーサ専用
  • #2 多重回線の場合、論理回線のN番
  • #3 YYYY-MM-DDThh:mm:ss+09:00(UTC+09:00)
    ＜値の例＞2016-12-01T10:05:48+09:00
  • #4 YYYY-MM-DDThh:mm:ss+09:00(UTC+09:00)
    ＜値の例＞2016-12-01T10:05:48+09:00
  • #5 trueは即時変更のお申込、falseは予約変更のお申込を示す

Example Result

{
    "receptionDatetime": "2016-12-01T16:07:15+09:00",
    "immediate": false,
    "bandwidth": "1000",
    "commitPlanDatetime": "2016-12-31T12:30:00+09:00",
    "customerId": "C0050******",
    "reservationId": "0100-0001",
    "contractNumber": "N1600*****"
}

帯域変更お申込(変更)

帯域変更のお申込内容を変更するためのAPIです。

PUT /v1/flexible/leasedline/bandwidth/reservations/{reservationId}
Name Description
reservationId 申込受付ID #1
  • #1 01xx-xxxx:イーサ専用

Request Parameters

Name Description Type Mandatory
bandwidth 変更後帯域(Mbps) string Yes #1
commitPlanDatetime お申込実行日時 string Yes #2
  • #1 ＜候補値＞
    1G-IF:100, 200, 300, 400, 500, 600, 700, 800, 900, 1000
    10G-IF:100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 2000, 3000, 4000, 5000, 6000, 7000, 8000, 9000, 10000
  • #2 YYYY-MM-DDThh:mm:ss+09:00(UTC+09:00)
    ＜値の例＞2016-12-01T10:05:48+09:00

Example Request

{
    "bandwidth": "900",
    "commitPlanDatetime": "2016-12-13T21:30:00+09:00"
}

Response Parameters

Name Description Type
reservationId 申込受付ID string #1
contractNumber 契約回線番号(論理回線N番) string  
commitPlanDatetime 工事予定時刻 string #2
bandwidth 変更後帯域(Mbps) string  
receptionDatetime お申込受付日時 string #3
customerId お客様番号 string  
immediate 即時フラグ boolean #4
  • #1 01xx-xxxx:イーサ専用
  • #2 YYYY-MM-DDThh:mm:ss+09:00(UTC+09:00)
    ＜値の例＞2016-12-01T10:05:48+09:00
  • #3 YYYY-MM-DDThh:mm:ss+09:00(UTC+09:00)
    ＜値の例＞2016-12-01T10:05:48+09:00
  • #4 trueは即時変更のお申込、falseは予約変更のお申込を示す

Example Result

{
    "bandwidth": "900",
    "receptionDatetime": "2016-12-01T19:29:32+09:00",
    "commitPlanDatetime": "2016-12-13T21:30:00+09:00",
    "customerId": "C0050******",
    "reservationId": "0300-0002",
    "contractNumber": "N1500*****",
    "immediate": false
}

帯域変更お申込(取消)

帯域変更のお申込を取消すためのAPIです。

DELETE /v1/flexible/leasedline/bandwidth/reservations/{reservationId}
Name Description
reservationId 申込受付ID #1
  • #1 01xx-xxxx:イーサ専用

経路情報取得

ご利用中の経路および設定可能な経路の情報を取得するためのAPIです。

GET /v1/flexible/leasedline/route

Example Request

{
    "requestHeader": {
        "trnsSeq": "20150515122345001",
        "nnum": "NXXXXXXXXX"
    }
}

Example Result

{
    "responseHeader": {
        "trnsSeq": "20150515122345001",
        "result": "000000"
    },
    "routeInfo": [
        {
            "row": {
                "isSelected": "1",
                "regulationId": "1",
                "isDual": "0",
                "pRouteNm": "太平洋ルート",
                "pLatencyValue": "20.123",
                "hasPCnstInfo": "1",
                "pCnstInfo": [
                    {
                        "cnstTitle": "設備メンテナンス工事のお知らせ",
                        "pblshDtFrom": "20150807151245",
                        "pblshDtTo": "20150930235959",
                        "chgDtFrom": "20150907140000",
                        "chgDtTo": "20150907153000",
                        "rlbkDtFrom": "20150907160000",
                        "rlbkDtTo": "20150907173000",
                        "cnstCont": "装置の機能拡充を図ります。工事期間内に、一時的に通信回線が不安定となる可能性があります。",
                        "option1": "次回メンテナンス日は2015年12月末を予定しています。"
                    }
                ]
            }
        },
        {
            "row": {
                "isSelected": "0",
                "regulationId": "2",
                "isDual": "0",
                "pRouteNm": "中日本ルート",
                "pLatencyValue": "40.345",
                "hasPCnstInfo": "0"
            }
        },
        {
            "row": {
                "isSelected": "0",
                "regulationId": "3",
                "isDual": "0",
                "pRouteNm": "日本海ルート",
                "pLatencyValue": "60.456",
                "hasPCnstInfo": "0"
            }
        }
    ]   
}

経路変更設計

経路変更の設計を実施するためのAPIです。
※設計後は、変更設定または変更取消まで、次のお申込みを受付られません。

POST /v1/flexible/leasedline/route/orders

Example Request

{
    "requestHeader": {
        "trnsSeq": "20150515122345001",
        "nnum": "NXXXXXXXXX"
    },
    "aftRegulationId": "2"
}

Example Result

{
    "responseHeader": {
        "trnsSeq": "20150515122345001",
        "result": "000000"
    },
    "soNum": "AXXXXXXXXXXXXX",
    "soNumRev": 1
}

経路変更設定

経路変更設計済みの回線に対して経路変更を実施するためのAPIです。

PUT /v1/flexible/leasedline/route/orders

Example Request

{
    "requestHeader": {
        "trnsSeq": "20150515122345001",
        "nnum": "NXXXXXXXXX"
    },
    "soNum": "AXXXXXXXXXXXXX",
    "soNumRev": 1
}

Example Result

{
    "responseHeader": {
        "trnsSeq": "20150515122345001",
    "result": "000000"
    },
    "soNum": "AXXXXXXXXXXXXX",
    "soNumRev": 2
}

経路変更設計取消

経路変更の設計を取消すためのAPIです。

DELETE /v1/flexible/leasedline/route/orders

Example Request

{
    "requestHeader": {
        "trnsSeq": "20150515122345001",
        "nnum": "NXXXXXXXXX"
    },
    "soNum": "AXXXXXXXXXXXXX",
    "soNumRev": 1
}

Example Result

{
    "responseHeader": {
        "trnsSeq": "20150515122345001",
        "result": "000000"
    },
    "soNum": "AXXXXXXXXXXXXX",
    "soNumRev": 2
}

経路変更状態参照

経路変更のお申込状況を取得するためのAPIです。

GET /v1/flexible/leasedline/route/orders

Example Request

{
    "requestHeader": {
        "trnsSeq": "20150515122345001",
        "nnum": "NXXXXXXXXX"
    },
    "soNum": "AXXXXXXXXXXXXX",
    "soNumRev": 1
}

Example Result

{
    "responseHeader": {
        "trnsSeq": "20150515122345001",
        "result": "000000"
    },
    "soStatus": "10"
}