WVS2 API (1.0.0)

Download OpenAPI specification:Download

ログインAPI

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  ログイン認証画面から法人権限でログインし、DBのログイン情報を参照更新する

通常ログイン機能

Request Body schema: application/json

loginId required	string <= 18 characters ^[a-zA-Z][a-zA-Z0-9][0-9]{5}@V[0-9]{8}0$ 項目和名：ログインID 備考　　：-
password required	string [ 8 .. 20 ] characters ^[a-zA-Z0-9]{8,20}$ 項目和名：パスワード備考　　：-
isForceLogin required	boolean 項目和名：強制ログインフラグ備考　　：既に同一ユーザーでログイン中に強制的にログインする場合は「true」を指定、通常時は「false」を指定する。

Responses

Request samples

Payload
Curl

Content type

application/json

{"loginId": "Aa12345@V000000010",
"password": "xxxxxxxx",
"isForceLogin": true
}

Response samples

Content type

application/json

{"tokenId": "ede66c43-9b9d-4222-93ed-5f11c96e08e2",
"passwordExpiredDate": "2021-11-20",
"passwordLimit": 0
}

管理者ログインAPI

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  システム管理者・運用者ユーザがログインし、DBのログイン情報を参照更新する

管理者ログイン機能

Request Body schema: application/json

loginId required	string <= 7 characters ^[a-zA-Z][a-zA-Z0-9][0-9]{5}$ 項目和名：ログインID 備考　　：-
password required	string [ 8 .. 20 ] characters ^[a-zA-Z0-9]{8,20}$ 項目和名：パスワード備考　　：-
isForceLogin required	boolean 項目和名：強制ログインフラグ備考　　：既に同一ユーザーでログイン中に強制的にログインする場合は「true」を指定、通常時は「false」を指定する。

Responses

Request samples

Payload
Curl

Content type

application/json

{"loginId": "Aa12345",
"password": "xxxxxxxx",
"isForceLogin": true
}

Response samples

Content type

application/json

{"tokenId": "ede66c43-9b9d-4222-93ed-5f11c96e08e2"
}

ログアウトAPI

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  ログインしているアカウントのログイン情報にログアウト日時を登録し、トークンIDをテーブルから削除する

ユーザをログアウトしてログイン画面に遷移する結果コードを返す

Responses

Request samples

Curl

curl --request POST \
  --url https://wvs2.kddi.ne.jp/api/v1/auth/logout

Response samples

401
500

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

管理者ログアウトAPI

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  管理者ログインAPIでログインしたユーザのトークンIDをテーブルから削除する

管理者ユーザをログアウトする

Responses

Request samples

Curl

curl --request POST \
  --url https://wvs2.kddi.ne.jp/api/v1/auth/logout/admin

Response samples

401
403
500

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

お知らせAPI

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  お知らせ情報一覧と、お知らせ情報の詳細を取得する

お知らせ情報一覧を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/information/notifications

Response samples

200
401
403
500

Content type

application/json

{"noticeInfoTotal": 1,
"noticeInfoList": [{"noticeInfoSeq": "1",
"noticeInfoTitle": "タイトル",
"postStartDateTime": "2021-11-23T00:09:44+09:00"
}
]
}

お知らせ情報一覧を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v2/information/notifications

Response samples

200
401
403
500

Content type

application/json

{"noticeInfoTotal": 1,
"noticeInfoList": [{"noticeInfoSeq": "1",
"noticeType": "NOTIFICATION",
"noticeInfoTitle": "タイトル",
"postStartDateTime": "2021-11-23T00:09:44+09:00",
"isRead": true
}
]
}

お知らせ詳細情報を取得

path Parameters

noticeInfoSeq

required

string <= 19 characters

Example: 1

項目和名：お知らせSEQ
備考　　：主キー

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/information/notification/1

Response samples

Content type

application/json

{"noticeInfoTitle": "タイトル",
"postStartDateTime": "2021-11-23T00:09:44+09:00",
"postEndDateTime": "2021-11-23T00:09:44+09:00",
"noticeText": "メッセージ"
}

お知らせを既読更新

path Parameters

noticeInfoSeq

required

string <= 19 characters

Example: 1

項目和名：お知らせSEQ
備考　　：主キー

Responses

Request samples

Curl

curl --request POST \
  --url https://wvs2.kddi.ne.jp/api/v1/information/notification/1/read

Response samples

400
401
403
500

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

お知らせ詳細情報を取得

path Parameters

noticeInfoSeq

required

string <= 19 characters

Example: 1

項目和名：お知らせSEQ
備考　　：主キー

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v2/information/notification/1

Response samples

Content type

application/json

{"noticeInfoTitle": "タイトル",
"postStartDateTime": "2021-11-23T00:09:44+09:00",
"postEndDateTime": "2021-11-23T00:09:44+09:00",
"noticeText": "メッセージ",
"failureDateTime": "2021-11-23T00:09:44+09:00",
"recoveryDateTime": "2021-11-23T00:09:44+09:00",
"isUnderInvestigation": true,
"recoveryType": "COMPLETE"
}

ログインユーザー情報API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  ログインしているアカウントの権限(ロール)、前回ログイン情報、パスワード有効期限を取得する

ログインユーザーに紐づく情報を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/information/login-user

Response samples

200
401
403
500

Content type

application/json

{"loginId": "Aa12345",
"roleCode": "C0001",
"loginDateTime": "2021-11-23T00:09:44+09:00",
"logoutDateTime": "2021-11-23T00:09:44+09:00",
"passwordExpiredDate": "2021-11-20",
"passwordLimit": 0
}

各種ダウンロード情報API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  各種ダウンロード情報の一覧とファイルのダウンロードを行う

各種ダウンロード情報一覧を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/information/downloads

Response samples

200
401
403
500

Content type

application/json

{"downloadTotal": 1,
"downloadList": [{"downloadSeq": "2",
"fileName": "download.pdf",
"downloadTitle": "タイトル"
}
]
}

ファイルダウンロードを行う

path Parameters

downloadSeq

required

string <= 19 characters

Example: 2

項目和名：ダウンロードSEQ
備考　　：主キー

query Parameters

tokenId

required

string <uuid>

Example: tokenId=ede66c43-9b9d-4222-93ed-5f11c96e08e2

項目和名：トークンID
備考　　：ファイルダウンロード系のAPIはトークンIDをクエリパラメータに持つ。

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v1/information/download/2?tokenId=ede66c43-9b9d-4222-93ed-5f11c96e08e2'

Response samples

400
401
403
404
500

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

法人情報API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  (1) 法人およびパートナー毎のロゴ情報を取得する。
  (2) 法人およびパートナー毎の特記事項情報を取得する。

ロゴファイルの取得を行う

query Parameters

tokenId

required

string <uuid>

Example: tokenId=ede66c43-9b9d-4222-93ed-5f11c96e08e2

項目和名：トークンID
備考　　：ファイルダウンロード系のAPIはトークンIDをクエリパラメータに持つ。

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v1/information/service-logo?tokenId=ede66c43-9b9d-4222-93ed-5f11c96e08e2'

Response samples

401
403
500

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

特記事項の取得を行う

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/information/specialnotes

Response samples

200
401
403
500

Content type

application/json

{"corporationInfoList": [{"title": "その他お問い合わせ窓口",
"body": "その他お問い合わせに関しては以下の電話番号またはURLよりお問い合わせください。",
"linkTitle": "ネットワークのお問合せ",
"linkUrl": "https://wvs2.kddi.ne.jp/api/v1/notice/info.html"
}
]
}

操作履歴API

１．概要
（1）インターフェースタイプ
　　　同期応答方式
（2）内容
　　　操作履歴(契約変更やネットワーク・ポリシー設定等の設定変更履歴)を取得する。

操作履歴情報全件の一覧を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/information/operation-histories

Response samples

200
401
403
500

Content type

application/json

{"total": 1,
"operationList": [{"operationSeq": "1",
"sourceSeq": "1",
"content": "ポリシー設定",
"account": "Aa01234@V000000010",
"acceptDateTime": "2018-11-23T00:10:00+09:00",
"endDateTime": "2020-11-23T00:09:44+09:00",
"orderStatus": "SUCCESS",
"note": "メッセージ",
"isCustomer": true
}
],
"operationHistoryKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

一覧情報から選択された操作履歴情報詳細を取得

path Parameters

operationSeq

required

string <= 19 characters

Example: 1

項目和名：操作SEQ
備考　　：主キー

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/information/operation-history/1

Response samples

200
400
401
403
500

Content type

application/json

{"content": "ポリシー設定",
"orderList": [{"orderType": "VNコネクト",
"orderTarget": "W170014800",
"orderStatus": "SUCCESS",
"additionalInformation": "予約中認証IDが存在します。",
"orderDetailList": [{"orderItem": "VNコネクト状態設定",
"before": "無効",
"after": "有効"
}
]
}
]
}

操作履歴 CSVダウンロード API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  操作履歴のcsvファイルを生成送信する機能。

操作履歴情報の一覧のCSVを取得

query Parameters

tokenId

required

string <uuid>

Example: tokenId=ede66c43-9b9d-4222-93ed-5f11c96e08e2

項目和名：トークンID
備考　　：ファイルダウンロード系のAPIはトークンIDをクエリパラメータに持つ。

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v1/information/operation-history/csv?tokenId=ede66c43-9b9d-4222-93ed-5f11c96e08e2'

Response samples

401
403
500

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

障害情報取得API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  障害情報の一覧参照を行う

障害情報一覧をDBから取得

query Parameters

service	string Enum: "VN" "IPSEC" "VNL2L3" "CPA_5GSA" "MULTICLOUD" "TYPE4" Example: service=VN 項目和名：サービス備考　　：指定していなければ全表示する。 VN ：VNコネクト, IPSEC ：IPsec, VNL2L3 ：VN L2/L3コネクト, CPA_5GSA ：CPA 5GSA, MULTICLOUD：マルチクラウド, TYPE4 ：インターネットTYPE4
maintenance	boolean 項目和名：メンテナンス情報備考　　：true:「あり」、false:「なし」
failure	boolean 項目和名：障害情報備考　　：true:「あり」、false:「なし」
ifStatus	string Enum: "NO_SHUTDOWN" "SHUTDOWN" Example: ifStatus=NO_SHUTDOWN 項目和名：IF状態備考　　：NO_SHUTDOWN: 開放状態, SHUTDOWN: 閉塞状態
wnumber	string <= 10 characters ^W[0-9]{9}$ Example: wnumber=W000000020 項目和名：W番号備考　　：サービスがIPsec以外の場合は指定可能。絞り込まない場合はNULLを指定する。
domain	string <= 20 characters Example: domain=cpx.121212 項目和名：ドメイン名備考　　：サービスがCPA 5GSAの場合は指定可能。絞り込まない場合はNULLを指定する。
vnConnectName	string <= 20 characters Example: vnConnectName=TEST1 項目和名：VNコネクト名備考　　：サービスがIPsecとCPA 5GSA以外の場合は指定可能。絞り込まない場合はNULLを指定する。
enumber	string <= 10 characters ^E[0-9]{8}0$ Example: enumber=E000000010 項目和名：E番号備考　　：サービスがTYPE4とCPA 5GSA以外の場合は指定可能。絞り込まない場合はNULLを指定する。
vpnVnCode	string <= 6 characters ^[BCD][A-Z][0-9]{4}$ Example: vpnVnCode=BA1234 項目和名：VPN/VNコード備考　　：サービスがVNコネクト、マルチクラウド、TYPE4の場合は指定可能。絞り込まない場合はNULLを指定する。

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v1/information/failure?service=VN&maintenance=SOME_BOOLEAN_VALUE&failure=SOME_BOOLEAN_VALUE&ifStatus=NO_SHUTDOWN&wnumber=W000000020&domain=cpx.121212&vnConnectName=TEST1&enumber=E000000010&vpnVnCode=BA1234'

Response samples

200
400
401
403
500

Content type

application/json

{"total": 1,
"vnConnectTotal": 1,
"ipsecTotal": 1,
"cpaTotal": 1,
"l2l3Total": 1,
"cloudTotal": 1,
"type4Total": 1,
"vnConnectList": [{"wnumber": "W000000020",
"vnConnectName": "TEST1",
"enumber": "E000000010",
"vpnVnCode": "BA1234",
"vlanIdType": "SPECIFIED",
"vlanId": 1111,
"ifStatus": "NO_SHUTDOWN",
"isVnConnectStatus": true,
"commandStatus": "OK",
"maintenance": "障害のため現在サービス利用不可となっています。",
"failure": "メンテナンス中はご利用できなくなります。"
}
],
"ipsecList": [{"xnumber": "X000000010",
"ipsecLineName": "IPSEC回線１",
"userFqdn": "fqdn@IoT",
"enumber": "E000000010",
"ifStatus": "NO_SHUTDOWN",
"commandStatus": "OK",
"maintenance": "障害のため現在サービス利用不可となっています。",
"failure": "メンテナンス中はご利用できなくなります。"
}
],
"cpaList": [{"wnumber": {"wnumberAct": "W000000020",
"wnumberSby": "W000000030"
},
"domain": "cpx.121212",
"maintenance": "障害のため現在サービス利用不可となっています。",
"failure": "メンテナンス中はご利用できなくなります。"
}
],
"vnl2l3ConnectList": [{"wnumber": "W000000020",
"vnConnectName": "TEST1",
"enumber": "E000000010",
"l2VnName": "TEST_L2",
"l2VnCode": "CA1234",
"l3VlanType": "SPECIFIED",
"l3VlanId": 1111,
"l3VnName": "TEST_L3",
"l3VnCode": "BA1234",
"ifStatus": "NO_SHUTDOWN",
"commandStatus": "OK",
"maintenance": "障害のため現在サービス利用不可となっています。",
"failure": "メンテナンス中はご利用できなくなります。"
}
],
"cloudList": [{"wnumber": "W000000020",
"vnConnectName": "TEST1",
"enumber": "E000000010",
"cloudServiceType": "AWS",
"vpnVnCode": "BA1234",
"ifStatus": "NO_SHUTDOWN",
"isVnConnectStatus": true,
"commandStatus": "OK",
"maintenance": "障害のため現在サービス利用不可となっています。",
"failure": "メンテナンス中はご利用できなくなります。"
}
],
"type4List": [{"wnumber": "W000000020",
"vnConnectName": "TEST1",
"type4Id": "TY412345",
"vpnVnCode": "BA1234",
"maintenance": "障害のため現在サービス利用不可となっています。",
"failure": "メンテナンス中はご利用できなくなります。"
}
]
}

障害情報一覧をDBから取得

query Parameters

service	string Enum: "VN" "IPSEC" "VNL2L3" "CPA_5GSA" "MULTICLOUD" "TYPE4" Example: service=VN 項目和名：サービス備考　　：指定していなければ全表示する。 VN ：VNコネクト, IPSEC ：IPsec, VNL2L3 ：VN L2/L3コネクト, CPA_5GSA ：CPA 5GSA, MULTICLOUD：マルチクラウド, TYPE4 ：インターネットTYPE4
maintenance	boolean 項目和名：メンテナンス情報備考　　：true:「あり」、false:「なし」
failure	boolean 項目和名：障害情報備考　　：true:「あり」、false:「なし」
ifStatus	string Enum: "NO_SHUTDOWN" "SHUTDOWN" Example: ifStatus=NO_SHUTDOWN 項目和名：IF状態備考　　：NO_SHUTDOWN: 開放状態, SHUTDOWN: 閉塞状態
wnumber	string <= 10 characters ^W[0-9]{9}$ Example: wnumber=W000000020 項目和名：W番号備考　　：サービスがIPsec以外の場合は指定可能。絞り込まない場合はNULLを指定する。
domain	string <= 20 characters Example: domain=cpx.121212 項目和名：ドメイン名備考　　：サービスがCPA 5GSAの場合は指定可能。絞り込まない場合はNULLを指定する。
vnConnectName	string <= 20 characters Example: vnConnectName=TEST1 項目和名：VNコネクト名備考　　：サービスがIPsecとCPA 5GSA以外の場合は指定可能。絞り込まない場合はNULLを指定する。
enumber	string <= 10 characters ^E[0-9]{8}0$ Example: enumber=E000000010 項目和名：E番号備考　　：サービスがTYPE4とCPA 5GSA以外の場合は指定可能。絞り込まない場合はNULLを指定する。
vpnVnCode	string <= 6 characters ^[BCD][A-Z][0-9]{4}$ Example: vpnVnCode=BA1234 項目和名：VPN/VNコード備考　　：サービスがVNコネクト、マルチクラウド、TYPE4の場合は指定可能。絞り込まない場合はNULLを指定する。

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v2/information/failure?service=VN&maintenance=SOME_BOOLEAN_VALUE&failure=SOME_BOOLEAN_VALUE&ifStatus=NO_SHUTDOWN&wnumber=W000000020&domain=cpx.121212&vnConnectName=TEST1&enumber=E000000010&vpnVnCode=BA1234'

Response samples

200
400
401
403
500

Content type

application/json

{"total": 1,
"vnConnectTotal": 1,
"ipsecTotal": 1,
"cpaTotal": 1,
"l2l3Total": 1,
"cloudTotal": 1,
"type4Total": 1,
"vnConnectList": [{"wnumber": "W000000020",
"vnConnectName": "TEST1",
"enumber": "E000000010",
"vpnVnCode": "BA1234",
"vlanIdType": "SPECIFIED",
"vlanId": 1111,
"ifStatus": "NO_SHUTDOWN",
"isVnConnectStatus": true,
"commandStatus": "OK",
"maintenance": "障害のため現在サービス利用不可となっています。",
"failure": "メンテナンス中はご利用できなくなります。"
}
],
"ipsecList": [{"xnumber": "X000000010",
"ipsecLineName": "IPSEC回線１",
"userFqdn": "fqdn@IoT",
"enumber": "E000000010",
"ifStatus": "NO_SHUTDOWN",
"commandStatus": "OK",
"maintenance": "障害のため現在サービス利用不可となっています。",
"failure": "メンテナンス中はご利用できなくなります。"
}
],
"cpaList": [{"wnumber": {"wnumberAct": "W000000020",
"wnumberSby": "W000000030"
},
"domain": "cpx.121212",
"maintenance": "障害のため現在サービス利用不可となっています。",
"failure": "メンテナンス中はご利用できなくなります。"
}
],
"vnl2l3ConnectList": [{"wnumber": "W000000020",
"vnConnectName": "TEST1",
"enumber": "E000000010",
"l2VnName": "TEST_L2",
"l2VnCode": "CA1234",
"l3VlanType": "SPECIFIED",
"l3VlanId": 1111,
"l3VnName": "TEST_L3",
"l3VnCode": "BA1234",
"ifStatus": "NO_SHUTDOWN",
"commandStatus": "OK",
"maintenance": "障害のため現在サービス利用不可となっています。",
"failure": "メンテナンス中はご利用できなくなります。"
}
],
"cloudList": [{"wnumber": "W000000020",
"vnConnectName": "TEST1",
"enumber": "E000000010",
"cloudServiceType": "AWS",
"vpnVnCode": "BA1234",
"ifStatus": "NO_SHUTDOWN",
"isVnConnectStatus": true,
"commandStatus": "OK",
"maintenance": "障害のため現在サービス利用不可となっています。",
"failure": "メンテナンス中はご利用できなくなります。"
}
],
"type4List": [{"wnumber": "W000000020",
"vnConnectName": "TEST1",
"type4Id": "TY412345",
"vpnVnCode": "BA1234",
"maintenance": "障害のため現在サービス利用不可となっています。",
"failure": "メンテナンス中はご利用できなくなります。"
}
]
}

障害情報更新API

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST：受付非同期方式
2. 内容
  障害情報のカスコンに接続してDB情報の更新を行う

障害情報の更新状態ステータスの情報取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/information/failure/update

Response samples

200
401
403
404
500

Content type

application/json

{"failureKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d",
"failureStatus": "UPDATING",
"lastUpdateDateTime": "2021-12-01T11:59:59+09:00"
}

プロビジョニングステータス取得API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  プロビジョニングステータスを取得し、メッセージを通知する。

プロビジョニングステータスを取得

query Parameters

qosType

string

Enum: "QOS" "CLOUD_QOS"

Example: qosType=QOS

項目和名：QoSタイプ
備考　　：QoS/クラウドQo設定時の確認用
　　　　　全パターンチェックをする場合にはnullを指定する。
　　　　　QOS：QoS
　　　　　CLOUD_QOS：クラウドQoS

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v1/information/provisioning-status?qosType=QOS'

Response samples

200
401
403
500

Content type

application/json

{"messageCode": "CC99017I",
"message": "只今、設定が可能です。"
}

プロビジョニングステータスの詳細情報を取得

path Parameters

jobId

required

string <= 19 characters

Example: 1

項目和名：プロビジョニング実行ID
備考　　：プロビジョニングを実施する各機能APIのレスポンスで返却されたjobIdを指定する。

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/information/provisioning-status/1

Response samples

Content type

application/json

{"provisioningStatus": "SCHEDULED",
"provisioningType": "POLISY_SETTING"
}

VPN/VNコード取得API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  VPN/VNコード、およびそれに紐づく名称情報を通知する。

VPN/VNコードの一覧を取得する。

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/information/vpn-vn-code

Response samples

200
401
403
500

Content type

application/json

{"total": 1,
"vpnVnCodeList": [{"vpnVnCode": "BA1234",
"vnName": "TEST_1",
"vnType": "L2",
"vlanIdType": "SPECIFIED",
"vlanId": 1111
}
]
}

同意API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  同意マスタ情報の取得及び同意状況の取得、登録、更新をする。

同意状況一覧を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/information/agreements

Response samples

200
401
403
500

Content type

application/json

{"total": 1,
"agreementList": [{"agreementSeq": "1",
"postStartDate": "2021-11-23T14:30:00+09:00",
"agreementTitle": "タイトル",
"signedDate": "2021-11-23T14:30:00+09:00",
"signer": "田中太郎",
"agreementStatus": "AGREED"
}
],
"agreementKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

同意マスタ情報を取得

path Parameters

agreementSeq

required

string <= 19 characters

Example: 1

項目和名：同意マスタSEQ
備考　　：主キー

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/information/agreement/1

Response samples

Content type

application/json

{"agreementSeq": "1",
"postStartDate": "2021-11-23T14:30:00+09:00",
"agreementTitle": "タイトル",
"agreementText": "メッセージ"
}

同意状況を同意に登録または更新

path Parameters

agreementSeq

required

string <= 19 characters

Example: 1

項目和名：同意マスタSEQ
備考　　：主キー

Request Body schema: application/json

agreementKeyId

required

string (agreementKeyId)

項目和名：同意排他情報
備考　　：排他確認用パラメータ
　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"agreementKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

同意状況を保留に登録または更新

path Parameters

agreementSeq

required

string <= 19 characters

Example: 1

項目和名：同意マスタSEQ
備考　　：主キー

Request Body schema: application/json

agreementKeyId

required

string (agreementKeyId)

項目和名：同意排他情報
備考　　：排他確認用パラメータ
　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"agreementKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

パスワード変更API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  ログインユーザーのパスワード変更を実施する

パスワード変更を行う

Request Body schema: application/json

currentPassword required	string [ 8 .. 20 ] characters ^[a-zA-Z0-9]{8,20}$ 項目和名：現在のパスワード備考　　：-
newPassword required	string [ 8 .. 20 ] characters ^[a-zA-Z0-9]{8,20}$ 項目和名：新しいパスワード備考　　：-
confirmation required	string [ 8 .. 20 ] characters ^[a-zA-Z0-9]{8,20}$ 項目和名：新しいパスワード（確認用）備考　　：-

Responses

Request samples

Payload
Curl

Content type

application/json

{"currentPassword": "currentPassword",
"newPassword": "newPassword",
"confirmation": "newPassword"
}

Response samples

400
401
403
404
500

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

ワンタイムURL発行API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  パスワード再発行手続きのワンタイムURL通知メール情報登録を行い、登録メールアドレスに情報を送信する

ワンタイムURL発行

Request Body schema: application/json

loginId required	string (loginId2) <= 18 characters ^[a-zA-Z][a-zA-Z0-9][0-9]{5}@V[0-9]{8}0$ 項目和名：ログインID 備考　　：-
email required	string (email) <= 127 characters ([a-zA-Z0-9!#$%&+\-/=?^_`{\|}~]+[.]{0,1})[a-... 項目和名：メールアドレス備考　　：-
oneTimeUrl	string (oneTimeUrl) ^(https?)(:\/\/[-_.!~*\'()a-zA-Z0-9;\/?:\@&=+... 項目和名：ワンタイム認証URL 備考　　：URLを指定する場合は、設定する。　　　　　決められたドメイン以外は受け付けない。

Responses

Request samples

Payload
Curl

Content type

application/json

{"loginId": "Aa01234@V000000010",
"email": "Aa01234@kddi.com",
"oneTimeUrl": "https://wvs2.kddi.ne.jp/api/online/authenticate.html"
}

Response samples

400
404
500

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

ワンタイム認証API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  ワンタイム認証キーによる認証結果を取得する

ワンタイム認証キーによる認証を行い、その結果を返却する

query Parameters

identifyKey

required

string <= 30 characters [^0169bglpqIO]{30}$

Example: identifyKey=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

項目和名：ワンタイムURL識別キー
備考：30桁のユニークなキー

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v1/password/reissueance?identifyKey=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'

Response samples

200
400
500

Content type

application/json

{"contact": "サービスコントロールセンター",
"contactPhone": "0120-993-600（無料）",
"acceptanceDateTime": "24時間365日",
"oneTimeResultCode": "VALID"
}

パスワード再発行メールを送信する

query Parameters

identifyKey

required

string <= 30 characters [^0169bglpqIO]{30}$

Example: identifyKey=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

項目和名：ワンタイムURL識別キー
備考：30桁のユニークなキー

Request Body schema: application/json

loginId required	string (loginId2) <= 18 characters ^[a-zA-Z][a-zA-Z0-9][0-9]{5}@V[0-9]{8}0$ 項目和名：ログインID 備考　　：-
email required	string (email) <= 127 characters ([a-zA-Z0-9!#$%&+\-/=?^_`{\|}~]+[.]{0,1})[a-... 項目和名：メールアドレス備考　　：-
loginUrl	string (loginUrl) ^(https?)(:\/\/[-_.!~*\'()a-zA-Z0-9;\/?:\@&=+... 項目和名：ログインURL 備考　　：URLを指定する場合は、設定する。　　　　　決められたドメイン以外は受け付けない。

Responses

Request samples

Payload
Curl

Content type

application/json

{"loginId": "Aa01234@V000000010",
"email": "Aa01234@kddi.com",
"loginUrl": "https://wvs2.kddi.ne.jp/api/online/loginOpe.html"
}

Response samples

200
400
500

Content type

application/json

{"contact": "サービスコントロールセンター",
"contactPhone": "0120-993-600（無料）",
"acceptanceDateTime": "24時間365日",
"oneTimeResultCode": "VALID"
}

ユーザ管理API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  ユーザの参照・登録・変更・削除を行う。

ユーザ設定情報を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/users

Response samples

200
401
403
500

Content type

application/json

{"total": 1,
"vnumber": "V000000010",
"userList": [{"userSeq": "1",
"loginId": "Aa12345@V000000010",
"familyName": "田中",
"givenName": "太郎",
"familyNameKana": "タナカ",
"givenNameKana": "タロウ",
"group": "開発グループ",
"phone": "0311112222",
"email": "test@kddi.com",
"operationType": "ADMIN",
"ipAuthAddressList": ["192.169.1.1"
],
"createDate": "2021-12-01",
"updateDate": "2021-12-01"
}
],
"userKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

ユーザ設定情報を追加

Request Body schema: application/json

loginId required	string (loginId3) <= 7 characters ^[a-zA-Z][a-zA-Z0-9][0-9]{5}$ 項目和名：ログインID 備考　　：-
familyName required	string (familyName) <= 10 characters 項目和名：姓備考　　：-
givenName required	string (givenName) <= 10 characters 項目和名：名備考　　：-
familyNameKana	string (familyNameKana) <= 20 characters ^[ァ-ヶー]*$ 項目和名：カナ姓備考　　：-
givenNameKana	string (givenNameKana) <= 20 characters ^[ァ-ヶー]*$ 項目和名：カナ名備考　　：-
group	string (group) <= 50 characters 項目和名：所属グループ備考　　：追加、変更時に選択する候補値はユーザグループ情報APIより取得する。　　　　　設定する値が存在する所属グループの場合、ユーザグループ情報APIより取得した候補値から設定する。　　　　　設定する値が存在しない所属グループの場合、登録したいグループを設定する。
phone	string (phone) <= 15 characters ^[0-9]{1,15}$ 項目和名：電話番号備考　　：-
email required	string (email1) <= 127 characters ([a-zA-Z0-9!#$%&+\-/=?^_`{\|}~]+[.]{0,1})[a-... 項目和名：メールアドレス備考　　：-
operationType required	string (operationType) Enum: "ADMIN" "SETTING" "VIEWING" 項目和名：運用種別備考　　：以下のいずれかを設定します。　　　　　ADMIN: 法人管理者　　　　　SETTING: 設定権限　　　　　VIEWING: 閲覧権限
ipAuthAddressList required	Array of strings 項目和名：IP認証備考　　：IP認証をしない場合、[](空の状態)になります。
oneTimeUrl	string (oneTimeUrl) ^(https?)(:\/\/[-_.!~*\'()a-zA-Z0-9;\/?:\@&=+... 項目和名：ワンタイム認証URL 備考　　：URLを指定する場合は、設定する。　　　　　決められたドメイン以外は受け付けない。

Responses

Request samples

Payload
Curl

Content type

application/json

{"loginId": "Aa12345",
"familyName": "田中",
"givenName": "太郎",
"familyNameKana": "タナカ",
"givenNameKana": "タロウ",
"group": "開発グループ",
"phone": "0311112222",
"email": "test@kddi.com",
"operationType": "ADMIN",
"ipAuthAddressList": ["192.169.1.1"
],
"oneTimeUrl": "https://wvs2.kddi.ne.jp/api/online/authenticate.html"
}

Response samples

201
400
401
403
500

Content type

application/json

{"userSeq": "1",
"userKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

ユーザ設定情報を変更

path Parameters

userSeq

required

string <= 19 characters

Example: 1

項目和名：ユーザSEQ

Request Body schema: application/json

familyName required	string (familyName) <= 10 characters 項目和名：姓備考　　：-
givenName required	string (givenName) <= 10 characters 項目和名：名備考　　：-
familyNameKana	string (familyNameKana) <= 20 characters ^[ァ-ヶー]*$ 項目和名：カナ姓備考　　：-
givenNameKana	string (givenNameKana) <= 20 characters ^[ァ-ヶー]*$ 項目和名：カナ名備考　　：-
group	string (group) <= 50 characters 項目和名：所属グループ備考　　：追加、変更時に選択する候補値はユーザグループ情報APIより取得する。　　　　　設定する値が存在する所属グループの場合、ユーザグループ情報APIより取得した候補値から設定する。　　　　　設定する値が存在しない所属グループの場合、登録したいグループを設定する。
phone	string (phone) <= 15 characters ^[0-9]{1,15}$ 項目和名：電話番号備考　　：-
email required	string (email1) <= 127 characters ([a-zA-Z0-9!#$%&+\-/=?^_`{\|}~]+[.]{0,1})[a-... 項目和名：メールアドレス備考　　：-
operationType required	string (operationType) Enum: "ADMIN" "SETTING" "VIEWING" 項目和名：運用種別備考　　：以下のいずれかを設定します。　　　　　ADMIN: 法人管理者　　　　　SETTING: 設定権限　　　　　VIEWING: 閲覧権限
ipAuthAddressList required	Array of strings 項目和名：IP認証備考　　：IP認証をしない場合、[](空の状態)になります。　　　　　登録されているIP認証情報(IPアドレス)を変更しない場合、getで取得した情報をそのまま設定する。　　　登録されているIP認証情報(IPアドレス)を変更する場合、getで取得した情報から、変更対象のIPアドレスを変更して設定する。　　　登録されているIP認証情報(IPアドレス)を削除したい場合、getで取得した情報のうち、削除したいIPアドレスをリストに設定しない。　　　新たにIP認証情報(IPアドレス)を登録する場合、getで取得した情報にIPアドレスを追加設定する。
userKeyId required	string (userKeyId) 項目和名：ユーザー管理排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"familyName": "田中",
"givenName": "太郎",
"familyNameKana": "タナカ",
"givenNameKana": "タロウ",
"group": "開発グループ",
"phone": "0311112222",
"email": "test@kddi.com",
"operationType": "ADMIN",
"ipAuthAddressList": ["192.169.1.1"
],
"userKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

400
401
403
409
500

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

ユーザ設定情報を削除

Request Body schema: application/json

userSeqList required	Array of strings (userSeq) [ items <= 19 characters ]
userKeyId required	string (userKeyId) 項目和名：ユーザー管理排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"userSeqList": ["1"
],
"userKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

400
401
403
409
500

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

ユーザグループ情報API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  ユーザグループ情報の一覧を取得する

ユーザーグループ情報の一覧を取得する

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/user/groups

Response samples

200
401
403
500

Content type

application/json

{"total": 2,
"userGroupList": ["group_A",
"group_B"
]
}

契約情報API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  ログインしているアカウントの契約情報を取得する。

契約回線情報を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/contract/information

Response samples

200
401
403
500

Content type

application/json

{"contractSeq": "1",
"vnumber": "V000000010",
"vpnCode": "BA1234",
"email": "test@kddi.com",
"total": 1,
"contractList": [{"contractDetailSeq": "2",
"enumber": "E000000010",
"contractor": "エンドユーザ企業A",
"endUserName": "エンドユーザA",
"office": "事業所A",
"accessType": "INTERNET",
"startEndDate": "2021-12-01",
"isSecurityOption": true,
"delegatedContract": {"settingTimes": "0",
"contractTimes": "1"
},
"address": "住所A",
"building": "住所A2",
"bandwidthType": "BANDWIDTH_SECURED",
"bandwidth": {"value": "100",
"unit": "MBPS"
},
"qos": "OFF",
"vlanControl": "OFF",
"updateDate": "2021-12-01"
}
]
}

契約サマリー API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  契約に関するサマリーを取得する。

契約に関するサマリーを取得する。

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/contract/summary

Response samples

200
401
403
500

Content type

application/json

{"vnumber": "V000000010",
"contractor": "エンドユーザ企業A",
"vpnCode": "BA1234",
"email": "test@kddi.com",
"isLargeScaleContract": true,
"isVnConnectPreSetPossible": true,
"isNat": true,
"isPacketFiltering": true,
"isInternetFw": true,
"isUtm": true,
"isIntranetFw": true,
"isInternetType1": true,
"isVirtualNetworkL3": true,
"isVirtualNetworkL2": true,
"isSecuritySetting": true,
"isTrafficInfo": true,
"isSessionInfo": true,
"isStatisticsInfo": true,
"isLogKeepDisc": true,
"isDetailTrafficReport": true,
"isSetupAgency": true,
"isDownloadList": true,
"isAllowLog": true
}

契約情報 CSVダウンロード API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  ログインしているアカウントの契約情報をCSVで一覧取得する。

ログインしているアカウントの契約情報をCSVで一覧取得する。

query Parameters

tokenId

required

string <uuid>

Example: tokenId=ede66c43-9b9d-4222-93ed-5f11c96e08e2

項目和名：トークンID
備考　　：ログイン時に取得するトークンIDを設定

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v1/contract/information/csv?tokenId=ede66c43-9b9d-4222-93ed-5f11c96e08e2'

Response samples

401
403
500

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

契約毎設定上限値情報API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  契約単位の設定上限値（最大値と現在値）を取得するAPI

契約単位の設定上限値（最大値と現在値）を取得するAPI

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/contract/upperlimit

Response samples

200
401
403
500

Content type

application/json

{"vnumber": "V150001780",
"upperLimitList": [{"upperLimitItemName": "FQDN数",
"current": 1,
"upperLimit": 20,
"unit": "個"
}
]
}

契約単位の設定上限値（最大値と現在値）を取得するAPI

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v2/contract/upperlimit

Response samples

200
401
403
500

Content type

application/json

{"vnumber": "V150001780",
"upperLimitList": [{"upperLimitItemName": "FQDN数",
"current": 1,
"upperLimit": 20,
"unit": "個"
}
]
}

回線毎設定上限値情報API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  回線単位の設定上限値（最大値と現在値）を取得するAPI

回線単位の設定上限値（最大値と現在値）を取得するAPI

query Parameters

upperLimitLineManageUnit required	string Enum: "ACCESS" "PFGW" "VNL2L3" "VN" "APPLIANCE" "MULTI_CLOUD" "INTERNET_TYPE4" 項目和名：上限値管理単位備考　　：設定値で、必須となるクエリーパラメータが変化する。 ※各クエリーパラメータ参照 ACCESS：アクセス回線 ※"VLAN IDのType指定"で、取得上限値項目名が異なる。 PFGW：PFGW(イントラ) VNL2L3：VN L2L3コネクト VN：VNコネクト APPLIANCE：アプライアンス ※"アプライアンス種別"で、取得上限値項目名が異なる。 MULTI_CLOUD：マルチクラウド接続 ※"クラウドサービス"で、W番号と取得上限値項目名が異なる。 INTERNET_TYPE4：インターネット回線Type4
applianceType	string Enum: "PACKET_FILTERING" "INTERNET_FW" "UTM" "INTRANET_FW" "NAT" Example: applianceType=PACKET_FILTERING 項目和名：アプライアンス種別備考　　：必須/不必須条件は下記になる。上限値管理単位がアプライアンス：必須上記以外：使用しない(オブジェクト無し、存在した場合無視される) 回線情報検索APIで取得したアプライアンス種別を選択する。 ※複数のアプライアンス種別は指定できない。 INTERNET_FW：インターネットFW PACKET_FILTERING：パケットフィルタリング UTM：UTM INTRANET_FW：イントラネットFW NAT：NAT
enumber	string <= 10 characters ^E[0-9]{8}0$ Example: enumber=E000000010 項目和名：E番号備考　　：必須/不必須条件は下記になる。上限値管理単位がアクセス回線：必須上限値管理単位がVN L2L3コネクト：必須上限値管理単位がPFGW(イントラ) ：必須, enumberActを指定する。上限値管理単位がアプライアンス（インターネット回線Type1かつ、UTMまたはNAT、インターネットFWのいずれかの場合）：必須, enumberMainActを指定する。上記以外：使用しない(オブジェクト無し、存在した場合無視される) 回線情報検索APIで取得したE番号を選択する。
vlanIdType	string Enum: "UNTAG" "OTHER" "SPECIFIED" Example: vlanIdType=SPECIFIED 項目和名：VLAN IDのType指定備考　　：選択条件は下記になる。上限値管理単位がアクセス回線かつE番号に"VLAN IDのType指定"が紐づいている場合：選択できる。上記以外：使用しない(オブジェクト無し、存在した場合無視される) 回線情報検索APIで取得したVLAN ID TYPEを選択する。 UNTAG: IDの指定なし OTHER: 他の仮想ネットワークで指定されていないID,もしくは指定なし SPECIFIED: 指定ID
vlanId	integer <int32> [ 1 .. 4094 ] Example: vlanId=1111 項目和名：VLAN ID 備考　　：必須/不必須条件は下記になる。上限値管理単位がアクセス回線かつ"VLAN IDのType指定"が"SPECIFIED"の場合：必須上記以外：使用しない(オブジェクト無し、存在した場合無視される) 回線情報検索APIで取得したVLAN IDを選択する。
wnumber	string <= 10 characters ^W[0-9]{9}$ Example: wnumber=W000000020 項目和名：W番号備考　　：必須/不必須条件は下記になる。上限値管理単位がVNコネクト：必須上限値管理単位がマルチクラウド接続の場合：選択できる, wnumberActを指定する。上限値管理単位がアプライアンス（インターネット回線Type4）：必須, wnumberMainActを指定する。上記以外：使用しない(オブジェクト無し、存在した場合無視される) 回線情報検索APIで取得したW番号を選択する。
type4Id	string^TY4[0-9]{5}$ Example: type4Id=TY412345 項目和名：インターネット回線(Type4)のType4ID 備考　　：必須/不必須条件は下記になる。上限値管理単位がアプライアンスでType4の回線がある場合：必須上限値管理単位がインターネット回線Type4の場合：必須上記以外：使用しない(オブジェクト無し、存在した場合無視される) 回線情報検索APIで取得したType4IDを選択する。
cloudLineSeq	string <= 19 characters Example: cloudLineSeq=1 項目和名：クラウド回線SEQ 備考　　：必須/不必須条件は下記になる。上限値管理単位がマルチクラウド接続：必須上記以外：使用しない(オブジェクト無し、存在した場合無視される) 回線情報検索APIで取得したクラウド回線SEQを選択する。

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v1/contract/upperlimit/line?upperLimitLineManageUnit=SOME_STRING_VALUE&applianceType=PACKET_FILTERING&enumber=E000000010&vlanIdType=SPECIFIED&vlanId=1111&wnumber=W000000020&type4Id=TY412345&cloudLineSeq=1'

Response samples

Content type

application/json

{"accessLine": {"enumber": "E000000010",
"vlanIdType": "SPECIFIED",
"vlanId": 1111,
"upperLimitList": [{"upperLimitItemName": "StaticルーティングのLANアドレス数",
"current": 0,
"upperLimit": 30,
"unit": "個"
}
]
},
"pfgwLine": {"enumberAct": "E000000010",
"enumberSby": "E000000020",
"upperLimitList": [{"upperLimitItemName": "StaticルーティングのLANアドレス数",
"current": 0,
"upperLimit": 30,
"unit": "個"
}
]
},
"vnl2l3Line": {"enumber": "E000000010",
"upperLimitList": [{"upperLimitItemName": "StaticルーティングのLANアドレス数",
"current": 0,
"upperLimit": 30,
"unit": "個"
}
]
},
"vnConnect": {"wnumber": "W000000020",
"upperLimitList": [{"upperLimitItemName": "StaticルーティングのLANアドレス数",
"current": 0,
"upperLimit": 30,
"unit": "個"
}
]
},
"internetLine": {"type1": {"enumberMainAct": "E000000010",
"enumberMainSby": "E000000020",
"enumberBcpAct": "E000000030",
"enumberBcpSby": "E000000040"
},
"type4": {"type4Id": "TY412345",
"wnumberMainAct": "W000000020",
"wnumberMainSby": "W000000030",
"wnumberBcpAct": "W000000040",
"wnumberBcpSby": "W000000050",
"vnCode": "DA1234"
},
"applianceType": "PACKET_FILTERING",
"upperLimitList": [{"upperLimitItemName": "StaticルーティングのLANアドレス数",
"current": 0,
"upperLimit": 30,
"unit": "個"
}
]
},
"cloudLine": {"cloudLineSeq": "1",
"enumber": "E000000010",
"cloudServiceMenu": "AWS",
"wnumberAct": "W000000020",
"wnumberSby": "W000000030",
"upperLimitList": [{"upperLimitItemName": "StaticルーティングのLANアドレス数",
"current": 0,
"upperLimit": 30,
"unit": "個"
}
]
}
}

回線単位の設定上限値（最大値と現在値）を取得するAPI

query Parameters

upperLimitLineManageUnit required	string Enum: "ACCESS" "PFGW" "VNL2L3" "VN" "APPLIANCE" "MULTI_CLOUD" "INTERNET_TYPE4" 項目和名：上限値管理単位備考　　：設定値で、必須となるクエリーパラメータが変化する。 ※各クエリーパラメータ参照 ACCESS：アクセス回線 ※"VLAN IDのType指定"で、取得上限値項目名が異なる。 PFGW：PFGW(イントラ) VNL2L3：VN L2L3コネクト VN：VNコネクト APPLIANCE：アプライアンス ※"アプライアンス種別"で、取得上限値項目名が異なる。 MULTI_CLOUD：マルチクラウド接続 ※"クラウドサービス"で、W番号と取得上限値項目名が異なる。 INTERNET_TYPE4：インターネット回線Type4
applianceType	string Enum: "PACKET_FILTERING" "INTERNET_FW" "UTM" "INTRANET_FW" "NAT" Example: applianceType=PACKET_FILTERING 項目和名：アプライアンス種別備考　　：必須/不必須条件は下記になる。上限値管理単位がアプライアンス：必須上記以外：使用しない(オブジェクト無し、存在した場合無視される) 回線情報検索APIで取得したアプライアンス種別を選択する。 ※複数のアプライアンス種別は指定できない。 INTERNET_FW：インターネットFW PACKET_FILTERING：パケットフィルタリング UTM：UTM INTRANET_FW：イントラネットFW NAT：NAT
enumber	string <= 10 characters ^E[0-9]{8}0$ Example: enumber=E000000010 項目和名：E番号備考　　：必須/不必須条件は下記になる。上限値管理単位がアクセス回線：必須上限値管理単位がVN L2L3コネクト：必須上限値管理単位がPFGW(イントラ) ：必須, enumberActを指定する。上限値管理単位がアプライアンス（インターネット回線Type1かつ、UTMまたはNAT、インターネットFWのいずれかの場合）：必須, enumberMainActを指定する。上記以外：使用しない(オブジェクト無し、存在した場合無視される) 回線情報検索APIで取得したE番号を選択する。
vlanIdType	string Enum: "UNTAG" "OTHER" "SPECIFIED" Example: vlanIdType=SPECIFIED 項目和名：VLAN IDのType指定備考　　：選択条件は下記になる。上限値管理単位がアクセス回線かつE番号に"VLAN IDのType指定"が紐づいている場合：選択できる。上記以外：使用しない(オブジェクト無し、存在した場合無視される) 回線情報検索APIで取得したVLAN ID TYPEを選択する。 UNTAG: IDの指定なし OTHER: 他の仮想ネットワークで指定されていないID,もしくは指定なし SPECIFIED: 指定ID
vlanId	integer <int32> [ 1 .. 4094 ] Example: vlanId=1111 項目和名：VLAN ID 備考　　：必須/不必須条件は下記になる。上限値管理単位がアクセス回線かつ"VLAN IDのType指定"が"SPECIFIED"の場合：必須上記以外：使用しない(オブジェクト無し、存在した場合無視される) 回線情報検索APIで取得したVLAN IDを選択する。
wnumber	string <= 10 characters ^W[0-9]{9}$ Example: wnumber=W000000020 項目和名：W番号備考　　：必須/不必須条件は下記になる。上限値管理単位がVNコネクト：必須上限値管理単位がマルチクラウド接続の場合：選択できる, wnumberActを指定する。上限値管理単位がアプライアンス（インターネット回線Type4）：必須, wnumberMainActを指定する。上記以外：使用しない(オブジェクト無し、存在した場合無視される) 回線情報検索APIで取得したW番号を選択する。
type4Id	string^TY4[0-9]{5}$ Example: type4Id=TY412345 項目和名：インターネット回線(Type4)のType4ID 備考　　：必須/不必須条件は下記になる。上限値管理単位がアプライアンスでType4の回線がある場合：必須上限値管理単位がインターネット回線Type4の場合：必須上記以外：使用しない(オブジェクト無し、存在した場合無視される) 回線情報検索APIで取得したType4IDを選択する。
cloudLineSeq	string <= 19 characters Example: cloudLineSeq=1 項目和名：クラウド回線SEQ 備考　　：必須/不必須条件は下記になる。上限値管理単位がマルチクラウド接続：必須上記以外：使用しない(オブジェクト無し、存在した場合無視される) 回線情報検索APIで取得したクラウド回線SEQを選択する。

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v2/contract/upperlimit/line?upperLimitLineManageUnit=SOME_STRING_VALUE&applianceType=PACKET_FILTERING&enumber=E000000010&vlanIdType=SPECIFIED&vlanId=1111&wnumber=W000000020&type4Id=TY412345&cloudLineSeq=1'

Response samples

Content type

application/json

{"accessLine": {"enumber": "E000000010",
"vlanIdType": "SPECIFIED",
"vlanId": 1111,
"upperLimitList": [{"upperLimitItemName": "StaticルーティングのLANアドレス数",
"current": 0,
"upperLimit": 30,
"unit": "個"
}
]
},
"pfgwLine": {"enumberAct": "E000000010",
"enumberSby": "E000000020",
"upperLimitList": [{"upperLimitItemName": "StaticルーティングのLANアドレス数",
"current": 0,
"upperLimit": 30,
"unit": "個"
}
]
},
"vnl2l3Line": {"enumber": "E000000010",
"upperLimitList": [{"upperLimitItemName": "StaticルーティングのLANアドレス数",
"current": 0,
"upperLimit": 30,
"unit": "個"
}
]
},
"vnConnect": {"wnumber": "W000000020",
"upperLimitList": [{"upperLimitItemName": "StaticルーティングのLANアドレス数",
"current": 0,
"upperLimit": 30,
"unit": "個"
}
]
},
"internetLine": {"type1": {"enumberMainAct": "E000000010",
"enumberMainSby": "E000000020",
"enumberBcpAct": "E000000030",
"enumberBcpSby": "E000000040"
},
"type4": {"type4Id": "TY412345",
"wnumberMainAct": "W000000020",
"wnumberMainSby": "W000000030",
"wnumberBcpAct": "W000000040",
"wnumberBcpSby": "W000000050",
"vnCode": "DA1234"
},
"applianceType": "PACKET_FILTERING",
"upperLimitList": [{"upperLimitItemName": "StaticルーティングのLANアドレス数",
"current": 0,
"upperLimit": 30,
"unit": "個"
}
]
},
"cloudLine": {"cloudLineSeq": "1",
"enumber": "E000000010",
"cloudServiceMenu": "AWS",
"wnumberAct": "W000000020",
"wnumberSby": "W000000030",
"upperLimitList": [{"upperLimitItemName": "StaticルーティングのLANアドレス数",
"current": 0,
"upperLimit": 30,
"unit": "個"
}
]
}
}

回線単位の設定上限値（最大値と現在値）を取得するAPI

query Parameters

upperLimitLineManageUnit required	string Enum: "ACCESS" "PFGW" "VNL2L3" "VN" "APPLIANCE" "MULTI_CLOUD" "INTERNET_TYPE4" 項目和名：上限値管理単位備考　　：設定値で、必須となるクエリーパラメータが変化する。 ※各クエリーパラメータ参照 ACCESS：アクセス回線 ※"VLAN IDのType指定"で、取得上限値項目名が異なる。 PFGW：PFGW(イントラ) VNL2L3：VN L2L3コネクト VN：VNコネクト APPLIANCE：アプライアンス ※"アプライアンス種別"で、取得上限値項目名が異なる。 MULTI_CLOUD：マルチクラウド接続 ※"クラウドサービス"で、W番号と取得上限値項目名が異なる。 INTERNET_TYPE4：インターネット回線Type4
applianceType	string Enum: "PACKET_FILTERING" "INTERNET_FW" "UTM" "INTRANET_FW" "NAT" Example: applianceType=PACKET_FILTERING 項目和名：アプライアンス種別備考　　：必須/不必須条件は下記になる。上限値管理単位がアプライアンス：必須上記以外：使用しない(オブジェクト無し、存在した場合無視される) 回線情報検索APIで取得したアプライアンス種別を選択する。 ※複数のアプライアンス種別は指定できない。 INTERNET_FW：インターネットFW PACKET_FILTERING：パケットフィルタリング UTM：UTM INTRANET_FW：イントラネットFW NAT：NAT
enumber	string <= 10 characters ^E[0-9]{8}0$ Example: enumber=E000000010 項目和名：E番号備考　　：必須/不必須条件は下記になる。上限値管理単位がアクセス回線：必須上限値管理単位がVN L2L3コネクト：必須上限値管理単位がPFGW(イントラ) ：必須, enumberActを指定する。上限値管理単位がアプライアンス（インターネット回線Type1かつ、UTMまたはNAT、インターネットFWのいずれかの場合）：必須, enumberMainActを指定する。上限値管理単位がマルチクラウド接続かつアクセス回線に紐づく上限値を取得する場合：必須、cloudLineSeqが指定されている場合無視される(enumber, cloudLineSeqのどちらかは必須) 上記以外：使用しない(オブジェクト無し、存在した場合無視される) 回線情報検索APIで取得したE番号を選択する。
vlanIdType	string Enum: "UNTAG" "OTHER" "SPECIFIED" Example: vlanIdType=SPECIFIED 項目和名：VLAN IDのType指定備考　　：選択条件は下記になる。上限値管理単位がアクセス回線かつE番号に"VLAN IDのType指定"が紐づいている場合：選択できる。上記以外：使用しない(オブジェクト無し、存在した場合無視される) 回線情報検索APIで取得したVLAN ID TYPEを選択する。 UNTAG: IDの指定なし OTHER: 他の仮想ネットワークで指定されていないID,もしくは指定なし SPECIFIED: 指定ID
vlanId	integer <int32> [ 1 .. 4094 ] Example: vlanId=1111 項目和名：VLAN ID 備考　　：必須/不必須条件は下記になる。上限値管理単位がアクセス回線かつ"VLAN IDのType指定"が"SPECIFIED"の場合：必須上記以外：使用しない(オブジェクト無し、存在した場合無視される) 回線情報検索APIで取得したVLAN IDを選択する。
wnumber	string <= 10 characters ^W[0-9]{9}$ Example: wnumber=W000000020 項目和名：W番号備考　　：必須/不必須条件は下記になる。上限値管理単位がVNコネクト：必須上限値管理単位がマルチクラウド接続の場合：選択できる, wnumberActを指定する。上限値管理単位がアプライアンス（インターネット回線Type4）：必須, wnumberMainActを指定する。上記以外：使用しない(オブジェクト無し、存在した場合無視される) 回線情報検索APIで取得したW番号を選択する。
type4Id	string^TY4[0-9]{5}$ Example: type4Id=TY412345 項目和名：インターネット回線(Type4)のType4ID 備考　　：必須/不必須条件は下記になる。上限値管理単位がアプライアンスでType4の回線がある場合：必須上限値管理単位がインターネット回線Type4の場合：必須上記以外：使用しない(オブジェクト無し、存在した場合無視される) 回線情報検索APIで取得したType4IDを選択する。
cloudLineSeq	string <= 19 characters Example: cloudLineSeq=1 項目和名：クラウド回線SEQ 備考　　：必須/不必須条件は下記になる。上限値管理単位がマルチクラウド接続かつクラウドサービスごとに紐づく上限値を取得する場合：必須上記以外：使用しない(オブジェクト無し、存在した場合無視される) 回線情報検索APIで取得したクラウド回線SEQを選択する。

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v3/contract/upperlimit/line?upperLimitLineManageUnit=SOME_STRING_VALUE&applianceType=PACKET_FILTERING&enumber=E000000010&vlanIdType=SPECIFIED&vlanId=1111&wnumber=W000000020&type4Id=TY412345&cloudLineSeq=1'

Response samples

Content type

application/json

{"accessLine": {"enumber": "E000000010",
"vlanIdType": "SPECIFIED",
"vlanId": 1111,
"upperLimitList": [{"upperLimitItemName": "StaticルーティングのLANアドレス数",
"current": 0,
"upperLimit": 30,
"unit": "個"
}
]
},
"pfgwLine": {"enumberAct": "E000000010",
"enumberSby": "E000000020",
"upperLimitList": [{"upperLimitItemName": "StaticルーティングのLANアドレス数",
"current": 0,
"upperLimit": 30,
"unit": "個"
}
]
},
"vnl2l3Line": {"enumber": "E000000010",
"upperLimitList": [{"upperLimitItemName": "StaticルーティングのLANアドレス数",
"current": 0,
"upperLimit": 30,
"unit": "個"
}
]
},
"vnConnect": {"wnumber": "W000000020",
"upperLimitList": [{"upperLimitItemName": "StaticルーティングのLANアドレス数",
"current": 0,
"upperLimit": 30,
"unit": "個"
}
]
},
"internetLine": {"type1": {"enumberMainAct": "E000000010",
"enumberMainSby": "E000000020",
"enumberBcpAct": "E000000030",
"enumberBcpSby": "E000000040"
},
"type4": {"type4Id": "TY412345",
"wnumberMainAct": "W000000020",
"wnumberMainSby": "W000000030",
"wnumberBcpAct": "W000000040",
"wnumberBcpSby": "W000000050",
"vnCode": "DA1234"
},
"applianceType": "PACKET_FILTERING",
"upperLimitList": [{"upperLimitItemName": "StaticルーティングのLANアドレス数",
"current": 0,
"upperLimit": 30,
"unit": "個"
}
]
},
"cloudLine": {"cloudLineSeq": "1",
"enumber": "E000000010",
"cloudServiceMenu": "AWS",
"wnumberAct": "W000000020",
"wnumberSby": "W000000030",
"upperLimitList": [{"upperLimitItemName": "StaticルーティングのLANアドレス数",
"current": 0,
"upperLimit": 30,
"unit": "個"
}
]
}
}

オプション契約毎設定上限値情報API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  契約(オプション契約)単位の設定上限値を取得,更新するAPI

契約単位（オプション契約）の設定上限値（最大値と現在値）を取得するAPI

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/contract/upperlimit/option

Response samples

200
401
403
500

Content type

application/json

{"upperLimitContractKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d",
"vnConnect": {"upperLimitVnConnect": 1,
"possibleUpperLimitVnConnect": 100,
"numberOfVnConnect": 5
},
"ipsec": {"upperLimitIpsec": 1,
"possibleUpperLimitIpsec": 100,
"numberOfIpsec": 5
}
}

契約単位（オプション契約）の設定上限値を更新するAPI

Request Body schema: application/json

upperLimitContractKeyId required	string (upperLimitContractKeyId) 項目和名：契約上限値設定排他情報備考　　：排他確認用パラメータ　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。
upperLimitVnConnect	integer <int32> 項目和名：VNコネクト数上限値備考　　：課金対象VNコネクト数の上限値を設定する。　　　　　VNコネクトのオプション契約情報がない場合はNULLとなる。
upperLimitIpsec	integer <int32> 項目和名：IPSec数上限値備考　　：IPSecゲートウェイのAC回線数の上限値を設定する。　　　　　IPsecのオプション契約情報がないはNULLとなる。
note	string <= 200 characters 項目和名：操作履歴の備考備考　　：-

Responses

Request samples

Payload
Curl

Content type

application/json

{"upperLimitContractKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d",
"upperLimitVnConnect": 1,
"upperLimitIpsec": 1,
"note": "操作履歴の備考"
}

Response samples

400
401
403
409
500

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

回線情報検索API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  上限値管理単位に紐づく回線情報を取得するAPI

上限値管理単位に紐づく回線情報を取得するAPI

query Parameters

upperLimitManageUnit

required

string

Enum: "ACCESS" "PFGW" "VNL2L3" "VN" "APPLIANCE" "MULTI_CLOUD" "INTERNET_TYPE4"

項目和名：上限値管理単位
備考　　：
ACCESS：アクセス回線
PFGW：PFGW(イントラ)
VNL2L3：VN L2L3コネクト
VN：VNコネクト
APPLIANCE：アプライアンス
MULTI_CLOUD：マルチクラウド接続
INTERNET_TYPE4：インターネット回線Type4

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v1/contract/upperlimit/line/search?upperLimitManageUnit=SOME_STRING_VALUE'

Response samples

200
400
401
403
500

Content type

application/json

{"total": 1,
"accessLineList": [{"enumber": "E000000010",
"siteList": [{"vlanIdType": "SPECIFIED",
"vlanId": 1111
}
]
}
],
"pfgwLineList": [{"enumberAct": "E000000010",
"enumberSby": "E000000020"
}
],
"vnl2l3LineList": [{"enumber": "E000000010"
}
],
"vnLineList": [{"wnumber": "W000000020"
}
],
"internetLineList": [{"type1": {"enumberMainAct": "E000000010",
"enumberMainSby": "E000000020",
"enumberBcpAct": "E000000030",
"enumberBcpSby": "E000000040"
},
"type4": {"type4Id": "TY412345",
"wnumberMainAct": "W000000020",
"wnumberMainSby": "W000000030",
"wnumberBcpAct": "W000000040",
"wnumberBcpSby": "W000000050",
"vnCode": "DA1234"
},
"applianceType": "PACKET_FILTERING"
}
],
"cloudLineList": [{"cloudLineSeq": "1",
"enumber": "E000000010",
"cloudServiceMenu": "AWS",
"vnConnectList": [{"wnumberAct": "W000000020",
"wnumberSby": "W000000030"
}
]
}
],
"internetType4List": [{"type4Id": "TY412345",
"wnumberMainAct": "W000000020",
"wnumberMainSby": "W000000030",
"wnumberBcpAct": "W000000040",
"wnumberBcpSby": "W000000050"
}
]
}

上限値管理単位に紐づく回線情報を取得するAPI

query Parameters

upperLimitManageUnit

required

string

Enum: "ACCESS" "PFGW" "VNL2L3" "VN" "APPLIANCE" "MULTI_CLOUD" "INTERNET_TYPE4"

項目和名：上限値管理単位
備考　　：
ACCESS：アクセス回線
PFGW：PFGW(イントラ)
VNL2L3：VN L2L3コネクト
VN：VNコネクト
APPLIANCE：アプライアンス
MULTI_CLOUD：マルチクラウド接続
INTERNET_TYPE4：インターネット回線Type4

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v2/contract/upperlimit/line/search?upperLimitManageUnit=SOME_STRING_VALUE'

Response samples

200
400
401
403
500

Content type

application/json

{"total": 1,
"accessLineList": [{"enumber": "E000000010",
"siteList": [{"vlanIdType": "SPECIFIED",
"vlanId": 1111
}
]
}
],
"pfgwLineList": [{"enumberAct": "E000000010",
"enumberSby": "E000000020"
}
],
"vnl2l3LineList": [{"enumber": "E000000010"
}
],
"vnLineList": [{"wnumber": "W000000020"
}
],
"internetLineList": [{"type1": {"enumberMainAct": "E000000010",
"enumberMainSby": "E000000020",
"enumberBcpAct": "E000000030",
"enumberBcpSby": "E000000040"
},
"type4": {"type4Id": "TY412345",
"wnumberMainAct": "W000000020",
"wnumberMainSby": "W000000030",
"wnumberBcpAct": "W000000040",
"wnumberBcpSby": "W000000050",
"vnCode": "DA1234"
},
"applianceType": "PACKET_FILTERING"
}
],
"cloudLineList": [{"cloudLineSeq": "1",
"enumber": "E000000010",
"cloudServiceMenu": "AWS",
"vnConnectList": [{"wnumberAct": "W000000020",
"wnumberSby": "W000000030"
}
]
}
],
"internetType4List": [{"type4Id": "TY412345",
"wnumberMainAct": "W000000020",
"wnumberMainSby": "W000000030",
"wnumberBcpAct": "W000000040",
"wnumberBcpSby": "W000000050"
}
]
}

アプライアンス情報API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  アプライアンス情報の一覧取得を行う。

アプライアンス情報一覧を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/contract/appliances

Response samples

200
401
403
500

Content type

application/json

{"total": 1,
"applianceInfoList": [{"contractSeq": "1",
"enumberMainAct": "E000000010",
"enumberMainSby": "E000000020",
"enumberBcpAct": "E000000030",
"enumberBcpSby": "E000000040",
"wnumberMainAct": "W000000010",
"wnumberMainSby": "W000000020",
"wnumberBcpAct": "W000000030",
"wnumberBcpSby": "W000000040",
"vpnVnCode": "BA1234",
"internetType": "TYPE4",
"type4Name": "サーバ向け",
"type4Id": "TY412345",
"mainSite": "TOKYO",
"isM365": true,
"applianceType": "UTM_BE",
"isSecurityOption": false,
"isStart": true,
"isInternetPause": true,
"bandwidth": {"value": 100,
"unit": "MBPS"
},
"numberOfAddGlobalIpAddress": 1
}
]
}

サービスメニューAPI（インターネットType1）

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST：受付非同期方式
2. 内容
  インターネットType1のアプライアンス契約を取得・変更する。

サービスメニュー(インターネットType1)を取得する。

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/contract/service/appliance/type1

Response samples

200
401
403
500

Content type

application/json

{"contractType1KeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d",
"enumberMainAct": "E000000010",
"enumberMainSby": "E000000020",
"enumberBcpAct": "E000000030",
"enumberBcpSby": "E000000040",
"vpnCode": "BA1234",
"applianceType": "IFW",
"contractType": "BANDWIDTH_SECURED",
"bandwidth": {"value": 100,
"unit": "MBPS"
},
"policyType": "ALLOW_SPECIFIC_ONE_WAY",
"globalIpAddressList": [{"globalIpAddressSeq": "52",
"globalIpAddress": "106.186.213.152/32",
"isInitialAddress": false
}
],
"isSecurityOption": true,
"status": "ACTIVE"
}

サービスメニュー(インターネットType1)の変更を行う。

Request Body schema: application/json

contractType1KeyId required	string (contractType1KeyId) 項目和名：インターネットType1契約排他情報備考　　：排他確認用パラメータ。　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。
	object (bandwidth1) 項目和名：帯域値備考　　：「帯域確保」の場合は必須。「ベストエフォート」の場合はNULLとなる。
numberOfAddGlobalIpAddress	integer <int32> [ 1 .. 31 ] 項目和名：グローバルIP追加数(単位:個) 備考　　：追加で払い出すグローバルIPアドレスの数。　　　　　初期グローバルIPアドレスが必ず一つ含まれるがそれを数に含めない。　　　　　初期グローバルIPアドレスのみで利用する場合はNULL。
deleteGlobalIpAddressSeqList	Array of strings (globalIpAddressSeq) [ 1 .. 31 ] items [ items <= 19 characters ] 項目和名：削除グローバルIPアドレスSEQリスト備考　　：0件の場合はNULL
note	string <= 200 characters 項目和名：操作履歴の備考備考　　：-

Responses

Request samples

Payload
Curl

Content type

application/json

{"contractType1KeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d",
"bandwidth": {"value": 100,
"unit": "MBPS"
},
"numberOfAddGlobalIpAddress": 2,
"deleteGlobalIpAddressSeqList": ["52"
],
"note": "操作履歴の備考"
}

Response samples

Content type

application/json

{"jobId": "1"
}

サービスメニューAPI（Type1アプライアンス）

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST：受付非同期方式
2. 内容
  インターネットType1のNAT、インターネットFW、UTMの契約状態を取得・変更する。

Type1のNAT、インターネットFW、UTMの契約状態を取得する。

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/contract/service/appliance/brief/type1

Response samples

200
401
403
500

Content type

application/json

{"contractType1KeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d",
"utmEnabled": true,
"ifwEnabled": true,
"natEnabled": true,
"natRuleCount": 0
}

Type1のNAT、インターネットFW、UTMの契約状態を変更する。

Request Body schema: application/json

contractType1KeyId required	string (contractType1KeyId) 項目和名：インターネットType1契約排他情報備考　　：排他確認用パラメータ。　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。
utmEnabled required	boolean 項目和名：UTM契約ON/OFF 備考　　：「ON」の場合はtrue、「OFF」の場合はfalseを設定する。　　　　　ON→OFFへの設定変更のみ可能とする。
ifwEnabled required	boolean 項目和名：インターネットFW契約ON/OFF 備考　　：「ON」の場合はtrue、「OFF」の場合はfalseを設定する。　　　　　ON→OFFへの設定変更のみ可能とする。
natEnabled required	boolean 項目和名：NAT契約ON/OFF 備考　　：「ON」の場合はtrue、「OFF」の場合はfalseを設定する。
note	string <= 200 characters 項目和名：操作履歴の備考備考　　：-

Responses

Request samples

Payload
Curl

Content type

application/json

{"contractType1KeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d",
"utmEnabled": true,
"ifwEnabled": true,
"natEnabled": true,
"note": "操作履歴の備考"
}

Response samples

Content type

application/json

{"jobId": "1"
}

サービスメニューAPI(インターネットType4)

概要

インターフェースタイプ
GET ：同期応答方式
POST：非同期応答方式
内容
インターネットType4のアプライアンス契約を取得・追加・変更・削除する

サービスメニュー(インターネットType4)追加

Request Body schema: application/json

policyType required	string (policyType) Enum: "ALLOW_SPECIFIC_ONE_WAY" "ALLOW_ALL_ONE_WAY" "ALLOW_ALL_TWO_WAY" 項目和名：デフォルトポリシー種別備考　　：ALLOW_SPECIFIC_ONE_WAY：片方向の特定サービスallow 　　　　　ALLOW_ALL_ONE_WAY：片方向の全allow 　　　　　ALLOW_ALL_TWO_WAY：双方向の全allow
type4Name required	string <= 20 characters 項目和名：Type4名備考　　：半角、全角
isMicrosoft365 required	boolean 項目和名：Microsoft365フラグ備考　　：「ON」の場合はtrue、「OFF」の場合はfalseを設定
applianceType required	string (applianceType3) Enum: "IFW" "UTM" 項目和名：アプライアンス種別備考　　：IFW：インターネットFW 　　　　　UTM：UTM
vpnVnCode required	string <= 6 characters ^[BCD][A-Z][0-9]{4}$ 項目和名：VPN/VNコード備考　　：Bから始まる場合はVPN。それ以外の場合はVN
mainSite required	string (mainSite1) Enum: "TOKYO" "OSAKA" 項目和名：メインサイト備考　　：TOKYO：東京　　　　：OSAKA：大阪
note	string <= 200 characters 項目和名：操作履歴の備考備考　　：-

Responses

Request samples

Payload
Curl

Content type

application/json

{"policyType": "ALLOW_SPECIFIC_ONE_WAY",
"type4Name": "インターネットType4名",
"isMicrosoft365": true,
"applianceType": "IFW",
"vpnVnCode": "DA0000",
"mainSite": "TOKYO",
"note": "操作履歴..."
}

Response samples

Content type

application/json

{"jobId": "1"
}

サービスメニュー(インターネットType4)追加

Request Body schema: application/json

policyType required	string (policyType) Enum: "ALLOW_SPECIFIC_ONE_WAY" "ALLOW_ALL_ONE_WAY" "ALLOW_ALL_TWO_WAY" 項目和名：デフォルトポリシー種別備考　　：ALLOW_SPECIFIC_ONE_WAY：片方向の特定サービスallow 　　　　　ALLOW_ALL_ONE_WAY：片方向の全allow 　　　　　ALLOW_ALL_TWO_WAY：双方向の全allow
type4Name required	string <= 20 characters 項目和名：Type4名備考　　：半角、全角
isMicrosoft365 required	boolean 項目和名：Microsoft365フラグ備考　　：「ON」の場合はtrue、「OFF」の場合はfalseを設定
applianceType required	string (applianceType3) Enum: "IFW" "UTM" 項目和名：アプライアンス種別備考　　：IFW：インターネットFW 　　　　　UTM：UTM
vpnVnCode required	string <= 6 characters ^[BCD][A-Z][0-9]{4}$ 項目和名：VPN/VNコード備考　　：Bから始まる場合はVPN。それ以外の場合はVN
mainSite required	string (mainSite1) Enum: "TOKYO" "OSAKA" 項目和名：メインサイト備考　　：TOKYO：東京　　　　：OSAKA：大阪
required	object (maintenance1) 項目和名：保守情報備考　　：-
note	string <= 200 characters 項目和名：操作履歴の備考備考　　：-

Responses

Request samples

Payload
Curl

Content type

application/json

{"policyType": "ALLOW_SPECIFIC_ONE_WAY",
"type4Name": "インターネットType4名",
"isMicrosoft365": true,
"applianceType": "IFW",
"vpnVnCode": "DA0000",
"mainSite": "TOKYO",
"maintenance": {"company": "ABC社",
"department": "DEF部",
"name": "田中太郎",
"phone": 123456789,
"email": "test@kddi.com"
},
"note": "操作履歴..."
}

Response samples

Content type

application/json

{"jobId": "1"
}

サービスメニュー(インターネットType4)取得

path Parameters

type4Id

required

string^TY4[0-9]{5}$

Example: TY412345

項目和名：Type4ID
備考　　：主キー
　　　　　アプライアンス情報APIより取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/contract/service/appliance/type4/TY412345

Response samples

200
400
401
403
500

Content type

application/json

{"policyType": "ALLOW_SPECIFIC_ONE_WAY",
"type4Name": "インターネットType4名",
"isMicrosoft365": true,
"contractType": "BEST_EFFORT",
"bandwidth": {"value": 100,
"unit": "KBPS"
},
"applianceType": "IFW",
"contractType4KeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d",
"wnumberMainAct": "W123456789",
"wnumberMainSby": "W123456789",
"wnumberBcpAct": "W123456789",
"wnumberBcpSby": "W123456789",
"vpnVnCode": "DA0000",
"vnName": "VN名",
"mainSite": "TOKYO",
"type4Id": "TY412345",
"isSecurityOption": true,
"globalIpAddressList": [{"globalIpAddressSeq": "52",
"globalIpAddress": "106.186.213.152/32",
"isInitialAddress": false
}
],
"status": "UNCONNECTED"
}

サービスメニュー(インターネットType4)設定

path Parameters

type4Id

required

string^TY4[0-9]{5}$

Example: TY412345

項目和名：Type4ID
備考　　：主キー
　　　　　サービスメニューAPI(インターネットType4)より取得

Request Body schema: application/json

policyType required	string (policyType) Enum: "ALLOW_SPECIFIC_ONE_WAY" "ALLOW_ALL_ONE_WAY" "ALLOW_ALL_TWO_WAY" 項目和名：デフォルトポリシー種別備考　　：ALLOW_SPECIFIC_ONE_WAY：片方向の特定サービスallow 　　　　　ALLOW_ALL_ONE_WAY：片方向の全allow 　　　　　ALLOW_ALL_TWO_WAY：双方向の全allow
type4Name required	string <= 20 characters 項目和名：Type4名備考　　：半角、全角
isMicrosoft365 required	boolean 項目和名：Microsoft365フラグ備考　　：「ON」の場合はtrue、「OFF」の場合はfalseを設定
contractType required	string (contractType1) Enum: "BEST_EFFORT" "SECURING" 項目和名：契約種別備考　　：アプライアンス種別がインターネットFWまたは帯域タイプが帯域指定不可(BEのみ)の場合、　　　　　ベストエフォートのみ選択可能　　　　　Type4追加の場合、契約種別は必ずベストエフォート　　　　　BEST_EFFORT：ベストエフォート　　　　　SECURING：帯域確保
	object (bandwidth2) 項目和名：帯域備考　　：契約種別がベストエフォートの場合はnull、帯域確保の場合は必須　　　　　低帯域アプライアンスの場合は10~1000Mbps 　　　　　広帯域アプライアンスの場合は設定された上限・下限値に従う。
applianceType required	string (applianceType3) Enum: "IFW" "UTM" 項目和名：アプライアンス種別備考　　：IFW：インターネットFW 　　　　　UTM：UTM
numberOfAddGlobalIpAddress	integer <int32> [ 1 .. 31 ] 項目和名：グローバルIP追加数(単位:個) 備考　　：新たに払い出すグローバルIPアドレスの数　　　　　現在払い出し済みのグローバルIPアドレスは数に含めない。　　　　　グローバルIPアドレスを新たに追加しない場合はnull
deleteGlobalIpAddressSeqList	Array of strings [ 1 .. 31 ] items [ items <= 19 characters ] 項目和名：削除グローバルIPアドレスSEQリスト備考　　：0件の場合はnull
note	string <= 200 characters 項目和名：操作履歴の備考備考　　：-
contractType4KeyId required	string 項目和名：インターネットType4契約排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"policyType": "ALLOW_SPECIFIC_ONE_WAY",
"type4Name": "インターネットType4名",
"isMicrosoft365": true,
"contractType": "BEST_EFFORT",
"bandwidth": {"value": 100,
"unit": "KBPS"
},
"applianceType": "IFW",
"numberOfAddGlobalIpAddress": 2,
"deleteGlobalIpAddressSeqList": ["51"
],
"note": "操作履歴...",
"contractType4KeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

サービスメニュー(インターネットType4)取得

path Parameters

type4Id

required

string^TY4[0-9]{5}$

Example: TY412345

項目和名：Type4ID
備考　　：主キー
　　　　　アプライアンス情報APIより取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v2/contract/service/appliance/type4/TY412345

Response samples

200
400
401
403
500

Content type

application/json

{"policyType": "ALLOW_SPECIFIC_ONE_WAY",
"type4Name": "インターネットType4名",
"isMicrosoft365": true,
"contractType": "BEST_EFFORT",
"bandwidth": {"value": 100,
"unit": "KBPS"
},
"applianceType": "IFW",
"contractType4KeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d",
"wnumberMainAct": "W123456789",
"wnumberMainSby": "W123456789",
"wnumberBcpAct": "W123456789",
"wnumberBcpSby": "W123456789",
"vpnVnCode": "DA0000",
"vnName": "VN名",
"mainSite": "TOKYO",
"type4Id": "TY412345",
"isSecurityOption": true,
"globalIpAddressList": [{"globalIpAddressSeq": "52",
"globalIpAddress": "106.186.213.152/32",
"isInitialAddress": false
}
],
"status": "UNCONNECTED",
"contractInfo": {"contractor": "エンドユーザ企業A",
"endUserName": "エンドユーザA",
"email": "test@kddi.com"
},
"maintenance": {"company": "ABC社",
"department": "DEF部",
"name": "田中太郎",
"phone": 123456789,
"email": "test@kddi.com"
}
}

サービスメニュー(インターネットType4)設定

path Parameters

type4Id

required

string^TY4[0-9]{5}$

Example: TY412345

項目和名：Type4ID
備考　　：主キー
　　　　　サービスメニューAPI(インターネットType4)より取得

Request Body schema: application/json

policyType required	string (policyType) Enum: "ALLOW_SPECIFIC_ONE_WAY" "ALLOW_ALL_ONE_WAY" "ALLOW_ALL_TWO_WAY" 項目和名：デフォルトポリシー種別備考　　：ALLOW_SPECIFIC_ONE_WAY：片方向の特定サービスallow 　　　　　ALLOW_ALL_ONE_WAY：片方向の全allow 　　　　　ALLOW_ALL_TWO_WAY：双方向の全allow
type4Name required	string <= 20 characters 項目和名：Type4名備考　　：半角、全角
isMicrosoft365 required	boolean 項目和名：Microsoft365フラグ備考　　：「ON」の場合はtrue、「OFF」の場合はfalseを設定
contractType required	string (contractType1) Enum: "BEST_EFFORT" "SECURING" 項目和名：契約種別備考　　：アプライアンス種別がインターネットFWまたは帯域タイプが帯域指定不可(BEのみ)の場合、　　　　　ベストエフォートのみ選択可能　　　　　Type4追加の場合、契約種別は必ずベストエフォート　　　　　BEST_EFFORT：ベストエフォート　　　　　SECURING：帯域確保
	object (bandwidth2) 項目和名：帯域備考　　：契約種別がベストエフォートの場合はnull、帯域確保の場合は必須　　　　　低帯域アプライアンスの場合は10~1000Mbps 　　　　　広帯域アプライアンスの場合は設定された上限・下限値に従う。
applianceType required	string (applianceType3) Enum: "IFW" "UTM" 項目和名：アプライアンス種別備考　　：IFW：インターネットFW 　　　　　UTM：UTM
numberOfAddGlobalIpAddress	integer <int32> [ 1 .. 31 ] 項目和名：グローバルIP追加数(単位:個) 備考　　：新たに払い出すグローバルIPアドレスの数　　　　　現在払い出し済みのグローバルIPアドレスは数に含めない。　　　　　グローバルIPアドレスを新たに追加しない場合はnull
deleteGlobalIpAddressSeqList	Array of strings [ 1 .. 31 ] items [ items <= 19 characters ] 項目和名：削除グローバルIPアドレスSEQリスト備考　　：0件の場合はnull
required	object (maintenance1) 項目和名：保守情報備考　　：-
note	string <= 200 characters 項目和名：操作履歴の備考備考　　：-
contractType4KeyId required	string 項目和名：インターネットType4契約排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"policyType": "ALLOW_SPECIFIC_ONE_WAY",
"type4Name": "インターネットType4名",
"isMicrosoft365": true,
"contractType": "BEST_EFFORT",
"bandwidth": {"value": 100,
"unit": "KBPS"
},
"applianceType": "IFW",
"numberOfAddGlobalIpAddress": 2,
"deleteGlobalIpAddressSeqList": ["51"
],
"maintenance": {"company": "ABC社",
"department": "DEF部",
"name": "田中太郎",
"phone": 123456789,
"email": "test@kddi.com"
},
"note": "操作履歴...",
"contractType4KeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

サービスメニュー(インターネットType4)削除

path Parameters

type4Id

required

string^TY4[0-9]{5}$

Example: TY412345

項目和名：Type4ID
備考　　：主キー
　　　　　サービスメニューAPI(インターネットType4)より取得

Request Body schema: application/json

contractType4KeyId required	string 項目和名：インターネットType4契約排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。
note	string <= 200 characters 項目和名：操作履歴の備考備考　　：-

Responses

Request samples

Payload
Curl

Content type

application/json

{"contractType4KeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d",
"note": "操作履歴..."
}

Response samples

Content type

application/json

{"jobId": "1"
}

インターネットType4設定情報取得API

概要

インターフェースタイプ
同期応答方式
内容
インターネットType4の設定に関連する情報を取得する

インターネットType4帯域アプライアンス許可設定を取得

path Parameters

type4Id

required

string^TY4[0-9]{5}$

Example: TY412345

項目和名：Type4ID
備考　　：主キー
　　　　　サービスメニューAPI(インターネットType4)より取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/contract/service/appliance/type4/TY412345/options

Response samples

200
400
401
403
500

Content type

application/json

{"bandwidthType": "NO_SECURING",
"lowerLimitBandwidth": {"value": 100,
"unit": "KBPS"
},
"upperLimitBandwidth": {"value": 100,
"unit": "KBPS"
}
}

インターネットType4追加可能なVN面及びVPN面の情報を渡す

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/contract/service/appliance/type4/vpn-vn-list

Response samples

200
401
403
500

Content type

application/json

{"total": 1,
"type4VpnVnList": [{"vpnVnCode": "DA0011",
"vnName": "仮想ネットワーク名"
}
]
}

インターネットType4利用開始API

概要

インターフェースタイプ
非同期応答方式
内容
インターネットType4の利用を開始する

インターネットType4利用開始

path Parameters

type4Id

required

string^TY4[0-9]{5}$

Example: TY412345

項目和名：Type4ID
備考　　：主キー
　　　　　サービスメニューAPI(インターネットType4)より取得

Request Body schema: application/json

contractType4KeyId

required

string

項目和名：インターネットType4契約排他情報
備考　　：排他確認用パラメータ
　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"contractType4KeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

サービスメニューAPI（オプション）

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST：受付非同期方式
2. 内容
  オプション契約を取得・変更する。

オプション契約を取得する。

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/contract/service/appliance/options

Response samples

200
401
403
500

Content type

application/json

{"additionalLogCapacity": 10,
"isAllowLog": true,
"isStatistics": true,
"contractOptionKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

オプション契約を変更する。

Request Body schema: application/json

additionalLogCapacity	integer multiple of 10 [ 0 .. 90 ] 項目和名：課金対象となる追加ログ容量の指定備考　　：単位は「GB」, 10GB刻みで指定可能となる。　　　　　0を指定すると、課金対象の追加ログがOFF扱いとなる。　　　　　課金対象ではないログ容量は10GBあり、　　　　　本パラメータの容量と合わせた容量が、ログ保存容量となる。　　　　　　以下の場合、NULLを返す。　　　　　・パートナーユーザーで「ログ保存用ディスク表示フラグ」がOFFの場合
isAllowLog	boolean 項目和名：ポリシー単位のsyslog出力ON/OFF 備考　　：「ON」の場合はtrue、「OFF」の場合はfalseを設定する。　　　　　以下の場合、NULLを返す。　　　　　・パートナーユーザーで「Allowログ表示フラグ」がOFFの場合
isStatistics	boolean 項目和名：統計情報フラグ備考　　：「ON」の場合はtrue、「OFF」の場合はfalseを設定する。　　　　　以下の場合、NULLを返す。　　　　　・パートナーユーザーで「統計情報レポート表示フラグ」がOFFの場合
note	string <= 200 characters 項目和名：操作履歴の備考備考　　：-
contractOptionKeyId required	string (contractOptionKeyId) 項目和名：契約オプション排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"additionalLogCapacity": 10,
"isAllowLog": true,
"isStatistics": true,
"note": "操作履歴の備考",
"contractOptionKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

サービスメニューAPI（イントラネットFW）

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST：受付非同期方式
2. 内容
  アプライアンス（イントラネットFW）の契約変更に必要な情報を取得・変更する。

アプライアンス（イントラネットFW）の契約情報を取得する。

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/contract/service/appliance/intranetfw

Response samples

200
401
403
500

Content type

application/json

{"contractIntranetFwKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d",
"vpnCode": "BA1234",
"intranetFwBandwidth": {"value": 100,
"unit": "MBPS"
},
"accessLineList": [{"bandwidth": {"value": 100,
"unit": "MBPS"
},
"enumber": "E000000010"
}
],
"remoteAccessGwList": [{"bandwidthActSby": {"value": 100,
"unit": "MBPS"
},
"enumberAct": "E000000010",
"enumberSby": "E000000020",
"menu": "REMOTE_ACCESS_GW2_FRE",
"contractType": "BESTEFFORT",
"contractBandwidth": {"value": 100,
"unit": "MBPS"
}
}
],
"pfgwList": [{"bandwidthActSby": {"value": 100,
"unit": "MBPS"
},
"enumberAct": "E000000010",
"enumberSby": "E000000020",
"office": "事業所A",
"wvs2ToKcpsZoneRelationId": "obj44557",
"kcpsToWvs2ZoneRelationId": "obj44557"
}
]
}

アプライアンス（イントラネットFW）の契約変更を行う。

Request Body schema: application/json

contractIntranetFwKeyId required	string (contractIntranetFwKeyId) 項目和名：イントラネットFW契約排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。
required	object (intranetFwBandwidth) 項目和名：帯域値備考　　：イントラネットFWの帯域を指定する。
required	Array of objects 項目和名：アクセス回線リスト備考　　：アクセス回線の割り当て帯域の変更を行う。　　　　　変更する回線および変更なしの回線をリストに含める。　　　　　削除する回線は、リストに含めない。　　　　　全アクセス回線廃止済みの場合は、空のリストとなる。
required	Array of objects 項目和名：リモートアクセスゲートウェイリスト備考　　：リモートアクセスゲートウェイの割り当て帯域の変更を行う。　　　　　変更する回線および変更なしの回線をリストに含める。　　　　　削除する回線は、リストに含めない。　　　　　全リモートアクセスゲートウェイ廃止済みの場合は、空のリストとなる。
required	Array of objects 項目和名：プラットフォームゲートウェイリスト備考　　：プラットフォームゲートウェイの割り当て帯域の変更を行う。　　　　　変更する回線および変更なしの回線をリストに含める。　　　　　削除する回線は、リストに含めない。　　　　　全プラットフォームゲートウェイ廃止済みの場合は、空のリストとなる。
note	string (note1) <= 200 characters 項目和名：操作履歴の備考備考　　：-

Responses

Request samples

Payload
Curl

Content type

application/json

{"contractIntranetFwKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d",
"intranetFwBandwidth": {"value": 100,
"unit": "MBPS"
},
"accessLineList": [{"bandwidth": {"value": 100,
"unit": "MBPS"
},
"enumber": "E000000010"
}
],
"remoteAccessGwList": [{"bandwidthActSby": {"value": 100,
"unit": "MBPS"
},
"enumberAct": "E000000010"
}
],
"pfgwList": [{"bandwidthActSby": {"value": 100,
"unit": "MBPS"
},
"enumberAct": "E000000010"
}
],
"note": "操作履歴の備考"
}

Response samples

Content type

application/json

{"jobId": "1"
}

アプライアンス（イントラネットFW）の契約削除を行う。

Request Body schema: application/json

contractIntranetFwKeyId required	string (contractIntranetFwKeyId) 項目和名：イントラネットFW契約排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。
note	string (note1) <= 200 characters 項目和名：操作履歴の備考備考　　：-

Responses

Request samples

Payload
Curl

Content type

application/json

{"contractIntranetFwKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d",
"note": "操作履歴の備考"
}

Response samples

Content type

application/json

{"jobId": "1"
}

Microsoft Peering API

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST：受付非同期方式
2. 内容
  Microsoft Peering設定の参照・登録・変更・削除を行う。

Microsoft Peering設定情報の一覧を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/contract/service/cloud/ms-peerings

Response samples

200
401
403
500

Content type

application/json

{"total": 1,
"msPeeringList": [{"msServiceSeq": "1",
"vpnVnCode": "BA1234",
"vnName": "TEST_1",
"msPeering": {"upperLimitNapt": 32,
"upperLimitNat": 32
}
}
],
"msPeeringKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Microsoft Peering設定情報を追加

Request Body schema: application/json

vpnVnCode required	string (vpnVnCode2) <= 6 characters ^[BCD][A-Z][0-9]{4}$ 項目和名：VPN/VNコード備考　　：VPNの場合は「VPNコード」、VNの場合は「VNコード」の形式で表示する。
	object (msPeering) 項目和名：Microsoft Peering 備考　　： NULLの場合は「利用しない」、NULL以外の場合は「利用する」とする。
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
msPeeringKeyId required	string (msPeeringKeyId) 項目和名：Microsoft Peering排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"vpnVnCode": "BA1234",
"msPeering": {"upperLimitNapt": 32,
"upperLimitNat": 32
},
"note": "メッセージ",
"msPeeringKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

Microsoft Peering設定情報を変更

path Parameters

msServiceSeq

required

string <= 19 characters

Example: 1

項目和名：MicrosoftサービスSEQ

Request Body schema: application/json

	object (msPeering) 項目和名：Microsoft Peering 備考　　： NULLの場合は「利用しない」、NULL以外の場合は「利用する」とする。
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
msPeeringKeyId required	string (msPeeringKeyId) 項目和名：Microsoft Peering排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"msPeering": {"upperLimitNapt": 32,
"upperLimitNat": 32
},
"note": "メッセージ",
"msPeeringKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

Microsoft Peering設定情報を削除

Request Body schema: application/json

msServiceSeq required	string (msServiceSeq) <= 19 characters 項目和名：MicrosoftサービスSEQ 備考　　：主キー
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
msPeeringKeyId required	string (msPeeringKeyId) 項目和名：Microsoft Peering排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"msServiceSeq": "1",
"note": "メッセージ",
"msPeeringKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

SaaSサービス利用申込API

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST：受付非同期方式
2. 内容
  SaaSサービス設定の参照・追加・変更・削除を行う。

SaaSサービス設定情報の一覧を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/contract/service/cloud/saas

Response samples

200
401
403
500

Content type

application/json

{"total": 1,
"saasServiceList": [{"saasCommon": {"vpnVnCode": "BA1234",
"vnName": "TEST_1"
},
"msPeeringInfo": {"msServiceSeq": "1",
"msPeering": {"upperLimitNapt": 32,
"upperLimitNat": 32
}
},
"sfdcInfo": {"sfdcServiceSeq": "1",
"sfdc": {"upperLimitNapt": 1
}
}
}
],
"saasKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

SaaSサービス設定情報の追加、変更

Request Body schema: application/json

required	object 項目和名：SaaS設定共通情報備考　　：-
required	object 項目和名：Microsoft Peering設定情報備考　　　追加する場合、MicrosoftサービスSEQをNULLとする。　　　　　変更する場合、MicrosoftサービスSEQを必須とする。
required	object 項目和名：SFDC設定情報備考　　：追加する場合、SFDCサービスSEQをNULLとする。　　　　　変更する場合、SFDCサービスSEQを必須とする。
saasKeyId required	string (saasKeyId) 項目和名：SaaSサービス排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"saasCommon": {"vpnVnCode": "BA1234"
},
"msPeeringInfo": {"msServiceSeq": "1",
"msPeering": {"upperLimitNapt": 32,
"upperLimitNat": 32
}
},
"sfdcInfo": {"sfdcServiceSeq": "1",
"sfdc": {"upperLimitNapt": 1
}
},
"saasKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

SaaSサービス設定情報を削除

Request Body schema: application/json

vpnVnCode required	string (vpnVnCode3) <= 6 characters ^[BCD][A-Z][0-9]{4}$ 項目和名：VPN/VNコード備考　　：VPNの場合は「VPNコード」、VNの場合は「VNコード」の形式で表示する。
saasKeyId required	string (saasKeyId) 項目和名：SaaSサービス排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"vpnVnCode": "BA1234",
"saasKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

サービスメニューAPI（パケットフィルタリング）

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST：受付非同期方式
2. 内容
  パケットフィルタリングの契約状態を取得・変更する。

パケットフィルタリングの契約状態を取得する。

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/contract/service/appliance/packetfiltering

Response samples

200
401
403
500

Content type

application/json

{"contractPacketFilterKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d",
"packetFilterEnabled": true,
"packetFilterRuleCount": 0
}

パケットフィルタリングの契約状態を変更する。

Request Body schema: application/json

contractPacketFilterKeyId required	string (contractPacketFilterKeyId) 項目和名：パケットフィルタリング契約排他情報備考　　：排他確認用パラメータ。　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。
packetFilterEnabled required	boolean 項目和名：パケットフィルタリング契約ON/OFF 備考　　：「ON」の場合はtrue、「OFF」の場合はfalseを設定する。
note	string <= 200 characters 項目和名：操作履歴の備考備考　　：-

Responses

Request samples

Payload
Curl

Content type

application/json

{"contractPacketFilterKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d",
"packetFilterEnabled": true,
"note": "操作履歴の備考"
}

Response samples

Content type

application/json

{"jobId": "1"
}

アクセス品目API

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST：受付非同期方式
2. 内容
  アクセス回線の契約情報の参照・登録を行う

アクセス回線の契約一覧情報を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/contract/accessitem/accesslines

Response samples

200
401
403
500

Content type

application/json

{"total": 1,
"bandwidthList": [{"lineSeq": "1",
"enumberAct": "E000000010",
"enumberSby": "E000000020",
"menu": "PF_ACCESS_GW",
"isPfagw2L2": false,
"isUno": false,
"physicalInterface": "IF_100M",
"bandwidthType": "BANDWIDTH_SECURED",
"fixingBandwidth": "OFF",
"bandwidth": {"value": 100,
"unit": "MBPS"
},
"isQosPath": false,
"qos": "OFF",
"vlanControl": "OFF",
"office": "事業所A",
"contractor": "エンドユーザ企業A",
"endUserName": "エンドユーザA",
"address": "住所A",
"building": "住所A2"
}
],
"bandwidthKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

アクセス回線の契約情報を登録

Request Body schema: application/json

required	Array of objects
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
bandwidthKeyId required	string (bandwidthKeyId) 項目和名：帯域設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"bandwidthList": [{"lineSeq": "1",
"bandwidthType": "BANDWIDTH_SECURED",
"fixingBandwidth": "OFF",
"bandwidth": {"value": 100,
"unit": "MBPS"
},
"qos": "OFF",
"vlanControl": "OFF"
}
],
"note": "メッセージ",
"bandwidthKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

アクセス回線の契約一覧情報を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v2/contract/accessitem/accesslines

Response samples

200
401
403
500

Content type

application/json

{"total": 1,
"bandwidthList": [{"lineSeq": "1",
"enumberAct": "E000000010",
"enumberSby": "E000000020",
"menu": "PF_ACCESS_GW",
"isPfagw2L2": false,
"isUno": false,
"physicalInterface": "IF_100M",
"bandwidthType": "BANDWIDTH_SECURED",
"fixingBandwidth": "OFF",
"bandwidth": {"value": 100,
"unit": "MBPS"
},
"isQosPath": false,
"qos": "OFF",
"vlanControl": "OFF",
"office": "事業所A",
"contractor": "エンドユーザ企業A",
"endUserName": "エンドユーザA",
"address": "住所A",
"building": "住所A2"
}
],
"bandwidthKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

アクセス回線の契約情報を登録

Request Body schema: application/json

required	Array of objects
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
bandwidthKeyId required	string (bandwidthKeyId) 項目和名：帯域設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"bandwidthList": [{"lineSeq": "1",
"bandwidthType": "BANDWIDTH_SECURED",
"fixingBandwidth": "OFF",
"bandwidth": {"value": 100,
"unit": "MBPS"
},
"qos": "OFF",
"vlanControl": "OFF"
}
],
"note": "メッセージ",
"bandwidthKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

アクセス品目 CSVダウンロード API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  アクセス回線の契約一覧のcsvファイルを生成送信する機能

アクセス回線の契約一覧情報のCSVを取得

検索条件として「enumber」、「menu」、「bandwidthType」、「fixingBandwidth」、「qos」、「vlanControl」、「office」のいずれも指定しない場合、全件ダウンロードする。

query Parameters

tokenId required	string <uuid> Example: tokenId=ede66c43-9b9d-4222-93ed-5f11c96e08e2 項目和名：トークンID 備考　　：ログイン時に取得するトークンIDを設定
enumber	string <= 10 characters ^E[0-9]{8}0$ Example: enumber=E000000010 項目和名：E番号備考　　：全E番号を表示する場合には指定しない。
menu	string Enum: "PF_ACCESS_GW" "EXTEND_ETHERNET" "ETHERNET2" "ETHERNET2_PF" "BROADBAND_ACCESS3" "ETHERNET_LIGHT" "WIRELESS_ACCESS2" "PF_ACCESS_GW2" "MULTI_CLOUD_GW" Example: menu=PF_ACCESS_GW 項目和名：メニュー備考　　：以下のいずれかを指定する。　　　　　PF_ACCESS_GW:PFアクセスGW 　　　　　EXTEND_ETHERNET:エクステンドイーサ　　　　　ETHERNET2:イーサネット方式Ⅱ 　　　　　ETHERNET2_PF:イーサネット方式Ⅱ PF 　　　　　BROADBAND_ACCESS3:ブロードバンドアクセス方式Ⅲ 　　　　　ETHERNET_LIGHT:イーサネットライト　　　　　WIRELESS_ACCESS2:ワイヤレスアクセス方式Ⅱ 　　　　　PF_ACCESS_GW2:PFアクセスGWⅡ 　　　　　MULTI_CLOUD_GW:マルチクラウドGW 　　　　：全メニューを表示する場合には指定しない。
bandwidthType	string Enum: "BANDWIDTH_SECURED" "TRAFFICFREE" "BURST10" "BURST100" "BESTEFFORT" Example: bandwidthType=BANDWIDTH_SECURED 項目和名：帯域タイプ備考　　：以下のいずれかを指定する。　　　　　BANDWIDTH_SECURED:帯域確保　　　　　TRAFFICFREE:トラフィックフリー　　　　　BURST10:バースト10 　　　　　BURST100:バースト100 　　　　　BESTEFFORT:ベストエフォート　　　　　全帯域タイプを表示する場合には指定しない。
fixingBandwidth	string Enum: "ON" "OFF" Example: fixingBandwidth=OFF 項目和名：帯域固定備考　　：ON：固定あり　　　　　OFF：固定なし　　　　　帯域固定ON/OFF両方を表示する場合には指定しない。
qos	string Enum: "ON" "OFF" Example: qos=OFF 項目和名：QoS 備考　　：ON: 有　　　　　OFF: 無　　　　　QoS ON/OFF両方を表示する場合には指定しない。
vlanControl	string Enum: "ON" "OFF" Example: vlanControl=OFF 項目和名：VLAN制御備考　　：ON: ON 　　　　　OFF：OFF 　　　　　VLAN制御ON/OFF両方を表示する場合には指定しない。
office	string <= 85 characters Example: office=事業所A 項目和名：事業所名備考　　：全事業所名を表示する場合には指定しない。

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v1/contract/accessitem/accessline/csv?tokenId=ede66c43-9b9d-4222-93ed-5f11c96e08e2&enumber=E000000010&menu=PF_ACCESS_GW&bandwidthType=BANDWIDTH_SECURED&fixingBandwidth=OFF&qos=OFF&vlanControl=OFF&office=%E4%BA%8B%E6%A5%AD%E6%89%80A'

Response samples

400
401
403
500

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

Type1インターネットサイトゾーン取得API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  Type1インターネットサイトゾーン設定の取得を行う。

Type1インターネットサイトゾーン情報を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/sitezones/internet/type1

Response samples

200
401
403
500

Content type

application/json

{"addressTotal": 1,
"addressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス1",
"ipAddress": "24.23.1.6/32",
"zoneId": "obj41988"
}
],
"fqdnTotal": 1,
"fqdnList": [{"fqdnId": "obj44559",
"fqdnName": "FQDN1",
"fqdn": "example.com",
"zoneId": "obj41988"
}
],
"zone": {"zoneId": "obj41988",
"zoneName": "ゾーン1"
},
"type1SiteZoneKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Type1インターネットサイト設定API

概要
1. インターフェースタイプ
  受付非同期方式
2. 内容
  Type1インターネットアドレスの追加・変更・削除を行う。

Type1インターネットサイト設定情報を一括更新（追加/変更/削除）

Request Body schema: application/json

required	Array of objects 項目和名：アドレスリスト備考　　：0件の場合は空配列
required	Array of objects 項目和名：FQDNリスト備考　　：0件の場合は空配列
type1SiteZoneKeyId required	string (type1SiteZoneKeyId) 項目和名：Type1サイトゾーン設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"addressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス1",
"ipAddress": "24.23.1.6/32",
"zoneId": "obj41988"
}
],
"fqdnList": [{"fqdnId": "obj44559",
"fqdnName": "FQDN1",
"fqdn": "example.com",
"zoneId": "string"
}
],
"type1SiteZoneKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

Type1インターネットゾーン設定API

概要
1. インターフェースタイプ
  受付非同期方式
2. 内容
  Type1インターネットゾーンの追加・変更・削除を行う。

Type1インターネットゾーンを追加

Request Body schema: application/json

zoneName	string <= 20 characters 項目和名：ゾーン名備考　　：ゾーン名未設定時、「Unassigned」を設定する。　　　　　「Unassigned」が使用済みの場合、「Unassigned(2)」を設定し　　　　　以降のゾーン名は括弧内の数値を1ずつ増加させた名前を設定する。
type1SiteZoneKeyId required	string (type1SiteZoneKeyId) 項目和名：Type1サイトゾーン設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"zoneName": "ゾーン1",
"type1SiteZoneKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

Type1インターネットゾーンを変更

path Parameters

zoneId

required

string <= 22 characters

Example: obj44557

項目和名：ゾーンID
備考　　：アドレスオブジェクトの主キー
　　　　　"obj"+"数値"の形式
　　　　　Type1インターネットサイトゾーン取得APIから取得か、または
　　　　　Type1インターネットゾーン設定API（POSTメソッド）のレスポンスから取得

Request Body schema: application/json

zoneName	string <= 20 characters 項目和名：ゾーン名備考　　：ゾーン名を削除する場合はNULLを指定
type1SiteZoneKeyId required	string (type1SiteZoneKeyId) 項目和名：Type1サイトゾーン設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"zoneName": "ゾーン1",
"type1SiteZoneKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

Type1インターネットゾーンを削除

path Parameters

zoneId

required

string <= 22 characters

Example: obj44557

項目和名：ゾーンID
備考　　：アドレスオブジェクトの主キー
　　　　　"obj"+"数値"の形式
　　　　　Type1インターネットサイトゾーン取得APIから取得か、または
　　　　　Type1インターネットゾーン設定API（POSTメソッド）のレスポンスから取得

Request Body schema: application/json

type1SiteZoneKeyId

required

string (type1SiteZoneKeyId)

項目和名：Type1サイトゾーン設定排他情報
備考　　：排他確認用パラメータ
　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"type1SiteZoneKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

Type1エクストラサイトゾーン取得API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  Type1エクストラサイトゾーン設定の取得を行う。

Type1エクストラサイトゾーン取得情報を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/sitezones/extra/type1

Response samples

200
401
403
500

Content type

application/json

{"siteTotal": 1,
"siteList": [{"siteId": "obj44558",
"siteName": "サイト1",
"addressTotal": 1,
"addressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス1",
"ipAddress": "24.23.1.6/32",
"zoneId": "obj41988"
}
]
}
],
"zone": {"zoneId": "obj41988",
"zoneName": "ゾーン1"
},
"type1SiteZoneKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Type1エクストラサイト設定API

概要
1. インターフェースタイプ
  受付非同期方式
2. 内容
  Type1エクストラアドレスの追加・変更・削除を行う。

Type1エクストラサイト設定情報を追加

Request Body schema: application/json

siteName required	string <= 20 characters 項目和名：サイト名備考　　：新規にサイトを作成する場合は必須
required	Array of objects 項目和名：アドレスリスト備考　　：0件の場合は空配列
type1SiteZoneKeyId required	string (type1SiteZoneKeyId) 項目和名：Type1サイトゾーン設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"siteName": "サイト1",
"addressList": [{"ipAddressName": "アドレス1",
"ipAddress": "24.23.1.6/32",
"zoneId": "obj41988"
}
],
"type1SiteZoneKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

Type1エクストラサイト設定情報を変更

path Parameters

siteId

required

string <= 22 characters

Example: obj44558

項目和名：サイトID
備考　　：サイトオブジェクトの主キー
　　　　　"obj"+"数値"の形式
　　　　　既存サイトにアドレスを追加する場合は必須

Request Body schema: application/json

siteName required	string (siteName) <= 20 characters 項目和名：サイト名備考　　：-
required	Array of objects 項目和名：アドレスリスト備考　　：0件の場合は空配列
type1SiteZoneKeyId required	string (type1SiteZoneKeyId) 項目和名：Type1サイトゾーン設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"siteName": "サイト1",
"addressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス1",
"ipAddress": "24.23.1.6/32",
"zoneId": "obj41988"
}
],
"type1SiteZoneKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

Type1エクストラサイト設定情報を削除

Request Body schema: application/json

siteList required	Array of strings[ items <= 22 characters ]
type1SiteZoneKeyId required	string (type1SiteZoneKeyId) 項目和名：Type1サイトゾーン設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"siteList": ["obj44560"
],
"type1SiteZoneKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

Type1エクストラゾーン設定API

概要
1. インターフェースタイプ
  受付非同期方式
2. 内容
  Type1エクストラゾーンの追加・変更・削除を行う。

Type1エクストラゾーンを追加

Request Body schema: application/json

zoneName	string <= 20 characters 項目和名：ゾーン名備考　　：ゾーン名未設定時、「Unassigned」を設定する。　　　　　「Unassigned」が使用済みの場合、「Unassigned(2)」を設定し　　　　　以降のゾーン名は括弧内の数値を1ずつ増加させた名前を設定する。
type1SiteZoneKeyId required	string (type1SiteZoneKeyId) 項目和名：Type1サイトゾーン設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"zoneName": "ゾーン1",
"type1SiteZoneKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

Type1エクストラゾーンを変更

path Parameters

zoneId

required

string <= 22 characters

Example: obj44557

項目和名：ゾーンID
備考　　：アドレスオブジェクトの主キ
　　　　　"obj"+"数値"の形式
　　　　　Type1エクストラサイトゾーン取得APIから取得か、または
　　　　　Type1エクストラゾーン設定API（POSTメソッド）のレスポンスから取得

Request Body schema: application/json

zoneName	string <= 20 characters 項目和名：ゾーン名備考　　：ゾーン名を削除する場合はNULLを指定
type1SiteZoneKeyId required	string (type1SiteZoneKeyId) 項目和名：Type1サイトゾーン設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"zoneName": "ゾーン1",
"type1SiteZoneKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

Type1エクストラゾーンを削除

path Parameters

zoneId

required

string <= 22 characters

Example: obj44557

項目和名：ゾーンID
備考　　：アドレスオブジェクトの主キー
　　　　　"obj"+"数値"の形式
　　　　　Type1エクストラサイトゾーン取得APIから取得か、または
　　　　　Type1エクストラゾーン設定API（POSTメソッド）のレスポンスから取得

Request Body schema: application/json

type1SiteZoneKeyId

required

string (type1SiteZoneKeyId)

項目和名：Type1サイトゾーン設定排他情報
備考　　：排他確認用パラメータ
　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"type1SiteZoneKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

Type1プライベートサイトゾーン取得API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  Type1プライベートサイトゾーン設定の取得を行う。

Type1プライベートサイトゾーン取得情報を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/sitezones/private/type1

Response samples

200
401
403
500

Content type

application/json

{"lineTotal": 1,
"lineList": [{"enumber": "E000000010",
"accessType": "ETHERNET_L2",
"isEnable": true,
"siteTotal": 1,
"siteList": [{"siteId": "obj44558",
"siteName": "サイト1",
"vlanIdType": "SPECIFIED",
"vlanId": 1111,
"addressTotal": 1,
"addressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス1",
"ipAddress": "24.23.1.6/32",
"zoneId": "obj41988"
}
]
}
]
}
],
"zoneTotal": 1,
"zoneList": [{"zoneId": "obj41988",
"zoneName": "ゾーン1"
}
],
"type1SiteZoneKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Type1プライベートサイト設定API

概要
1. インターフェースタイプ
  受付非同期方式
2. 内容
  Type1プライベートアドレスの追加・変更・削除を行う。

Type1プライベートサイト設定情報を追加

path Parameters

enumber

required

string <= 10 characters ^E[0-9]{8}0$

Example: E000000010

項目和名：E番号
備考　　：主キー
　　　　　Type1プライベートサイトゾーン取得APIから取得

Request Body schema: application/json

required	object (postPrivateSite)
type1SiteZoneKeyId required	string (type1SiteZoneKeyId) 項目和名：Type1サイトゾーン設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"site": {"siteName": "サイト1",
"vlanIdType": "SPECIFIED",
"vlanId": 1111
},
"type1SiteZoneKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

Type1プライベートサイト設定情報を変更

path Parameters

enumber required	string <= 10 characters ^E[0-9]{8}0$ Example: E000000010 項目和名：E番号備考　　：主キー　　　　　Type1プライベートサイトゾーン取得APIから取得
siteId required	string <= 22 characters Example: obj44558 項目和名：サイトID 備考　　：サイトオブジェクトの主キー　　　　　"obj"+"数値"の形式

Request Body schema: application/json

required	object (putPrivateSite)
type1SiteZoneKeyId required	string (type1SiteZoneKeyId) 項目和名：Type1サイトゾーン設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"site": {"siteName": "サイト1",
"addressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス1",
"ipAddress": "24.23.1.6/32",
"zoneId": "obj41988"
}
]
},
"type1SiteZoneKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

Type1プライベートサイト設定情報を削除

Request Body schema: application/json

required	Array of objects
type1SiteZoneKeyId required	string (type1SiteZoneKeyId) 項目和名：Type1サイトゾーン設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"lineList": [{"enumber": "E000000010",
"siteIdList": ["obj44559"
]
}
],
"type1SiteZoneKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

Type1プライベートゾーン設定API

概要
1. インターフェースタイプ
  受付非同期方式
2. 内容
  Type1プライベートゾーンの追加・変更・削除を行う。

Type1プライベートゾーンを追加

Request Body schema: application/json

zoneName	string <= 20 characters 項目和名：ゾーン名備考　　：ゾーン名未設定時、「Unassigned」を設定する。　　　　　「Unassigned」が使用済みの場合、「Unassigned(2)」を設定し　　　　　以降のゾーン名は括弧内の数値を1ずつ増加させた名前を設定する。
type1SiteZoneKeyId required	string (type1SiteZoneKeyId) 項目和名：Type1サイトゾーン設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"zoneName": "ゾーン1",
"type1SiteZoneKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

Type1プライベートゾーンを変更

path Parameters

zoneId

required

string <= 22 characters

Example: obj44557

備考　　：アドレスオブジェクトの主キー
　　　　　"obj"+"数値"の形式
　　　　　Type1プライベートサイトゾーン取得APIから取得か、または
　　　　　Type1プライベートゾーン設定API（POSTメソッド）のレスポンスから取得

Request Body schema: application/json

zoneName	string <= 20 characters 項目和名：ゾーン名備考　　：ゾーン名を削除する場合はNULLを指定
type1SiteZoneKeyId required	string (type1SiteZoneKeyId) 項目和名：Type1サイトゾーン設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"zoneName": "ゾーン1",
"type1SiteZoneKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

Type1プライベートゾーンを削除

Request Body schema: application/json

zoneIdList required	Array of strings[ items <= 22 characters ]
type1SiteZoneKeyId required	string (type1SiteZoneKeyId) 項目和名：Type1サイトゾーン設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"zoneIdList": ["obj44560"
],
"type1SiteZoneKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

NW設計情報 CSVダウンロード API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  NW設計情報のcsvファイルを生成、送信する。

NW設計情報の一覧のCSVを取得

query Parameters

tokenId

required

string <uuid>

Example: tokenId=ede66c43-9b9d-4222-93ed-5f11c96e08e2

項目和名：トークンID
備考　　：ログイン時に取得するトークンIDを設定

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v1/network/information/csv?tokenId=ede66c43-9b9d-4222-93ed-5f11c96e08e2'

Response samples

401
403
404
500

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

Type4インターネットサイト取得API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  Type4インターネットサイト設定の取得を行う

Type4インターネットサイト情報を取得

path Parameters

type4Id

required

string^TY4[0-9]{5}$

Example: TY412345

項目和名：Type4ID
備考　　：主キー
　　　　　アプライアンス情報APIより取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/sites/internet/type4/TY412345

Response samples

200
400
401
403
500

Content type

application/json

{"addressTotal": 1,
"addressList": [{"ipAddressId": "obj44557",
"ipAddressName": "IPアドレス1",
"ipAddress": "24.23.1.6/32",
"isPolicyInUse": true
}
],
"fqdnTotal": 1,
"fqdnList": [{"fqdnId": "obj44559",
"fqdnName": "FQDN1",
"fqdn": "example.com",
"isPolicyInUse": true
}
],
"type4SiteKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Type4インターネットサイト設定API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  Type4インターネットアドレスの追加・変更・削除を行う

Type4インターネットサイト設定情報を一括更新（追加/変更/削除）

path Parameters

type4Id

required

string^TY4[0-9]{5}$

Example: TY412345

項目和名：Type4ID
備考　　：主キー
　　　　　アプライアンス情報APIより取得

Request Body schema: application/json

required	Array of objects (Address) 項目和名：アドレスリスト備考　　：0件の場合は空配列
required	Array of objects (Fqdn) 項目和名：FQDNリスト備考　　：0件の場合は空配列
type4SiteKeyId required	string 項目和名：Type4サイト設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"addressList": [{"ipAddressId": "obj44557",
"ipAddressName": "IPアドレス1",
"ipAddress": "24.23.1.6/32"
}
],
"fqdnList": [{"fqdnId": "obj44559",
"fqdnName": "FQDN1",
"fqdn": "example.com"
}
],
"type4SiteKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

400
401
403
409
500

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

Type4エクストラサイト取得API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  Type4エクストラサイト設定の取得を行う

Type4エクストラサイト情報を取得

path Parameters

type4Id

required

string^TY4[0-9]{5}$

Example: TY412345

項目和名：Type4ID
備考　　：主キー
　　　　　アプライアンス情報APIより取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/sites/extra/type4/TY412345

Response samples

200
400
401
403
500

Content type

application/json

{"siteTotal": 1,
"siteList": [{"siteId": "obj44558",
"siteName": "サイト1",
"addressTotal": 1,
"addressList": [{"ipAddressId": "obj44557",
"ipAddressName": "IPアドレス1",
"ipAddress": "24.23.1.6/32",
"isPolicyInUse": true
}
]
}
],
"type4SiteKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Type4エクストラサイト設定API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  Type4エクストラアドレスの追加・変更・削除を行う

Type4エクストラサイト設定情報を追加

path Parameters

type4Id

required

string^TY4[0-9]{5}$

Example: TY412345

項目和名：Type4ID
備考　　：主キー
　　　　　アプライアンス情報APIより取得

Request Body schema: application/json

siteName required	string <= 20 characters 項目和名：サイト名備考　　：-
type4SiteKeyId required	string 項目和名：Type4サイト設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"siteName": "サイト1",
"type4SiteKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"siteId": "obj44560",
"type4SiteKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Type4エクストラサイト設定情報を変更

path Parameters

siteId required	string <= 22 characters Example: obj44558 項目和名：サイトID 備考　　：サイトオブジェクトの主キー　　　　　"obj"+"数値"の形式
type4Id required	string^TY4[0-9]{5}$ Example: TY412345 項目和名：Type4ID 備考　　：主キー　　　　　アプライアンス情報APIより取得

Request Body schema: application/json

siteName required	string <= 20 characters 項目和名：サイト名備考　　：-
required	Array of objects (Address) 項目和名：アドレスリスト備考　　：0件の場合は空配列
type4SiteKeyId required	string 項目和名：Type4サイト設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"siteName": "サイト1",
"addressList": [{"ipAddressId": "obj44557",
"ipAddressName": "IPアドレス1",
"ipAddress": "24.23.1.6/32"
}
],
"type4SiteKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

400
401
403
409
500

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

Type4エクストラサイト設定情報を削除

path Parameters

type4Id

required

string^TY4[0-9]{5}$

Example: TY412345

項目和名：Type4ID
備考　　：主キー
　　　　　アプライアンス情報APIより取得

Request Body schema: application/json

siteList required	Array of strings[ items <= 22 characters ]
type4SiteKeyId required	string 項目和名：Type4サイト設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"siteList": ["obj44560"
],
"type4SiteKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

400
401
403
409
500

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

ゾーン関係API

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST：受付非同期方式
2. 内容
  ゾーン関係情報の参照を行う。

ゾーン関係情報の一覧を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/zone/type1/relations

Response samples

200
401
403
500

Content type

application/json

{"total": 1,
"zoneRelationList": [{"zoneRelationId": "1",
"srcZoneId": "obj41989",
"srcZoneName": "エクストラゾーン",
"srcZoneType": "EXTRA",
"dstZoneId": "obj41988",
"dstZoneName": "プライベートゾーン",
"dstZoneType": "PRIVATE"
}
],
"zoneRelationKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

ゾーン関係情報の追加

Request Body schema: application/json

srcZoneId required	string <= 22 characters 項目和名：接続元ゾーンID 備考　　：ゾーンオブジェクトの主キー　　　　　　"obj"+"数値"の形式　　　　　Type1インターネットサイトゾーン取得API, Type1エクストラサイトゾーン取得API, 　　　　　Type1プライベートサイトゾーン取得APIから取得
dstZoneId required	string <= 22 characters 項目和名：接続先ゾーンID 備考　　：ゾーンオブジェクトの主キー　　　　　　"obj"+"数値"の形式　　　　　Type1インターネットサイトゾーン取得API, Type1エクストラサイトゾーン取得API, 　　　　　Type1プライベートサイトゾーン取得APIから取得
zoneRelationKeyId required	string (zoneRelationKeyId) 項目和名：ゾーン関係設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"srcZoneId": "obj41989",
"dstZoneId": "obj41988",
"zoneRelationKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

ゾーン関係情報の削除

path Parameters

zoneRelationId

required

string <= 19 characters

Example: 1

項目和名：ゾーン関係ID
備考　　：主キー
　　　　　ゾーン関係APIのGET/POSTメソッドから取得

Request Body schema: application/json

zoneRelationKeyId

required

string (zoneRelationKeyId)

項目和名：ゾーン関係設定排他情報
備考　　：排他確認用パラメータ
　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"zoneRelationKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

プラットフォームゲートウェイゾーンAPI

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST：受付非同期方式
2. 内容
  ①プラットフォームゲートウェイのアドレス設定の取得・追加・変更・削除を行う。
  ②プラットフォームゲートウェイのゾーン関連IDの作成、削除を行う。

プラットフォームゲートウェイのアドレス情報を取得

path Parameters

enumberAct

required

string <= 10 characters ^E[0-9]{8}0$

Example: E000000010

項目和名：E番号(ACT)
備考　　：主キー
　　　　　サービスメニューAPI（イントラネットFW）のGETメソッドから取得したACT側のE番号

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/pfgw/zone/E000000010

Response samples

Content type

application/json

{"wvs2AddressTotal": 1,
"wvs2AddressList": [{"ipAddressId": "obj44554",
"ipAddress": "24.23.1.6/32"
}
],
"kcpsAddressTotal": 1,
"kcpsAddressList": [{"ipAddressId": "obj44554",
"ipAddress": "24.23.1.6/32"
}
],
"zoneIdTotal": 2,
"zoneIdList": [{"srcZoneId": "obj44555",
"dstZoneId": "obj44556"
}
],
"wvs2ZoneId": "obj44555",
"kcpsZoneId": "obj44556",
"wvs2ToKcpsZoneRelationId": "1",
"kcpsToWvs2ZoneRelationId": "2",
"pfgwAddressKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

プラットフォームゲートウェイ情報（アドレス、ゾーン関係ID）を更新（追加、変更、削除）

path Parameters

enumberAct

required

string <= 10 characters ^E[0-9]{8}0$

Example: E000000010

項目和名：E番号(ACT)
備考　　：主キー
　　　　　サービスメニューAPI（イントラネットFW）のGETメソッドから取得したACT側のE番号

Request Body schema: application/json

wvs2AddressList required	Array of strings 項目和名：アドレスリスト(WVS2) 備考　　：0件の場合は空配列を設定する。
kcpsAddressList required	Array of strings 項目和名：アドレスリスト(KCPS) 備考　　：0件の場合は空配列を設定する。
required	Array of objects 項目和名：接続元、接続先ゾーンIDのリスト備考　　：WVS2ゾーンID、またはKCPSゾーンIDを設定する。　　　　　リストは最大2件まで。0件の場合は空配列を設定する。
pfgwAddressKeyId required	string (pfgwAddressKeyId) 項目和名：プラットフォームゲートウェイアドレス設定排他情報備考　　：排他確認用　　　　：設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"wvs2AddressList": ["24.23.1.6/32"
],
"kcpsAddressList": ["24.23.1.7/32"
],
"zoneIdList": [{"srcZoneId": "obj44555",
"dstZoneId": "obj44556"
}
],
"pfgwAddressKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

ポリシーAPI

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST：受付非同期方式
2. 内容
  ポリシー設定の一覧取得や追加、変更、削除を行う

Type4のポリシー設定の一覧を取得する

path Parameters

type4Id

required

string <= 8 characters ^TY4[0-9]{5}$

Example: TY412345

項目和名：Type4Id
備考　　：主キー

query Parameters

policyType

string

Enum: "UTM" "IFW" "IPMASQUERADE" "NAT" "UTM_IPMASQUERADE" "UTM_NAT" "UTM_IPMASQUERADE_NAT" "IFW_IPMASQUERADE" "IFW_NAT" "IFW_IPMASQUERADE_NAT" "IPMASQUERADE_NAT"

Example: policyType=UTM

項目和名：ポリシー種別
備考　　：アプライアンスの組み合わせを指定する。
指定省略時、type4Idに紐づくすべての状態取得を行う。
　UTM ：UTM
　IFW ：IFW
　IPMASQUERADE ：IP Masquerade
　NAT ：Destination NAT
　UTM_IPMASQUERADE ：UTM,IP Masquerade
　UTM_NAT ：UTM,Destination NAT
　UTM_IPMASQUERADE_NAT：UTM,IP Masquerade,Destination NAT
　IFW_IPMASQUERADE ：IFW,IP Masquerade
　IFW_NAT ：IFW,Destination NAT
　IFW_IPMASQUERADE_NAT：IFW,IP Masquerade,Destination NAT
　IPMASQUERADE_NAT ：IP Masquerade,Destination NAT

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v1/network/policy/type4/TY412345?policyType=UTM'

Response samples

200
400
401
403
500

Content type

application/json

{"policyUtmType4": {"internetToAccessPointTotal": 1,
"internetToAccessPointPolicyList": [{"policyObjectId": "2",
"policyId": "1001",
"srcAddress": {"srcAddressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス名1",
"ipAddress": "24.23.1.6/32"
}
],
"srcFqdnList": [{"fqdnId": "obj44557",
"fqdnName": "FQDN1",
"fqdn": "example.com"
}
],
"srcCountryList": [{"countrySeq": "1",
"country": "Japan"
}
]
},
"dstAddress": {"dstAddressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス名1",
"ipAddress": "24.23.1.6/32"
}
]
},
"serviceOption": "ANY",
"defaultServiceList": [{"serviceSeq": "3",
"serviceName": "FTP",
"protocol": "TCP",
"portNumber": "80-90,100"
}
],
"customServiceList": [{"customServiceSeq": "3",
"serviceName": "FTP",
"protocol": "TCP",
"portNumber": "80-90,100"
}
],
"profile": {"internetFW": "USER",
"profileInternetFw": {"profileInternetFwSeq": "5",
"profileInternetFwName": "プロファイル名"
},
"idsIps": "OFF",
"urlFiltering": "USER",
"profileUrl": {"profileUrlSeq": "5",
"profileUrlName": "プロファイル名"
},
"webAntiVirus": "OFF",
"mailAntiVirus": "OFF",
"isAntiSpyware": false
},
"actionType": "DENY",
"isLogOutput": true,
"isPolicyStatus": false,
"policyCategoryInfo": "CUSTOM_POLICY",
"description": "メモ"
}
],
"accessPointToInternetTotal": 1,
"accessPointToInternetPolicyList": [{"policyObjectId": "2",
"policyId": "1001",
"srcAddress": {"srcAddressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス名1",
"ipAddress": "24.23.1.6/32"
}
]
},
"dstAddress": {"dstAddressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス名1",
"ipAddress": "24.23.1.6/32"
}
],
"dstFqdnList": [{"fqdnId": "obj44557",
"fqdnName": "FQDN1",
"fqdn": "example.com"
}
],
"dstCountryList": [{"countrySeq": "1",
"country": "Japan"
}
]
},
"serviceOption": "ANY",
"defaultServiceList": [{"serviceSeq": "3",
"serviceName": "FTP",
"protocol": "TCP",
"portNumber": "80-90,100"
}
],
"customServiceList": [{"customServiceSeq": "3",
"serviceName": "FTP",
"protocol": "TCP",
"portNumber": "80-90,100"
}
],
"profile": {"internetFW": "USER",
"profileInternetFw": {"profileInternetFwSeq": "5",
"profileInternetFwName": "プロファイル名"
},
"idsIps": "OFF",
"urlFiltering": "USER",
"profileUrl": {"profileUrlSeq": "5",
"profileUrlName": "プロファイル名"
},
"webAntiVirus": "OFF",
"mailAntiVirus": "OFF",
"isAntiSpyware": false
},
"actionType": "DENY",
"isLogOutput": true,
"isPolicyStatus": false,
"policyCategoryInfo": "CUSTOM_POLICY",
"description": "メモ"
}
]
},
"policyIfwType4": {"internetToAccessPointTotal": 1,
"internetToAccessPointPolicyList": [{"policyObjectId": "2",
"policyId": "1001",
"srcAddress": {"srcAddressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス名1",
"ipAddress": "24.23.1.6/32"
}
],
"srcFqdnList": [{"fqdnId": "obj44557",
"fqdnName": "FQDN1",
"fqdn": "example.com"
}
],
"srcCountryList": [{"countrySeq": "1",
"country": "Japan"
}
]
},
"dstAddress": {"dstAddressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス名1",
"ipAddress": "24.23.1.6/32"
}
]
},
"serviceOption": "ANY",
"defaultServiceList": [{"serviceSeq": "3",
"serviceName": "FTP",
"protocol": "TCP",
"portNumber": "80-90,100"
}
],
"customServiceList": [{"customServiceSeq": "3",
"serviceName": "FTP",
"protocol": "TCP",
"portNumber": "80-90,100"
}
],
"profile": {"internetFW": "USER",
"profileInternetFw": {"profileInternetFwSeq": "5",
"profileInternetFwName": "プロファイル名"
}
},
"actionType": "DENY",
"isLogOutput": true,
"isPolicyStatus": false,
"policyCategoryInfo": "CUSTOM_POLICY",
"description": "メモ"
}
],
"accessPointToInternetTotal": 1,
"accessPointToInternetPolicyList": [{"policyObjectId": "2",
"policyId": "1001",
"srcAddress": {"srcAddressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス名1",
"ipAddress": "24.23.1.6/32"
}
]
},
"dstAddress": {"dstAddressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス名1",
"ipAddress": "24.23.1.6/32"
}
],
"dstFqdnList": [{"fqdnId": "obj44557",
"fqdnName": "FQDN1",
"fqdn": "example.com"
}
],
"dstCountryList": [{"countrySeq": "1",
"country": "Japan"
}
]
},
"serviceOption": "ANY",
"defaultServiceList": [{"serviceSeq": "3",
"serviceName": "FTP",
"protocol": "TCP",
"portNumber": "80-90,100"
}
],
"customServiceList": [{"customServiceSeq": "3",
"serviceName": "FTP",
"protocol": "TCP",
"portNumber": "80-90,100"
}
],
"profile": {"internetFW": "USER",
"profileInternetFw": {"profileInternetFwSeq": "5",
"profileInternetFwName": "プロファイル名"
}
},
"actionType": "DENY",
"isLogOutput": true,
"isPolicyStatus": false,
"policyCategoryInfo": "CUSTOM_POLICY",
"description": "メモ"
}
]
},
"policyIPMasqueradeType4": {"total": 1,
"policyList": [{"policyObjectId": "2",
"policyId": "1001",
"srcAddressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス名1",
"ipAddress": "24.23.1.6/32"
}
],
"dstAddressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス名1",
"ipAddress": "24.23.1.6/32"
}
],
"ipPoolList": [{"ipPoolSeq": "4",
"ipPoolName": "pool1",
"globalIpAddress": "192.168.1.1/29",
"description": "メモ"
}
],
"isPolicyStatus": false,
"policyCategoryInfo": "CUSTOM_POLICY",
"description": "メモ"
}
]
},
"policyNatType4": {"total": 1,
"policyList": [{"policyObjectId": "2",
"policyId": "1001",
"srcAddressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス名1",
"ipAddress": "24.23.1.6/32"
}
],
"ipMapping": {"virtualIpAddressSeq": "4",
"ipMappingName": "pmap1",
"description": "備考"
},
"isPolicyStatus": false,
"description": "メモ"
}
]
},
"policyKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Type4のポリシー設定を更新する

path Parameters

type4Id

required

string <= 8 characters ^TY4[0-9]{5}$

Example: TY412345

項目和名：Type4Id
備考　　：主キー

query Parameters

policyType

required

string

Enum: "UTM" "IFW" "IPMASQUERADE" "NAT" "UTM_IPMASQUERADE" "UTM_NAT" "UTM_IPMASQUERADE_NAT" "IFW_IPMASQUERADE" "IFW_NAT" "IFW_IPMASQUERADE_NAT" "IPMASQUERADE_NAT"

Example: policyType=UTM

項目和名：ポリシー種別
備考　　：アプライアンスの組み合わせを指定する。
　指定省略時、一括更新を行う。
　UTM ：UTM
　IFW ：IFW
　IPMASQUERADE ：IP Masquerade
　NAT ：Destination NAT
　UTM_IPMASQUERADE ：UTM,IP Masquerade
　UTM_NAT ：UTM,Destination NAT
　UTM_IPMASQUERADE_NAT：UTM,IP Masquerade,Destination NAT
　IFW_IPMASQUERADE ：IFW,IP Masquerade
　IFW_NAT ：IFW,Destination NAT
　IFW_IPMASQUERADE_NAT：IFW,IP Masquerade,Destination NAT
　IPMASQUERADE_NAT ：IP Masquerade,Destination NAT

Request Body schema: application/json

	object (PolicyUtmType4PutModel) 項目和名：Type4ポリシー(UTM) 備考　　：クエリパラメータのポリシー種別の対象外の場合と　　　　　Type4ポリシー(IFW)契約時はNULLを設定
	object (PolicyIfwType4PutModel) 項目和名：Type4ポリシー(IFW) 備考　　：クエリパラメータのポリシー種別の対象外の場合と　　　　　Type4ポリシー(UTM)契約時はNULLを設定
	object (PolicyIPMasqueradeType4PutModel) 項目和名：Type4ポリシー(IP Masquerade) 備考　　：クエリパラメータのポリシー種別の対象外の場合はNULLを設定
	object (PolicyNatType4PutModel) 項目和名：Type4ポリシー(Destination NAT) 備考　　：クエリパラメータのポリシー種別の対象外の場合はNULLを設定
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
policyKeyId required	string (policyKeyId) 項目和名：ポリシー設定排他情報備考　　：排他確認用パラメータ　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"policyUtmType4": {"internetToAccessPointPolicyList": [{"policyObjectId": "2",
"policyId": "1001",
"srcAddress": {"srcAddressList": ["obj44557"
],
"srcFqdnList": ["obj44557"
],
"srcCountryList": ["1"
]
},
"dstAddress": {"dstAddressList": ["obj44557"
]
},
"serviceOption": "ANY",
"defaultServiceList": ["3"
],
"customServiceList": ["3"
],
"profile": {"internetFW": "USER",
"profileInternetFw": {"profileInternetFwSeq": "5"
},
"idsIps": "OFF",
"urlFiltering": "USER",
"profileUrl": {"profileUrlSeq": "5"
},
"webAntiVirus": "OFF",
"mailAntiVirus": "OFF",
"isAntiSpyware": false
},
"actionType": "DENY",
"isLogOutput": true,
"isPolicyStatus": false,
"policyCategoryInfo": "CUSTOM_POLICY",
"description": "メモ"
}
],
"accessPointToInternetPolicyList": [{"policyObjectId": "2",
"policyId": "1001",
"srcAddress": {"srcAddressList": ["obj44557"
]
},
"dstAddress": {"dstAddressList": ["obj44557"
],
"dstFqdnList": ["obj44557"
],
"dstCountryList": ["1"
]
},
"serviceOption": "ANY",
"defaultServiceList": ["3"
],
"customServiceList": ["3"
],
"profile": {"internetFW": "USER",
"profileInternetFw": {"profileInternetFwSeq": "5"
},
"idsIps": "OFF",
"urlFiltering": "USER",
"profileUrl": {"profileUrlSeq": "5"
},
"webAntiVirus": "OFF",
"mailAntiVirus": "OFF",
"isAntiSpyware": false
},
"actionType": "DENY",
"isLogOutput": true,
"isPolicyStatus": false,
"policyCategoryInfo": "CUSTOM_POLICY",
"description": "メモ"
}
]
},
"policyIfwType4": {"internetToAccessPointPolicyList": [{"policyObjectId": "2",
"policyId": "1001",
"srcAddress": {"srcAddressList": ["obj44557"
],
"srcFqdnList": ["obj44557"
],
"srcCountryList": ["1"
]
},
"dstAddress": {"dstAddressList": ["obj44557"
]
},
"serviceOption": "ANY",
"defaultServiceList": ["3"
],
"customServiceList": ["3"
],
"profile": {"internetFW": "USER",
"profileInternetFw": {"profileInternetFwSeq": "5"
}
},
"actionType": "DENY",
"isLogOutput": true,
"isPolicyStatus": false,
"policyCategoryInfo": "CUSTOM_POLICY",
"description": "メモ"
}
],
"accessPointToInternetPolicyList": [{"policyObjectId": "2",
"policyId": "1001",
"srcAddress": {"srcAddressList": ["obj44557"
]
},
"dstAddress": {"dstAddressList": ["obj44557"
],
"dstFqdnList": ["obj44557"
],
"dstCountryList": ["1"
]
},
"serviceOption": "ANY",
"defaultServiceList": ["3"
],
"customServiceList": ["3"
],
"profile": {"internetFW": "USER",
"profileInternetFw": {"profileInternetFwSeq": "5"
}
},
"actionType": "DENY",
"isLogOutput": true,
"isPolicyStatus": false,
"policyCategoryInfo": "CUSTOM_POLICY",
"description": "メモ"
}
]
},
"policyIPMasqueradeType4": {"policyList": [{"policyObjectId": "2",
"policyId": "1001",
"srcAddressList": ["obj44557"
],
"dstAddressList": ["obj44557"
],
"ipPoolList": ["4"
],
"isPolicyStatus": false,
"policyCategoryInfo": "CUSTOM_POLICY",
"description": "メモ"
}
]
},
"policyNatType4": {"policyList": [{"policyObjectId": "2",
"policyId": "1001",
"srcAddressList": ["obj44557"
],
"ipMapping": {"virtualIpAddressSeq": "4"
},
"isPolicyStatus": false,
"description": "メモ"
}
]
},
"note": "メッセージ",
"policyKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

Type1のポリシー設定の一覧を取得する

query Parameters

policyType

string

Enum: "UTM" "IFW" "IPMASQUERADE" "NAT" "UTM_IPMASQUERADE" "UTM_NAT" "UTM_IPMASQUERADE_NAT" "IFW_IPMASQUERADE" "IFW_NAT" "IFW_IPMASQUERADE_NAT" "IPMASQUERADE_NAT"

Example: policyType=UTM

項目和名：ポリシー種別
備考　　：アプライアンスの組み合わせを指定する。
　指定省略時、全取得を行う。
　UTM ：UTM
　IFW ：IFW
　IPMASQUERADE ：IP Masquerade
　NAT ：Destination NAT
　UTM_IPMASQUERADE ：UTM,IP Masquerade
　UTM_NAT ：UTM,Destination NAT
　UTM_IPMASQUERADE_NAT：UTM,IP Masquerade,Destination NAT
　IFW_IPMASQUERADE ：IFW,IP Masquerade
　IFW_NAT ：IFW,Destination NAT
　IFW_IPMASQUERADE_NAT：IFW,IP Masquerade,Destination NAT
　IPMASQUERADE_NAT ：IP Masquerade,Destination NAT

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v1/network/policy/type1?policyType=UTM'

Response samples

200
400
401
403
500

Content type

application/json

{"policyUtmType1": {"internetToAccessPointList": [{"zoneRelationId": "44557",
"total": 1,
"policyList": [{"policyObjectId": "2",
"policyId": "1001",
"srcAddress": {"srcAddressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス名1",
"ipAddress": "24.23.1.6/32"
}
],
"srcFqdnList": [{"fqdnId": "obj44557",
"fqdnName": "FQDN1",
"fqdn": "example.com"
}
],
"srcCountryList": [{"countrySeq": "1",
"country": "Japan"
}
]
},
"dstAddress": {"dstAddressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス名1",
"ipAddress": "24.23.1.6/32"
}
]
},
"serviceOption": "ANY",
"defaultServiceList": [{"serviceSeq": "3",
"serviceName": "FTP",
"protocol": "TCP",
"portNumber": "80-90,100"
}
],
"customServiceList": [{"customServiceSeq": "3",
"serviceName": "FTP",
"protocol": "TCP",
"portNumber": "80-90,100"
}
],
"profile": {"internetFW": "USER",
"profileInternetFw": {"profileInternetFwSeq": "5",
"profileInternetFwName": "プロファイル名"
},
"idsIps": "OFF",
"urlFiltering": "USER",
"profileUrl": {"profileUrlSeq": "5",
"profileUrlName": "プロファイル名"
},
"webAntiVirus": "OFF",
"mailAntiVirus": "OFF",
"isAntiSpyware": false
},
"actionType": "DENY",
"isLogOutput": true,
"isPolicyStatus": false,
"policyCategoryInfo": "CUSTOM_POLICY",
"description": "メモ"
}
]
}
],
"accessPointToInternetList": [{"zoneRelationId": "44557",
"total": 1,
"policyList": [{"policyObjectId": "2",
"policyId": "1001",
"srcAddress": {"srcAddressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス名1",
"ipAddress": "24.23.1.6/32"
}
]
},
"dstAddress": {"dstAddressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス名1",
"ipAddress": "24.23.1.6/32"
}
],
"dstFqdnList": [{"fqdnId": "obj44557",
"fqdnName": "FQDN1",
"fqdn": "example.com"
}
],
"dstCountryList": [{"countrySeq": "1",
"country": "Japan"
}
]
},
"serviceOption": "ANY",
"defaultServiceList": [{"serviceSeq": "3",
"serviceName": "FTP",
"protocol": "TCP",
"portNumber": "80-90,100"
}
],
"customServiceList": [{"customServiceSeq": "3",
"serviceName": "FTP",
"protocol": "TCP",
"portNumber": "80-90,100"
}
],
"profile": {"internetFW": "USER",
"profileInternetFw": {"profileInternetFwSeq": "5",
"profileInternetFwName": "プロファイル名"
},
"idsIps": "OFF",
"urlFiltering": "USER",
"profileUrl": {"profileUrlSeq": "5",
"profileUrlName": "プロファイル名"
},
"webAntiVirus": "OFF",
"mailAntiVirus": "OFF",
"isAntiSpyware": false
},
"actionType": "DENY",
"isLogOutput": true,
"isPolicyStatus": false,
"policyCategoryInfo": "CUSTOM_POLICY",
"description": "メモ"
}
]
}
]
},
"policyIfwType1": {"internetToAccessPointList": [{"zoneRelationId": "44557",
"total": 1,
"policyList": [{"policyObjectId": "2",
"policyId": "1001",
"srcAddress": {"srcAddressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス名1",
"ipAddress": "24.23.1.6/32"
}
],
"srcFqdnList": [{"fqdnId": "obj44557",
"fqdnName": "FQDN1",
"fqdn": "example.com"
}
],
"srcCountryList": [{"countrySeq": "1",
"country": "Japan"
}
]
},
"dstAddress": {"dstAddressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス名1",
"ipAddress": "24.23.1.6/32"
}
]
},
"serviceOption": "ANY",
"defaultServiceList": [{"serviceSeq": "3",
"serviceName": "FTP",
"protocol": "TCP",
"portNumber": "80-90,100"
}
],
"customServiceList": [{"customServiceSeq": "3",
"serviceName": "FTP",
"protocol": "TCP",
"portNumber": "80-90,100"
}
],
"profile": {"internetFW": "USER",
"profileInternetFw": {"profileInternetFwSeq": "5",
"profileInternetFwName": "プロファイル名"
}
},
"actionType": "DENY",
"isLogOutput": true,
"isPolicyStatus": false,
"policyCategoryInfo": "CUSTOM_POLICY",
"description": "メモ"
}
]
}
],
"accessPointToInternetList": [{"zoneRelationId": "44557",
"total": 1,
"policyList": [{"policyObjectId": "2",
"policyId": "1001",
"srcAddress": {"srcAddressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス名1",
"ipAddress": "24.23.1.6/32"
}
]
},
"dstAddress": {"dstAddressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス名1",
"ipAddress": "24.23.1.6/32"
}
],
"dstFqdnList": [{"fqdnId": "obj44557",
"fqdnName": "FQDN1",
"fqdn": "example.com"
}
],
"dstCountryList": [{"countrySeq": "1",
"country": "Japan"
}
]
},
"serviceOption": "ANY",
"defaultServiceList": [{"serviceSeq": "3",
"serviceName": "FTP",
"protocol": "TCP",
"portNumber": "80-90,100"
}
],
"customServiceList": [{"customServiceSeq": "3",
"serviceName": "FTP",
"protocol": "TCP",
"portNumber": "80-90,100"
}
],
"profile": {"internetFW": "USER",
"profileInternetFw": {"profileInternetFwSeq": "5",
"profileInternetFwName": "プロファイル名"
}
},
"actionType": "DENY",
"isLogOutput": true,
"isPolicyStatus": false,
"policyCategoryInfo": "CUSTOM_POLICY",
"description": "メモ"
}
]
}
]
},
"policyIPMasqueradeType1List": [{"zoneRelationId": "44557",
"total": 1,
"policyList": [{"policyObjectId": "2",
"policyId": "1001",
"srcAddressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス名1",
"ipAddress": "24.23.1.6/32"
}
],
"dstAddressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス名1",
"ipAddress": "24.23.1.6/32"
}
],
"ipPoolList": [{"ipPoolSeq": "4",
"ipPoolName": "pool1",
"globalIpAddress": "192.168.1.1/29",
"description": "メモ"
}
],
"isPolicyStatus": false,
"policyCategoryInfo": "CUSTOM_POLICY",
"description": "メモ"
}
]
}
],
"policyNatType1List": [{"zoneRelationId": "44557",
"total": 1,
"policyList": [{"policyObjectId": "2",
"policyId": "1001",
"srcAddressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス名1",
"ipAddress": "24.23.1.6/32"
}
],
"ipMapping": {"virtualIpAddressSeq": "4",
"ipMappingName": "pmap1",
"description": "備考"
},
"isPolicyStatus": false,
"description": "メモ"
}
]
}
],
"policyKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Type1のポリシー設定を更新する

query Parameters

policyType

required

string

Enum: "UTM" "IFW" "IPMASQUERADE" "NAT" "UTM_IPMASQUERADE" "UTM_NAT" "UTM_IPMASQUERADE_NAT" "IFW_IPMASQUERADE" "IFW_NAT" "IFW_IPMASQUERADE_NAT" "IPMASQUERADE_NAT"

Example: policyType=UTM

項目和名：ポリシー種別
備考　　：アプライアンスの組み合わせを指定する。
　指定省略時、一括更新を行う。
　UTM ：UTM
　IFW ：IFW
　IPMASQUERADE ：IP Masquerade
　NAT ：Destination NAT
　UTM_IPMASQUERADE ：UTM,IP Masquerade
　UTM_NAT ：UTM,Destination NAT
　UTM_IPMASQUERADE_NAT：UTM,IP Masquerade,Destination NAT
　IFW_IPMASQUERADE ：IFW,IP Masquerade
　IFW_NAT ：IFW,Destination NAT
　IFW_IPMASQUERADE_NAT：IFW,IP Masquerade,Destination NAT
　IPMASQUERADE_NAT ：IP Masquerade,Destination NAT

Request Body schema: application/json

	object (PolicyUtmType1PutModel) 項目和名：Type1ポリシー(UTM) 備考　　：クエリパラメータのポリシー種別の対象外の場合と　　　　　Type1ポリシー(IFW)契約時はNULLを設定
	object (PolicyIfwType1PutModel) 項目和名：Type1ポリシー(IFW) 備考　　：クエリパラメータのポリシー種別の対象外の場合と　　　　　Type1ポリシー(UTM)契約時はNULLを設定
	Array of objects (PolicyIPMasqueradeType1PutModel) 項目和名：Type1ポリシー(IP Masquerade)のリスト備考　　：クエリパラメータのポリシー種別の対象外の場合、空配列を設定
	Array of objects (PolicyNatType1PutModel) 項目和名：Type1ポリシー(Destination NAT)のリスト備考　　：クエリパラメータのポリシー種別の対象外の場合、空配列を設定
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
policyKeyId required	string (policyKeyId) 項目和名：ポリシー設定排他情報備考　　：排他確認用パラメータ　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"policyUtmType1": {"internetToAccessPointList": [{"zoneRelationId": "44557",
"policyList": [{"policyObjectId": "2",
"policyId": "1001",
"srcAddress": {"srcAddressList": ["obj44557"
],
"srcFqdnList": ["obj44557"
],
"srcCountryList": ["1"
]
},
"dstAddress": {"dstAddressList": ["obj44557"
]
},
"serviceOption": "ANY",
"defaultServiceList": ["3"
],
"customServiceList": ["3"
],
"profile": {"internetFW": "USER",
"profileInternetFw": {"profileInternetFwSeq": "5"
},
"idsIps": "OFF",
"urlFiltering": "USER",
"profileUrl": {"profileUrlSeq": "5"
},
"webAntiVirus": "OFF",
"mailAntiVirus": "OFF",
"isAntiSpyware": false
},
"actionType": "DENY",
"isLogOutput": true,
"isPolicyStatus": false,
"policyCategoryInfo": "CUSTOM_POLICY",
"description": "メモ"
}
]
}
],
"accessPointToInternetList": [{"zoneRelationId": "44557",
"policyList": [{"policyObjectId": "2",
"policyId": "1001",
"srcAddress": {"srcAddressList": ["obj44557"
]
},
"dstAddress": {"dstAddressList": ["obj44557"
],
"dstFqdnList": ["obj44557"
],
"dstCountryList": ["1"
]
},
"serviceOption": "ANY",
"defaultServiceList": ["3"
],
"customServiceList": ["3"
],
"profile": {"internetFW": "USER",
"profileInternetFw": {"profileInternetFwSeq": "5"
},
"idsIps": "OFF",
"urlFiltering": "USER",
"profileUrl": {"profileUrlSeq": "5"
},
"webAntiVirus": "OFF",
"mailAntiVirus": "OFF",
"isAntiSpyware": false
},
"actionType": "DENY",
"isLogOutput": true,
"isPolicyStatus": false,
"policyCategoryInfo": "CUSTOM_POLICY",
"description": "メモ"
}
]
}
]
},
"policyIfwType1": {"internetToAccessPointList": [{"zoneRelationId": "44557",
"policyList": [{"policyObjectId": "2",
"policyId": "1001",
"srcAddress": {"srcAddressList": ["obj44557"
],
"srcFqdnList": ["obj44557"
],
"srcCountryList": ["1"
]
},
"dstAddress": {"dstAddressList": ["obj44557"
]
},
"serviceOption": "ANY",
"defaultServiceList": ["3"
],
"customServiceList": ["3"
],
"profile": {"internetFW": "USER",
"profileInternetFw": {"profileInternetFwSeq": "5"
}
},
"actionType": "DENY",
"isLogOutput": true,
"isPolicyStatus": false,
"policyCategoryInfo": "CUSTOM_POLICY",
"description": "メモ"
}
]
}
],
"accessPointToInternetList": [{"zoneRelationId": "44557",
"policyList": [{"policyObjectId": "2",
"policyId": "1001",
"srcAddress": {"srcAddressList": ["obj44557"
]
},
"dstAddress": {"dstAddressList": ["obj44557"
],
"dstFqdnList": ["obj44557"
],
"dstCountryList": ["1"
]
},
"serviceOption": "ANY",
"defaultServiceList": ["3"
],
"customServiceList": ["3"
],
"profile": {"internetFW": "USER",
"profileInternetFw": {"profileInternetFwSeq": "5"
}
},
"actionType": "DENY",
"isLogOutput": true,
"isPolicyStatus": false,
"policyCategoryInfo": "CUSTOM_POLICY",
"description": "メモ"
}
]
}
]
},
"policyIPMasqueradeType1List": [{"zoneRelationId": "44557",
"policyList": [{"policyObjectId": "2",
"policyId": "1001",
"srcAddressList": ["obj44557"
],
"dstAddressList": ["obj44557"
],
"ipPoolList": ["4"
],
"isPolicyStatus": false,
"policyCategoryInfo": "CUSTOM_POLICY",
"description": "メモ"
}
]
}
],
"policyNatType1List": [{"zoneRelationId": "44557",
"policyList": [{"policyObjectId": "2",
"policyId": "1001",
"srcAddressList": ["obj44557"
],
"ipMapping": {"virtualIpAddressSeq": "4"
},
"isPolicyStatus": false,
"description": "メモ"
}
]
}
],
"note": "メッセージ",
"policyKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

国API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  国名の一覧を取得する。

国名の一覧を取得する

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/policy/country

Response samples

200
401
403
500

Content type

application/json

{"countryList": [{"countrySeq": "1",
"country": "Japan"
}
]
}

ポリシーAPI(イントラネットFW)

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST：受付非同期方式
2. 内容
  ポリシー（イントラネットFW（PFGW含む））の一覧取得、追加、変更、削除を行う。

ポリシー情報（イントラネットFW（PFGW含む））を一覧取得する。

query Parameters

policyType

required

string

Enum: "INTRANET_FW" "INTRANET_FW_PFGW"

Example: policyType=INTRANET_FW

項目和名：ポリシー種別
備考　　：アプライアンスの種別を指定する。
INTRANET_FW ：イントラネットFW
INTRANET_FW_PFGW ：イントラネットFW（PFGW）

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v1/network/policy/intranetfw?policyType=INTRANET_FW'

Response samples

200
401
403
500

Content type

application/json

{"privateToPrivateList": [{"zoneRelationId": "1",
"total": 1,
"policyList": [{"policyObjectId": "1",
"policyId": "1002",
"srcAddressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス名",
"ipAddress": "24.23.1.6/32"
}
],
"dstAddressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス名",
"ipAddress": "24.23.1.6/32"
}
],
"serviceList": [{"serviceSeq": "3",
"serviceName": "FTP",
"protocol": "TCP",
"portNumber": "80-90,100",
"protocolNumber": 2,
"icmpType": 0,
"icmpCode": 0
}
],
"customServiceList": [{"customServiceSeq": "4",
"customServiceName": "FTP",
"protocol": "TCP",
"portNumber": "80-90,100",
"protocolNumber": 2,
"icmpType": 0,
"icmpCode": 0
}
],
"actionType": "DENY",
"isPolicyStatus": false,
"policyCategoryInfo": "CUSTOM_POLICY",
"description": "メモ"
}
]
}
],
"extraToPrivateList": [{"zoneRelationId": "1",
"total": 1,
"policyList": [{"policyObjectId": "1",
"policyId": "1002",
"srcAddressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス名",
"ipAddress": "24.23.1.6/32"
}
],
"dstAddressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス名",
"ipAddress": "24.23.1.6/32"
}
],
"serviceList": [{"serviceSeq": "3",
"serviceName": "FTP",
"protocol": "TCP",
"portNumber": "80-90,100",
"protocolNumber": 2,
"icmpType": 0,
"icmpCode": 0
}
],
"customServiceList": [{"customServiceSeq": "4",
"customServiceName": "FTP",
"protocol": "TCP",
"portNumber": "80-90,100",
"protocolNumber": 2,
"icmpType": 0,
"icmpCode": 0
}
],
"actionType": "DENY",
"isPolicyStatus": false,
"policyCategoryInfo": "CUSTOM_POLICY",
"description": "メモ"
}
]
}
],
"privateToExtraList": [{"zoneRelationId": "1",
"total": 1,
"policyList": [{"policyObjectId": "1",
"policyId": "1002",
"srcAddressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス名",
"ipAddress": "24.23.1.6/32"
}
],
"dstAddressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス名",
"ipAddress": "24.23.1.6/32"
}
],
"serviceList": [{"serviceSeq": "3",
"serviceName": "FTP",
"protocol": "TCP",
"portNumber": "80-90,100",
"protocolNumber": 2,
"icmpType": 0,
"icmpCode": 0
}
],
"customServiceList": [{"customServiceSeq": "4",
"customServiceName": "FTP",
"protocol": "TCP",
"portNumber": "80-90,100",
"protocolNumber": 2,
"icmpType": 0,
"icmpCode": 0
}
],
"actionType": "DENY",
"isPolicyStatus": false,
"policyCategoryInfo": "CUSTOM_POLICY",
"description": "メモ"
}
]
}
],
"wvs2ToKcpsList": [{"enumberAct": "E000000010",
"zoneRelationId": "1",
"total": 1,
"policyList": [{"policyObjectId": "1",
"policyId": "1002",
"srcAddressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス名",
"ipAddress": "24.23.1.6/32"
}
],
"dstAddressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス名",
"ipAddress": "24.23.1.6/32"
}
],
"serviceList": [{"serviceSeq": "3",
"serviceName": "FTP",
"protocol": "TCP",
"portNumber": "80-90,100",
"protocolNumber": 2,
"icmpType": 0,
"icmpCode": 0
}
],
"customServiceList": [{"customServiceSeq": "4",
"customServiceName": "FTP",
"protocol": "TCP",
"portNumber": "80-90,100",
"protocolNumber": 2,
"icmpType": 0,
"icmpCode": 0
}
],
"actionType": "DENY",
"isPolicyStatus": false,
"policyCategoryInfo": "CUSTOM_POLICY",
"description": "メモ"
}
]
}
],
"kcpsToWvs2List": [{"enumberAct": "E000000010",
"zoneRelationId": "1",
"total": 1,
"policyList": [{"policyObjectId": "1",
"policyId": "1002",
"srcAddressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス名",
"ipAddress": "24.23.1.6/32"
}
],
"dstAddressList": [{"ipAddressId": "obj44557",
"ipAddressName": "アドレス名",
"ipAddress": "24.23.1.6/32"
}
],
"serviceList": [{"serviceSeq": "3",
"serviceName": "FTP",
"protocol": "TCP",
"portNumber": "80-90,100",
"protocolNumber": 2,
"icmpType": 0,
"icmpCode": 0
}
],
"customServiceList": [{"customServiceSeq": "4",
"customServiceName": "FTP",
"protocol": "TCP",
"portNumber": "80-90,100",
"protocolNumber": 2,
"icmpType": 0,
"icmpCode": 0
}
],
"actionType": "DENY",
"isPolicyStatus": false,
"policyCategoryInfo": "CUSTOM_POLICY",
"description": "メモ"
}
]
}
],
"policyIntranetFwKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

ポリシー設定（イントラネットFW（PFGW含む））を変更する。

query Parameters

policyType required	string Enum: "INTRANET_FW" "INTRANET_FW_PFGW" Example: policyType=INTRANET_FW 項目和名：ポリシー種別備考　　：アプライアンスの種別を指定する。 INTRANET_FW ：イントラネットFW INTRANET_FW_PFGW ：イントラネットFW（PFGW）
enumberAct	string <= 10 characters ^E[0-9]{8}0$ Example: enumberAct=E000000010 項目和名：E番号(ACT) 備考　　：主キー　　　　　GETメソッドから取得したACT側のE番号　　　　　ポリシー種別でINTRANET_FW_PFGWを指定時必須

Request Body schema: application/json

	Array of objects 項目和名：ポリシーリスト備考　　：プライベートゾーンからプライベートゾーンのゾーン関係IDが無い場合、　　　　　またはクエリパラメータのポリシー種別にINTRANET_FW_PFGWを指定した場合、空リストを設定
	Array of objects 項目和名：ポリシーリスト備考　　：エクストラゾーンからプライベートゾーンのゾーン関係IDが無い場合、　　　　　またはクエリパラメータのポリシー種別にINTRANET_FW_PFGWを指定した場合、空リストを設定
	Array of objects 項目和名：ポリシーリスト備考　　：プライベートゾーンからエクストラゾーンのゾーン関係IDが無い場合、　　　　　またはクエリパラメータのポリシー種別にINTRANET_FW_PFGWを指定した場合、空リストを設定
	object 項目和名：WVS2ゾーンからKCPSゾーンのポリシー備考　　：WVS2ゾーンからKCPSゾーンのゾーン関係IDが無い場合、　　　　　またはクエリパラメータのポリシー種別にINTRANET_FWを指定した場合、NULLを設定
	object 項目和名：KCPSゾーンからWVS2ゾーンのポリシー備考　　：KCPSゾーンからWVS2ゾーンのゾーン関係IDが無い場合、　　　　　またはクエリパラメータのポリシー種別にINTRANET_FWを指定した場合、NULLを設定
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
policyIntranetFwKeyId required	string (policyIntranetFwKeyId) 項目和名：イントラネットFW設定排他情報備考　　：排他確認用パラメータ　　　　：設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと

Responses

Request samples

Payload
Curl

Content type

application/json

{"privateToPrivateList": [{"zoneRelationId": "1",
"policyList": [{"policyObjectId": "1",
"policyId": "1002",
"srcAddressList": ["obj44557"
],
"dstAddressList": ["obj44557"
],
"serviceList": ["3"
],
"customServiceList": ["4"
],
"actionType": "DENY",
"isPolicyStatus": false,
"policyCategoryInfo": "CUSTOM_POLICY",
"description": "メモ"
}
]
}
],
"extraToPrivateList": [{"zoneRelationId": "1",
"policyList": [{"policyObjectId": "1",
"policyId": "1002",
"srcAddressList": ["obj44557"
],
"dstAddressList": ["obj44557"
],
"serviceList": ["3"
],
"customServiceList": ["4"
],
"actionType": "DENY",
"isPolicyStatus": false,
"policyCategoryInfo": "CUSTOM_POLICY",
"description": "メモ"
}
]
}
],
"privateToExtraList": [{"zoneRelationId": "1",
"policyList": [{"policyObjectId": "1",
"policyId": "1002",
"srcAddressList": ["obj44557"
],
"dstAddressList": ["obj44557"
],
"serviceList": ["3"
],
"customServiceList": ["4"
],
"actionType": "DENY",
"isPolicyStatus": false,
"policyCategoryInfo": "CUSTOM_POLICY",
"description": "メモ"
}
]
}
],
"wvs2ToKcps": {"zoneRelationId": "1",
"policyList": [{"policyObjectId": "1",
"policyId": "1002",
"srcAddressList": ["obj44557"
],
"dstAddressList": ["obj44557"
],
"serviceList": ["3"
],
"customServiceList": ["4"
],
"actionType": "DENY",
"isPolicyStatus": false,
"policyCategoryInfo": "CUSTOM_POLICY",
"description": "メモ"
}
]
},
"kcpsToWvs2": {"zoneRelationId": "1",
"policyList": [{"policyObjectId": "1",
"policyId": "1002",
"srcAddressList": ["obj44557"
],
"dstAddressList": ["obj44557"
],
"serviceList": ["3"
],
"customServiceList": ["4"
],
"actionType": "DENY",
"isPolicyStatus": false,
"policyCategoryInfo": "CUSTOM_POLICY",
"description": "メモ"
}
]
},
"note": "メッセージ",
"policyIntranetFwKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

デフォルトサービスAPI（インターネットFW）

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  デフォルトサービス情報（インターネットFW）の参照を行う。

デフォルトサービス情報（インターネットFW）を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/services/default/internetfw

Response samples

200
401
403
500

Content type

application/json

{"total": 1,
"defaultServiceList": [{"serviceSeq": "1",
"serviceName": "ALL_TCP",
"protocol": "TCP",
"portNumber": "80-90,100"
}
]
}

デフォルトサービスAPI（イントラネットFW）

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  デフォルトサービス情報（イントラネットFW）の参照を行う。

デフォルトサービス情報（イントラネットFW）を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/services/default/intranetfw

Response samples

200
401
403
500

Content type

application/json

{"total": 1,
"defaultServiceList": [{"serviceSeq": "1",
"serviceName": "ALL_TCP",
"protocol": "TCP",
"portNumber": "80-90,100",
"protocolNumber": 2,
"icmpType": 0,
"icmpCode": 0
}
]
}

カスタムサービスAPI

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST：受付非同期方式
2. 内容
  カスタムサービス設定の参照・登録・変更・削除を行う。

Type1カスタムサービス情報を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/policy/services/custom/internetfw/type1

Response samples

200
401
403
500

Content type

application/json

{"total": 1,
"customServiceList": [{"customServiceSeq": "1",
"serviceName": "HTTP",
"protocol": "TCP",
"portNumber": "80-90,100",
"isPolicyInUse": true,
"description": "メモ"
}
],
"customServiceKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Type4カスタムサービス情報を取得

path Parameters

type4Id

required

string^TY4[0-9]{5}$

Example: TY412345

項目和名：Type4ID
備考　　：主キー
　　　　　アプライアンス情報APIより取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/policy/services/custom/internetfw/type4/TY412345

Response samples

Content type

application/json

{"total": 1,
"customServiceList": [{"customServiceSeq": "1",
"serviceName": "HTTP",
"protocol": "TCP",
"portNumber": "80-90,100",
"isPolicyInUse": true,
"description": "メモ"
}
],
"customServiceKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Type1カスタムサービス情報を登録

Request Body schema: application/json

serviceName required	string (serviceName3) <= 63 characters 項目和名：サービス名備考　　：-
protocol required	string (protocol3) Enum: "TCP" "UDP" 項目和名：プロトコル備考　　：TCP : TCP 　　　　　UDP : UDP
portNumber required	string (portNumber2) <= 119 characters ^[-0-9,]+$ 項目和名：ポート番号備考　　：Port番号は0～65535が設定可能　　　　　"-"で範囲、","複数設定(最大10個)可能　　　　　TCP、またはUDP選択時必須
description	string (description2) <= 20 characters 項目和名：設定値の説明備考　　：-
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
customServiceKeyId required	string (customServiceKeyId) 項目和名：カスタムサービス設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"serviceName": "HTTP",
"protocol": "TCP",
"portNumber": "80-90,100",
"description": "メモ",
"note": "メッセージ",
"customServiceKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

Type4カスタムサービス情報を登録

path Parameters

type4Id

required

string^TY4[0-9]{5}$

Example: TY412345

項目和名：Type4ID
備考　　：主キー
　　　　　アプライアンス情報APIより取得

Request Body schema: application/json

serviceName required	string (serviceName3) <= 63 characters 項目和名：サービス名備考　　：-
protocol required	string (protocol3) Enum: "TCP" "UDP" 項目和名：プロトコル備考　　：TCP : TCP 　　　　　UDP : UDP
portNumber required	string (portNumber2) <= 119 characters ^[-0-9,]+$ 項目和名：ポート番号備考　　：Port番号は0～65535が設定可能　　　　　"-"で範囲、","複数設定(最大10個)可能　　　　　TCP、またはUDP選択時必須
description	string (description2) <= 20 characters 項目和名：設定値の説明備考　　：-
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
customServiceKeyId required	string (customServiceKeyId) 項目和名：カスタムサービス設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"serviceName": "HTTP",
"protocol": "TCP",
"portNumber": "80-90,100",
"description": "メモ",
"note": "メッセージ",
"customServiceKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

Type1カスタムサービス情報を変更

path Parameters

customServiceSeq

required

string <= 19 characters

Example: 1

項目和名：サービスSEQ
備考　　：主キー
　　　　　カスタムサービスAPIより取得

Request Body schema: application/json

serviceName required	string (serviceName3) <= 63 characters 項目和名：サービス名備考　　：-
protocol required	string (protocol3) Enum: "TCP" "UDP" 項目和名：プロトコル備考　　：TCP : TCP 　　　　　UDP : UDP
portNumber required	string (portNumber2) <= 119 characters ^[-0-9,]+$ 項目和名：ポート番号備考　　：Port番号は0～65535が設定可能　　　　　"-"で範囲、","複数設定(最大10個)可能　　　　　TCP、またはUDP選択時必須
description	string (description2) <= 20 characters 項目和名：設定値の説明備考　　：-
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
customServiceKeyId required	string (customServiceKeyId) 項目和名：カスタムサービス設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"serviceName": "HTTP",
"protocol": "TCP",
"portNumber": "80-90,100",
"description": "メモ",
"note": "メッセージ",
"customServiceKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

Type4カスタムサービス情報を変更

path Parameters

type4Id required	string^TY4[0-9]{5}$ Example: TY412345 項目和名：Type4ID 備考　　：主キー　　　　　アプライアンス情報APIより取得
customServiceSeq required	string <= 19 characters Example: 1 項目和名：サービスSEQ 備考　　：主キー　　　　　カスタムサービスAPIより取得

Request Body schema: application/json

serviceName required	string (serviceName3) <= 63 characters 項目和名：サービス名備考　　：-
protocol required	string (protocol3) Enum: "TCP" "UDP" 項目和名：プロトコル備考　　：TCP : TCP 　　　　　UDP : UDP
portNumber required	string (portNumber2) <= 119 characters ^[-0-9,]+$ 項目和名：ポート番号備考　　：Port番号は0～65535が設定可能　　　　　"-"で範囲、","複数設定(最大10個)可能　　　　　TCP、またはUDP選択時必須
description	string (description2) <= 20 characters 項目和名：設定値の説明備考　　：-
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
customServiceKeyId required	string (customServiceKeyId) 項目和名：カスタムサービス設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"serviceName": "HTTP",
"protocol": "TCP",
"portNumber": "80-90,100",
"description": "メモ",
"note": "メッセージ",
"customServiceKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

Type1カスタムサービス情報を削除

Request Body schema: application/json

customServiceSeqList required	Array of strings (customServiceSeq2) [ items <= 19 characters ]
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
customServiceKeyId required	string (customServiceKeyId) 項目和名：カスタムサービス設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"customServiceSeqList": ["1"
],
"note": "メッセージ",
"customServiceKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

Type4カスタムサービス情報を削除

path Parameters

type4Id

required

string^TY4[0-9]{5}$

Example: TY412345

項目和名：Type4ID
備考　　：主キー
　　　　　アプライアンス情報APIより取得

Request Body schema: application/json

customServiceSeqList required	Array of strings (customServiceSeq2) [ items <= 19 characters ]
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
customServiceKeyId required	string (customServiceKeyId) 項目和名：カスタムサービス設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"customServiceSeqList": ["1"
],
"note": "メッセージ",
"customServiceKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

カスタムサービスAPI(イントラネットFW)

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST：受付非同期方式
2. 内容
  カスタムサービス設定(イントラネットFW)の参照・登録・変更・削除を行う。

カスタムサービス情報(イントラネットFW)を取得

query Parameters

policyType required	string Enum: "INTRANET_FW" "INTRANET_FW_PFGW" Example: policyType=INTRANET_FW 項目和名：ポリシー種別備考　　：アプライアンスの種別を指定する。 INTRANET_FW ：イントラネットFW INTRANET_FW_PFGW ：イントラネットFW（PFGW）
enumberAct	string <= 10 characters ^E[0-9]{8}0$ Example: enumberAct=E000000010 項目和名：E番号(ACT) 備考　　：主キー　　　　　GETメソッドから取得したACT側のE番号　　　　　ポリシー種別でINTRANET_FW_PFGWを指定時必須

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v1/network/policy/services/custom/intranetfw?policyType=INTRANET_FW&enumberAct=E000000010'

Response samples

200
401
403
500

Content type

application/json

{"total": 1,
"customServiceIntranetList": [{"customServiceSeq": "1",
"serviceName": "HTTP",
"protocol": "TCP",
"portNumber": "80-90,100",
"protocolNumber": 2,
"icmpType": 0,
"icmpCode": 0,
"isPolicyInUse": true,
"description": "メモ"
}
],
"customServiceKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

カスタムサービス情報(イントラネットFW)を登録

query Parameters

policyType required	string Enum: "INTRANET_FW" "INTRANET_FW_PFGW" Example: policyType=INTRANET_FW 項目和名：ポリシー種別備考　　：アプライアンスの種別を指定する。 INTRANET_FW ：イントラネットFW INTRANET_FW_PFGW ：イントラネットFW（PFGW）
enumberAct	string <= 10 characters ^E[0-9]{8}0$ Example: enumberAct=E000000010 項目和名：E番号(ACT) 備考　　：主キー　　　　　GETメソッドから取得したACT側のE番号　　　　　ポリシー種別でINTRANET_FW_PFGWを指定時必須

Request Body schema: application/json

serviceName required	string (serviceName3) <= 63 characters 項目和名：サービス名備考　　：-
protocol required	string (intranetfwProtocol1) Enum: "TCP" "UDP" "IP" "ICMP" 項目和名：プロトコル(イントラネットFW) 備考　　：TCP : TCP 　　　　　UDP : UDP 　　　　　IP : IP 　　　　　ICMP : ICMP
portNumber	string (portNumber2) <= 119 characters ^[-0-9,]+$ 項目和名：ポート番号備考　　：Port番号は0～65535が設定可能　　　　　"-"で範囲、","複数設定(最大10個)可能　　　　　TCP、またはUDP選択時必須
protocolNumber	integer (protocolNumber) [ 0 .. 254 ] 項目和名：プロトコル番号備考　　：0～254の範囲で入力　　　　　IP選択時必須
icmpType	integer (icmpType) [ 0 .. 255 ] 項目和名：ICMPタイプ備考　　：0～255の範囲で入力　　　　　ICMP選択時必須
icmpCode	integer (icmpCode) [ 0 .. 255 ] 項目和名：ICMPコード備考　　：0～255の範囲で入力　　　　　ICMP選択時必須
description	string (description2) <= 20 characters 項目和名：設定値の説明備考　　：-
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
customServiceKeyId required	string (customServiceKeyId) 項目和名：カスタムサービス設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"serviceName": "HTTP",
"protocol": "TCP",
"portNumber": "80-90,100",
"protocolNumber": 2,
"icmpType": 0,
"icmpCode": 0,
"description": "メモ",
"note": "メッセージ",
"customServiceKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

カスタムサービス情報(イントラネットFW)を変更

path Parameters

customServiceSeq

required

string <= 19 characters

Example: 1

項目和名：サービスSEQ
備考　　：主キー
　　　　　カスタムサービスAPI(イントラネットFW)より取得

query Parameters

policyType required	string Enum: "INTRANET_FW" "INTRANET_FW_PFGW" Example: policyType=INTRANET_FW 項目和名：ポリシー種別備考　　：アプライアンスの種別を指定する。 INTRANET_FW ：イントラネットFW INTRANET_FW_PFGW ：イントラネットFW（PFGW）
enumberAct	string <= 10 characters ^E[0-9]{8}0$ Example: enumberAct=E000000010 項目和名：E番号(ACT) 備考　　：主キー　　　　　GETメソッドから取得したACT側のE番号　　　　　ポリシー種別でINTRANET_FW_PFGWを指定時必須

Request Body schema: application/json

serviceName required	string (serviceName3) <= 63 characters 項目和名：サービス名備考　　：-
protocol required	string (intranetfwProtocol1) Enum: "TCP" "UDP" "IP" "ICMP" 項目和名：プロトコル(イントラネットFW) 備考　　：TCP : TCP 　　　　　UDP : UDP 　　　　　IP : IP 　　　　　ICMP : ICMP
portNumber	string (portNumber2) <= 119 characters ^[-0-9,]+$ 項目和名：ポート番号備考　　：Port番号は0～65535が設定可能　　　　　"-"で範囲、","複数設定(最大10個)可能　　　　　TCP、またはUDP選択時必須
protocolNumber	integer (protocolNumber) [ 0 .. 254 ] 項目和名：プロトコル番号備考　　：0～254の範囲で入力　　　　　IP選択時必須
icmpType	integer (icmpType) [ 0 .. 255 ] 項目和名：ICMPタイプ備考　　：0～255の範囲で入力　　　　　ICMP選択時必須
icmpCode	integer (icmpCode) [ 0 .. 255 ] 項目和名：ICMPコード備考　　：0～255の範囲で入力　　　　　ICMP選択時必須
description	string (description2) <= 20 characters 項目和名：設定値の説明備考　　：-
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
customServiceKeyId required	string (customServiceKeyId) 項目和名：カスタムサービス設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"serviceName": "HTTP",
"protocol": "TCP",
"portNumber": "80-90,100",
"protocolNumber": 2,
"icmpType": 0,
"icmpCode": 0,
"description": "メモ",
"note": "メッセージ",
"customServiceKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

カスタムサービス情報(イントラネットFW)を削除

query Parameters

policyType required	string Enum: "INTRANET_FW" "INTRANET_FW_PFGW" Example: policyType=INTRANET_FW 項目和名：ポリシー種別備考　　：アプライアンスの種別を指定する。 INTRANET_FW ：イントラネットFW INTRANET_FW_PFGW ：イントラネットFW（PFGW）
enumberAct	string <= 10 characters ^E[0-9]{8}0$ Example: enumberAct=E000000010 項目和名：E番号(ACT) 備考　　：主キー　　　　　GETメソッドから取得したACT側のE番号　　　　　ポリシー種別でINTRANET_FW_PFGWを指定時必須

Request Body schema: application/json

customServiceSeqList required	Array of strings (customServiceSeq2) [ items <= 19 characters ]
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
customServiceKeyId required	string (customServiceKeyId) 項目和名：カスタムサービス設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"customServiceSeqList": ["1"
],
"note": "メッセージ",
"customServiceKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

プロファイルAPI

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  NW設計のプロファイルの参照を行う。

Type1プロファイル(インターネットFW)の一覧情報を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/policy/profiles/internetfw/type1

Response samples

200
401
403
500

Content type

application/json

{"total": 1,
"profileList": [{"profileInternetFwSeq": "1",
"profileInternetFwName": "プロファイル名",
"isPolicyInUse": true,
"description": "メモ"
}
],
"profileInternetFwKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Type4プロファイル(インターネットFW)の一覧情報を取得

path Parameters

type4Id

required

string <= 8 characters ^TY4[0-9]{5}$

Example: TY412345

項目和名：Type4ID
備考　　：主キー
　　　　　アプライアンス情報APIより取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/policy/profiles/internetfw/type4/TY412345

Response samples

200
400
401
403
500

Content type

application/json

{"total": 1,
"profileList": [{"profileInternetFwSeq": "1",
"profileInternetFwName": "プロファイル名",
"isPolicyInUse": true,
"description": "メモ"
}
],
"profileInternetFwKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Type1プロファイル(URLフィルタリング)の一覧情報を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/policy/profiles/urlfiltering/type1

Response samples

200
401
403
500

Content type

application/json

{"total": 1,
"profileList": [{"profileUrlSeq": "1",
"profileUrlName": "プロファイル名",
"isPolicyInUse": true,
"description": "メモ"
}
],
"profileUrlKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Type4プロファイル(URLフィルタリング)の一覧情報を取得

path Parameters

type4Id

required

string <= 8 characters ^TY4[0-9]{5}$

Example: TY412345

項目和名：Type4ID
備考　　：主キー
　　　　　アプライアンス情報APIより取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/policy/profiles/urlfiltering/type4/TY412345

Response samples

200
400
401
403
500

Content type

application/json

{"total": 1,
"profileList": [{"profileUrlSeq": "1",
"profileUrlName": "プロファイル名",
"isPolicyInUse": true,
"description": "メモ"
}
],
"profileUrlKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

プロファイルAPI（インターネットFW）

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST：受付非同期方式
2. 内容
  プロファイル（インターネットFW）の参照・登録・変更・削除を行う。

アプリケーション情報を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/policy/profile/internetfw/applications

Response samples

200
401
403
500

Content type

application/json

{"applicationList": [{"applicationSeq": "1",
"applicationName": "skype",
"category": "collaboration",
"subcategory": "voip-video",
"technology": "peer-to-peer",
"risk": 5
}
]
}

Type1プロファイル情報（インターネットFW）を取得

path Parameters

profileInternetFwSeq

required

string <= 19 characters

Example: 1

項目和名：インターネットFWのプロファイルSEQ
　　　　：主キー
　　　　　プロファイルAPIから取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/policy/profile/internetfw/type1/1

Response samples

Content type

application/json

{"profileInternetFwName": "Profile1",
"applicationList": [{"applicationSeq": "1",
"applicationName": "skype",
"category": "collaboration",
"subcategory": "voip-video",
"technology": "peer-to-peer",
"risk": 5
}
],
"isPolicyInUse": true,
"description": "メモ",
"profileInternetFwKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Type1プロファイル情報（インターネットFW）を変更

path Parameters

profileInternetFwSeq

required

string <= 19 characters

Example: 1

項目和名：インターネットFWのプロファイルSEQ
　　　　：主キー
　　　　　プロファイルAPIから取得

Request Body schema: application/json

profileInternetFwName required	string (profileInternetFwName2) <= 20 characters 項目和名：インターネットFWのプロファイル名備考　　：-
applicationSeqList required	Array of strings (applicationSeq) [ items <= 19 characters ] 項目和名：アプリケーション情報リスト備考　　：アプリケーション情報が0件の場合は空配列を設定
description	string (description4) <= 20 characters 項目和名：設定値の説明備考　　：-
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
profileInternetFwKeyId required	string (profileInternetFwKeyId) 項目和名：インターネットFWのプロファイル設定排他情報備考　　：排他確認用パラメータ　　　　：設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"profileInternetFwName": "Profile1",
"applicationSeqList": ["1"
],
"description": "メモ",
"note": "メッセージ",
"profileInternetFwKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

Type4プロファイル情報（インターネットFW）を取得

path Parameters

type4Id required	string <= 8 characters ^TY4[0-9]{5}$ Example: TY412345 項目和名：Type4ID 備考　　：主キー　　　　　アプライアンス情報APIより取得
profileInternetFwSeq required	string <= 19 characters Example: 1 項目和名：インターネットFWのプロファイルSEQ 　　　　：主キー　　　　　プロファイルAPIから取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/policy/profile/internetfw/type4/TY412345/1

Response samples

Content type

application/json

{"profileInternetFwName": "Profile1",
"applicationList": [{"applicationSeq": "1",
"applicationName": "skype",
"category": "collaboration",
"subcategory": "voip-video",
"technology": "peer-to-peer",
"risk": 5
}
],
"isPolicyInUse": true,
"description": "メモ",
"profileInternetFwKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Type4プロファイル情報（インターネットFW）を変更

path Parameters

type4Id required	string <= 8 characters ^TY4[0-9]{5}$ Example: TY412345 項目和名：Type4ID 備考　　：主キー　　　　　アプライアンス情報APIより取得
profileInternetFwSeq required	string <= 19 characters Example: 1 項目和名：インターネットFWのプロファイルSEQ 　　　　：主キー　　　　　プロファイルAPIから取得

Request Body schema: application/json

profileInternetFwName required	string (profileInternetFwName2) <= 20 characters 項目和名：インターネットFWのプロファイル名備考　　：-
applicationSeqList required	Array of strings (applicationSeq) [ items <= 19 characters ] 項目和名：アプリケーション情報リスト備考　　：アプリケーション情報が0件の場合は空配列を設定
description	string (description4) <= 20 characters 項目和名：設定値の説明備考　　：-
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
profileInternetFwKeyId required	string (profileInternetFwKeyId) 項目和名：インターネットFWのプロファイル設定排他情報備考　　：排他確認用パラメータ　　　　：設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"profileInternetFwName": "Profile1",
"applicationSeqList": ["1"
],
"description": "メモ",
"note": "メッセージ",
"profileInternetFwKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

Type1プロファイル情報（インターネットFW）を登録

Request Body schema: application/json

profileInternetFwName required	string (profileInternetFwName2) <= 20 characters 項目和名：インターネットFWのプロファイル名備考　　：-
applicationSeqList required	Array of strings (applicationSeq) [ items <= 19 characters ] 項目和名：アプリケーション情報リスト備考　　：アプリケーション情報が0件の場合は空配列を設定
description	string (description4) <= 20 characters 項目和名：設定値の説明備考　　：-
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
profileInternetFwKeyId required	string (profileInternetFwKeyId) 項目和名：インターネットFWのプロファイル設定排他情報備考　　：排他確認用パラメータ　　　　：設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"profileInternetFwName": "Profile1",
"applicationSeqList": ["1"
],
"description": "メモ",
"note": "メッセージ",
"profileInternetFwKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

Type4プロファイル情報（インターネットFW）を登録

path Parameters

type4Id

required

string <= 8 characters ^TY4[0-9]{5}$

Example: TY412345

項目和名：Type4ID
備考　　：主キー
　　　　　アプライアンス情報APIより取得

Request Body schema: application/json

profileInternetFwName required	string (profileInternetFwName2) <= 20 characters 項目和名：インターネットFWのプロファイル名備考　　：-
applicationSeqList required	Array of strings (applicationSeq) [ items <= 19 characters ] 項目和名：アプリケーション情報リスト備考　　：アプリケーション情報が0件の場合は空配列を設定
description	string (description4) <= 20 characters 項目和名：設定値の説明備考　　：-
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
profileInternetFwKeyId required	string (profileInternetFwKeyId) 項目和名：インターネットFWのプロファイル設定排他情報備考　　：排他確認用パラメータ　　　　：設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"profileInternetFwName": "Profile1",
"applicationSeqList": ["1"
],
"description": "メモ",
"note": "メッセージ",
"profileInternetFwKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

Type1プロファイル情報（インターネットFW）を削除

Request Body schema: application/json

profileInternetFwSeqList required	Array of strings (profileInternetFwSeq2) [ items <= 19 characters ] 項目和名：インターネットFWのプロファイルSEQリスト備考　　：-
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
profileInternetFwKeyId required	string (profileInternetFwKeyId) 項目和名：インターネットFWのプロファイル設定排他情報備考　　：排他確認用パラメータ　　　　：設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"profileInternetFwSeqList": ["1"
],
"note": "メッセージ",
"profileInternetFwKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

Type4プロファイル情報（インターネットFW）を削除

path Parameters

type4Id

required

string <= 8 characters ^TY4[0-9]{5}$

Example: TY412345

項目和名：Type4ID
備考　　：主キー
　　　　　アプライアンス情報APIより取得

Request Body schema: application/json

profileInternetFwSeqList required	Array of strings (profileInternetFwSeq2) [ items <= 19 characters ] 項目和名：インターネットFWのプロファイルSEQリスト備考　　：-
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
profileInternetFwKeyId required	string (profileInternetFwKeyId) 項目和名：インターネットFWのプロファイル設定排他情報備考　　：排他確認用パラメータ　　　　：設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"profileInternetFwSeqList": ["1"
],
"note": "メッセージ",
"profileInternetFwKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

プロファイルAPI(URLフィルタリング)

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST：受付非同期方式
2. 内容
  プロファイル（URLフィルタリング）の参照・登録・変更・削除を行う

プロファイル（URLフィルタリング）のカテゴリ情報の一覧を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/policy/profile/urlfiltering/categories

Response samples

200
401
403
500

Content type

application/json

{"categoryList": [{"categoryName": "abortion",
"actionType": "ALLOW"
}
]
}

Type1プロファイル（URLフィルタリング）の詳細情報を取得

path Parameters

profileUrlSeq

required

string <= 19 characters

Example: 1

項目和名：URLフィルタリングのプロファイルSEQ
備考　　：主キー
　　　　　プロファイルAPIから取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/policy/profile/urlfiltering/type1/1

Response samples

Content type

application/json

{"profileUrlName": "Profile1",
"blackList": ["www.xxx.jp"
],
"blackListAction": "BLOCK",
"whiteList": ["www.xxx.jp"
],
"categoryList": [{"categoryName": "abortion",
"actionType": "ALLOW"
}
],
"description": "メモ",
"isPolicyInUse": true,
"profileUrlKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Type1プロファイル（URLフィルタリング）情報を変更

path Parameters

profileUrlSeq

required

string <= 19 characters

Example: 1

項目和名：URLフィルタリングのプロファイルSEQ
備考　　：主キー
　　　　　プロファイルAPIから取得

Request Body schema: application/json

profileUrlName required	string (profileUrlName2) <= 31 characters 項目和名：URLフィルタリングのプロファイル名備考　　：-
blackList required	Array of strings (blackList) [ items <= 255 characters ]
blackListAction required	string (blackListAction) Enum: "ALERT" "BLOCK" "CONTINUE" 項目和名：ブラックリストの動作備考　　：ALERT : alert 　　　　　BLOCK : block 　　　　　CONTINUE : continue
whiteList required	Array of strings (whiteList) [ items <= 255 characters ]
required	Array of objects (categoryList) 項目和名：個別カテゴリリスト備考　　：登録時にはすべての個別カテゴリを指定すること。
description	string (description5) <= 20 characters 項目和名：設定値の説明備考　　：-
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
profileUrlKeyId required	string (profileUrlKeyId1) 項目和名：URLフィルタリングのプロファイル設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"profileUrlName": "Profile1",
"blackList": ["www.xxx.jp"
],
"blackListAction": "BLOCK",
"whiteList": ["www.xxx.jp"
],
"categoryList": [{"categoryName": "abortion",
"actionType": "ALLOW"
}
],
"description": "メモ",
"note": "メッセージ",
"profileUrlKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

Type4プロファイル（URLフィルタリング）の詳細情報を取得

path Parameters

type4Id required	string <= 8 characters ^TY4[0-9]{5}$ Example: TY412345 項目和名：Type4ID 備考　　：主キー　　　　　アプライアンス情報APIより取得
profileUrlSeq required	string <= 19 characters Example: 1 項目和名：URLフィルタリングのプロファイルSEQ 備考　　：主キー　　　　　プロファイルAPIから取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/policy/profile/urlfiltering/type4/TY412345/1

Response samples

Content type

application/json

{"profileUrlName": "Profile1",
"blackList": ["www.xxx.jp"
],
"blackListAction": "BLOCK",
"whiteList": ["www.xxx.jp"
],
"categoryList": [{"categoryName": "abortion",
"actionType": "ALLOW"
}
],
"description": "メモ",
"isPolicyInUse": true,
"profileUrlKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Type4プロファイル（URLフィルタリング）情報を変更

path Parameters

type4Id required	string <= 8 characters ^TY4[0-9]{5}$ Example: TY412345 項目和名：Type4ID 備考　　：主キー　　　　　アプライアンス情報APIより取得
profileUrlSeq required	string <= 19 characters Example: 1 項目和名：URLフィルタリングのプロファイルSEQ 備考　　：主キー　　　　　プロファイルAPIから取得

Request Body schema: application/json

profileUrlName required	string (profileUrlName2) <= 31 characters 項目和名：URLフィルタリングのプロファイル名備考　　：-
blackList required	Array of strings (blackList) [ items <= 255 characters ]
blackListAction required	string (blackListAction) Enum: "ALERT" "BLOCK" "CONTINUE" 項目和名：ブラックリストの動作備考　　：ALERT : alert 　　　　　BLOCK : block 　　　　　CONTINUE : continue
whiteList required	Array of strings (whiteList) [ items <= 255 characters ]
required	Array of objects (categoryList) 項目和名：個別カテゴリリスト備考　　：登録時にはすべての個別カテゴリを指定すること。
description	string (description5) <= 20 characters 項目和名：設定値の説明備考　　：-
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
profileUrlKeyId required	string (profileUrlKeyId1) 項目和名：URLフィルタリングのプロファイル設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"profileUrlName": "Profile1",
"blackList": ["www.xxx.jp"
],
"blackListAction": "BLOCK",
"whiteList": ["www.xxx.jp"
],
"categoryList": [{"categoryName": "abortion",
"actionType": "ALLOW"
}
],
"description": "メモ",
"note": "メッセージ",
"profileUrlKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

Type1 プロファイル（URLフィルタリング）情報を登録

Request Body schema: application/json

profileUrlName required	string (profileUrlName2) <= 31 characters 項目和名：URLフィルタリングのプロファイル名備考　　：-
blackList required	Array of strings (blackList) [ items <= 255 characters ]
blackListAction required	string (blackListAction) Enum: "ALERT" "BLOCK" "CONTINUE" 項目和名：ブラックリストの動作備考　　：ALERT : alert 　　　　　BLOCK : block 　　　　　CONTINUE : continue
whiteList required	Array of strings (whiteList) [ items <= 255 characters ]
required	Array of objects (categoryList) 項目和名：個別カテゴリリスト備考　　：登録時にはすべての個別カテゴリを指定すること。
description	string (description5) <= 20 characters 項目和名：設定値の説明備考　　：-
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
profileUrlKeyId required	string (profileUrlKeyId1) 項目和名：URLフィルタリングのプロファイル設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"profileUrlName": "Profile1",
"blackList": ["www.xxx.jp"
],
"blackListAction": "BLOCK",
"whiteList": ["www.xxx.jp"
],
"categoryList": [{"categoryName": "abortion",
"actionType": "ALLOW"
}
],
"description": "メモ",
"note": "メッセージ",
"profileUrlKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

Type4 プロファイル（URLフィルタリング）情報を登録

path Parameters

type4Id

required

string <= 8 characters ^TY4[0-9]{5}$

Example: TY412345

項目和名：Type4ID
備考　　：主キー
　　　　　アプライアンス情報APIより取得

Request Body schema: application/json

profileUrlName required	string (profileUrlName2) <= 31 characters 項目和名：URLフィルタリングのプロファイル名備考　　：-
blackList required	Array of strings (blackList) [ items <= 255 characters ]
blackListAction required	string (blackListAction) Enum: "ALERT" "BLOCK" "CONTINUE" 項目和名：ブラックリストの動作備考　　：ALERT : alert 　　　　　BLOCK : block 　　　　　CONTINUE : continue
whiteList required	Array of strings (whiteList) [ items <= 255 characters ]
required	Array of objects (categoryList) 項目和名：個別カテゴリリスト備考　　：登録時にはすべての個別カテゴリを指定すること。
description	string (description5) <= 20 characters 項目和名：設定値の説明備考　　：-
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
profileUrlKeyId required	string (profileUrlKeyId1) 項目和名：URLフィルタリングのプロファイル設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"profileUrlName": "Profile1",
"blackList": ["www.xxx.jp"
],
"blackListAction": "BLOCK",
"whiteList": ["www.xxx.jp"
],
"categoryList": [{"categoryName": "abortion",
"actionType": "ALLOW"
}
],
"description": "メモ",
"note": "メッセージ",
"profileUrlKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

Type1プロファイル(URLフィルタリング)情報を削除

Request Body schema: application/json

profileUrlSeqList required	Array of strings (profileUrlSeq2) [ items <= 19 characters ] 項目和名：URLフィルタリングのプロファイルSEQリスト備考　　：-
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
profileUrlKeyId required	string (profileUrlKeyId1) 項目和名：URLフィルタリングのプロファイル設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"profileUrlSeqList": ["1"
],
"note": "メッセージ",
"profileUrlKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

Type4プロファイル(URLフィルタリング)情報を削除

path Parameters

type4Id

required

string <= 8 characters ^TY4[0-9]{5}$

Example: TY412345

項目和名：Type4ID
備考　　：主キー
　　　　　アプライアンス情報APIより取得

Request Body schema: application/json

profileUrlSeqList required	Array of strings (profileUrlSeq2) [ items <= 19 characters ] 項目和名：URLフィルタリングのプロファイルSEQリスト備考　　：-
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
profileUrlKeyId required	string (profileUrlKeyId1) 項目和名：URLフィルタリングのプロファイル設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"profileUrlSeqList": ["1"
],
"note": "メッセージ",
"profileUrlKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

IP Pool API

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST：受付非同期方式
2. 内容
  IP Pool設定(TYPE1、TYPE4)の設定取得/追加/変更/削除を行う。

IP Pool設定情報(TYPE1)を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/policy/ip-pools/type1

Response samples

200
401
403
500

Content type

application/json

{"total": 1,
"ipPoolList": [{"ipPoolSeq": "1",
"ipPoolName": "Pool1",
"globalIpAddress": "189.192.169.18/32",
"description": "備考",
"isPolicyInUse": true
}
],
"ipPoolKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

IP Pool設定情報(TYPE4)を取得

path Parameters

type4Id

required

string <= 8 characters ^TY4[0-9]{5}$

Example: TY412345

項目和名：TYPE4ID

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/policy/ip-pools/type4/TY412345

Response samples

Content type

application/json

{"total": 1,
"ipPoolList": [{"ipPoolSeq": "1",
"ipPoolName": "Pool1",
"globalIpAddress": "189.192.169.18/32",
"description": "備考",
"isPolicyInUse": true
}
],
"ipPoolKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

IP Pool設定情報(TYPE1)を追加

Request Body schema: application/json

ipPoolName required	string (ipPoolName1) <= 35 characters ([0-9a-zA-Z]{1,2})\|(^[0-9a-zA-Z][0-9a-zA-Z ]{... 項目和名：IPプール名備考　　：-
globalIpAddress required	string (globalIpAddress2) ^(([1-9]?[0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5])... 項目和名：グローバルIPアドレス備考　　：追加・変更時に選択する候補値はTYPE１の時にはサービスメニューAPI（インターネットType1）、TYPE4の時にはサービスメニューAPI(インターネットType4)より取得する。
description	string (description6) <= 20 characters 項目和名：設定値の説明備考　　：-
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
ipPoolKeyId required	string (ipPoolKeyId) 項目和名：IPpool排他情報備考　　：排他確認用パラメータ　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"ipPoolName": "Pool1",
"globalIpAddress": "189.192.169.18/32",
"description": "備考",
"note": "メッセージ",
"ipPoolKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

IP Pool設定情報(TYPE4)を追加

path Parameters

type4Id

required

string <= 8 characters ^TY4[0-9]{5}$

Example: TY412345

項目和名：TYPE4ID

Request Body schema: application/json

ipPoolName required	string (ipPoolName1) <= 35 characters ([0-9a-zA-Z]{1,2})\|(^[0-9a-zA-Z][0-9a-zA-Z ]{... 項目和名：IPプール名備考　　：-
globalIpAddress required	string (globalIpAddress2) ^(([1-9]?[0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5])... 項目和名：グローバルIPアドレス備考　　：追加・変更時に選択する候補値はTYPE１の時にはサービスメニューAPI（インターネットType1）、TYPE4の時にはサービスメニューAPI(インターネットType4)より取得する。
description	string (description6) <= 20 characters 項目和名：設定値の説明備考　　：-
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
ipPoolKeyId required	string (ipPoolKeyId) 項目和名：IPpool排他情報備考　　：排他確認用パラメータ　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"ipPoolName": "Pool1",
"globalIpAddress": "189.192.169.18/32",
"description": "備考",
"note": "メッセージ",
"ipPoolKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

IP Pool設定情報(TYPE1)を変更

path Parameters

ipPoolSeq

required

string <= 19 characters

Example: 1

項目和名：IPプールSEQ

Request Body schema: application/json

globalIpAddress required	string (globalIpAddress2) ^(([1-9]?[0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5])... 項目和名：グローバルIPアドレス備考　　：追加・変更時に選択する候補値はTYPE１の時にはサービスメニューAPI（インターネットType1）、TYPE4の時にはサービスメニューAPI(インターネットType4)より取得する。
description	string (description6) <= 20 characters 項目和名：設定値の説明備考　　：-
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
ipPoolKeyId required	string (ipPoolKeyId) 項目和名：IPpool排他情報備考　　：排他確認用パラメータ　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"globalIpAddress": "189.192.169.18/32",
"description": "備考",
"note": "メッセージ",
"ipPoolKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

IP Pool設定情報(TYPE4)を変更

path Parameters

type4Id required	string <= 8 characters ^TY4[0-9]{5}$ Example: TY412345 項目和名：TYPE4ID
ipPoolSeq required	string <= 19 characters Example: 1 項目和名：IPプールSEQ

Request Body schema: application/json

globalIpAddress required	string (globalIpAddress2) ^(([1-9]?[0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5])... 項目和名：グローバルIPアドレス備考　　：追加・変更時に選択する候補値はTYPE１の時にはサービスメニューAPI（インターネットType1）、TYPE4の時にはサービスメニューAPI(インターネットType4)より取得する。
description	string (description6) <= 20 characters 項目和名：設定値の説明備考　　：-
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
ipPoolKeyId required	string (ipPoolKeyId) 項目和名：IPpool排他情報備考　　：排他確認用パラメータ　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"globalIpAddress": "189.192.169.18/32",
"description": "備考",
"note": "メッセージ",
"ipPoolKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

IP Pool設定情報(TYPE1)を削除

Request Body schema: application/json

ipPoolList required	Array of strings (ipPoolSeq) [ items <= 19 characters ]
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
ipPoolKeyId required	string (ipPoolKeyId) 項目和名：IPpool排他情報備考　　：排他確認用パラメータ　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"ipPoolList": ["1"
],
"note": "メッセージ",
"ipPoolKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

IP Pool設定情報(TYPE4)を削除

path Parameters

type4Id

required

string <= 8 characters ^TY4[0-9]{5}$

Example: TY412345

項目和名：TYPE4ID

Request Body schema: application/json

ipPoolList required	Array of strings (ipPoolSeq) [ items <= 19 characters ]
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
ipPoolKeyId required	string (ipPoolKeyId) 項目和名：IPpool排他情報備考　　：排他確認用パラメータ　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"ipPoolList": ["1"
],
"note": "メッセージ",
"ipPoolKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

IPマッピングAPI

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST：受付非同期方式
2. 内容
  インターネットからイントラネット内の拠点へアクセスする際のNATのマッピング設定(TYPE1、TYPE4)の設定取得/追加/変更/削除を行う。

IPマッピング設定情報(TYPE1)を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/policy/ip-mappings/type1

Response samples

200
401
403
500

Content type

application/json

{"total": 1,
"ipMappingList": [{"virtualIpAddressSeq": "1",
"description": "備考",
"ipMappingName": "ipforward1",
"globalIpAddress": "111.98.206.8/32",
"ipAddressId": "obj44557",
"privateIpAddress": "192.168.0.10/32",
"isPortForward": true,
"protocol": "TCP",
"globalPort": "80",
"privatePort": "80",
"isPolicyInUse": true
}
],
"ipMappingKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

IPマッピング設定情報(TYPE4)を取得

path Parameters

type4Id

required

string <= 8 characters ^TY4[0-9]{5}$

Example: TY412345

項目和名：TYPE4ID

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/policy/ip-mappings/type4/TY412345

Response samples

200
400
401
403
500

Content type

application/json

{"total": 1,
"ipMappingList": [{"virtualIpAddressSeq": "1",
"description": "備考",
"ipMappingName": "ipforward1",
"globalIpAddress": "111.98.206.8/32",
"ipAddressId": "obj44557",
"privateIpAddress": "192.168.0.10/32",
"isPortForward": true,
"protocol": "TCP",
"globalPort": "80",
"privatePort": "80",
"isPolicyInUse": true
}
],
"ipMappingKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

IPマッピング設定情報(TYPE1)を追加

Request Body schema: application/json

description	string (description7) <= 20 characters 項目和名：設定値の説明備考　　：-
ipMappingName required	string (ipMappingName1) <= 63 characters ^[0-9a-zA-Z]+$ 項目和名：IPマッピング名備考　　：-
globalIpAddress required	string (globalIpAddress3) ^(([1-9]?[0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5])... 項目和名：グローバルIPアドレス備考　　：追加時に選択する候補値はType1の時にはサービスメニューAPI（インターネットType1）、TYPE4の時にはサービスメニューAPI(インターネットType4)より取得する。取得する項目はグローバルIPアドレスになります。
ipAddressId required	string (ipAddressId2) <= 22 characters 項目和名：アドレスID 備考　　：プライベートIPアドレスのアドレスオブジェクトの主キー。　　　　　追加、変更時に選択するプライベートIPアドレスに紐づく値で候補値はTYPE1の時にはType1プライベートサイトゾーン取得APIとType1エクストラサイトゾーン取得APIをあわせた情報、TYPE4の時にはtype4エクストラサイト取得APIより取得する。GETの時は現在登録されているプライベートIPアドレスに紐づく値を返却する。
isPortForward required	boolean (isPortForward) 項目和名：ポートフォワードフラグ備考　　：ONの場合は「true」、OFFの場合は「false」を設定する。
protocol	string (protocol4) Enum: "TCP" "UDP" 項目和名：プロトコル備考　　：POST (追加)時にポートフォワードフラグがtrueの場合は必須になります。以下のいずれかを設定します。　　　　　TCP: TCP 　　　　　UDP: UDP
globalPort	string (globalPort) 項目和名：グローバル側Port 備考　　：POST(追加)時にポートフォワードフラグがtrueの場合は必須になります。　　　　　ポート用のチェックはパターンでは表現できないため、パターンでは実行せずに他の方法で下記のチェックを実行する。　　　　　1:指定範囲を1～65535とする。　　　　　2:"-"で範囲指定可能の為、数値 + "-" + 数値の形式での指定を可能とする。
privatePort	string (privatePort) 項目和名：プライベート拠点側Port 備考　　：POST(追加)時にポートフォワードフラグがtrueの場合は必須になります。　　　　　ポート用のチェックはパターンでは表現できないため、パターンでは実行せずに他の方法で下記のチェックを実行する。　　　　　1:指定範囲を1～65535とする。　　　　　2:"-"で範囲指定可能の為、数値 + "-" + 数値の形式での指定を可能とする。
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
ipMappingKeyId required	string (ipMappingKeyId) 項目和名：IPマッピング排他情報備考　　：排他確認用パラメータ　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"description": "備考",
"ipMappingName": "ipforward1",
"globalIpAddress": "111.98.206.8/32",
"ipAddressId": "obj44557",
"isPortForward": true,
"protocol": "TCP",
"globalPort": "80",
"privatePort": "80",
"note": "メッセージ",
"ipMappingKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

IPマッピング設定情報(TYPE4)を追加

path Parameters

type4Id

required

string <= 8 characters ^TY4[0-9]{5}$

Example: TY412345

項目和名：TYPE4ID

Request Body schema: application/json

description	string (description7) <= 20 characters 項目和名：設定値の説明備考　　：-
ipMappingName required	string (ipMappingName1) <= 63 characters ^[0-9a-zA-Z]+$ 項目和名：IPマッピング名備考　　：-
globalIpAddress required	string (globalIpAddress3) ^(([1-9]?[0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5])... 項目和名：グローバルIPアドレス備考　　：追加時に選択する候補値はType1の時にはサービスメニューAPI（インターネットType1）、TYPE4の時にはサービスメニューAPI(インターネットType4)より取得する。取得する項目はグローバルIPアドレスになります。
ipAddressId required	string (ipAddressId2) <= 22 characters 項目和名：アドレスID 備考　　：プライベートIPアドレスのアドレスオブジェクトの主キー。　　　　　追加、変更時に選択するプライベートIPアドレスに紐づく値で候補値はTYPE1の時にはType1プライベートサイトゾーン取得APIとType1エクストラサイトゾーン取得APIをあわせた情報、TYPE4の時にはtype4エクストラサイト取得APIより取得する。GETの時は現在登録されているプライベートIPアドレスに紐づく値を返却する。
isPortForward required	boolean (isPortForward) 項目和名：ポートフォワードフラグ備考　　：ONの場合は「true」、OFFの場合は「false」を設定する。
protocol	string (protocol4) Enum: "TCP" "UDP" 項目和名：プロトコル備考　　：POST (追加)時にポートフォワードフラグがtrueの場合は必須になります。以下のいずれかを設定します。　　　　　TCP: TCP 　　　　　UDP: UDP
globalPort	string (globalPort) 項目和名：グローバル側Port 備考　　：POST(追加)時にポートフォワードフラグがtrueの場合は必須になります。　　　　　ポート用のチェックはパターンでは表現できないため、パターンでは実行せずに他の方法で下記のチェックを実行する。　　　　　1:指定範囲を1～65535とする。　　　　　2:"-"で範囲指定可能の為、数値 + "-" + 数値の形式での指定を可能とする。
privatePort	string (privatePort) 項目和名：プライベート拠点側Port 備考　　：POST(追加)時にポートフォワードフラグがtrueの場合は必須になります。　　　　　ポート用のチェックはパターンでは表現できないため、パターンでは実行せずに他の方法で下記のチェックを実行する。　　　　　1:指定範囲を1～65535とする。　　　　　2:"-"で範囲指定可能の為、数値 + "-" + 数値の形式での指定を可能とする。
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
ipMappingKeyId required	string (ipMappingKeyId) 項目和名：IPマッピング排他情報備考　　：排他確認用パラメータ　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"description": "備考",
"ipMappingName": "ipforward1",
"globalIpAddress": "111.98.206.8/32",
"ipAddressId": "obj44557",
"isPortForward": true,
"protocol": "TCP",
"globalPort": "80",
"privatePort": "80",
"note": "メッセージ",
"ipMappingKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

IPマッピング設定情報(TYPE1)を変更

path Parameters

virtualIpAddressSeq

required

string <= 19 characters

Example: 1

項目和名：バーチャルIPアドレスSEQ

Request Body schema: application/json

description	string (description7) <= 20 characters 項目和名：設定値の説明備考　　：-
ipAddressId required	string (ipAddressId2) <= 22 characters 項目和名：アドレスID 備考　　：プライベートIPアドレスのアドレスオブジェクトの主キー。　　　　　追加、変更時に選択するプライベートIPアドレスに紐づく値で候補値はTYPE1の時にはType1プライベートサイトゾーン取得APIとType1エクストラサイトゾーン取得APIをあわせた情報、TYPE4の時にはtype4エクストラサイト取得APIより取得する。GETの時は現在登録されているプライベートIPアドレスに紐づく値を返却する。
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
ipMappingKeyId required	string (ipMappingKeyId) 項目和名：IPマッピング排他情報備考　　：排他確認用パラメータ　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"description": "備考",
"ipAddressId": "obj44557",
"note": "メッセージ",
"ipMappingKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

IPマッピング設定情報(TYPE4)を変更

path Parameters

type4Id required	string <= 8 characters ^TY4[0-9]{5}$ Example: TY412345 項目和名：TYPE4ID
virtualIpAddressSeq required	string <= 19 characters Example: 1 項目和名：バーチャルIPアドレスSEQ

Request Body schema: application/json

description	string (description7) <= 20 characters 項目和名：設定値の説明備考　　：-
ipAddressId required	string (ipAddressId2) <= 22 characters 項目和名：アドレスID 備考　　：プライベートIPアドレスのアドレスオブジェクトの主キー。　　　　　追加、変更時に選択するプライベートIPアドレスに紐づく値で候補値はTYPE1の時にはType1プライベートサイトゾーン取得APIとType1エクストラサイトゾーン取得APIをあわせた情報、TYPE4の時にはtype4エクストラサイト取得APIより取得する。GETの時は現在登録されているプライベートIPアドレスに紐づく値を返却する。
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
ipMappingKeyId required	string (ipMappingKeyId) 項目和名：IPマッピング排他情報備考　　：排他確認用パラメータ　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"description": "備考",
"ipAddressId": "obj44557",
"note": "メッセージ",
"ipMappingKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

IPマッピング設定情報(TYPE1)を削除

Request Body schema: application/json

ipMappingList required	Array of strings (virtualIpAddressSeq) [ items <= 19 characters ]
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
ipMappingKeyId required	string (ipMappingKeyId) 項目和名：IPマッピング排他情報備考　　：排他確認用パラメータ　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"ipMappingList": ["1"
],
"note": "メッセージ",
"ipMappingKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

IPマッピング設定情報(TYPE4)を削除

path Parameters

type4Id

required

string <= 8 characters ^TY4[0-9]{5}$

Example: TY412345

項目和名：TYPE4ID

Request Body schema: application/json

ipMappingList required	Array of strings (virtualIpAddressSeq) [ items <= 19 characters ]
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
ipMappingKeyId required	string (ipMappingKeyId) 項目和名：IPマッピング排他情報備考　　：排他確認用パラメータ　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"ipMappingList": ["1"
],
"note": "メッセージ",
"ipMappingKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

仮想ネットワークAPI

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST：受付非同期方式
2. 内容
  仮想ネットワークの一覧参照・登録・変更・削除を行う

仮想ネットワークの一覧情報を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/vnetwork/vns

Response samples

200
401
403
500

Content type

application/json

{"totalBillingLine": 2,
"total": 1,
"vnInfoList": [{"vnType": "L3",
"vnName": "TEST_1",
"vlanIdType": "SPECIFIED",
"vlanId": 1111,
"vnCode": "DA1234",
"numberOfVnConnect": 0,
"upperLimitVnConnect": 100,
"numberOfBillingLine": 1
}
],
"vnKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

仮想ネットワークを追加

Request Body schema: application/json

vnType required	string (vnType1) Enum: "L2" "L3" 項目和名：仮想ネットワークタイプ備考　　：L2回線、L3回線どちらかを選択する。
vnName required	string (vnName3) <= 20 characters 項目和名：仮想ネットワーク名備考　　：-
vlanIdType	string (vlanIdType4) Enum: "UNTAG" "OTHER" "SPECIFIED" 項目和名：VLAN IDのType指定備考　　：L2回線のときのみ適用項目 UNTAG: IDの指定なし OTHER: 他の仮想ネットワークで指定されていないID,もしくは指定なし SPECIFIED: 指定ID
vlanId	integer <int32> (vlanId2) [ 1 .. 4094 ] 項目和名：VLAN ID 備考　　：L2回線のときかつ、vlanIdTypeで「SPECIFIED: 指定ID」を選択しているときに入力可能
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
vnKeyId required	string (vnKeyId) 項目和名：仮想ネットワーク設定排他情報備考　　：排他確認用パラメータ。　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"vnType": "L3",
"vnName": "TEST_1",
"vlanIdType": "SPECIFIED",
"vlanId": 1111,
"note": "メッセージ",
"vnKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

仮想ネットワークを変更

path Parameters

vnCode

required

string <= 6 characters ^[CD][A-Z][0-9]{4}$

Example: DA1234

項目和名：VNコード

Request Body schema: application/json

vnName required	string (vnName3) <= 20 characters 項目和名：仮想ネットワーク名備考　　：-
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
vnKeyId required	string (vnKeyId) 項目和名：仮想ネットワーク設定排他情報備考　　：排他確認用パラメータ。　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"vnName": "TEST_1",
"note": "メッセージ",
"vnKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

仮想ネットワークを削除

Request Body schema: application/json

vnCodeList required	Array of strings (vnCode1) [ items <= 6 characters ^[CD][A-Z][0-9]{4}$ ] 項目和名：VNコードリスト備考　　：削除対象の仮想ネットワークのVNコードを指定する。
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
vnKeyId required	string (vnKeyId) 項目和名：仮想ネットワーク設定排他情報備考　　：排他確認用パラメータ。　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"vnCodeList": ["DA1234"
],
"note": "メッセージ",
"vnKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

QoS設定API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  VNコネクトに対するQoS設定の参照・更新を行う。

QoS設定情報を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/vnetwork/qos

Response samples

200
401
403
500

Content type

application/json

{"total": 1,
"qosInfoList": [{"vpnVnCode": "BA1234",
"vnName": "TEST_1",
"vlanIdType": "SPECIFIED",
"vlanId": 1111,
"qosType": "BANDWIDTH",
"priorityTarget": "COS",
"numberOfVnConnect": "1",
"upperLimitVnConnect": "50",
"qosControl": "ENABLE"
}
]
}

絶対優先方式におけるQoS設定のデフォルトパターン情報を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/vnetwork/qos/absolute/default-patterns

Response samples

200
401
403
500

Content type

application/json

{"patternA": {"priority0": "NORMAL",
"priority1": "LOW",
"priority2": "LOW",
"priority3": "NORMAL",
"priority4": "MEDIUM",
"priority5": "MEDIUM",
"priority6": "HIGH",
"priority7": "HIGH"
},
"patternBCos": {"priority0": "LOW",
"priority1": "LOW",
"priority2": "NORMAL",
"priority3": "LOW",
"priority4": "MEDIUM",
"priority5": "HIGH",
"priority6": "MEDIUM",
"priority7": "MEDIUM"
},
"patternBIp": {"priority0": "LOW",
"priority1": "LOW",
"priority2": "NORMAL",
"priority3": "LOW",
"priority4": "MEDIUM",
"priority5": "HIGH",
"priority6": "HIGH",
"priority7": "MEDIUM"
}
}

QoS設定詳細を1件取得

path Parameters

vpnVnCode

required

string <= 6 characters ^[BCD][A-Z][0-9]{4}$

Example: BA1234

項目和名：VPN/VNコード
備考　　：主キー

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/vnetwork/BA1234/qos

Response samples

Content type

application/json

{"qosType": "BANDWIDTH",
"priorityTarget": "COS",
"qosAbsolute": {"priority0": "NORMAL",
"priority1": "NORMAL",
"priority2": "NORMAL",
"priority3": "NORMAL",
"priority4": "NORMAL",
"priority5": "NORMAL",
"priority6": "NORMAL",
"priority7": "NORMAL"
},
"qosBandwidth": {"priorityType1": "VALUE_1",
"priorityType2": "VALUE_2",
"priorityType3": "VALUE_4TO7",
"qosBandwidthList": [{"patternName": "PATTERN_A",
"priorityType1Value": 30,
"priorityType2Value": 30,
"priorityType3Value": 5,
"bestEffort": 10,
"isType1TopPriority": true
}
]
},
"qosKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

QoS設定の変更を行う

path Parameters

vpnVnCode

required

string <= 6 characters ^[BCD][A-Z][0-9]{4}$

Example: BA1234

項目和名：VPN/VNコード
備考　　：主キー

Request Body schema: application/json

qosType required	string (qosType1) Enum: "BANDWIDTH" "ABSOLUTE" "NONE" 項目和名：QoS方式備考　　：以下のいずれかを返す。 BANDWIDTH: 帯域制御方式 ABSOLUTE: 絶対優先方式 NONE: 未設定
priorityTarget required	string (priorityTarget) Enum: "IPPRECEDENCE" "COS" "NONE" 項目和名：優先度参照先備考　　：以下のいずれかを返す。 IPPRECEDENCE: IP Precedence COS: CoS NONE: 未設定
	object (qosPutAbsolute) 項目和名：絶対優先設定値情報(設定変更用) 備考　　：絶対優先方式の設定値情報。qosTypeがABSOLUTEの場合は必須、それ以外の場合はNULLになります。
	object (qosPutBandwidth) 項目和名：帯域制御設定値情報(設定変更用) 備考　　：帯域制御方式の設定値情報。　　　　　帯域制御方式の設定値情報。qosTypeがBANDWIDTHの場合は必須、それ以外の場合はNULLになります。　　　　　本プロパティではbestEffortを持たない(API内部で算出するため、通知不要)
qosKeyId required	string (qosKeyId) 項目和名：QoS設定排他情報備考　　：排他確認用パラメータ　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"qosType": "BANDWIDTH",
"priorityTarget": "COS",
"qosAbsolute": {"priority0": "NORMAL",
"priority1": "NORMAL",
"priority2": "NORMAL",
"priority3": "NORMAL",
"priority4": "NORMAL",
"priority5": "NORMAL",
"priority6": "NORMAL",
"priority7": "NORMAL"
},
"qosBandwidth": {"priorityType1": "VALUE_1",
"priorityType2": "VALUE_2",
"priorityType3": "VALUE_4TO7",
"qosBandwidthList": [{"patternName": "PATTERN_A",
"priorityType1Value": 30,
"priorityType2Value": 30,
"priorityType3Value": 5,
"isType1TopPriority": true
}
]
},
"qosKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

QoS設定 CSVダウンロード API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  QoS設定のcsvファイルを生成送信する機能

QoS設定情報のCSVを取得

query Parameters

tokenId

required

string <uuid>

Example: tokenId=ede66c43-9b9d-4222-93ed-5f11c96e08e2

項目和名：トークンID
備考　　：ログイン時に取得するトークンIDを設定

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v1/network/vnetwork/qos/csv?tokenId=ede66c43-9b9d-4222-93ed-5f11c96e08e2'

Response samples

401
403
500

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

VNコネクトAPI

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST：受付非同期方式
2. 内容
  VNコネクトの一覧参照・登録・変更・削除を行う。

VNコネクトを取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/vnetwork/vnconnects

Response samples

200
401
403
500
503

Content type

application/json

{"total": 1,
"vnConnectList": [{"wnumber": "W000000001",
"vnConnectName": "TEST1",
"enumber": "E000000010",
"isAssociate": true,
"vlanIdType": "SPECIFIED",
"vlanId": 1111,
"vnName": "VN名1",
"vpnVnCode": "BA1234",
"vnType": "L2",
"siteName": "サイト名1",
"ifStatus": "NO_SHUTDOWN",
"isVnConnectStatus": true
}
],
"vnConnectKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

VNコネクトを追加

Request Body schema: application/json

siteId required	string <= 22 characters 項目和名：サイトID 備考　　：サイト名特定するために必要　　　　"obj"+"数値"の形式　　　　Type1プライベートサイトゾーン取得APIのGETより取得 VNコネクト作成時のサイト情報はType1プライベートサイトゾーン取得APIのGETから取得する。 E番号:Type1プライベートサイトゾーン取得API.GET.enumber サイト名:Type1プライベートサイトゾーン取得API.GET.siteName vlanIdType:Type1プライベートサイトゾーン取得API.GET.vlanIdType vlanId:Type1プライベートサイトゾーン取得API.GET.vlanId
vpnVnCode required	string <= 6 characters ^[BCD][A-Z][0-9]{4}$ 項目和名: 接続先VPN/VNコード備考　　: VNコードはVPN/VNコード取得APIのGETより取得 VNコネクト作成時の接続先ネットワーク(VPN/VN)名はVPN/VNコード取得APIのGETから作成する。 VN名:VPN/VNコード取得API.GET.vnName VNコード:VPN/VNコード取得API.GET.vpnVnCode VN回線モード:VPN/VNコード取得.GET.vnType
vnConnectName required	string (vnConnectName) <= 20 characters 項目和名：VNコネクト名備考　　：-
pairLine	string (pairLine) <= 10 characters ^W[0-9]{9}$ 項目和名：ペア回線備考：ペア回線がなければNULLを設定
bandwidthType required	string Enum: "BURST" "BANDWIDTH_SECURED" "TRAFFICFREE" "PF" "BESTEFFORT" 項目和名：帯域タイプ備考　　：以下のいずれかを設定する。 BURST:バースト BANDWIDTH_SECURED:帯域確保 TRAFFICFREE:トラフィックフリー PF:PF BESTEFFORT:ベストエフォート　回線のアクセス回線種別によって、設定可能な帯域区分は以下になる。 1.アクセス回線種別が「イーサネット方式(L2モード)」:BURST 2.アクセス回線種別が「イーサネット方式(L3モード)」:BURST 3.アクセス回線種別が「ブロードバンドアクセス方式Ⅱ(L2モード)」:BURST 4.アクセス回線種別が「ブロードバンドアクセス方式Ⅱ(L3モード)」:BURST 5.アクセス回線種別が「ワイヤレスアクセス方式(L2モード)」:BURST 6.アクセス回線種別が「ワイヤレスアクセス方式(L3モード)」:BURST 7.アクセス回線種別が「PFGW」:BURST 8.アクセス回線種別が「IPsec方式」:BURST 9.アクセス回線種別が「イーサネット方式Ⅱ(TF有り)」:TRAFFICFREE/BANDWIDTH_SECURED 9.アクセス回線種別が「イーサネット方式Ⅱ (TF無し)」:BANDWIDTH_SECURED 9.アクセス回線種別が「イーサネット方式Ⅱ (UNO)」:BANDWIDTH_SECURED 9.アクセス回線種別が「イーサネット方式Ⅱ (10G/100G)」:BANDWIDTH_SECURED 10.アクセス回線種別が「イーサネット方式Ⅱ PF」:PF/BANDWIDTH_SECURED 10.アクセス回線種別が「イーサネット方式Ⅱ PF(UNO)」:PF/BANDWIDTH_SECURED 10.アクセス回線種別が「イーサネット方式Ⅱ PF (10G/100G)」:PF/BANDWIDTH_SECURED 11.アクセス回線種別が「ブロードバンドアクセス方式Ⅲ」:BESTEFFORT 12.アクセス回線種別が「ワイヤレスアクセス方式Ⅱ」:BESTEFFORT 13.アクセス回線種別が「イーサネットライト」:BESTEFFORT 14.アクセス回線種別が「PFアクセスGWⅡ」:PF/BANDWIDTH_SECURED 15.アクセス回線種別が「エクステンドイーサネット方式」:BURST/BANDWIDTH_SECURED 16.アクセス回線種別が「PFアクセスGW」:BURST/BANDWIDTH_SECURED その際、VNコネクトを作成する回線の情報はアクセス品目APIのGETから取得する。 - VNコネクトを作成する回線の帯域タイプ:アクセス品目API.GET.accessType - UNO回線判定フラグ:アクセス品目API.GET.isUno - 物理I/F:アクセス品目API.GET.physicalInterface なお、TF有り、TF無し、UNO、10G/100Gに関しては上記VNコネクトを作成する回線の情報から判定する。
	object (bandwidth5) 項目和名：帯域備考　　：帯域タイプで「BURST」「BESTEFFORT」が選択された場合、bandwidthはNULLとなる。　　　　　帯域は以下の値を設定可能とする。　　　　　0.5M･1M～9M(1M刻み)､10M～90M(10M刻み)､100M～1G(100M刻み)､2G～10G(1G刻み) 　　　　　20G～100G(10G刻み)　※100G回線の場合のみ
description	string (description8) <= 20 characters 項目和名：設定値の説明備考　　：-
	object (qos1) 項目和名：QoS設定備考　　：以下の場合、NULLを設定する。　　　　　・アクセス回線種別が「イーサネット方式Ⅱ (10G/100G)」または「イーサネット方式ⅡPF (10G/100G)」　　　　　・設定対象のVPN/VNコードのQoS設定がOFFまたは、ONでQoS方式未設定の場合　　　　　QoS設定がONで絶対優先の場合は、isQoSをtureに設定し、qosBandControlPatternをNULLにする　　　　　QoS設定がONで帯域優先の他場合は、isQoSをtureに設定し、qosBandControlPatternを合わせて設定する
	object (l2) 項目和名：L2回線備考　　：L3回線選択の場合NULLになる。
	object (l3) 項目和名：L3回線備考　　：L2回線選択の場合NULLになる。
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
vnConnectKeyId required	string (vnConnectKeyId) 項目和名：VNコネクト設定排他情報備考　　：排他確認用パラメータ　　　　：設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"siteId": "obj44558",
"vpnVnCode": "BA1234",
"vnConnectName": "TEST1",
"pairLine": "W000000002",
"bandwidthType": "BANDWIDTH_SECURED",
"bandwidth": {"value": 100,
"unit": "MBPS"
},
"description": "メッセージ",
"qos": {"isQoS": true,
"qosBandControlPattern": "PATTERN_A"
},
"l2": {"isVlanControl": true
},
"l3": {"wanAddress": "192.168.1.1/29",
"dhcpRelay": {"primaryAddress": "192.168.1.103",
"secondaryAddress": "192.168.1.32"
},
"static": [{"lanAddress": "192.168.1.1/29",
"nextHopAddress": "192.168.1.1"
}
],
"bgp4": {"routeAggregation": "ON",
"routeAggregationAddressList": ["192.168.1.1/29",
"192.168.1.2/29"
],
"peerIpAddress": "192.168.1.1",
"asNumber": 9996,
"md5Key": "9ab5b5d1a393a2ab6ee8298ef4e18770",
"maximumPrefix": 100,
"med": "LOW_PRIORITY",
"localPreference": "LOW_PRIORITY"
}
},
"note": "メッセージ",
"vnConnectKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

VNコネクト情報詳細を取得

path Parameters

wnumber

required

string <= 10 characters ^W[0-9]{9}$

Example: W000000001

項目和名：W番号

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/vnetwork/vnconnect/W000000001

Response samples

Content type

application/json

{"vnConnectName": "TEST1",
"enumber": "E000000010",
"isAssociate": true,
"vlanIdType": "SPECIFIED",
"vlanId": 1111,
"vnName": "VN名1",
"vpnVnCode": "BA1234",
"vnType": "L2",
"siteName": "サイト名1",
"pairLine": "W000000002",
"bandwidthType": "BANDWIDTH_SECURED",
"bandwidth": {"value": 100,
"unit": "MBPS"
},
"description": "メッセージ",
"qos": {"isQoS": true,
"qosBandControlPattern": "PATTERN_A"
},
"l2": {"isVlanControl": true
},
"l3": {"wanAddress": "192.168.1.1/29",
"dhcpRelay": {"primaryAddress": "192.168.1.103",
"secondaryAddress": "192.168.1.32"
},
"static": [{"lanAddress": "192.168.1.1/29",
"nextHopAddress": "192.168.1.1"
}
],
"bgp4": {"routeAggregation": "ON",
"routeAggregationAddressList": ["192.168.1.1/29",
"192.168.1.2/29"
],
"peerIpAddress": "192.168.1.1",
"asNumber": 9996,
"md5Key": "9ab5b5d1a393a2ab6ee8298ef4e18770",
"maximumPrefix": 100,
"med": "LOW_PRIORITY",
"localPreference": "LOW_PRIORITY"
}
},
"ifStatus": "NO_SHUTDOWN",
"isVnConnectStatus": true,
"vnConnectKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

VNコネクトの詳細内容を変更

path Parameters

wnumber

required

string <= 10 characters ^W[0-9]{9}$

Example: W000000001

項目和名：W番号

Request Body schema: application/json

vnConnectName required	string (vnConnectName) <= 20 characters 項目和名：VNコネクト名備考　　：-
bandwidthType required	string Enum: "BURST" "BANDWIDTH_SECURED" "TRAFFICFREE" "PF" "BESTEFFORT" 項目和名：帯域タイプ備考　　：以下のいずれかを設定する。 BURST:バースト BANDWIDTH_SECURED:帯域確保 TRAFFICFREE:トラフィックフリー PF:PF BESTEFFORT:ベストエフォートその際、以下の場合のみ設定変更が可能となる。・選択した回線のアクセス回線種別が「イーサネット方式Ⅱ PF」の場合・選択した回線のアクセス回線種別が「PFアクセスGWⅡ」の場合・選択した回線のアクセス回線種別が「イーサネット方式Ⅱ」かつ、設定済みの帯域タイプが「トラフィックフリー」であった場合また、選択した回線のアクセス回線種別によって、設定可能な帯域区分は以下になる。 1.アクセス回線種別が「イーサネット方式Ⅱ」:TRAFFICFREE/BANDWIDTH_SECURED 2.アクセス回線種別が「イーサネット方式Ⅱ PF」:PF/BANDWIDTH_SECURED 3.アクセス回線種別が「PFアクセスGWⅡ」:PF/BANDWIDTH_SECURED
	object (bandwidth5) 項目和名：帯域備考　　：帯域タイプで「BURST」「BESTEFFORT」が選択された場合、bandwidthはNULLとなる。　　　　　帯域は以下の値を設定可能とする。　　　　　0.5M･1M～9M(1M刻み)､10M～90M(10M刻み)､100M～1G(100M刻み)､2G～10G(1G刻み) 　　　　　20G～100G(10G刻み)　※100G回線の場合のみ
description	string (description8) <= 20 characters 項目和名：設定値の説明備考　　：-
	object (qos1) 項目和名：QoS設定備考　　：以下の場合、NULLを設定する。　　　　　・アクセス回線種別が「イーサネット方式Ⅱ (10G/100G)」または「イーサネット方式ⅡPF (10G/100G)」　　　　　・設定対象のVPN/VNコードのQoS設定がOFFまたは、ONでQoS方式未設定の場合　　　　　QoS設定がONで絶対優先の場合は、isQoSをtureに設定し、qosBandControlPatternをNULLにする　　　　　QoS設定がONで帯域優先の他場合は、isQoSをtureに設定し、qosBandControlPatternを合わせて設定する
	object 項目和名：L3回線備考　　：L2回線選択の場合NULLになる
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
vnConnectKeyId required	string (vnConnectKeyId) 項目和名：VNコネクト設定排他情報備考　　：排他確認用パラメータ　　　　：設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"vnConnectName": "TEST1",
"bandwidthType": "BANDWIDTH_SECURED",
"bandwidth": {"value": 100,
"unit": "MBPS"
},
"description": "メッセージ",
"qos": {"isQoS": true,
"qosBandControlPattern": "PATTERN_A"
},
"l3": {"dhcpRelay": {"primaryAddress": "192.168.1.103",
"secondaryAddress": "192.168.1.32"
},
"static": [{"lanAddress": "192.168.1.1/29",
"nextHopAddress": "192.168.1.1"
}
],
"bgp4": {"routeAggregation": "ON",
"routeAggregationAddressList": ["192.168.1.1/29",
"192.168.1.2/29"
],
"peerIpAddress": "192.168.1.1",
"asNumber": 9996,
"md5Key": "9ab5b5d1a393a2ab6ee8298ef4e18770",
"maximumPrefix": 100,
"med": "LOW_PRIORITY",
"localPreference": "LOW_PRIORITY"
}
},
"note": "メッセージ",
"vnConnectKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

VNコネクトの有効無効状態を有効に変更(※有効無効状態の変更件数上限は10件まで)

Request Body schema: application/json

orderList required	Array of strings (wnumber1) [ items <= 10 characters ^W[0-9]{9}$ ]
vnConnectKeyId required	string (vnConnectKeyId) 項目和名：VNコネクト設定排他情報備考　　：排他確認用パラメータ　　　　：設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"orderList": ["W000000001"
],
"vnConnectKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

VNコネクトの有効無効状態を無効に変更(※有効無効状態の変更件数上限は10件まで)

Request Body schema: application/json

orderList required	Array of strings (wnumber1) [ items <= 10 characters ^W[0-9]{9}$ ]
vnConnectKeyId required	string (vnConnectKeyId) 項目和名：VNコネクト設定排他情報備考　　：排他確認用パラメータ　　　　：設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"orderList": ["W000000001"
],
"vnConnectKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

VNコネクトを削除

path Parameters

wnumber

required

string <= 10 characters ^W[0-9]{9}$

Example: W000000001

項目和名：W番号

Request Body schema: application/json

vnConnectKeyId

required

string (vnConnectKeyId)

項目和名：VNコネクト設定排他情報
備考　　：排他確認用パラメータ
　　　　：設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"vnConnectKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

VNコネクト CSVダウンロード API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  VNコネクト一覧のcsvファイルを生成送信する機能

VNコネクト一覧のCSVを取得

query Parameters

tokenId

required

string <uuid>

Example: tokenId=ede66c43-9b9d-4222-93ed-5f11c96e08e2

項目和名：トークンID
備考　　：ログイン時に取得するトークンIDを設定

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v1/network/vnetwork/vnconnects/csv?tokenId=ede66c43-9b9d-4222-93ed-5f11c96e08e2'

Response samples

401
403
404
500

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

VNコネクトCSV一括登録API

概要
1. インターフェースタイプ
  登録チェック：同期応答方式
  登録：受付非同期方式
2. 内容
  VNコネクト一括情報の登録チェック、登録を行う

VNコネクト一括登録情報の登録チェック

query Parameters

fileType required	string Enum: "L2VN" "L3VN_STATIC" "L3VN_BGP4" 項目和名：ファイル種別備考　　：L2VN:L2回線 L3VN_STATIC:L3回線STATIC選択 L3VN_BGP4:L3回線BGP4選択
fileName required	string Example: fileName=virtual_line_setting_20211213171354.csv 項目和名：ファイル名備考　　：csvファイル形式であること

Request Body schema: text/csv

string <binary> (csvFile)

Responses

Request samples

Curl

curl --request POST \
  --url 'https://wvs2.kddi.ne.jp/api/v1/network/vnetwork/vnconnect-csv/check?fileType=SOME_STRING_VALUE&fileName=virtual_line_setting_20211213171354.csv'

Response samples

Content type

application/json

{"success": {"total": 1,
"vnConnectCsvList": [{"enumber": "E000000010",
"siteName": "サイト名1",
"vlanIdType": "SPECIFIED",
"vlanId": 1111,
"vpnVnCode": "BA1234",
"vnConnectName": "TEST_L3_1",
"bandwidthType": "BANDWIDTH_SECURED",
"bandwidth": {"value": 100,
"unit": "MBPS"
},
"description": "メッセージ",
"qos": {"isQoS": true,
"qosBandControlPattern": "PATTERN_A"
},
"l2": {"isVlanControl": true
},
"l3": {"wanAddress": "192.168.1.1/29",
"dhcpRelay": {"primaryAddress": "192.168.1.103",
"secondaryAddress": "192.168.1.32"
},
"static": [{"lanAddress": "192.168.1.1/29",
"nextHopAddress": "192.168.1.1"
}
],
"bgp4": {"routeAggregation": "CUSTOM",
"routeAggregationAddressList": ["192.168.1.1/29",
"192.168.1.2/29"
],
"asNumber": 9996,
"peerIpAddress": "192.168.1.1",
"md5Key": "kddi",
"med": "HIGH_PRIORITY",
"localPreference": "HIGH_PRIORITY"
}
}
}
],
"vnConnectCsvKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
},
"error": {"checkErrorList": [{"rowNumber": 1,
"checkErrorMessageList": ["未契約のアクセス回線が含まれています。"
]
}
]
}
}

VNコネクト一括登録情報の登録

Request Body schema: application/json

required	Array of objects
vnConnectCsvKeyId required	string (vnConnectCsvKeyId) 項目和名：VNコネクトCSV一括登録排他情報備考　　：排他確認用　　　　　設定変更を行う場合にはチェックのPOSTメソッドのレスポンスにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"vnConnectCsvList": [{"enumber": "E000000010",
"siteName": "サイト名1",
"vlanIdType": "SPECIFIED",
"vlanId": 1111,
"vpnVnCode": "BA1234",
"vnConnectName": "TEST_L3_1",
"bandwidthType": "BANDWIDTH_SECURED",
"bandwidth": {"value": 100,
"unit": "MBPS"
},
"description": "メッセージ",
"qos": {"isQoS": true,
"qosBandControlPattern": "PATTERN_A"
},
"l2": {"isVlanControl": true
},
"l3": {"wanAddress": "192.168.1.1/29",
"dhcpRelay": {"primaryAddress": "192.168.1.103",
"secondaryAddress": "192.168.1.32"
},
"static": [{"lanAddress": "192.168.1.1/29",
"nextHopAddress": "192.168.1.1"
}
],
"bgp4": {"routeAggregation": "CUSTOM",
"routeAggregationAddressList": ["192.168.1.1/29",
"192.168.1.2/29"
],
"asNumber": 9996,
"peerIpAddress": "192.168.1.1",
"md5Key": "kddi",
"med": "HIGH_PRIORITY",
"localPreference": "HIGH_PRIORITY"
}
}
}
],
"vnConnectCsvKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

パケットフィルタAPI

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST(VNコネクト用) ：受付非同期方式
  POST(アクセス回線用)：受付非同期方式
2. 内容
  パケットフィルタリング設定情報の一覧参照・変更・削除を行う。

パケットフィルタ用VNコネクト一覧を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/vnetwork/packetfilters/vnconnect

Response samples

200
401
403
500

Content type

application/json

{"total": 1,
"packetFilterList": [{"wnumber": "W000000001",
"vnConnectName": "TEST_L3_1",
"enumberAct": "E000000010",
"enumberSby": "E000000020",
"menu": "ETHER2",
"vlanIdType": "SPECIFIED",
"vlanId": 1111,
"vnName": "VN名1",
"dstVpnVnCode": "BA1234",
"siteName": "サイト名1",
"filterringSettingStatus": "FILTERING"
}
],
"vnConnectPacketFilterKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

パケットフィルタ用アクセス回線一覧を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/vnetwork/packetfilters/access-line

Response samples

200
401
403
500

Content type

application/json

{"total": 1,
"packetFilterList": [{"enumber": "E000000010",
"menu": "EXTEND_ETHERNET",
"filterringSettingStatus": "FILTERING"
}
],
"accessLinePacketFilterKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

VNコネクト用パケットフィルタのパケットフィルタルール一覧を取得

path Parameters

wnumber

required

string <= 10 characters ^W[0-9]{9}$

Example: W000000001

項目和名：W番号
備考　　：主キー相当

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/vnetwork/packetfilters/vnconnect/W000000001

Response samples

Content type

application/json

{"total": 1,
"packetFilterRuleList": [{"packetFilterRuleSeq": "3",
"isDefaultRule": false,
"protocol": "TCP",
"protocolNumber": 1,
"action": "PERMIT",
"srcAddress": "192.168.1.1/29",
"srcPort": 1111,
"dstAddress": "192.168.1.1/29",
"dstPort": 1111,
"filteringStatus": "ENABLED",
"description": "メッセージ"
}
]
}

VNコネクト用パケットフィルタのパケットフィルタルールを変更

path Parameters

wnumber

required

string <= 10 characters ^W[0-9]{9}$

Example: W000000001

項目和名：W番号
備考　　：主キー相当

Request Body schema: application/json

required	Array of objects (PutPacketFilterRuleModel) 項目和名：パケットフィルタルールリスト備考　　：指定したルールの順が処理順となる。　　　　　変更対象となるルールはユーザ設定フィルタルールのみとする。　　　　　（変更対象外のデフォルトルールが含まれていても読み飛ばし、処理を継続する。）　　　　　ルールの新規追加時にはpacketFilterRuleSeqにNULLを指定する。
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
vnConnectPacketFilterKeyId required	string (vnConnectPacketFilterKeyId) 項目和名：VNコネクト用パケットフィルタ設定排他情報備考　　：排他確認用パラメータ　　　　：設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"packetFilterRuleList": [{"packetFilterRuleSeq": "3",
"isDefaultRule": false,
"protocol": "TCP",
"protocolNumber": 1,
"action": "PERMIT",
"srcAddress": "192.168.1.1/29",
"srcPort": 1111,
"dstAddress": "192.168.1.1/29",
"dstPort": 1111,
"filteringStatus": "ENABLED",
"description": "メッセージ"
}
],
"note": "メッセージ",
"vnConnectPacketFilterKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

アクセス回線用パケットフィルタのパケットフィルタルール一覧を取得

path Parameters

enumber

required

string <= 10 characters ^E[0-9]{8}0$

Example: E000000010

項目和名：E番号
備考　　：主キー相当

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/vnetwork/packetfilters/access-line/E000000010

Response samples

Content type

application/json

{"total": 1,
"packetFilterRuleList": [{"packetFilterRuleSeq": "3",
"isDefaultRule": false,
"protocol": "TCP",
"protocolNumber": 1,
"action": "PERMIT",
"srcAddress": "192.168.1.1/29",
"srcPort": 1111,
"dstAddress": "192.168.1.1/29",
"dstPort": 1111,
"filteringStatus": "ENABLED",
"description": "メッセージ"
}
]
}

アクセス回線用パケットフィルタのパケットフィルタルールを変更

path Parameters

enumber

required

string <= 10 characters ^E[0-9]{8}0$

Example: E000000010

項目和名：E番号
備考　　：主キー相当

Request Body schema: application/json

required	Array of objects (PutPacketFilterRuleModel) 項目和名：パケットフィルタルールリスト備考　　：指定したルールの順が処理順となる。　　　　　変更対象となるルールはユーザ設定フィルタルールのみとする。　　　　　（変更対象外のデフォルトルールが含まれていても読み飛ばし、処理を継続する。）　　　　　ルールの新規追加時にはpacketFilterRuleSeqにNULLを指定する。
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
accessLinePacketFilterKeyId required	string (accessLinePacketFilterKeyId) 項目和名：アクセス回線用パケットフィルタ設定排他情報備考　　：排他確認用パラメータ　　　　：設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"packetFilterRuleList": [{"packetFilterRuleSeq": "3",
"isDefaultRule": false,
"protocol": "TCP",
"protocolNumber": 1,
"action": "PERMIT",
"srcAddress": "192.168.1.1/29",
"srcPort": 1111,
"dstAddress": "192.168.1.1/29",
"dstPort": 1111,
"filteringStatus": "ENABLED",
"description": "メッセージ"
}
],
"note": "メッセージ",
"accessLinePacketFilterKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

VNコネクト用パケットフィルタ設定回線のパケットフィルタルールを削除

Request Body schema: application/json

wnumber required	string (wnumber2) <= 10 characters ^W[0-9]{9}$ 項目和名：W番号備考　　：主キー相当
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
vnConnectPacketFilterKeyId required	string (vnConnectPacketFilterKeyId) 項目和名：VNコネクト用パケットフィルタ設定排他情報備考　　：排他確認用パラメータ　　　　：設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"wnumber": "W000000001",
"note": "メッセージ",
"vnConnectPacketFilterKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

アクセス回線用パケットフィルタ設定回線のパケットフィルタルールを削除

Request Body schema: application/json

enumber required	string (enumber) <= 10 characters ^E[0-9]{8}0$ 項目和名：E番号備考　　：-
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
accessLinePacketFilterKeyId required	string (accessLinePacketFilterKeyId) 項目和名：アクセス回線用パケットフィルタ設定排他情報備考　　：排他確認用パラメータ　　　　：設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"enumber": "E000000010",
"note": "メッセージ",
"accessLinePacketFilterKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

パケットフィルタ CSVダウンロード API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  パケットフィルタリング設定情報のcsvファイルを生成送信する機能

パケットフィルタ一覧のCSVを取得

query Parameters

tokenId

required

string <uuid>

Example: tokenId=ede66c43-9b9d-4222-93ed-5f11c96e08e2

項目和名：トークンID
備考　　：ログイン時に取得するトークンIDを設定

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v1/network/vnetwork/packetfilters/csv?tokenId=ede66c43-9b9d-4222-93ed-5f11c96e08e2'

Response samples

401
403
500

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

VN L2/L3コネクト API

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST：受付非同期方式
2. 内容
  VN L2L3コネクト設定の取得や追加、更新、削除を行う。

VN L2/L3回線を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/vnetwork/vnl2l3lines

Response samples

200
401
403
500

Content type

application/json

{"lineList": ["E000000010"
]
}

VN L2/L3コネクト一覧を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/vnetwork/vnl2l3connects

Response samples

200
401
403
500

Content type

application/json

{"vnl2l3ConnectKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d",
"total": 1,
"vnl2l3ConnectList": [{"enumber": "E000000010",
"wnumber": "W000000001",
"vnConnectName": "TEST_L3_1",
"routingType": "BGP4",
"l2VnVlanIdType": "SPECIFIED",
"l2VnVlanId": 1111,
"vnl2l3VlanIdType": "SPECIFIED",
"vnl2l3VnVlanId": 1111,
"description": "メッセージ",
"l2VnName": "L2VN",
"l2VnCode": "CA1234",
"l3VpnVnName": "L3VN",
"l3VpnVnCode": "BA1234"
}
]
}

VN L2/L3コネクト設定を行う(追加)

登録時に設定対象となるenumberは、VN L2/L3回線一覧を取得(プルダウン用)メソッドで取得したリストから選択する。
VPN/VNコードは、VPN/VNコード取得APIのGETメソッドにて取得する。

Request Body schema: application/json

vnl2l3ConnectKeyId required	string (vnl2l3ConnectKeyId) 項目和名：VNL2L3コネクト設定排他情報備考　　：排他確認用パラメータ。　　　　：設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。
l2VnCode required	string (l2VnCode) <= 6 characters ^C[A-Z][0-9]{4}$ 項目和名：L2VNコード備考　　：
l3VpnVnCode required	string (l3VpnVnCode) <= 6 characters ^[BD][A-Z][0-9]{4}$ 項目和名：L3VPN/VNコード備考　　：Bから始まる場合はVPN。それ以外の場合はVN
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
vnConnectName required	string (vnConnectName2) <= 20 characters 項目和名：VNL2L3コネクト名備考　　：-
	Array of objects (bgp42) 項目和名：L3VN_BGP4 備考　　：ルーティング種別で「BGP4」以外を選択した場合NULLになる
required	Array of objects (static2) 項目和名：L3VN_STATIC 備考　　：ルーティング種別で「STATIC」以外を選択した場合,または「LANアドレス」と「ネクストホップアドレス」を登録しない場合は空配列になる
	object (ospf) 項目和名：L3VN_OSPF 備考　　：ルーティング種別で「OSPF」以外を選択した場合NULLになる
description	string (description11) <= 20 characters 項目和名：設定値の説明備考　　：-
enumber required	string (enumber) <= 10 characters ^E[0-9]{8}0$ 項目和名：E番号備考　　：-
vnl2l3VlanIdType required	string (vnl2l3VlanIdType) Enum: "UNTAG" "SPECIFIED" 項目和名：VN L2/L3コネクトのVLAN IDのType指定備考　　：l2VnVlanIdTypeがUNTAGの場合はUNTAGを設定　　　　　l2VnVlanIdTypeがOTHERかつ、本パラメータでUNTAGを指定したい場合はUNTAGを設定　　　　　l2VnVlanIdTypeがOTHERかつ、本パラメータでSPECIFIEDを指定したい場合はSPECIFIEDを設定　　　　　l2VnVlanIdTypeがSPECIFIEDの場合はSPECIFIEDを設定　　　　　UNTAG: IDの指定なし　　　　　SPECIFIED: 指定ID
vnl2l3VnVlanId	integer <int32> (vnl2l3VnVlanId) [ 1 .. 4094 ] 項目和名：VN L2/L3コネクトのVLAN ID 備考　　：vnl2l3VlanIdTypeで「SPECIFIED: 指定ID」を選択しているときに必須項目
routingType required	string (routingType) Enum: "BGP4" "STATIC" "OSPF" 項目和名：ルーティング種別備考　　：必須項目　　　　　BGP4：BGP4ルーティング　　　　　STATIC：静的ルーティング　　　　　OSPF：OSPFルーティング
wanAddress required	string (wanAddress) ^(([1-9]?[0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5])... 項目和名：WANアドレス備考　　：必須項目

Responses

Request samples

Payload
Curl

Content type

application/json

{"vnl2l3ConnectKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d",
"l2VnCode": "CA1234",
"l3VpnVnCode": "BA1234",
"note": "メッセージ",
"vnConnectName": "TEST_L3_1",
"bgp4": [{"peerName": "PEER1",
"peerIpAddress": "192.168.1.1",
"asNumber": 9995,
"md5Key": "5d41402abc4b2a76b9719d911017c5f7",
"maximumPrefix": 100,
"med": "LOW_PRIORITY",
"localPreference": "LOW_PRIORITY",
"isRouteAggregation": false
}
],
"static": [{"lanAddress": "192.168.1.1/29",
"nextHopAddress": "192.168.1.1"
}
],
"ospf": {"areaNumber": "123"
},
"description": "メッセージ",
"enumber": "E000000010",
"vnl2l3VlanIdType": "SPECIFIED",
"vnl2l3VnVlanId": 1111,
"routingType": "BGP4",
"wanAddress": "192.168.1.1/29"
}

Response samples

Content type

application/json

{"jobId": "1"
}

VN L2/L3コネクトの詳細情報を取得

path Parameters

wnumber

required

string <= 10 characters ^W[0-9]{9}$

Example: W000000001

項目和名：W番号
備考　　：-

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/vnetwork/vnl2l3connect/W000000001

Response samples

Content type

application/json

{"vnl2l3ConnectKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d",
"l2VnName": "L2VN",
"l2VnCode": "CA1234",
"l3VpnVnName": "L3VN",
"l3VpnVnCode": "BA1234",
"vnConnectName": "TEST_L3_1",
"bgp4": [{"peerName": "PEER1",
"peerIpAddress": "192.168.1.1",
"asNumber": 9995,
"md5Key": "5d41402abc4b2a76b9719d911017c5f7",
"maximumPrefix": 100,
"med": "LOW_PRIORITY",
"localPreference": "LOW_PRIORITY",
"isRouteAggregation": false
}
],
"static": [{"lanAddress": "192.168.1.1/29",
"nextHopAddress": "192.168.1.1"
}
],
"ospf": {"areaNumber": "123"
},
"description": "メッセージ",
"enumber": "E000000010",
"l2VnVlanIdType": "SPECIFIED",
"l2VnVlanId": 1111,
"vnl2l3VlanIdType": "SPECIFIED",
"vnl2l3VnVlanId": 1111,
"routingType": "BGP4",
"wanAddress": "192.168.1.1/29",
"ifStatus": "NO_SHUTDOWN"
}

VN L2/L3コネクト設定を行う(変更)

path Parameters

wnumber

required

string <= 10 characters ^W[0-9]{9}$

Example: W000000001

項目和名：W番号
備考　　：-

Request Body schema: application/json

vnl2l3ConnectKeyId required	string (vnl2l3ConnectKeyId) 項目和名：VNL2L3コネクト設定排他情報備考　　：排他確認用パラメータ。　　　　：設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
vnConnectName required	string (vnConnectName2) <= 20 characters 項目和名：VNL2L3コネクト名備考　　：-
	Array of objects (bgp42) 項目和名：L3VN_BGP4 備考　　：ルーティング種別で「BGP4」以外を選択した場合NULLになる
required	Array of objects (static2) 項目和名：L3VN_STATIC 備考　　：ルーティング種別で「STATIC」以外を選択した場合,または「LANアドレス」と「ネクストホップアドレス」を登録しない場合は空配列になる
	object (ospf) 項目和名：L3VN_OSPF 備考　　：ルーティング種別で「OSPF」以外を選択した場合NULLになる
description	string (description11) <= 20 characters 項目和名：設定値の説明備考　　：-

Responses

Request samples

Payload
Curl

Content type

application/json

{"vnl2l3ConnectKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d",
"note": "メッセージ",
"vnConnectName": "TEST_L3_1",
"bgp4": [{"peerName": "PEER1",
"peerIpAddress": "192.168.1.1",
"asNumber": 9995,
"md5Key": "5d41402abc4b2a76b9719d911017c5f7",
"maximumPrefix": 100,
"med": "LOW_PRIORITY",
"localPreference": "LOW_PRIORITY",
"isRouteAggregation": false
}
],
"static": [{"lanAddress": "192.168.1.1/29",
"nextHopAddress": "192.168.1.1"
}
],
"ospf": {"areaNumber": "123"
},
"description": "メッセージ"
}

Response samples

Content type

application/json

{"jobId": "1"
}

VN L2/L3コネクト設定を行う(削除)

path Parameters

wnumber

required

string <= 10 characters ^W[0-9]{9}$

Example: W000000001

項目和名：W番号
備考　　：-

Request Body schema: application/json

vnl2l3ConnectKeyId

required

string (vnl2l3ConnectKeyId)

項目和名：VNL2L3コネクト設定排他情報
備考　　：排他確認用パラメータ。
　　　　：設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"vnl2l3ConnectKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

VN L2/L3コネクト CSVダウンロード API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  VN L2/L3コネクト接続一覧のcsvファイルを生成送信する機能

VN L2/L3コネクト接続申請情報の一覧のCSVを取得

query Parameters

tokenId

required

string <uuid>

Example: tokenId=ede66c43-9b9d-4222-93ed-5f11c96e08e2

項目和名：トークンID
備考　　：ログイン時に取得するトークンIDを設定

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v1/network/vnetwork/vnl2l3connects/csv?tokenId=ede66c43-9b9d-4222-93ed-5f11c96e08e2'

Response samples

401
403
500

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

フロー設定対象取得API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  フロー設定可能なVN回線の一覧を取得する。

フロー設定可能なVN回線の一覧を取得

query Parameters

enumber required	string <= 10 characters ^E[0-9]{8}0$ Example: enumber=E000000010 項目和名：E番号備考　　：主キー相当
vlanIdType required	string Enum: "UNTAG" "OTHER" "SPECIFIED" 項目和名：VLAN IDのType指定備考　　：UNTAG: IDの指定なし　　　　　OTHER: 他のVNコネクトで指定されていないID,もしくは指定なし　　　　　SPECIFIED: 指定ID
vlanId	integer <int32> [ 1 .. 4094 ] Example: vlanId=1111 項目和名：VLAN ID 備考　　：vlanIdTypeで「SPECIFIED: 指定ID」を選択しているときに入力可能

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v1/network/vnetwork/flow/target?enumber=E000000010&vlanIdType=SOME_STRING_VALUE&vlanId=1111'

Response samples

200
400
401
403
500

Content type

application/json

{"targetList": [{"vnConnectName": "TEST_L3_1",
"wnumber": "W000000001",
"vpnCode": "BA1234"
}
]
}

フローAPI

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST：受付非同期方式
2. 内容
  VN回線のフロー設定の参照・更新を行う。

VN回線のフロー設定情報を取得

query Parameters

enumber required	string <= 10 characters ^E[0-9]{8}0$ Example: enumber=E000000010 項目和名：E番号備考　　：主キー相当
vlanIdType required	string Enum: "UNTAG" "OTHER" "SPECIFIED" 項目和名：VLAN IDのType指定備考　　：UNTAG: IDの指定なし　　　　　OTHER: 他のVNコネクトで指定されていないID,もしくは指定なし　　　　　SPECIFIED: 指定ID
vlanId	integer <int32> [ 1 .. 4094 ] Example: vlanId=1111 項目和名：VLAN ID 備考　　：vlanIdTypeで「SPECIFIED: 指定ID」を選択しているときに入力可能

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v1/network/vnetwork/flow?enumber=E000000010&vlanIdType=SOME_STRING_VALUE&vlanId=1111'

Response samples

200
400
401
403
500

Content type

application/json

{"flowTotal": 1,
"flowList": [{"flowSeq": "1",
"vnConnectName": "TEST_L3_1",
"wnumber": "W000000001",
"vpnCode": "BA1234",
"srcAddress": "192.167.1.1/29",
"dstAddress": "192.167.1.2/29",
"flowStatus": "VALID",
"ifStatus": "SHUTDOWN",
"description": "メッセージ"
}
],
"flowKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

VN回線のフロー設定情報を変更

Request Body schema: application/json

enumber required	string (enumber3) <= 10 characters ^E[0-9]{8}0$ 項目和名：E番号備考　　：主キー相当
vlanIdType	string (vlanIdType8) Enum: "UNTAG" "OTHER" "SPECIFIED" 項目和名：VLAN IDのType指定備考　　：UNTAG: IDの指定なし　　　　　OTHER: 他のVNコネクトで指定されていないID,もしくは指定なし　　　　　SPECIFIED: 指定ID
vlanId	integer <int32> (vlanId4) [ 1 .. 4094 ] 項目和名：VLAN ID 備考　　：vlanIdTypeで「SPECIFIED: 指定ID」を選択しているときに入力可能
required	Array of objects 項目和名：フロー設定変更情報リスト備考　　：リストの順序はフロー設定の優先度に沿って指定追加時：flowSeqはNULL 変更時：flowSeqは必須削除時：本リストに対して削除対象要素の指定を行わない。全件削除時：本リストを空リストする。
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
flowKeyId required	string (flowKeyId) 項目和名：フロー設定排他情報備考　　：排他確認用パラメータ　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"enumber": "E000000010",
"vlanIdType": "UNTAG",
"vlanId": 1111,
"flowModifyList": [{"flowSeq": "1",
"wnumber": "W000000001",
"vpnCode": "BA1234",
"srcAddress": "192.167.1.1/29",
"dstAddress": "192.167.1.2/29",
"description": "メッセージ"
}
],
"note": "メッセージ",
"flowKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

クラウドパケットフィルタAPI

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST：受付非同期方式
2. 内容
  パケットフィルタリング設定情報の一覧参照・変更・削除を行う。

パケットフィルタ用クラウドVNコネクト一覧を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/vnetwork/packetfilters/cloud

Response samples

200
401
403
500

Content type

application/json

{"total": 1,
"packetFilterList": [{"wnumberAct": "W000000001",
"wnumberSby": "W000000002",
"vnConnectNameAct": "TEST_L3_1",
"vnConnectNameSby": "TEST_L3_2",
"enumber": "E000000010",
"vnName": "VN名1",
"dstVpnVnCode": "BA1234",
"cloudLineSeq": "1",
"cloudServiceType": "PRIVATE_PEERING",
"filterringSettingStatus": "FILTERING"
}
],
"vnConnectPacketFilterKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

パケットフィルタ用クラウドVNコネクト一覧を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v2/network/vnetwork/packetfilters/cloud

Response samples

200
401
403
500

Content type

application/json

{"total": 1,
"packetFilterList": [{"wnumberAct": "W000000001",
"wnumberSby": "W000000002",
"vnConnectNameAct": "TEST_L3_1",
"vnConnectNameSby": "TEST_L3_2",
"enumber": "E000000010",
"vnName": "VN名1",
"dstVpnVnCode": "BA1234",
"cloudLineSeq": "1",
"cloudServiceType": "PRIVATE_PEERING",
"filterringSettingStatus": "FILTERING"
}
],
"vnConnectPacketFilterKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

クラウドVNコネクト用パケットフィルタのパケットフィルタルール一覧を取得

path Parameters

wnumberAct

required

string <= 10 characters ^W[0-9]{9}$

Example: W000000001

項目和名：W番号
備考　　：主キー相当。ACT側のW番号を指定する。

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/vnetwork/packetfilters/cloud/W000000001

Response samples

Content type

application/json

{"total": 1,
"packetFilterRuleList": [{"packetFilterRuleSeq": "3",
"isDefaultRule": false,
"protocol": "TCP",
"protocolNumber": 1,
"action": "PERMIT",
"srcAddress": "192.168.1.1/29",
"srcPort": 1111,
"dstAddress": "192.168.1.1/29",
"dstPort": 1111,
"filteringStatus": "ENABLED",
"description": "メッセージ"
}
]
}

クラウドVNコネクト用パケットフィルタのパケットフィルタルールを変更

path Parameters

wnumberAct

required

string <= 10 characters ^W[0-9]{9}$

Example: W000000001

項目和名：W番号
備考　　：主キー相当。ACT側のW番号を指定する。

Request Body schema: application/json

required	Array of objects 項目和名：パケットフィルタルールリスト備考　　：指定したルールの順が処理順となる。　　　　　変更対象となるルールはユーザ設定フィルタルールのみとする。　　　　　（変更対象外のデフォルトルールが含まれていても読み飛ばし、処理を継続する。）　　　　　ルールの新規追加時にはpacketFilterRuleSeqにNULLを指定する。
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
vnConnectPacketFilterKeyId required	string (vnConnectPacketFilterKeyId) 項目和名：VNコネクト用パケットフィルタ設定排他情報備考　　：排他確認用パラメータ　　　　：設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"packetFilterRuleList": [{"packetFilterRuleSeq": "3",
"isDefaultRule": false,
"protocol": "TCP",
"protocolNumber": 1,
"action": "PERMIT",
"srcAddress": "192.168.1.1/29",
"srcPort": 1111,
"dstAddress": "192.168.1.1/29",
"dstPort": 1111,
"filteringStatus": "ENABLED",
"description": "メッセージ"
}
],
"note": "メッセージ",
"vnConnectPacketFilterKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

クラウドVNコネクト用パケットフィルタ設定回線のパケットフィルタルールを削除

Request Body schema: application/json

wnumberAct required	string (wnumberAct1) <= 10 characters ^W[0-9]{9}$ 項目和名：W番号(Act) 備考　　：主キー相当
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
vnConnectPacketFilterKeyId required	string (vnConnectPacketFilterKeyId) 項目和名：VNコネクト用パケットフィルタ設定排他情報備考　　：排他確認用パラメータ　　　　：設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"wnumberAct": "W000000001",
"note": "メッセージ",
"vnConnectPacketFilterKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

クラウドパケットフィルタCSVダウンロードAPI

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  クラウドVNコネクト用パケットフィルタリング設定情報のcsvファイルを生成送信する機能

クラウドVNコネクト用パケットフィルタのパケットフィルタ設定情報をCSVにてダウンロードする。

query Parameters

tokenId required	string <uuid> Example: tokenId=ede66c43-9b9d-4222-93ed-5f11c96e08e2 項目和名：トークンID 備考　　：ログイン時に取得するトークンIDを設定
enumber required	string <= 10 characters ^E[0-9]{8}0$ Example: enumber=E000000010 項目和名：E番号備考　　：検索条件として「enumber」を指定しない場合、全件ダウンロードする。

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v1/network/vnetwork/packetfilters/cloud/csv/packetfilter?tokenId=ede66c43-9b9d-4222-93ed-5f11c96e08e2&enumber=E000000010'

Response samples

400
401
403
500

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

IPsecゲートウェイAPI

概要
1. インターフェースタイプ GET ：同期応答方式 POST：受付非同期方式
2. 内容 IPsecゲートウェイ情報の参照・更新を行う。

IPsecゲートウェイ情報を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/ipsec/ipsecgw

Response samples

200
401
403
500

Content type

application/json

{"total": 1,
"ipsecGatewayList": [{"enumber": "E000000010",
"suffix": "suffix",
"numberOfIpsec": 1,
"upperLimitIpsec": 50,
"wanAddress": "1.1.1.0/29",
"ipsecGatewayAddress": "1.1.1.1",
"manageAddress1": "1.1.1.2",
"manageAddress2": "1.1.1.3",
"manageAddress3": "1.1.1.4"
}
],
"ipsecGatewayKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

IPsecゲートウェイ情報を変更

path Parameters

enumber

required

string <= 10 characters ^E[0-9]{8}0$

Example: E000000010

項目和名：回線番号

Request Body schema: application/json

suffix required	string (suffix) <= 32 characters ^[a-zA-Z0-9\.]*$ 項目和名：サフィックス備考　　：-
ipsecGatewayKeyId required	string (ipsecGatewayKeyId) 項目和名：IPsecゲートウェイ排他情報備考　　：排他確認用パラメータ　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"suffix": "suffix",
"ipsecGatewayKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

IPsecゲートウェイ CSVダウンロード API

概要
1. インターフェースタイプ同期応答方式
2. 内容 IPsecゲートウェイ一覧のcsvファイルを生成送信する機能。

IPsec情報一覧のCSVを取得。

query Parameters

tokenId

required

string <uuid>

Example: tokenId=ede66c43-9b9d-4222-93ed-5f11c96e08e2

項目和名：トークンID 備考　　：ログイン時に取得するトークンIDを設定

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v1/network/ipsec/ipsecgw/csv?tokenId=ede66c43-9b9d-4222-93ed-5f11c96e08e2'

Response samples

401
403
500

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

IPsec API

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST：受付非同期方式
2. 内容
  IPsec情報の参照、追加、変更、削除を行う。

IPsec情報を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/ipsecs

Response samples

200
401
403
500

Content type

application/json

{"total": 1,
"ipsecList": [{"acLineSeq": "1",
"vcLineSeq": "1",
"ipsecLineName": "IPSEC回線１",
"preSharedKey": "PRESHAREDKEY",
"connectTestIpAddress": "192.169.0.1",
"description": "メッセージ",
"xnumber": "X000000010",
"ifStatus": "NO_SHUTDOWN",
"enumber": "E000000010",
"userAccount": "user1",
"lanIpAddressList": [{"acLineIpAddressSeq": "2",
"ipAddress": "192.168.1.0/24"
}
]
}
],
"acLineKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

IPsec情報を追加

Request Body schema: application/json

ipsecLineName required	string (ipsecLineName) <= 20 characters 項目和名：IPsec回線名備考　　：-
preSharedKey required	string (preSharedKey) [ 8 .. 64 ] characters ^[-+._a-zA-Z0-9]+$ 項目和名：事前共有鍵備考　　：-
connectTestIpAddress required	string (connectTestIpAddress) ^(([1-9]?[0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5])... 項目和名：疎通試験用IPアドレス備考　　：-
description	string (description14) <= 20 characters 項目和名：設定値の説明備考　　：-
enumber required	string (enumber5) <= 10 characters ^E[0-9]{8}0$ 項目和名：E番号備考　　：
userAccount required	string (userAccount) <= 32 characters ^[-+._a-zA-Z0-9]+$ 項目和名：ユーザアカウント備考　　：「USER-FQDN」の左部分を設定する。
required	Array of objects 項目和名：LANアドレスリスト備考　　：データが存在しない場合、[](空の状態)となる。
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-

Responses

Request samples

Payload
Curl

Content type

application/json

{"ipsecLineName": "IPSEC回線１",
"preSharedKey": "PRESHAREDKEY",
"connectTestIpAddress": "192.169.0.1",
"description": "メッセージ",
"enumber": "E000000010",
"userAccount": "user1",
"lanIpAddressList": [{"ipAddress": "192.168.1.0/24"
}
],
"note": "メッセージ"
}

Response samples

Content type

application/json

{"jobId": "1"
}

IPsec情報を変更

path Parameters

xnumber

required

string <= 10 characters ^X[0-9]{9}$

Example: X000000010

項目和名：X番号

Request Body schema: application/json

ipsecLineName required	string (ipsecLineName) <= 20 characters 項目和名：IPsec回線名備考　　：-
preSharedKey required	string (preSharedKey) [ 8 .. 64 ] characters ^[-+._a-zA-Z0-9]+$ 項目和名：事前共有鍵備考　　：-
connectTestIpAddress required	string (connectTestIpAddress) ^(([1-9]?[0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5])... 項目和名：疎通試験用IPアドレス備考　　：-
description	string (description14) <= 20 characters 項目和名：設定値の説明備考　　：-
required	Array of objects 項目和名：LANアドレスリスト備考　　：データが存在しない場合、[](空の状態)となる。
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
acLineKeyId required	string (acLineKeyId) 項目和名：AC回線排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"ipsecLineName": "IPSEC回線１",
"preSharedKey": "PRESHAREDKEY",
"connectTestIpAddress": "192.169.0.1",
"description": "メッセージ",
"lanIpAddressList": [{"acLineIpAddressSeq": "2",
"ipAddress": "192.168.1.0/24"
}
],
"note": "メッセージ",
"acLineKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

IPsec情報を削除

Request Body schema: application/json

ipsecList required	Array of strings (xnumber) [ items <= 10 characters ^X[0-9]{9}$ ] 項目和名：IPsecリスト備考　　：削除対象のX番号を指定する。
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
acLineKeyId required	string (acLineKeyId) 項目和名：AC回線排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"ipsecList": ["X000000010"
],
"note": "メッセージ",
"acLineKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

クラウド情報API

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST(追加)：受付非同期方式
2. 内容
  回線情報に紐づくクラウド回線情報の参照、追加、変更、削除を行う

回線情報に紐づくクラウド回線情報を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/cloud/lines

Response samples

200
401
403
500

Content type

application/json

{"lineTotal": 1,
"lineList": [{"lineSeq": "1",
"enumber": "E000000010",
"accessType": "INTERNET",
"bandwidth": {"value": 100,
"unit": "MBPS"
},
"office": "事業所A",
"cloudLineTotal": 1,
"cloudLineList": [{"cloudLineSeq": "1",
"maxBandwidth": 1,
"bandwidth": {"value": 100,
"unit": "MBPS"
},
"description": "メモ書き",
"cloudServiceMenu": "AWS"
}
]
}
],
"cloudLineKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

回線情報に紐づくクラウド回線情報を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v2/network/cloud/lines

Response samples

200
401
403
500

Content type

application/json

{"lineTotal": 1,
"lineList": [{"lineSeq": "1",
"enumber": "E000000010",
"accessType": "INTERNET",
"bandwidth": {"value": 100,
"unit": "MBPS"
},
"office": "事業所A",
"cloudLineTotal": 1,
"cloudLineList": [{"cloudLineSeq": "1",
"maxBandwidth": 1,
"bandwidth": {"value": 100,
"unit": "MBPS"
},
"description": "メモ書き",
"cloudServiceMenu": "AWS"
}
]
}
],
"cloudLineKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

回線情報に紐づくクラウド回線情報を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v3/network/cloud/lines

Response samples

200
401
403
500

Content type

application/json

{"lineTotal": 1,
"lineList": [{"lineSeq": "1",
"enumber": "E000000010",
"accessType": "INTERNET",
"bandwidth": {"value": 100,
"unit": "MBPS"
},
"office": "事業所A",
"cloudLineTotal": 1,
"cloudLineList": [{"cloudLineSeq": "1",
"maxBandwidth": 1,
"bandwidth": {"value": 100,
"unit": "MBPS"
},
"description": "メモ書き",
"cloudServiceMenu": "AWS"
}
]
}
],
"cloudLineKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

回線情報に紐づくクラウド回線情報を追加する。サービス種別がMSの情報のみ追加可能となる。

path Parameters

enumber

required

string <= 10 characters ^E[0-9]{8}0$

Example: E000000010

項目和名：E番号

Request Body schema: application/json

required	object (bandwidth7) 項目和名：帯域備考　　：GET時に登録された帯域が存在しない場合は「0」を指定する。
description	string (description15) <= 200 characters 項目和名：設定値の説明備考　　：クラウド回線用の備考
cloudServiceMenu required	string(^MS) 項目和名：クラウドサービスメニュー備考　　：以下のいずれかを指定する(POSTではMSのみ指定可能)。
note	string (note2) <= 200 characters 項目和名：操作履歴の備考備考　　：-
cloudLineKeyId required	string (cloudLineKeyId) 項目和名：クラウド回線排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"bandwidth": {"value": 100,
"unit": "MBPS"
},
"description": "メモ書き",
"cloudServiceMenu": "MS",
"note": "クラウド上限値の操作",
"cloudLineKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

回線情報に紐づくクラウド回線情報を変更

path Parameters

cloudLineSeq

required

string <= 19 characters

Example: 1

項目和名：クラウド回線SEQ

Request Body schema: application/json

required	object (bandwidth7) 項目和名：帯域備考　　：GET時に登録された帯域が存在しない場合は「0」を指定する。
description	string (description15) <= 200 characters 項目和名：設定値の説明備考　　：クラウド回線用の備考
note	string (note2) <= 200 characters 項目和名：操作履歴の備考備考　　：-
cloudLineKeyId required	string (cloudLineKeyId) 項目和名：クラウド回線排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"bandwidth": {"value": 100,
"unit": "MBPS"
},
"description": "メモ書き",
"note": "クラウド上限値の操作",
"cloudLineKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

回線情報に紐づくクラウド回線情報を削除する。サービス種別がMSの情報のみ削除可能となる。

path Parameters

cloudLineSeq

required

string <= 19 characters

Example: 1

項目和名：クラウド回線SEQ

Request Body schema: application/json

note	string (note2) <= 200 characters 項目和名：操作履歴の備考備考　　：-
cloudLineKeyId required	string (cloudLineKeyId) 項目和名：クラウド回線排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"note": "クラウド上限値の操作",
"cloudLineKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

クラウド情報 CSVダウンロード API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  クラウドVNコネクト設定情報一覧のcsvファイルを生成送信する機能

V番号に紐づくクラウドVNコネクト設定情報をCSVにてダウンロードする。

query Parameters

tokenId

required

string <uuid>

Example: tokenId=ede66c43-9b9d-4222-93ed-5f11c96e08e2

項目和名：トークンID
備考　　：ログイン時に取得するトークンIDを設定

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v1/network/cloud/lines/csv/vnconnect?tokenId=ede66c43-9b9d-4222-93ed-5f11c96e08e2'

Response samples

401
403
500

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

クラウドQoS設定API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  VNコネクトに対するクラウドQoS設定の参照・更新を行う。

クラウドQoS設定情報を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/cloud/qos

Response samples

200
401
403
500

Content type

application/json

{"total": 1,
"qosInfoList": [{"vpnVnCode": "BA1234",
"vnName": "TEST_1",
"vlanIdType": "SPECIFIED",
"vlanId": 1111,
"qosType": "BANDWIDTH",
"priorityTarget": "DSCP",
"numberOfVnConnect": 1,
"upperLimitVnConnect": 50,
"wnumberAct": "W000000001",
"wnumberSby": "W000000002",
"qosControl": "ENABLE"
}
]
}

クラウドQoS設定詳細を1件取得

path Parameters

vpnVnCode

required

string <= 6 characters ^[BCD][A-Z][0-9]{4}$

Example: BA1234

項目和名：VPN/VNコード
備考　　：主キー

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/BA1234/cloud/qos

Response samples

Content type

application/json

{"qosType": "BANDWIDTH",
"priorityTarget": "DSCP",
"cloudQosAbsolute": {"priority0": "NORMAL",
"priority1": "NORMAL",
"priority2": "NORMAL",
"priority3": "NORMAL",
"priority4": "NORMAL",
"priority5": "NORMAL",
"priority6": "NORMAL",
"priority7": "NORMAL"
},
"cloudQosBandwidthList": [{"patternName": "PATTERN_A",
"dscp18Value": 20,
"dscp24Value": 20,
"dscp34Value": 20,
"dscp46Value": 10,
"bestEffort": 10,
"isDscp46TopPriority": true
}
],
"cloudQosKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

クラウドQoS設定の変更を行う

path Parameters

vpnVnCode

required

string <= 6 characters ^[BCD][A-Z][0-9]{4}$

Example: BA1234

項目和名：VPN/VNコード
備考　　：主キー

Request Body schema: application/json

qosType required	string (qosType2) Enum: "BANDWIDTH" "ABSOLUTE" "NONE" 項目和名：QoS方式備考　　：以下のいずれかを返す。 BANDWIDTH: 帯域制御方式 ABSOLUTE: 絶対優先方式 NONE: 未設定
priorityTarget required	string (priorityTarget1) Enum: "IPPRECEDENCE_DSCP" "DSCP" "NONE" 項目和名：優先度参照先備考　　：以下のいずれかを返す。 IPPRECEDENCE_DSCP: IP Precedence/DSCP DSCP: DSCP NONE: 未設定
	object (cloudQosPutAbsolute) 項目和名：絶対優先設定値情報(設定変更用) 備考　　：絶対優先方式の設定値情報。qosTypeがABSOLUTEの場合は必須、それ以外の場合はNULLになります。
required	Array of objects (cloudQosPutBandwidthList) 項目和名：帯域制御設定値情報(設定変更用) 備考　　：取得した帯域制御方式の設定値情報。qosTypeがBANDWIDTHの場合は必須、それ以外の場合は空配列になります。　　　　　本プロパティではbestEffortを持たない(API内部で算出するため、通知不要)
cloudQosKeyId required	string (cloudQosKeyId) 項目和名：クラウドQoS設定排他情報備考　　：排他確認用パラメータ。　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"qosType": "BANDWIDTH",
"priorityTarget": "DSCP",
"cloudQosAbsolute": {"priority0": "NORMAL",
"priority1": "NORMAL",
"priority2": "NORMAL",
"priority3": "NORMAL",
"priority4": "NORMAL",
"priority5": "NORMAL",
"priority6": "NORMAL",
"priority7": "NORMAL"
},
"cloudQosBandwidthList": [{"patternName": "PATTERN_A",
"dscp18Value": 20,
"dscp24Value": 20,
"dscp34Value": 20,
"dscp46Value": 10,
"isDscp46TopPriority": true
}
],
"cloudQosKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

クラウドQoS設定 CSVダウンロード API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  クラウドQoS設定のcsvファイルを生成送信する機能

クラウドQoS設定情報のCSVを取得

query Parameters

tokenId

required

string <uuid>

Example: tokenId=ede66c43-9b9d-4222-93ed-5f11c96e08e2

項目和名：トークンID
備考　　：ログイン時に取得するトークンIDを設定

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v1/network/cloud/qos/csv?tokenId=ede66c43-9b9d-4222-93ed-5f11c96e08e2'

Response samples

401
403
500

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

Microsoft Peering IP API

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST：受付非同期方式
2. 内容
  Microsoft Peeringで利用するNAT/NAPTのグローバルIPアドレス/プライベートIPアドレスの参照、登録、更新、削除を行う。

NAT/NAPTのグローバルIPアドレス情報を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/cloud/ms-peering/global-ip

Response samples

200
401
403
404
500

Content type

application/json

{"total": 1,
"msPeeringList": [{"msServiceSeq": "1",
"vpnVnCode": "BA1234",
"vnName": "TEST_1",
"upperLimitNapt": 32,
"usedNapt": 1,
"upperLimitNat": 32,
"usedNat": 1,
"msNaptGlobalIpList": [{"cloudGlobalIpAddressSeq": "1",
"globalIpAddress": "192.167.1.1/32",
"isInitialAddress": true
}
],
"msNatIpList": [{"cloudGlobalIpAddressSeq": "1",
"globalIpAddress": "192.167.1.1/32",
"privateIpAddress": "192.168.1.1/32",
"description": "メモ"
}
]
}
],
"msPeeringIpKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

NAT/NAPTのグローバルIPアドレス情報を更新（追加・削除）

path Parameters

msServiceSeq

required

string <= 19 characters

Example: 1

項目和名：MicrosoftサービスSEQ

Request Body schema: application/json

addNapt	integer <int32> 項目和名：追加グローバルIPアドレス数（NAPT用）備考　　：NAPT用グローバルIPアドレスに追加する数　　　　　初回登録時は必ず１以上の数値を設定する。
addNat	integer <int32> 項目和名：追加グローバルIPアドレス数（NAT用）備考　　：NAT用グローバルIPアドレスに追加する数
	Array of objects 項目和名：NAT用新規プライベートIPアドレスリスト備考　　：NAT用追加グローバルIPアドレスに紐づけるプライベートIPアドレスのリスト　　　　　本リストの要素数が追加するNATのグローバルIPアドレス数と必ず同数となるよう設定する。　　　　　グローバルIPアドレスを払い出さない場合(addNatがNULLの場合)、NULLになります。
deleteMsNaptGlobalIpList	Array of strings (cloudGlobalIpAddressSeq) [ items <= 19 characters ] 項目和名：削除グローバルIPアドレス一覧（NAPT用）備考　　：削除対象のグローバルIPアドレスのSEQを設定する。　　　　　削除対象が無い場合、NULLになります。
deleteMsNatGlobalIpList	Array of strings (cloudGlobalIpAddressSeq) [ items <= 19 characters ] 項目和名：削除グローバルIPアドレス一覧（NAT用）備考　　：削除対象のグローバルIPアドレスのSEQを設定する。　　　　　削除対象が無い場合、NULLになります。
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
msPeeringIpKeyId required	string (msPeeringIpKeyId) 項目和名：Microsoft Peering IP排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"addNapt": 1,
"addNat": 1,
"msNatAddPrivateIpList": [{"privateIpAddress": "192.168.1.1/32",
"description": "メモ"
}
],
"deleteMsNaptGlobalIpList": ["1"
],
"deleteMsNatGlobalIpList": ["1"
],
"note": "メッセージ",
"msPeeringIpKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

NATのプライベートIPアドレス情報を更新（変更）

path Parameters

msServiceSeq

required

string <= 19 characters

Example: 1

項目和名：MicrosoftサービスSEQ

Request Body schema: application/json

required	Array of objects
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
msPeeringIpKeyId required	string (msPeeringIpKeyId) 項目和名：Microsoft Peering IP排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"msNatSettingList": [{"cloudGlobalIpAddressSeq": "1",
"privateIpAddress": "192.168.1.1/32",
"description": "メモ"
}
],
"note": "メッセージ",
"msPeeringIpKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

クラウドVN回線(MS)API

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST：受付非同期方式
2. 内容
  MS向け回線毎VNコネクトの取得、設定、変更、削除を行う。

MS365申込済み仮想ネットワーク情報を取得(プルダウン用)

query Parameters

serviceKey

required

string

Example: serviceKey=1234

項目和名：サービスキー

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v1/network/cloud/line/ms/vpn-vn-code?serviceKey=1234'

Response samples

200
400
401
403
500

Content type

application/json

{"cloudVnConnectTotal": 1,
"cloudVnConnectsList": [{"vpnVnCode": "BA1234",
"isMsService": true
}
]
}

クラウドVN回線設定を取得

path Parameters

cloudLineSeq

required

string <= 19 characters

Example: 1

項目和名：クラウド回線SEQ

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/cloud/line/1/ms/vnconnects

Response samples

Content type

application/json

{"cloudVnConnectTotal": 1,
"enumber": "E000000010",
"accessType": "MULTI_CLOUD_GW",
"bandwidth": {"value": 10,
"unit": "GBPS"
},
"office": "事業所A",
"keyStatus": "SUCCESS",
"serviceKey": "1234",
"location": "EAST_JAPAN",
"cloudVnConnectsList": [{"cloudVnConnectCommon": {"cloudServiceType": "PRIVATE_PEERING",
"vpnVnCode": "BA1234",
"vnType": "L3",
"routingType": "BGP4",
"bandwidthType": "PF",
"bandwidth": {"value": 10,
"unit": "MBPS"
},
"description": "メッセージ"
},
"cloudVnConnectAct": {"vnConnectName": "TEST_L3_1",
"wnumber": "W123456780",
"ifStatus": "NO_SHUTDOWN",
"isVnConnectStatus": true
},
"cloudVnConnectSby": {"vnConnectName": "TEST_L3_1",
"wnumber": "W123456780",
"ifStatus": "NO_SHUTDOWN",
"isVnConnectStatus": true
}
}
],
"cloudVnMsKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

クラウドVN回線設定を追加

path Parameters

cloudLineSeq

required

string <= 19 characters

Example: 1

項目和名：クラウド回線SEQ

Request Body schema: application/json

required	object
required	object
required	object
note	string (note3) <= 200 characters 項目和名：操作履歴の備考備考　　：-
cloudVnMsKeyId required	string (cloudVnMsKeyId) 項目和名：クラウドVN回線(MS)排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"cloudVnConnectCommon": {"cloudServiceType": "PRIVATE_PEERING",
"vpnVnCode": "BA1234",
"bandwidthType": "PF",
"bandwidth": {"value": 10,
"unit": "MBPS"
},
"routeAggregation": "CUSTOM",
"routeAggregationAddressList": ["192.168.1.1/29",
"192.168.1.2/29"
],
"description": "メッセージ",
"qosBandControlPattern": "PATTERN_A"
},
"cloudVnConnectAct": {"vnConnectName": "TEST_L3_1",
"asNumber": 12076,
"wanAddress": "106.186.212.159/30",
"peerIpAddress": "106.186.212.160",
"maximumPrefix": 100
},
"cloudVnConnectSby": {"vnConnectName": "TEST_L3_1",
"asNumber": 12076,
"wanAddress": "106.186.212.159/30",
"peerIpAddress": "106.186.212.160",
"maximumPrefix": 100
},
"note": "操作履歴の備考",
"cloudVnMsKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

クラウドVN回線設定を変更

path Parameters

cloudLineSeq required	string <= 19 characters Example: 1 項目和名：クラウド回線SEQ
wnumber required	string <= 10 characters ^W[0-9]{9}$ Example: W123456780 項目和名：W番号備考　　：ACT回線のW番号を指定する。

Request Body schema: application/json

required	object
required	object
required	object
note	string (note3) <= 200 characters 項目和名：操作履歴の備考備考　　：-
cloudVnMsKeyId required	string (cloudVnMsKeyId) 項目和名：クラウドVN回線(MS)排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"cloudVnConnectCommon": {"bandwidth": {"value": 10,
"unit": "MBPS"
},
"routeAggregation": "CUSTOM",
"routeAggregationAddressList": ["192.168.1.1/29",
"192.168.1.2/29"
],
"description": "メッセージ",
"qosBandControlPattern": "PATTERN_A"
},
"cloudVnConnectAct": {"vnConnectName": "TEST_L3_1",
"maximumPrefix": 100
},
"cloudVnConnectSby": {"wnumber": "W123456780",
"vnConnectName": "TEST_L3_1",
"maximumPrefix": 100
},
"note": "操作履歴の備考",
"cloudVnMsKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

クラウドVN回線設定のロケーション情報を設定

path Parameters

cloudLineSeq

required

string <= 19 characters

Example: 1

項目和名：クラウド回線SEQ

Request Body schema: application/json

serviceKey required	string (serviceKey) 項目和名：クラウドサービスキー情報備考　　：-
location required	string (location) Enum: "EAST_JAPAN" "WEST_JAPAN" 項目和名：クラウドサービス利用拠点備考　　：下記のいずれかを指定する。　　　　　EAST_JAPAN: 東日本　　　　　WEST_JAPAN: 西日本

Responses

Request samples

Payload
Curl

Content type

application/json

{"serviceKey": "1234",
"location": "EAST_JAPAN"
}

Response samples

Content type

application/json

{"jobId": "1"
}

クラウドVNコネクトの有効/無効状態を有効に変更

Request Body schema: application/json

cloudVnConnectList required	Array of strings (wnumber5) [ items <= 10 characters ^W[0-9]{9}$ ]
cloudVnMsKeyId required	string (cloudVnMsKeyId) 項目和名：クラウドVN回線(MS)排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"cloudVnConnectList": ["W123456780"
],
"cloudVnMsKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

クラウドVNコネクトの有効/無効状態を無効に変更

Request Body schema: application/json

cloudVnConnectList required	Array of strings (wnumber5) [ items <= 10 characters ^W[0-9]{9}$ ]
cloudVnMsKeyId required	string (cloudVnMsKeyId) 項目和名：クラウドVN回線(MS)排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"cloudVnConnectList": ["W123456780"
],
"cloudVnMsKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

クラウドVN回線設定の詳細情報を取得

path Parameters

wnumber

required

string <= 10 characters ^W[0-9]{9}$

Example: W123456780

項目和名：W番号
備考　　：ACT回線のW番号を指定する。

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/cloud/line/ms/vnconnect/W123456780

Response samples

Content type

application/json

{"enumber": "E000000010",
"accessType": "MULTI_CLOUD_GW",
"bandwidth": {"value": 10,
"unit": "GBPS"
},
"office": "事業所A",
"keyStatus": "SUCCESS",
"serviceKey": "1234",
"location": "EAST_JAPAN",
"cloudVnConnectCommon": {"cloudServiceType": "PRIVATE_PEERING",
"vpnVnCode": "BA1234",
"vnType": "L3",
"vnName": "VN名1",
"routingType": "BGP4",
"bandwidthType": "PF",
"bandwidth": {"value": 10,
"unit": "MBPS"
},
"routeAggregation": "CUSTOM",
"routeAggregationAddressList": ["192.168.1.1/29",
"192.168.1.2/29"
],
"qos": {"isQos": false,
"qosBandControlPattern": "PATTERN_A"
},
"description": "メッセージ"
},
"cloudVnConnectAct": {"vnConnectName": "TEST_L3_1",
"wnumber": "W123456780",
"ifStatus": "NO_SHUTDOWN",
"isVnConnectStatus": true,
"asNumber": 12076,
"wanAddress": "106.186.212.159/30",
"peerIpAddress": "106.186.212.160",
"md5Key": "Kddicloud",
"maximumPrefix": 100,
"localPreference": "LOW_PRIORITY",
"med": "LOW_PRIORITY"
},
"cloudVnConnectSby": {"vnConnectName": "TEST_L3_1",
"wnumber": "W123456780",
"ifStatus": "NO_SHUTDOWN",
"isVnConnectStatus": true,
"asNumber": 12076,
"wanAddress": "106.186.212.159/30",
"peerIpAddress": "106.186.212.160",
"md5Key": "Kddicloud",
"maximumPrefix": 100,
"localPreference": "LOW_PRIORITY",
"med": "LOW_PRIORITY"
},
"cloudVnMsKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

クラウドVN回線設定を削除

path Parameters

cloudLineSeq

required

string <= 19 characters

Example: 1

項目和名：クラウド回線SEQ

Request Body schema: application/json

cloudVnConnectList required	Array of strings (wnumber5) [ items <= 10 characters ^W[0-9]{9}$ ]
note	string (note3) <= 200 characters 項目和名：操作履歴の備考備考　　：-
cloudVnMsKeyId required	string (cloudVnMsKeyId) 項目和名：クラウドVN回線(MS)排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"cloudVnConnectList": ["W123456780"
],
"note": "操作履歴の備考",
"cloudVnMsKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

クラウドVN回線(AWS)API

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST：受付非同期方式
2. 内容
  AWS向け回線毎VNコネクトの取得、設定、変更、削除を行う。

クラウドVN回線設定を取得

path Parameters

cloudLineSeq

required

string <= 19 characters

Example: 1

項目和名：クラウド回線SEQ

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/cloud/line/1/aws/vnconnects

Response samples

Content type

application/json

{"cloudVnConnectTotal": 1,
"enumber": "E000000010",
"accessType": "MULTI_CLOUD_GW",
"bandwidth": {"value": 10,
"unit": "GBPS"
},
"office": "事業所A",
"cloudVnConnectsList": [{"cloudVnConnectCommon": {"serviceKey": "1234",
"location": "EAST_JAPAN",
"vpnVnCode": "BA1234",
"vnType": "L3",
"routingType": "BGP4",
"bandwidthType": "PF",
"bandwidth": {"value": 10,
"unit": "MBPS"
},
"description": "メッセージ"
},
"cloudVnConnectAct": {"cloudVnConnectSeq": "2",
"vnConnectName": "TEST_L3_1",
"wnumber": "W123456780",
"ifStatus": "NO_SHUTDOWN",
"isVnConnectStatus": true
},
"cloudVnConnectSby": {"cloudVnConnectSeq": "2",
"vnConnectName": "TEST_L3_1",
"wnumber": "W123456780",
"ifStatus": "NO_SHUTDOWN",
"isVnConnectStatus": true
}
}
],
"cloudVnAwsKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

クラウドVN回線設定を追加

path Parameters

cloudLineSeq

required

string <= 19 characters

Example: 1

項目和名：クラウド回線SEQ

Request Body schema: application/json

	object ACT/SBY回線を同時に追加するパターン、ACT回線のみを追加するパターンでは必須となる。
	object ACT/SBY回線を同時に追加するパターン、ACT回線のみを追加するパターンでは必須となる。
	object ACT/SBY回線を同時に追加するパターン、SBY回線のみを追加するパターンでは必須となる。
note	string (note4) <= 200 characters 項目和名：操作履歴の備考備考　　：-
cloudVnAwsKeyId required	string (cloudVnAwsKeyId) 項目和名：クラウドVN回線(AWS)排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"cloudVnConnectCommon": {"serviceKey": "1234",
"location": "EAST_JAPAN",
"vpnVnCode": "BA1234",
"bandwidthType": "PF",
"bandwidth": {"value": 10,
"unit": "MBPS"
},
"routeAggregation": "CUSTOM",
"routeAggregationAddressList": ["192.168.1.1/29",
"192.168.1.2/29"
],
"description": "メッセージ"
},
"cloudVnConnectAct": {"vnConnectName": "TEST_L3_1",
"asNumber": 13884,
"wanAddress": "106.186.212.159/30",
"peerIpAddress": "106.186.212.160",
"maximumPrefix": 100
},
"cloudVnConnectSby": {"pairCloudVnConnectSeq": "3",
"vnConnectName": "TEST_L3_1",
"asNumber": 13884,
"wanAddress": "106.186.212.159/30",
"peerIpAddress": "106.186.212.160",
"maximumPrefix": 100
},
"note": "操作履歴の備考",
"cloudVnAwsKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

クラウドVN回線設定を取得

path Parameters

cloudLineSeq

required

string <= 19 characters

Example: 1

項目和名：クラウド回線SEQ

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v2/network/cloud/line/1/aws/vnconnects

Response samples

Content type

application/json

{"cloudVnConnectTotal": 1,
"enumber": "E000000010",
"accessType": "MULTI_CLOUD_GW",
"bandwidth": {"value": 10,
"unit": "GBPS"
},
"office": "事業所A",
"cloudVnConnectsList": [{"cloudVnConnectCommon": {"serviceKey": "1234",
"location": "EAST_JAPAN",
"directConnectType": "HOSTED_VIFS",
"vpnVnCode": "BA1234",
"vnType": "L3",
"routingType": "BGP4",
"bandwidthType": "PF",
"bandwidth": {"value": 10,
"unit": "MBPS"
},
"description": "メッセージ"
},
"cloudVnConnectAct": {"cloudVnConnectSeq": "2",
"vnConnectName": "TEST_L3_1",
"wnumber": "W123456780",
"ifStatus": "NO_SHUTDOWN",
"isVnConnectStatus": true,
"vlanId": "1234"
},
"cloudVnConnectSby": {"cloudVnConnectSeq": "2",
"vnConnectName": "TEST_L3_1",
"wnumber": "W123456780",
"ifStatus": "NO_SHUTDOWN",
"isVnConnectStatus": true,
"vlanId": "1234"
}
}
],
"cloudVnAwsKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

クラウドVN回線設定を追加

path Parameters

cloudLineSeq

required

string <= 19 characters

Example: 1

項目和名：クラウド回線SEQ

Request Body schema: application/json

	object ACT/SBY回線を同時に追加するパターン、ACT回線のみを追加するパターンでは必須となる。
	object ACT/SBY回線を同時に追加するパターン、ACT回線のみを追加するパターンでは必須となる。
	object ACT/SBY回線を同時に追加するパターン、SBY回線のみを追加するパターンでは必須となる。
note	string (note4) <= 200 characters 項目和名：操作履歴の備考備考　　：-
cloudVnAwsKeyId required	string (cloudVnAwsKeyId) 項目和名：クラウドVN回線(AWS)排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"cloudVnConnectCommon": {"serviceKey": "1234",
"location": "EAST_JAPAN",
"directConnectType": "HOSTED_VIFS",
"vpnVnCode": "BA1234",
"bandwidthType": "PF",
"bandwidth": {"value": 10,
"unit": "MBPS"
},
"routeAggregation": "CUSTOM",
"routeAggregationAddressList": ["192.168.1.1/29",
"192.168.1.2/29"
],
"description": "メッセージ"
},
"cloudVnConnectAct": {"vnConnectName": "TEST_L3_1",
"asNumber": 13884,
"wanAddress": "106.186.212.159/30",
"peerIpAddress": "106.186.212.160",
"maximumPrefix": 100
},
"cloudVnConnectSby": {"pairCloudVnConnectSeq": "3",
"vnConnectName": "TEST_L3_1",
"asNumber": 13884,
"wanAddress": "106.186.212.159/30",
"peerIpAddress": "106.186.212.160",
"maximumPrefix": 100
},
"note": "操作履歴の備考",
"cloudVnAwsKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

クラウドVN回線設定を追加

path Parameters

cloudLineSeq

required

string <= 19 characters

Example: 1

項目和名：クラウド回線SEQ

Request Body schema: application/json

	object ACT/SBY回線を同時に追加するパターン、ACT回線のみを追加するパターンでは必須となる。
	object ACT/SBY回線を同時に追加するパターン、ACT回線のみを追加するパターンでは必須となる。
	object ACT/SBY回線を同時に追加するパターン、SBY回線のみを追加するパターンでは必須となる。
note	string (note4) <= 200 characters 項目和名：操作履歴の備考備考　　：-
cloudVnAwsKeyId required	string (cloudVnAwsKeyId) 項目和名：クラウドVN回線(AWS)排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"cloudVnConnectCommon": {"serviceKey": "1234",
"location": "EAST_JAPAN",
"directConnectType": "HOSTED_VIFS",
"vpnVnCode": "BA1234",
"bandwidthType": "PF",
"bandwidth": {"value": 10,
"unit": "MBPS"
},
"routeAggregation": "CUSTOM",
"routeAggregationAddressList": ["192.168.1.1/29",
"192.168.1.2/29"
],
"description": "メッセージ"
},
"cloudVnConnectAct": {"vnConnectName": "TEST_L3_1",
"asNumber": 13884,
"wanAddress": "106.186.212.159/30",
"peerIpAddress": "106.186.212.160",
"maximumPrefix": 100
},
"cloudVnConnectSby": {"pairCloudVnConnectSeq": "3",
"vnConnectName": "TEST_L3_1",
"asNumber": 13884,
"wanAddress": "106.186.212.159/30",
"peerIpAddress": "106.186.212.160",
"maximumPrefix": 100
},
"note": "操作履歴の備考",
"cloudVnAwsKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

クラウドVN回線設定を変更

path Parameters

cloudLineSeq required	string <= 19 characters Example: 1 項目和名：クラウド回線SEQ
wnumber required	string <= 10 characters ^W[0-9]{9}$ Example: W123456780 項目和名：W番号備考　　：ACT回線のW番号を指定する。

Request Body schema: application/json

required	object
required	object
	object
note	string (note4) <= 200 characters 項目和名：操作履歴の備考備考　　：-
cloudVnAwsKeyId required	string (cloudVnAwsKeyId) 項目和名：クラウドVN回線(AWS)排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"cloudVnConnectCommon": {"bandwidth": {"value": 10,
"unit": "GBPS"
},
"routeAggregation": "CUSTOM",
"routeAggregationAddressList": ["192.168.1.1/29",
"192.168.1.2/29"
],
"description": "メッセージ"
},
"cloudVnConnectAct": {"vnConnectName": "TEST_L3_1",
"maximumPrefix": 100
},
"cloudVnConnectSby": {"wnumber": "W123456780",
"vnConnectName": "TEST_L3_1",
"maximumPrefix": 100
},
"note": "操作履歴の備考",
"cloudVnAwsKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

クラウドVNコネクトの有効/無効状態を有効に変更

Request Body schema: application/json

cloudVnConnectList required	Array of strings (wnumber6) [ items <= 10 characters ^W[0-9]{9}$ ]
cloudVnAwsKeyId required	string (cloudVnAwsKeyId) 項目和名：クラウドVN回線(AWS)排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"cloudVnConnectList": ["W123456780"
],
"cloudVnAwsKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

クラウドVNコネクトの有効/無効状態を無効に変更

Request Body schema: application/json

cloudVnConnectList required	Array of strings (wnumber6) [ items <= 10 characters ^W[0-9]{9}$ ]
cloudVnAwsKeyId required	string (cloudVnAwsKeyId) 項目和名：クラウドVN回線(AWS)排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"cloudVnConnectList": ["W123456780"
],
"cloudVnAwsKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

クラウドVN回線設定の詳細情報を取得

path Parameters

wnumber

required

string <= 10 characters ^W[0-9]{9}$

Example: W123456780

項目和名：W番号
備考　　：ACT回線のW番号を指定する。

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/cloud/line/aws/vnconnect/W123456780

Response samples

Content type

application/json

{"enumber": "E000000010",
"accessType": "MULTI_CLOUD_GW",
"bandwidth": {"value": 10,
"unit": "GBPS"
},
"office": "事業所A",
"cloudVnConnectCommon": {"serviceKey": "1234",
"location": "EAST_JAPAN",
"vpnVnCode": "BA1234",
"vnType": "L3",
"vnName": "VN名1",
"routingType": "BGP4",
"bandwidthType": "PF",
"bandwidth": {"value": 10,
"unit": "MBPS"
},
"routeAggregation": "CUSTOM",
"routeAggregationAddressList": ["192.168.1.1/29",
"192.168.1.2/29"
],
"description": "メッセージ"
},
"cloudVnConnectAct": {"cloudVnConnectSeq": "2",
"vnConnectName": "TEST_L3_1",
"wnumber": "W123456780",
"ifStatus": "NO_SHUTDOWN",
"isVnConnectStatus": true,
"asNumber": 13884,
"wanAddress": "106.186.212.159/30",
"peerIpAddress": "106.186.212.160",
"md5Key": "Kddicloud",
"maximumPrefix": 100,
"localPreference": "LOW_PRIORITY",
"med": "LOW_PRIORITY"
},
"cloudVnConnectSby": {"cloudVnConnectSeq": "2",
"vnConnectName": "TEST_L3_1",
"wnumber": "W123456780",
"ifStatus": "NO_SHUTDOWN",
"isVnConnectStatus": true,
"asNumber": 13884,
"wanAddress": "106.186.212.159/30",
"peerIpAddress": "106.186.212.160",
"md5Key": "Kddicloud",
"maximumPrefix": 100,
"localPreference": "LOW_PRIORITY",
"med": "LOW_PRIORITY"
},
"cloudVnAwsKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

クラウドVN回線設定の詳細情報を取得

path Parameters

wnumber

required

string <= 10 characters ^W[0-9]{9}$

Example: W123456780

項目和名：W番号
備考　　：ACT回線のW番号を指定する。

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v2/network/cloud/line/aws/vnconnect/W123456780

Response samples

Content type

application/json

{"enumber": "E000000010",
"accessType": "MULTI_CLOUD_GW",
"bandwidth": {"value": 10,
"unit": "GBPS"
},
"office": "事業所A",
"cloudVnConnectCommon": {"serviceKey": "1234",
"location": "EAST_JAPAN",
"directConnectType": "HOSTED_VIFS",
"vpnVnCode": "BA1234",
"vnType": "L3",
"vnName": "VN名1",
"routingType": "BGP4",
"bandwidthType": "PF",
"bandwidth": {"value": 10,
"unit": "MBPS"
},
"routeAggregation": "CUSTOM",
"routeAggregationAddressList": ["192.168.1.1/29",
"192.168.1.2/29"
],
"description": "メッセージ"
},
"cloudVnConnectAct": {"cloudVnConnectSeq": "2",
"vnConnectName": "TEST_L3_1",
"wnumber": "W123456780",
"ifStatus": "NO_SHUTDOWN",
"isVnConnectStatus": true,
"asNumber": 13884,
"wanAddress": "106.186.212.159/30",
"peerIpAddress": "106.186.212.160",
"md5Key": "Kddicloud",
"maximumPrefix": 100,
"localPreference": "LOW_PRIORITY",
"med": "LOW_PRIORITY",
"vlanId": "1234"
},
"cloudVnConnectSby": {"cloudVnConnectSeq": "2",
"vnConnectName": "TEST_L3_1",
"wnumber": "W123456780",
"ifStatus": "NO_SHUTDOWN",
"isVnConnectStatus": true,
"asNumber": 13884,
"wanAddress": "106.186.212.159/30",
"peerIpAddress": "106.186.212.160",
"md5Key": "Kddicloud",
"maximumPrefix": 100,
"localPreference": "LOW_PRIORITY",
"med": "LOW_PRIORITY",
"vlanId": "1234"
},
"cloudVnAwsKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

クラウドVN回線設定を削除

path Parameters

cloudLineSeq

required

string <= 19 characters

Example: 1

項目和名：クラウド回線SEQ

Request Body schema: application/json

cloudVnConnectList required	Array of strings (wnumber6) [ items <= 10 characters ^W[0-9]{9}$ ]
note	string (note4) <= 200 characters 項目和名：操作履歴の備考備考　　：-
cloudVnAwsKeyId required	string (cloudVnAwsKeyId) 項目和名：クラウドVN回線(AWS)排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"cloudVnConnectList": ["W123456780"
],
"note": "操作履歴の備考",
"cloudVnAwsKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

AWSホスト型接続利用可能取得API

概要
1. インターフェースタイプ
  GET ：同期応答方式
2. 内容
  AWSホスト型接続が利用可能であることを判断する。

AWSホスト型接続が利用可能かを取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/cloud/line/aws/hosts

Response samples

200
401
403
500

Content type

application/json

{"availableStatus": true
}

クラウドVN回線(GCP)API

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST：受付非同期方式
2. 内容
  GCP向け回線毎VNコネクトの取得、設定、変更、削除を行う。

クラウドVN回線設定を取得

path Parameters

cloudLineSeq

required

string <= 19 characters

Example: 1

項目和名：クラウド回線SEQ

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/cloud/line/1/gcp/vnconnects

Response samples

Content type

application/json

{"cloudVnConnectTotal": 1,
"enumber": "E000000010",
"accessType": "MULTI_CLOUD_GW",
"bandwidth": {"value": 10,
"unit": "GBPS"
},
"office": "事業所A",
"cloudVnConnectsList": [{"cloudVnConnectCommon": {"location": "EAST_JAPAN",
"vpnVnCode": "BA1234",
"vnType": "L3",
"routingType": "BGP4",
"bandwidthType": "PF",
"bandwidth": {"value": 10,
"unit": "MBPS"
},
"description": "メッセージ"
},
"cloudVnConnectAct": {"cloudVnConnectSeq": "2",
"vnConnectName": "TEST_L3_1",
"wnumber": "W123456780",
"ifStatus": "NO_SHUTDOWN",
"isVnConnectStatus": true,
"serviceKey": "1234"
},
"cloudVnConnectSby": {"cloudVnConnectSeq": "2",
"vnConnectName": "TEST_L3_1",
"wnumber": "W123456780",
"ifStatus": "NO_SHUTDOWN",
"isVnConnectStatus": true,
"serviceKey": "1234"
}
}
],
"cloudVnGcpKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

クラウドVN回線設定を追加

path Parameters

cloudLineSeq

required

string <= 19 characters

Example: 1

項目和名：クラウド回線SEQ

Request Body schema: application/json

	object ACT/SBY回線を同時に追加するパターン、ACT回線のみを追加するパターンでは必須となる。
	object ACT/SBY回線を同時に追加するパターン、ACT回線のみを追加するパターンでは必須となる。
	object ACT/SBY回線を同時に追加するパターン、SBY回線のみを追加するパターンでは必須となる。
note	string (note5) <= 200 characters 項目和名：操作履歴の備考備考　　：-
cloudVnGcpKeyId required	string (cloudVnGcpKeyId) 項目和名：クラウドVN回線(GCP)排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"cloudVnConnectCommon": {"location": "EAST_JAPAN",
"vpnVnCode": "BA1234",
"bandwidthType": "PF",
"bandwidth": {"value": 10,
"unit": "MBPS"
},
"routeAggregation": "CUSTOM",
"routeAggregationAddressList": ["192.168.1.1/29",
"192.168.1.2/29"
],
"description": "メッセージ"
},
"cloudVnConnectAct": {"serviceKey": "1234",
"vnConnectName": "TEST_L3_1",
"asNumber": 13884,
"maximumPrefix": 100
},
"cloudVnConnectSby": {"pairCloudVnConnectSeq": "3",
"serviceKey": "1234",
"vnConnectName": "TEST_L3_1",
"asNumber": 13884,
"maximumPrefix": 100
},
"note": "操作履歴の備考",
"cloudVnGcpKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

クラウドVN回線設定を変更

path Parameters

cloudLineSeq required	string <= 19 characters Example: 1 項目和名：クラウド回線SEQ
wnumber required	string <= 10 characters ^W[0-9]{9}$ Example: W123456780 項目和名：W番号備考　　：ACT回線のW番号を指定する。

Request Body schema: application/json

required	object
required	object
	object
note	string (note5) <= 200 characters 項目和名：操作履歴の備考備考　　：-
cloudVnGcpKeyId required	string (cloudVnGcpKeyId) 項目和名：クラウドVN回線(GCP)排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"cloudVnConnectCommon": {"bandwidth": {"value": 10,
"unit": "MBPS"
},
"routeAggregation": "CUSTOM",
"routeAggregationAddressList": ["192.168.1.1/29",
"192.168.1.2/29"
],
"description": "メッセージ"
},
"cloudVnConnectAct": {"vnConnectName": "TEST_L3_1",
"maximumPrefix": 100
},
"cloudVnConnectSby": {"wnumber": "W123456780",
"vnConnectName": "TEST_L3_1",
"maximumPrefix": 100
},
"note": "操作履歴の備考",
"cloudVnGcpKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

クラウドVNコネクトの有効/無効状態を有効に変更

Request Body schema: application/json

cloudVnConnectList required	Array of strings (wnumber7) [ items <= 10 characters ^W[0-9]{9}$ ]
cloudVnGcpKeyId required	string (cloudVnGcpKeyId) 項目和名：クラウドVN回線(GCP)排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"cloudVnConnectList": ["W123456780"
],
"cloudVnGcpKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

クラウドVNコネクトの有効/無効状態を無効に変更

Request Body schema: application/json

cloudVnConnectList required	Array of strings (wnumber7) [ items <= 10 characters ^W[0-9]{9}$ ]
cloudVnGcpKeyId required	string (cloudVnGcpKeyId) 項目和名：クラウドVN回線(GCP)排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"cloudVnConnectList": ["W123456780"
],
"cloudVnGcpKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

クラウドVN回線設定の詳細情報を取得

path Parameters

wnumber

required

string <= 10 characters ^W[0-9]{9}$

Example: W123456780

項目和名：W番号
備考　　：ACT回線のW番号を指定する。

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/cloud/line/gcp/vnconnect/W123456780

Response samples

Content type

application/json

{"enumber": "E000000010",
"accessType": "MULTI_CLOUD_GW",
"bandwidth": {"value": 10,
"unit": "GBPS"
},
"office": "事業所A",
"cloudVnConnectCommon": {"location": "EAST_JAPAN",
"vpnVnCode": "BA1234",
"vnType": "L3",
"vnName": "VN名1",
"routingType": "BGP4",
"bandwidthType": "PF",
"bandwidth": {"value": 10,
"unit": "MBPS"
},
"routeAggregation": "CUSTOM",
"routeAggregationAddressList": ["192.168.1.1/29",
"192.168.1.2/29"
],
"description": "メッセージ"
},
"cloudVnConnectAct": {"cloudVnConnectSeq": "2",
"vnConnectName": "TEST_L3_1",
"wnumber": "W123456780",
"ifStatus": "NO_SHUTDOWN",
"isVnConnectStatus": true,
"serviceKey": "1234",
"asNumber": 13884,
"wanAddress": "106.186.212.159/30",
"peerIpAddress": "106.186.212.160",
"md5Key": " ",
"maximumPrefix": 100,
"localPreference": "LOW_PRIORITY",
"med": "LOW_PRIORITY"
},
"cloudVnConnectSby": {"cloudVnConnectSeq": "2",
"vnConnectName": "TEST_L3_1",
"wnumber": "W123456780",
"ifStatus": "NO_SHUTDOWN",
"isVnConnectStatus": true,
"serviceKey": "1234",
"asNumber": 13884,
"wanAddress": "106.186.212.159/30",
"peerIpAddress": "106.186.212.160",
"md5Key": " ",
"maximumPrefix": 100,
"localPreference": "LOW_PRIORITY",
"med": "LOW_PRIORITY"
},
"cloudVnGcpKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

クラウドVN回線設定を削除

path Parameters

cloudLineSeq

required

string <= 19 characters

Example: 1

項目和名：クラウド回線SEQ

Request Body schema: application/json

cloudVnConnectList required	Array of strings (wnumber7) [ items <= 10 characters ^W[0-9]{9}$ ]
note	string (note5) <= 200 characters 項目和名：操作履歴の備考備考　　：-
cloudVnGcpKeyId required	string (cloudVnGcpKeyId) 項目和名：クラウドVN回線(GCP)排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"cloudVnConnectList": ["W123456780"
],
"note": "操作履歴の備考",
"cloudVnGcpKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

クラウドVN回線(IBM)API

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST：受付非同期方式
2. 内容
  IBM向け回線毎VNコネクトの取得、設定、変更、削除を行う。

クラウドVN回線設定を取得

path Parameters

cloudLineSeq

required

string <= 19 characters

Example: 1

項目和名：クラウド回線SEQ

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/cloud/line/1/ibm/vnconnects

Response samples

Content type

application/json

{"cloudVnConnectTotal": 1,
"enumber": "E000000010",
"accessType": "MULTI_CLOUD_GW",
"bandwidth": {"value": 10,
"unit": "GBPS"
},
"office": "事業所A",
"cloudVnConnectsList": [{"cloudVnConnectCommon": {"serviceKey": "1234",
"location": "EAST_JAPAN",
"vpnVnCode": "BA1234",
"vnType": "L3",
"routingType": "BGP4",
"bandwidthType": "PF",
"bandwidth": {"value": 10,
"unit": "MBPS"
},
"description": "メッセージ"
},
"cloudVnConnectAct": {"cloudVnConnectSeq": "2",
"vnConnectName": "TEST_L3_1",
"wnumber": "W123456780",
"ifStatus": "NO_SHUTDOWN",
"isVnConnectStatus": true
},
"cloudVnConnectSby": {"cloudVnConnectSeq": "2",
"vnConnectName": "TEST_L3_1",
"wnumber": "W123456780",
"ifStatus": "NO_SHUTDOWN",
"isVnConnectStatus": true
}
}
],
"cloudVnIbmKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

クラウドVN回線設定を追加

path Parameters

cloudLineSeq

required

string <= 19 characters

Example: 1

項目和名：クラウド回線SEQ

Request Body schema: application/json

	object ACT/SBY回線を同時に追加するパターン、ACT回線のみを追加するパターンでは必須となる。
	object ACT/SBY回線を同時に追加するパターン、ACT回線のみを追加するパターンでは必須となる。
	object ACT/SBY回線を同時に追加するパターン、SBY回線のみを追加するパターンでは必須となる。
note	string (note6) <= 200 characters 項目和名：操作履歴の備考備考　　：-
cloudVnIbmKeyId required	string (cloudVnIbmKeyId) 項目和名：クラウドVN回線(IBM)排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"cloudVnConnectCommon": {"serviceKey": "1234",
"location": "EAST_JAPAN",
"vpnVnCode": "BA1234",
"bandwidthType": "PF",
"bandwidth": {"value": 10,
"unit": "MBPS"
},
"routeAggregation": "CUSTOM",
"routeAggregationAddressList": ["192.168.1.1/29",
"192.168.1.2/29"
],
"description": "メッセージ"
},
"cloudVnConnectAct": {"vnConnectName": "TEST_L3_1",
"asNumber": 13884,
"maximumPrefix": 100
},
"cloudVnConnectSby": {"pairCloudVnConnectSeq": "3",
"vnConnectName": "TEST_L3_1",
"asNumber": 13884,
"maximumPrefix": 100
},
"note": "操作履歴の備考",
"cloudVnIbmKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

クラウドVN回線設定を変更

path Parameters

cloudLineSeq required	string <= 19 characters Example: 1 項目和名：クラウド回線SEQ
wnumber required	string <= 10 characters ^W[0-9]{9}$ Example: W123456780 項目和名：W番号備考　　：ACT回線のW番号を指定する。

Request Body schema: application/json

required	object
required	object
	object
note	string (note6) <= 200 characters 項目和名：操作履歴の備考備考　　：-
cloudVnIbmKeyId required	string (cloudVnIbmKeyId) 項目和名：クラウドVN回線(IBM)排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"cloudVnConnectCommon": {"bandwidth": {"value": 10,
"unit": "MBPS"
},
"routeAggregation": "CUSTOM",
"routeAggregationAddressList": ["192.168.1.1/29",
"192.168.1.2/29"
],
"description": "メッセージ"
},
"cloudVnConnectAct": {"vnConnectName": "TEST_L3_1",
"wanAddress": "106.186.212.159/30",
"peerIpAddress": "106.186.212.160",
"maximumPrefix": 100
},
"cloudVnConnectSby": {"wnumber": "W123456780",
"vnConnectName": "TEST_L3_1",
"wanAddress": "106.186.212.159/30",
"peerIpAddress": "106.186.212.160",
"maximumPrefix": 100
},
"note": "操作履歴の備考",
"cloudVnIbmKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

クラウドVNコネクトの有効/無効状態を有効に変更

Request Body schema: application/json

cloudVnConnectList required	Array of strings (wnumber8) [ items <= 10 characters ^W[0-9]{9}$ ]
cloudVnIbmKeyId required	string (cloudVnIbmKeyId) 項目和名：クラウドVN回線(IBM)排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"cloudVnConnectList": ["W123456780"
],
"cloudVnIbmKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

クラウドVNコネクトの有効/無効状態を無効に変更

Request Body schema: application/json

cloudVnConnectList required	Array of strings (wnumber8) [ items <= 10 characters ^W[0-9]{9}$ ]
cloudVnIbmKeyId required	string (cloudVnIbmKeyId) 項目和名：クラウドVN回線(IBM)排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"cloudVnConnectList": ["W123456780"
],
"cloudVnIbmKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

クラウドVN回線設定の詳細情報を取得

path Parameters

wnumber

required

string <= 10 characters ^W[0-9]{9}$

Example: W123456780

項目和名：W番号
備考　　：ACT回線のW番号を指定する。

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/cloud/line/ibm/vnconnect/W123456780

Response samples

Content type

application/json

{"enumber": "E000000010",
"accessType": "MULTI_CLOUD_GW",
"bandwidth": {"value": 10,
"unit": "GBPS"
},
"office": "事業所A",
"cloudVnConnectCommon": {"serviceKey": "1234",
"location": "EAST_JAPAN",
"vpnVnCode": "BA1234",
"vnType": "L3",
"vnName": "VN名1",
"routingType": "BGP4",
"bandwidthType": "PF",
"bandwidth": {"value": 10,
"unit": "MBPS"
},
"routeAggregation": "CUSTOM",
"routeAggregationAddressList": ["192.168.1.1/29",
"192.168.1.2/29"
],
"description": "メッセージ"
},
"cloudVnConnectAct": {"cloudVnConnectSeq": "2",
"vnConnectName": "TEST_L3_1",
"wnumber": "W123456780",
"ifStatus": "NO_SHUTDOWN",
"isVnConnectStatus": true,
"asNumber": 13884,
"wanAddress": "106.186.212.159/30",
"peerIpAddress": "106.186.212.160",
"md5Key": " ",
"maximumPrefix": 100,
"localPreference": "LOW_PRIORITY",
"med": "LOW_PRIORITY"
},
"cloudVnConnectSby": {"cloudVnConnectSeq": "2",
"vnConnectName": "TEST_L3_1",
"wnumber": "W123456780",
"ifStatus": "NO_SHUTDOWN",
"isVnConnectStatus": true,
"asNumber": 13884,
"wanAddress": "106.186.212.159/30",
"peerIpAddress": "106.186.212.160",
"md5Key": " ",
"maximumPrefix": 100,
"localPreference": "LOW_PRIORITY",
"med": "LOW_PRIORITY"
},
"cloudVnIbmKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

クラウドVN回線設定を削除

path Parameters

cloudLineSeq

required

string <= 19 characters

Example: 1

項目和名：クラウド回線SEQ

Request Body schema: application/json

cloudVnConnectList required	Array of strings (wnumber8) [ items <= 10 characters ^W[0-9]{9}$ ]
note	string (note6) <= 200 characters 項目和名：操作履歴の備考備考　　：-
cloudVnIbmKeyId required	string (cloudVnIbmKeyId) 項目和名：クラウドVN回線(IBM)排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"cloudVnConnectList": ["W123456780"
],
"note": "操作履歴の備考",
"cloudVnIbmKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

クラウドVN回線(ORACLE)API

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST：受付非同期方式
2. 内容
  ORACLE向け回線毎VNコネクトの取得、設定、変更、削除を行う。

クラウドVN回線設定を取得

path Parameters

cloudLineSeq

required

string <= 19 characters

Example: 1

項目和名：クラウド回線SEQ

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/cloud/line/1/oracle/vnconnects

Response samples

Content type

application/json

{"cloudVnConnectTotal": 1,
"enumber": "E000000010",
"accessType": "MULTI_CLOUD_GW",
"bandwidth": {"value": 10,
"unit": "GBPS"
},
"office": "事業所A",
"cloudVnConnectsList": [{"cloudVnConnectCommon": {"location": "EAST_JAPAN",
"vpnVnCode": "BA1234",
"vnType": "L3",
"routingType": "BGP4",
"bandwidthType": "PF",
"bandwidth": {"value": 10,
"unit": "MBPS"
},
"description": "メッセージ"
},
"cloudVnConnectAct": {"cloudVnConnectSeq": "2",
"vnConnectName": "TEST_L3_1",
"wnumber": "W123456780",
"ifStatus": "NO_SHUTDOWN",
"isVnConnectStatus": true,
"serviceKey": "1234"
},
"cloudVnConnectSby": {"cloudVnConnectSeq": "2",
"vnConnectName": "TEST_L3_1",
"wnumber": "W123456780",
"ifStatus": "NO_SHUTDOWN",
"isVnConnectStatus": true,
"serviceKey": "1234"
}
}
],
"cloudVnOracleKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

クラウドVN回線設定を追加

path Parameters

cloudLineSeq

required

string <= 19 characters

Example: 1

項目和名：クラウド回線SEQ

Request Body schema: application/json

	object ACT/SBY回線を同時に追加するパターン、ACT回線のみを追加するパターンでは必須となる。
	object ACT/SBY回線を同時に追加するパターン、ACT回線のみを追加するパターンでは必須となる。
	object ACT/SBY回線を同時に追加するパターン、SBY回線のみを追加するパターンでは必須となる。
note	string (note7) <= 200 characters 項目和名：操作履歴の備考備考　　：-
cloudVnOracleKeyId required	string (cloudVnOracleKeyId) 項目和名：クラウドVN回線(ORACLE)排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"cloudVnConnectCommon": {"location": "EAST_JAPAN",
"vpnVnCode": "BA1234",
"bandwidthType": "PF",
"bandwidth": {"value": 10,
"unit": "MBPS"
},
"routeAggregation": "CUSTOM",
"routeAggregationAddressList": ["192.168.1.1/29",
"192.168.1.2/29"
],
"description": "メッセージ"
},
"cloudVnConnectAct": {"serviceKey": "1234",
"vnConnectName": "TEST_L3_1",
"asNumber": 13884,
"wanAddress": "106.186.212.159/30",
"peerIpAddress": "106.186.212.160",
"maximumPrefix": 100
},
"cloudVnConnectSby": {"pairCloudVnConnectSeq": "3",
"serviceKey": "1234",
"vnConnectName": "TEST_L3_1",
"asNumber": 13884,
"wanAddress": "106.186.212.159/30",
"peerIpAddress": "106.186.212.160",
"maximumPrefix": 100
},
"note": "操作履歴の備考",
"cloudVnOracleKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

クラウドVN回線設定を変更

path Parameters

cloudLineSeq required	string <= 19 characters Example: 1 項目和名：クラウド回線SEQ
wnumber required	string <= 10 characters ^W[0-9]{9}$ Example: W123456780 項目和名：W番号備考　　：ACT回線のW番号を指定する。

Request Body schema: application/json

required	object
required	object
	object
note	string (note7) <= 200 characters 項目和名：操作履歴の備考備考　　：-
cloudVnOracleKeyId required	string (cloudVnOracleKeyId) 項目和名：クラウドVN回線(ORACLE)排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"cloudVnConnectCommon": {"bandwidth": {"value": 10,
"unit": "MBPS"
},
"routeAggregation": "CUSTOM",
"routeAggregationAddressList": ["192.168.1.1/29",
"192.168.1.2/29"
],
"description": "メッセージ"
},
"cloudVnConnectAct": {"vnConnectName": "TEST_L3_1",
"maximumPrefix": 100
},
"cloudVnConnectSby": {"wnumber": "W123456780",
"vnConnectName": "TEST_L3_1",
"maximumPrefix": 100
},
"note": "操作履歴の備考",
"cloudVnOracleKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

クラウドVNコネクトの有効/無効状態を有効に変更

Request Body schema: application/json

cloudVnConnectList required	Array of strings (wnumber9) [ items <= 10 characters ^W[0-9]{9}$ ]
cloudVnOracleKeyId required	string (cloudVnOracleKeyId) 項目和名：クラウドVN回線(ORACLE)排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"cloudVnConnectList": ["W123456780"
],
"cloudVnOracleKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

クラウドVNコネクトの有効/無効状態を無効に変更

Request Body schema: application/json

cloudVnConnectList required	Array of strings (wnumber9) [ items <= 10 characters ^W[0-9]{9}$ ]
cloudVnOracleKeyId required	string (cloudVnOracleKeyId) 項目和名：クラウドVN回線(ORACLE)排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"cloudVnConnectList": ["W123456780"
],
"cloudVnOracleKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

クラウドVN回線設定の詳細情報を取得

path Parameters

wnumber

required

string <= 10 characters ^W[0-9]{9}$

Example: W123456780

項目和名：W番号
備考　　：ACT回線のW番号を指定する。

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/cloud/line/oracle/vnconnect/W123456780

Response samples

Content type

application/json

{"enumber": "E000000010",
"accessType": "MULTI_CLOUD_GW",
"bandwidth": {"value": 10,
"unit": "GBPS"
},
"office": "事業所A",
"cloudVnConnectCommon": {"location": "EAST_JAPAN",
"vpnVnCode": "BA1234",
"vnType": "L3",
"vnName": "VN名1",
"routingType": "BGP4",
"bandwidthType": "PF",
"bandwidth": {"value": 10,
"unit": "MBPS"
},
"routeAggregation": "CUSTOM",
"routeAggregationAddressList": ["192.168.1.1/29",
"192.168.1.2/29"
],
"description": "メッセージ"
},
"cloudVnConnectAct": {"cloudVnConnectSeq": "2",
"vnConnectName": "TEST_L3_1",
"wnumber": "W123456780",
"ifStatus": "NO_SHUTDOWN",
"isVnConnectStatus": true,
"serviceKey": "1234",
"asNumber": 13884,
"wanAddress": "106.186.212.159/30",
"peerIpAddress": "106.186.212.160",
"md5Key": "Kddicloud",
"maximumPrefix": 100,
"localPreference": "LOW_PRIORITY",
"med": "LOW_PRIORITY"
},
"cloudVnConnectSby": {"cloudVnConnectSeq": "2",
"vnConnectName": "TEST_L3_1",
"wnumber": "W123456780",
"ifStatus": "NO_SHUTDOWN",
"isVnConnectStatus": true,
"serviceKey": "1234",
"asNumber": 13884,
"wanAddress": "106.186.212.159/30",
"peerIpAddress": "106.186.212.160",
"md5Key": "Kddicloud",
"maximumPrefix": 100,
"localPreference": "LOW_PRIORITY",
"med": "LOW_PRIORITY"
},
"cloudVnOracleKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

クラウドVN回線設定を削除

path Parameters

cloudLineSeq

required

string <= 19 characters

Example: 1

項目和名：クラウド回線SEQ

Request Body schema: application/json

cloudVnConnectList required	Array of strings (wnumber9) [ items <= 10 characters ^W[0-9]{9}$ ]
note	string (note7) <= 200 characters 項目和名：操作履歴の備考備考　　：-
cloudVnOracleKeyId required	string (cloudVnOracleKeyId) 項目和名：クラウドVN回線(ORACLE)排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"cloudVnConnectList": ["W123456780"
],
"note": "操作履歴の備考",
"cloudVnOracleKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

クラウドVN回線再設定API

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST：受付非同期方式
2. 内容
  クラウド用VNコネクトの再設定を行う。

再設定をするクラウドVN回線を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/cloud/line/vnconnects/resetting

Response samples

Content type

application/json

{"cloudVnConnectTotal": 1,
"cloudVnConnectsList": [{"cloudLineInfo": {"enumber": "E000000010",
"accessType": "MULTI_CLOUD_GW",
"bandwidth": {"value": 10,
"unit": "GBPS"
},
"office": "事業所A",
"cloudServiceMenu": "AWS"
},
"cloudVnConnectCommon": {"cloudServiceType": "PRIVATE_PEERING",
"location": "EAST_JAPAN",
"directConnectType": "HOSTED_VIFS",
"vpnVnCode": "BA1234",
"vnType": "L3",
"vnName": "VN名1",
"routingType": "BGP4",
"bandwidthType": "PF",
"bandwidth": {"value": 10,
"unit": "MBPS"
},
"routeAggregation": "CUSTOM",
"routeAggregationAddressList": ["192.168.1.1/29",
"192.168.1.2/29"
],
"naptGlobalIpTotal": 1,
"naptGlobalIpList": ["192.167.1.1/32",
"192.167.1.2/32"
],
"qos": {"isQos": false,
"qosBandControlPattern": "PATTERN_A"
},
"description": "メッセージ"
},
"cloudVnConnectAct": {"cloudVnConnectSeq": "2",
"serviceKey": "1234",
"vnConnectName": "TEST_L3_1",
"wnumber": "W123456780",
"asNumber": 12077,
"wanAddress": "106.186.212.159/30",
"peerIpAddress": "106.186.212.160",
"md5Key": "Kddicloud",
"maximumPrefix": 100,
"localPreference": "LOW_PRIORITY",
"med": "LOW_PRIORITY",
"vlanId": "1234"
},
"cloudVnConnectSby": {"cloudVnConnectSeq": "2",
"serviceKey": "1234",
"vnConnectName": "TEST_L3_1",
"wnumber": "W123456780",
"asNumber": 12077,
"wanAddress": "106.186.212.159/30",
"peerIpAddress": "106.186.212.160",
"md5Key": "Kddicloud",
"maximumPrefix": 100,
"localPreference": "LOW_PRIORITY",
"med": "LOW_PRIORITY",
"vlanId": "1234"
}
}
]
}

クラウドVN回線を再設定する

path Parameters

wnumber

required

string <= 10 characters ^W[0-9]{9}$

Example: W123456780

項目和名：W番号
備考　　：ACT回線のW番号を指定する。

Responses

Request samples

Curl

curl --request POST \
  --url https://wvs2.kddi.ne.jp/api/v1/network/cloud/line/vnconnects/resetting/W123456780

Response samples

400
401
403
409
500

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

IF状態変更API

概要
1. インターフェースタイプ
  受付非同期方式
2. 内容
  クラウドVNコネクト、VNコネクト、VN L2/L3コネクト、IPSec回線のIF状態の変更を行う。

VNコネクトのIF状態変更を実行する

path Parameters

lineCategory

required

string

Enum: "VN" "L2L3" "CLOUD" "AC"

Example: VN

項目和名：参照回線種別

Request Body schema: application/json

wnumber	string (wnumber11) <= 10 characters ^W[0-9]{9}$ 項目和名：W番号備考　　：参照回線種別を取得したAPIのGETメソッドにて取得する。参照回線種別がVN、L2L3、CLOUDであった場合は必須となる。
xnumber	string (xnumber1) <= 10 characters ^X[0-9]{9}$ 項目和名：X番号備考　　：参照回線種別を取得したAPIのGETメソッドにて取得する。参照回線種別がACであった場合は必須となる。
ifStatus required	string (ifStatus10) Enum: "SHUTDOWN" "NO_SHUTDOWN" 項目和名：IF状態備考　　：SHUTDOWN:閉塞(対象VNコネクトを利⽤した通信はドロップします。) 　　　　　NO_SHUTDOWN:開放(対象VNコネクトを利⽤した通信が可能です。)
ifStateKeyId required	string (ifStateKeyId) 項目和名：IF状態変更排他情報備考　　：排他確認用パラメータ。参照回線種別(lineCategory)を取得した、以下いずれかのAPIのGETメソッドから取得する。　　　　　・VNコネクトAPI 　　　　　・VN L2L3コネクトAPI 　　　　　・クラウドVNコネクトAPI(MS,AWS,GCP,IBM,ORACLE) 　　　　　・IPsec API

Responses

Request samples

Payload
Curl

Content type

application/json

{"wnumber": "W123456780",
"xnumber": "X123456780",
"ifStatus": "SHUTDOWN",
"ifStateKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

参照コマンドAPI

概要
1. インターフェースタイプ受付非同期方式
2. 内容クラウドVNコネクト、VNコネクト、VN L2/L3コネクト、IPSec回線への参照コマンドの送信要求を行う。

参照コマンドを実行

path Parameters

lineCategory

required

string

Enum: "VN" "L2L3" "CLOUD" "AC"

Example: VN

項目和名：参照回線種別

Request Body schema: application/json

wnumber	string (wnumber12) <= 10 characters ^W[0-9]{9}$ 項目和名：W番号備考　　：参照回線種別を取得したAPIのGETメソッドにて取得する。参照回線種別がVN、L2L3、CLOUDであった場合は必須となる。
xnumber	string (xnumber2) <= 10 characters ^X[0-9]{9}$ 項目和名：X番号備考　　：参照回線種別を取得したAPIのGETメソッドにて取得する。参照回線種別がACであった場合は必須となる。
commandType required	string (commandType) Enum: "ROUTE" "BGP" "ARP" "MAC" "OSPF" "GATEWAY" "SA" 項目和名: コマンド種別備考 : 以下のいずれかを指定する。 ROUTE: 経路情報参照。VNコネクトモード/クラウドVNコネクトモード(ルーティング種別)がL3(BGP4),L3(static),L2L3(BGP4),L2L3(static),L2L3(OSPF)の場合 BGP: BGPネイバー参照。VNコネクトモード/クラウドVNコネクトモード(ルーティング種別)がL3(BGP4),L2L3(BGP4)の場合 ARP: ARP参照。VNコネクトモード/クラウドVNコネクトモード(ルーティング種別)がL3(BGP4),L3(static),L2L3(BGP4),L2L3(static),L2L3(OSPF)の場合 MAC: MACテーブル参照。VNコネクトモード(ルーティング種別)がL2の場合 OSPF: OSPFネイバー参照。VNコネクトモード(ルーティング種別)がL2L3(OSPF)の場合 GATEWAY: ゲートウェイ経路情報参照。AC回線の場合 SA: SA状態参照。AC回線の場合
referenceCommandKeyId required	string (referenceCommandKeyId) 項目和名：参照コマンド排他情報備考　　：排他確認用パラメータ。参照回線種別(lineCategory)を取得した、以下いずれかのAPIのGETメソッドから取得する。　　　　　・VNコネクトAPI 　　　　　・VN L2L3コネクトAPI 　　　　　・クラウドVNコネクトAPI(MS,AWS,GCP,IBM,ORACLE) 　　　　　・IPsec API

Responses

Request samples

Payload
Curl

Content type

application/json

{"wnumber": "W123456780",
"xnumber": "X123456780",
"commandType": "ROUTE",
"referenceCommandKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

疎通確認API

概要
1. インターフェースタイプ
  受付非同期方式
2. 内容
  クラウドVNコネクト、VNコネクト、VN L2/L3コネクト、IPSec回線への疎通確認コマンドの送信要求を行う。

疎通確認コマンドの送信を行う。

path Parameters

lineCategory

required

string

Enum: "VN" "L2L3" "CLOUD" "AC"

Example: VN

項目和名：参照回線種別

Request Body schema: application/json

wnumber	string <= 10 characters ^W[0-9]{9}$ 項目和名：W番号備考　　：参照回線種別を取得したAPIのGETメソッドにて取得する。参照回線種別がVN、L2L3、CLOUDであった場合は必須となる。
xnumber	string <= 10 characters ^X[0-9]{9}$ 項目和名：X番号備考　　：参照回線種別を取得したAPIのGETメソッドにて取得する。参照回線種別がACであった場合は必須となる。
commandType required	string Enum: "PING" "TRACEROUTE" 項目和名：コマンド種別備考　　：PINGかTRACEROUTEを指定する。　　　　　PING:PING 　　　　　TRACEROUTE:TRACEROUTE
ipAddress required	string^(([1-9]?[0-9]\|1[0-9]{2}\|2[0-4][0-9]\|25[0-5])... 項目和名：IPアドレス備考　　：-
connectTestKeyId required	string 項目和名：疎通確認排他情報備考　　：排他確認用パラメータ。参照回線種別(lineCategory)を取得した、以下いずれかのAPIのGETメソッドから取得する。　　　　　・VNコネクトAPI 　　　　　・VN L2L3コネクトAPI 　　　　　・クラウドVNコネクトAPI(MS,AWS,GCP,IBM,ORACLE) 　　　　　・IPsec API

Responses

Request samples

Payload
Curl

Content type

application/json

{"wnumber": "W123456780",
"xnumber": "X123456780",
"commandType": "PING",
"ipAddress": "192.168.1.1",
"connectTestKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

クラウド回線情報API

概要
1. インターフェースタイプ
  受付非同期方式
2. 内容
  クラウド回線情報の取得・取得要求を行う。

クラウド回線情報の取得要求を行う。

Request Body schema: application/json

wnumber

required

string (wnumber13) <= 10 characters ^W[0-9]{9}$

項目和名：W番号
備考　　：クラウドVN回線(MS/AWS/GCP/IBM/ORACLE)APIのGETメソッドにて取得する。
　　　　　ACT回線のW番号を指定することで、SBY回線も取得する。

cloudLineInfomationKeyId

required

string (cloudLineInfomationKeyId)

項目和名：クラウド回線情報排他情報
備考　　：排他確認用パラメータ。以下いずれかのAPIのGETメソッドにて取得する。
　　　　　・クラウドVN回線(MS)API
　　　　　・クラウドVN回線(AWS)API
　　　　　・クラウドVN回線(GCP)API
　　　　　・クラウドVN回線(IBM)API
　　　　　・クラウドVN回線(ORACLE)API

Responses

Request samples

Payload
Curl

Content type

application/json

{"wnumber": "W123456780",
"cloudLineInfomationKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

運用コマンド実行結果一覧API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  コマンド実行結果の一覧及び詳細を取得する。

VN回線のコマンドの実行結果一覧を取得

path Parameters

vnLineCategory required	string Enum: "VN" "L2L3" "CLOUD" Example: VN 項目和名：参照回線種別(VN)
wnumber required	string <= 10 characters ^W[0-9]{9}$ Example: W123456780 項目和名：W番号

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/operation-tool/command-results/VN/W123456780

Response samples

200
400
401
403
500

Content type

application/json

{"total": 1,
"commandList": [{"entryNumber": "1",
"createDateTime": "2021-12-01T23:59:59+09:00",
"commandType": "PING",
"ipAddress": "192.168.1.1",
"commandStatus": "SUCCESS",
"endDateTime": "2021-12-01T23:59:59+09:00"
}
]
}

AC回線のコマンドの実行結果一覧を取得

path Parameters

acLineCategory required	string Value: "AC" Example: AC 項目和名：参照回線種別(AC)
xnumber required	string <= 10 characters ^X[0-9]{9}$ Example: X123456780 項目和名：X番号

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/operation-tool/command-results/AC/X123456780

Response samples

200
400
401
403
500

Content type

application/json

{"total": 1,
"commandList": [{"entryNumber": "1",
"createDateTime": "2021-12-01T23:59:59+09:00",
"commandType": "PING",
"ipAddress": "192.168.1.1",
"commandStatus": "SUCCESS",
"endDateTime": "2021-12-01T23:59:59+09:00"
}
]
}

コマンドの実行結果詳細を取得

path Parameters

lineCategory required	string Enum: "AC" "VN" Example: AC 項目和名：参照回線種別
entryNumber required	string <= 19 characters Example: 1 項目和名：コマンド登録番号備考　　：主キー

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/operation-tool/command-result/AC/1

Response samples

Content type

application/json

{"commandInfo": {"entryNumber": "1",
"createDateTime": "2021-12-01T23:59:59+09:00",
"commandType": "PING",
"ipAddress": "192.168.1.1",
"commandStatus": "SUCCESS",
"endDateTime": "2021-12-01T23:59:59+09:00"
},
"result": "2999/11/11 22:12:11.123 This is Sample Result.....   show_bgp_neighbou   Tue Sep 28 17:27:12 JST 2021   Peer: 192.168.101.2+179 AS 10124 Local:: 192.168.101.2+179 AS 10124   Type: External State: Established   Active prefixes: 1   Recieved prefixes: 1   Accepted prefixes: 1   Advertised prefixes: 1"
}

Type4経路設定API

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST ：非同期応答方式
2. 内容
  インターネットType4の経路情報を取得・変更する。

Type4経路情報取得

path Parameters

type4Id

required

string^TY4[0-9]{5}$

Example: TY412345

項目和名：Type4ID
備考　　：主キー
　　　　　アプライアンス情報APIより取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/routes/type4/TY412345

Response samples

200
400
401
403
500

Content type

application/json

{"type4RouteKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d",
"total": 1,
"type4RouteList": [{"internetAddress": "12.53.4.0/24",
"isMicrosoft365": true
}
]
}

Type4経路情報変更

path Parameters

type4Id

required

string^TY4[0-9]{5}$

Example: TY412345

項目和名：Type4ID
備考　　：主キー
　　　　　アプライアンス情報APIより取得

Request Body schema: application/json

type4RouteKeyId required	string 項目和名：Type4経路設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。
required	Array of objects (type4Route) 項目和名：Type4経路情報リスト備考　　：空の場合は空配列

Responses

Request samples

Payload
Curl

Content type

application/json

{"type4RouteKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d",
"type4RouteList": [{"internetAddress": "12.53.4.0/24",
"isMicrosoft365": true
}
]
}

Response samples

Content type

application/json

{"jobId": "1"
}

エクストラネットAPI

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST(申請)：同期応答方式
  POST(承認・取下げ・切断)：受付非同期方式
2. 内容
  接続中もしくは接続申請中、被接続申請中のエクストラネット接続情報の参照、申請、取下げ、切断処理を行う

エクストラネット設定情報を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/extranets

Response samples

200
401
403
500

Content type

application/json

{"total": 1,
"extranetInfo": [{"extranetSeq": "1",
"srcVNumber": "V000000010",
"srcVpnVnCode": "DA1234",
"dstVNumber": "V000000020",
"dstVpnVnCode": "DB1234",
"pinCode": "1234",
"approvalState": "APPLIED",
"message": "メッセージ",
"requestDateTime": "2021-12-01T23:59:59+09:00",
"expiredDateTime": "2021-12-16T23:59:59+09:00",
"approvalDateTime": "2021-12-02T23:59:59+09:00"
}
],
"extranetKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

エクストラネット申請

Request Body schema: application/json

srcVnCode required	string (srcVnCode) <= 6 characters ^[D][A-Z]*[0-9]{4}$ 項目和名：接続元VNコード備考　　：-
dstVNumber required	string (dstVNumber) <= 10 characters ^V[0-9]{8}0$ 項目和名：接続先V番号備考　　：-
dstVnCode required	string (dstVnCode) <= 6 characters ^[D][A-Z]*[0-9]{4}$ 項目和名：接続先VNコード備考　　：-
pinCode	string (pinCode) <= 4 characters ^[a-z0-9]{4}$ 項目和名：PINコード備考　　：GET：承認者側が承認前の時(APPLIED, COMPLETE以外の場合）にはNULLを設定　　　　　申請時：srcVNumberとdstVNumberが異なる場合のみ必須　　　　　承認・取下げ・切断時：srcVNumberとdstVNumberが異なる場合かつ　　　　　　　approvalRequestがAPPROVEの場合：必須　　　　　　　approvalRequestがAPPROVE以外の場合：NULL or undefined(プロパティなし)
message	string (message) <= 30 characters 項目和名：メッセージ備考　　：全半角、改行、記号(_ . , : ; ? < > + - * / = # % & $ @)の入力チェックが必要
extranetKeyId required	string (extranetKeyId) 項目和名：エクストラネット設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"srcVnCode": "DA1234",
"dstVNumber": "V000000020",
"dstVnCode": "DB1234",
"pinCode": "1234",
"message": "メッセージ",
"extranetKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"extranetSeq": "1",
"extranetKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

エクストラネット申請を承認・取り下げ、エクストラネットの切断

path Parameters

extranetSeq

required

string <= 19 characters

Example: 1

項目和名：エクストラネット接続申請SEQ

Request Body schema: application/json

pinCode	string (pinCode) <= 4 characters ^[a-z0-9]{4}$ 項目和名：PINコード備考　　：GET：承認者側が承認前の時(APPLIED, COMPLETE以外の場合）にはNULLを設定　　　　　申請時：srcVNumberとdstVNumberが異なる場合のみ必須　　　　　承認・取下げ・切断時：srcVNumberとdstVNumberが異なる場合かつ　　　　　　　approvalRequestがAPPROVEの場合：必須　　　　　　　approvalRequestがAPPROVE以外の場合：NULL or undefined(プロパティなし)
approvalRequest required	string (approvalRequest) Enum: "APPROVE" "DROP" "REJECTED" "DISCONNECT" 項目和名：ステータスの変更要求備考　　：以下のいずれかの内容を指定 APPROVE: 承認 DROP: 取り下げ REJECTED: 却下 DISCONNECT: 切断
note	string <= 200 characters 項目和名：操作履歴の備考備考　　：approvalRequestがAPPROVEの場合のみパラメータが入ること許容する。
extranetKeyId required	string (extranetKeyId) 項目和名：エクストラネット設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"pinCode": "1234",
"approvalRequest": "APPROVE",
"note": "備考入力",
"extranetKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

エクストラネットAPI CSVダウンロード API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  エクストラネット設定情報のcsvファイルを生成送信する機能

エクストラネット設定情報の一覧のCSVを取得

検索条件として「approvalState」を指定しない場合、全件ダウンロードする。

query Parameters

tokenId

required

string <uuid>

Example: tokenId=ede66c43-9b9d-4222-93ed-5f11c96e08e2

項目和名：トークンID
備考　　：ログイン時に取得するトークンIDを設定

approvalSearchState

string

Enum: "APPROVAL_PENDING" "APPLIED" "COMPLETE" "EXPIRED" "DROP" "REJECTED" "DISCONNECT" "FAILED"

Example: approvalSearchState=APPLIED

項目和名：承認ステータス(検索用)
備考　　：APPROVAL_PENDING: 承認待ち
APPLIED: 申請中
COMPLETE: 完了
EXPIRED: 有効期限切れ
DROP: 取り下げ
REJECTED: 却下
DISCONNECT: 切断
FAILED: 失敗
「approvalSearchState」を指定しない場合、全件ダウンロードされます。

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v1/network/extranets/csv?tokenId=ede66c43-9b9d-4222-93ed-5f11c96e08e2&approvalSearchState=APPLIED'

Response samples

400
401
403
500

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

Hub&Spoke API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  Hub&Spoke接続一覧を参照する機能

Hub&Spoke接続申請情報の一覧を取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/network/hub-spoke

Response samples

200
401
403
500

Content type

application/json

{"total": 1,
"hubSpokeInfoList": [{"hubSpokeSeq": "1",
"hubVNumber": "V000000020",
"hubVpnVnCode": "BA1234",
"spokeVNumber": "V000000010",
"spokeVpnVnCode": "BB1234",
"publicVpnCode": "BZ9999",
"hubSpokeStatus": "COMPLETE",
"requestDateTime": "2021-11-23T00:09:44+09:00",
"approvalDateTime": "2021-11-23T00:09:44+09:00"
}
]
}

Hub&Spoke CSVダウンロード API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  Hub&Spoke接続一覧のcsvファイルを生成送信する機能

Hub&Spoke接続申請情報の一覧のCSVを取得

query Parameters

tokenId

required

string <uuid>

Example: tokenId=ede66c43-9b9d-4222-93ed-5f11c96e08e2

項目和名：トークンID
備考　　：ログイン時に取得するトークンIDを設定

hubSpokeStatus

string

Enum: "REQUEST" "COMPLETE" "DISCONNECTED" "PROVISIONING_FAILURE"

Example: hubSpokeStatus=COMPLETE

項目和名：状態
備考　　：コードの内容は下記になります。
　　　　　REQUEST: Hub&Spokeの接続申請が承認待ちの場合
　　　　　COMPLETE: Hub&Spokeの接続申請が完了した場合
　　　　　DISCONNECTED: Hub&Spokeの接続申請が切断した場合
　　　　　PROVISIONING_FAILURE: Hub&Spokeの接続申請が失敗した場合
　　　　　「status」を指定しない場合、全件ダウンロードされます。

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v1/network/hub-spoke/csv?tokenId=ede66c43-9b9d-4222-93ed-5f11c96e08e2&hubSpokeStatus=COMPLETE'

Response samples

400
401
403
500

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

インターネット一時停止API

概要
1. インターフェースタイプ
  受付非同期方式
2. 内容
  ポリシー設定画面で選択されたインターネット回線の開始/停止処理要求を行う。

インターネットType1の開通/停止処理要求を行う。

Request Body schema: application/json

isInternetPause required	boolean (isInternetPause1) 項目和名：一時停止フラグ備考　　：true:「一時停止」、false:「開始」
note	string (note) <= 200 characters 項目和名：操作履歴の備考備考　　：-
contractType1KeyId required	string 項目和名：インターネットType1契約排他情報備考　　：排他確認用パラメータ　　　　　サービスメニューAPI（インターネットType1）のGETメソッドから取得する。

Responses

Request samples

Payload
Curl

Content type

application/json

{"isInternetPause": true,
"note": "メッセージ",
"contractType1KeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

インターネットType4の開通/停止処理要求を行う。

path Parameters

type4Id

required

string <= 8 characters ^TY4[0-9]{5}$

Example: TY412345

項目和名：TYPE4ID

Request Body schema: application/json

isInternetPause required	boolean (isInternetPause1) 項目和名：一時停止フラグ備考　　：true:「一時停止」、false:「開始」
contractType4KeyId required	string 項目和名：インターネットType4契約排他情報備考　　：排他確認用パラメータ　　　　　サービスメニューAPI（インターネットType4）のGETメソッドから取得する。

Responses

Request samples

Payload
Curl

Content type

application/json

{"isInternetPause": true,
"contractType4KeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"jobId": "1"
}

アプライアンスログレポ―ト作成依頼API

概要
1. インターフェースタイプ
  GET ：同期応答方式
  POST：非同期応答方式
2. 内容
  アプライアンスログの当日分のログ作成依頼を行う。

アプライアンスログ作成依頼が可能なアプライアンスの一覧を取得する

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/report/appliancelog/create

Response samples

200
401
403
500

Content type

application/json

{"total": 1,
"applianceList": [{"enumber": "E202271120",
"wnumber": "W123456780",
"applianceType": "INTERNET_FW"
}
]
}

アプライアンスログレポ―ト作成依頼

Request Body schema: application/json

enumber	string^E[0-9]{8}0$ 項目和名：E番号備考　　：インターネットType1回線のE番号(Main_ACT) 　　　　　インターネットType1回線の場合、必須　　　　　インターネットType4回線またはアプライアンス種別がイントラネットFWの場合、nullを設定
wnumber	string^W[0-9]{9}$ 項目和名：W番号備考　　：インターネットType4回線のW番号(Main_ACT) 　　　　　インターネットType4回線の場合、必須　　　　　インターネットType1回線またはアプライアンス種別がイントラネットFWの場合、nullを設定
applianceType required	string (applianceType4) Enum: "INTERNET_FW" "UTM" "INTRANET_FW" 項目和名：アプライアンス種別備考　　：INTERNET_FW：インターネットFW 　　　　　UTM：UTM 　　　　　INTRANET_FW：イントラネットFW
startDateTime required	string <date-time> 項目和名：開始日時備考　　：-
endDateTime required	string <date-time> 項目和名：終了日時備考　　：-

Responses

Request samples

Payload
Curl

Content type

application/json

{"enumber": "E202271120",
"wnumber": "W123456780",
"applianceType": "INTERNET_FW",
"startDateTime": "2021-12-01T23:59:59+09:00",
"endDateTime": "2021-12-01T23:59:59+09:00"
}

Response samples

400
401
403
500
503

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

アプライアンスログ検索API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  アプライアンスログの検索結果を取得する。

アプライアンスログ検索

query Parameters

reportDate	string^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[12][0-9]\|3... Example: reportDate=2021-12-01 項目和名　　：レポート対象日備考　　　　：-
enumber	string^E[0-9]{8}0$ Example: enumber=E202271120 項目和名：E番号備考　　：インターネットType1回線のE番号(Main_ACT) 　　　　　アプライアンス種別がイントラネットFWの場合、nullを設定
wnumber	string^W[0-9]{9}$ Example: wnumber=W123456780 項目和名：W番号備考　　：インターネットType4回線のW番号(Main_ACT) 　　　　　アプライアンス種別がイントラネットFWの場合、nullを設定
applianceType	string Enum: "INTERNET_FW" "UTM" "INTRANET_FW" 項目和名：アプライアンス種別備考　　：INTERNET_FW：インターネットFW 　　　　　UTM：UTM 　　　　　INTRANET_FW：イントラネットFW

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v1/report/appliancelog/search?reportDate=2021-12-01&enumber=E202271120&wnumber=W123456780&applianceType=SOME_STRING_VALUE'

Response samples

Content type

application/json

{"total": 1,
"applianceLogList": [{"reportDate": "2021-12-01",
"enumber": "E202271120",
"wnumber": "W123456780",
"applianceType": "INTERNET_FW",
"fileName": "APPLIANCELOG_REPORT_V123456780_InternetFirewall_20211002_000000-194800.zip",
"fileSize": 100
}
]
}

アプライアンスログAPI

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  アプライアンスログの取得、削除する。

アプライアンスログのダウンロード

query Parameters

fileName required	string <= 255 characters ^[A-Za-z0-9_-]+\.zip$ Example: fileName=APPLIANCELOG_REPORT_V123456780_InternetFirewall_20211002_000000-194800.zip 項目和名　　：ファイル名備考　　　　：取得するログのファイル名　　　　　　　アプライアンスログ検索APIより取得
tokenId required	string <uuid> Example: tokenId=ede66c43-9b9d-4222-93ed-5f11c96e08e2 項目和名：トークンID 備考　　：ログイン時に取得するトークンIDを設定

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v1/report/appliancelogs/download?fileName=APPLIANCELOG_REPORT_V123456780_InternetFirewall_20211002_000000-194800.zip&tokenId=ede66c43-9b9d-4222-93ed-5f11c96e08e2'

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

アプライアンスログのログ削除

Request Body schema: application/json

Array

string <= 255 characters ^(|\[作成中\]|\[作成失敗\])+[A-Za-z0-9_-]+\.zip$

Responses

Request samples

Payload
Curl

Content type

application/json

["APPLIANCELOG_REPORT_V123456780_InternetFirewall_20211002_000000-194800.zip"
]

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

アプライアンスログ情報API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  ご利用可能ログ容量と、現在の使用量を取得するAPI

ご利用可能ログ容量と、現在の使用量を表示

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/report/appliancelog/capacity-info

Response samples

Content type

application/json

{"capacityUsed": 30,
"applianceLogCapacity": 100
}

トラフィック回線検索API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  トラフィック情報のサービス（回線種別）に対応した回線を取得する。

サービス（回線種別）に対応した回線を取得する。

query Parameters

lineType

string

Enum: "ACCESS" "INTERNET" "VN" "CLOUD" "VNL2L3" "MULTICLOUD" "CPA_5GSA"

Example: lineType=ACCESS

項目和名：回線種別
備考　　：ACCESS ：アクセス回線
　　　　　INTERNET ：インターネット回線
　　　　　VN ：VNコネクト
　　　　　CLOUD ：クラウド接続
　　　　　VNL2L3 ：VN L2/L3コネクト
　　　　　MULTICLOUD：マルチクラウド種別
　　　　　CPA_5GSA ：CPA 5GSA
　　　　　※回線種別を指定しない場合は、全回線種別の情報を一括取得

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v1/report/traffic/lines?lineType=ACCESS'

Response samples

200
400
401
403
500

Content type

application/json

{"isStatistics": true,
"total": 2,
"lineTypeSearchList": [{"lineType": "ACCESS",
"total": 2,
"elementList": [{"enumberMainAct": "E000000010",
"enumberMainSby": "E000000020",
"enumberBcpAct": "E000000030",
"enumberBcpSby": "E000000040",
"wnumberMainAct": "W000000001",
"wnumberMainSby": "W000000002",
"wnumberBcpAct": "W000000003",
"wnumberBcpSby": "W000000004",
"office": "事業所A",
"internetType": "TYPE4",
"type4Id": "TY412345",
"applianceType": "INTERNET_FW",
"vpnVnCode": "BP0124",
"vnName": "TEST_1",
"vnConnectName": "TEST_L3_1",
"isAssociate": true,
"l2VnCode": "CA1234",
"l3VpnVnCode": "BA1234",
"cloudServiceMenu": "AWS",
"isMsPeering": true,
"domain": "cpx.121212"
}
]
}
]
}

サービス（回線種別）に対応した回線を取得する。

query Parameters

lineType

string

Enum: "ACCESS" "INTERNET" "VN" "CLOUD" "VNL2L3" "MULTICLOUD" "CPA_5GSA"

Example: lineType=ACCESS

項目和名：回線種別
備考　　：ACCESS ：アクセス回線
　　　　　INTERNET ：インターネット回線
　　　　　VN ：VNコネクト
　　　　　CLOUD ：クラウド接続
　　　　　VNL2L3 ：VN L2/L3コネクト
　　　　　MULTICLOUD：マルチクラウド種別
　　　　　CPA_5GSA ：CPA 5GSA
　　　　　※回線種別を指定しない場合は、全回線種別の情報を一括取得

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v2/report/traffic/lines?lineType=ACCESS'

Response samples

200
400
401
403
500

Content type

application/json

{"isStatistics": true,
"total": 2,
"lineTypeSearchList": [{"lineType": "ACCESS",
"total": 2,
"elementList": [{"enumberMainAct": "E000000010",
"enumberMainSby": "E000000020",
"enumberBcpAct": "E000000030",
"enumberBcpSby": "E000000040",
"wnumberMainAct": "W000000001",
"wnumberMainSby": "W000000002",
"wnumberBcpAct": "W000000003",
"wnumberBcpSby": "W000000004",
"office": "事業所A",
"internetType": "TYPE4",
"type4Id": "TY412345",
"applianceType": "INTERNET_FW",
"vpnVnCode": "BP0124",
"vnName": "TEST_1",
"vnConnectName": "TEST_L3_1",
"isAssociate": true,
"l2VnCode": "CA1234",
"l3VpnVnCode": "BA1234",
"cloudServiceMenu": "AWS",
"isMsPeering": true,
"domain": "cpx.121212"
}
]
}
]
}

トラフィック情報API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  トラフィック情報を取得する

トラフィック情報を取得する

query Parameters

lineType required	string Enum: "ACCESS" "INTERNET" "VN" "CLOUD" "VNL2L3" "MULTICLOUD" "CPA_5GSA" Example: lineType=ACCESS 項目和名：回線種別備考　　：ACCESS ：アクセス回線　　　　　INTERNET ：インターネット回線　　　　　VN ：VNコネクト　　　　　CLOUD ：クラウド接続　　　　　VNL2L3 ：VN L2/L3コネクト　　　　　MULTICLOUD：マルチクラウド種別　　　　　CPA_5GSA ：CPA 5GSA
enumberMainAct	string <= 10 characters ^E[0-9]{8}0$ Example: enumberMainAct=E000000010 項目和名：E番号備考　　：アクセス回線、マルチクラウド（クラウド帯域単位）の場合、E番号を指定。　　　　　回線種別が上記以外の場合NULLを設定する。
wnumberMain	string <= 10 characters ^W[0-9]{9}$ Example: wnumberMain=W000000001 項目和名：W番号備考　　：VNコネクト、クラウド接続、VNL2L3コネクト、マルチクラウド（VNコネクト単位）、CPA 5GSAの場合、W番号を指定。　　　　　マルチクラウド（VNコネクト単位）の場合ACT/SBY両方指定可能。それ以外の場合はACTのみ指定可能。　　　　　回線種別が上記以外の場合NULLを設定する。
internetType	string Enum: "TYPE1" "TYPE4" Example: internetType=TYPE4 項目和名：インターネット回線種別備考　　：回線種別がインターネット回線の場合以下のいずれかを設定し、それ以外はNULLを設定する。　　　　　TYPE1 ：インターネットTYPE1 　　　　　TYPE4 ：インターネットTYPE4
type4Id	string <= 6 characters ^TY4[0-9]{5}$ Example: type4Id=TY412345 項目和名：Type4ID 備考　　：internetTypeがTYPE4の場合に指定し、それ以外はNULLを設定する。
cloudServiceMenu	string(^AWS\|^MS[1-9][0-9]{0,8}$\|^GCP\|^Oracle\|^IBM) Example: cloudServiceMenu=AWS 項目和名：クラウドサービス備考　　：クラウド回線の主キー。回線種別がマルチクラウド（クラウド帯域単位）の場合のみ設定し、それ以外の場合はNULLを設定する。
applianceType	string Enum: "INTERNET_FW" "UTM" "INTRANET_FW" Example: applianceType=INTERNET_FW 項目和名：アプライアンス種別備考　　：回線種別がアクセス回線の場合かインターネット回線で、アプライアンス契約がある場合のみ以下のとおり設定する。　　　　　アクセス回線：イントラネットFW 　　　　　インターネット回線：インターネットFWもしくはUTM 　　　　　それ以外の場合はNULLを設定する。　　　　　INTERNET_FW：インターネットFW 　　　　　UTM：UTM 　　　　　INTRANET_FW：イントラネットFW
displayRange required	string Enum: "DAILY" "WEEKLY" "MONTHLY" "YEARLY" Example: displayRange=DAILY 項目和名：表示範囲備考　　：DAILY ：日次(periodDateとperiodTimeを指定) 　　　　　WEEKLY ：週次(periodDateを指定) 　　　　　MONTHLY：月次(periodDateを指定) 　　　　　YEARLY ：年次(指定なし)
periodDate	string Example: periodDate=2021-12-01 項目和名：表示終端年月日備考：表示終端の年月日表示範囲がYEARLYの場合NULLを設定する
periodTime	string <time> Example: periodTime=23:59 項目和名：表示終端時刻備考：表示終端の時刻表示範囲がWEEKLY、MONTHLY、YEARLYの場合NULLを設定する

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v1/report/traffic?lineType=ACCESS&enumberMainAct=E000000010&wnumberMain=W000000001&internetType=TYPE4&type4Id=TY412345&cloudServiceMenu=AWS&applianceType=INTERNET_FW&displayRange=DAILY&periodDate=2021-12-01&periodTime=23%3A59'

Response samples

Content type

application/json

{"lineType": "ACCESS",
"enumberMainAct": "E000000010",
"enumberMainSby": "E000000020",
"enumberBcpAct": "E000000030",
"enumberBcpSby": "E000000040",
"wnumberMainAct": "W000000001",
"wnumberMainSby": "W000000002",
"wnumberBcpAct": "W000000003",
"wnumberBcpSby": "W000000004",
"office": "事業所A",
"internetType": "TYPE4",
"type4Id": "TY412345",
"applianceType": "INTERNET_FW",
"vpnVnCode": "BA1234",
"vnName": "TEST_1",
"vnConnectName": "TEST_L3_1",
"isAssociate": true,
"l2VnCode": "CA1234",
"l3VpnVnCode": "BA1234",
"cloudServiceMenu": "AWS",
"isMsPeering": true,
"domain": "cpx.121212",
"total": 1,
"trafficInfoList": [{"trafficDateTime": "2021-12-01T23:59:59+09:00",
"receiveAverage": "1000",
"receiveMax": "1000",
"receiveNonTfAverage": "1000",
"receiveNonTfMax": "1000",
"sendAverage": "1000",
"sendMax": "1000"
}
]
}

トラフィック情報を取得する

query Parameters

lineType required	string Enum: "ACCESS" "INTERNET" "VN" "CLOUD" "VNL2L3" "MULTICLOUD" "CPA_5GSA" Example: lineType=ACCESS 項目和名：回線種別備考　　：ACCESS ：アクセス回線　　　　　INTERNET ：インターネット回線　　　　　VN ：VNコネクト　　　　　CLOUD ：クラウド接続　　　　　VNL2L3 ：VN L2/L3コネクト　　　　　MULTICLOUD：マルチクラウド種別　　　　　CPA_5GSA ：CPA 5GSA
enumberMainAct	string <= 10 characters ^E[0-9]{8}0$ Example: enumberMainAct=E000000010 項目和名：E番号備考　　：アクセス回線、マルチクラウド（クラウド帯域単位）の場合、E番号を指定。　　　　　回線種別が上記以外の場合NULLを設定する。
wnumberMain	string <= 10 characters ^W[0-9]{9}$ Example: wnumberMain=W000000001 項目和名：W番号備考　　：VNコネクト、クラウド接続、VNL2L3コネクト、マルチクラウド（VNコネクト単位）、CPA 5GSAの場合、W番号を指定。　　　　　マルチクラウド（VNコネクト単位）の場合ACT/SBY両方指定可能。それ以外の場合はACTのみ指定可能。　　　　　回線種別が上記以外の場合NULLを設定する。
internetType	string Enum: "TYPE1" "TYPE4" Example: internetType=TYPE4 項目和名：インターネット回線種別備考　　：回線種別がインターネット回線の場合以下のいずれかを設定し、それ以外はNULLを設定する。　　　　　TYPE1 ：インターネットTYPE1 　　　　　TYPE4 ：インターネットTYPE4
type4Id	string <= 6 characters ^TY4[0-9]{5}$ Example: type4Id=TY412345 項目和名：Type4ID 備考　　：internetTypeがTYPE4の場合に指定し、それ以外はNULLを設定する。
cloudServiceMenu	string(^AWS\|^MS[1-9][0-9]{0,8}$\|^GCP\|^Oracle\|^IBM\|^... Example: cloudServiceMenu=AWS 項目和名：クラウドサービス備考　　：クラウド回線の主キー。回線種別がマルチクラウド（クラウド帯域単位）の場合のみ設定し、それ以外の場合はNULLを設定する。
applianceType	string Enum: "INTERNET_FW" "UTM" "INTRANET_FW" Example: applianceType=INTERNET_FW 項目和名：アプライアンス種別備考　　：回線種別がアクセス回線の場合かインターネット回線で、アプライアンス契約がある場合のみ以下のとおり設定する。　　　　　アクセス回線：イントラネットFW 　　　　　インターネット回線：インターネットFWもしくはUTM 　　　　　それ以外の場合はNULLを設定する。　　　　　INTERNET_FW：インターネットFW 　　　　　UTM：UTM 　　　　　INTRANET_FW：イントラネットFW
displayRange required	string Enum: "DAILY" "WEEKLY" "MONTHLY" "YEARLY" Example: displayRange=DAILY 項目和名：表示範囲備考　　：DAILY ：日次(periodDateとperiodTimeを指定) 　　　　　WEEKLY ：週次(periodDateを指定) 　　　　　MONTHLY：月次(periodDateを指定) 　　　　　YEARLY ：年次(指定なし)
periodDate	string Example: periodDate=2021-12-01 項目和名：表示終端年月日備考：表示終端の年月日表示範囲がYEARLYの場合NULLを設定する
periodTime	string <time> Example: periodTime=23:59 項目和名：表示終端時刻備考：表示終端の時刻表示範囲がWEEKLY、MONTHLY、YEARLYの場合NULLを設定する

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v2/report/traffic?lineType=ACCESS&enumberMainAct=E000000010&wnumberMain=W000000001&internetType=TYPE4&type4Id=TY412345&cloudServiceMenu=AWS&applianceType=INTERNET_FW&displayRange=DAILY&periodDate=2021-12-01&periodTime=23%3A59'

Response samples

Content type

application/json

{"lineType": "ACCESS",
"enumberMainAct": "E000000010",
"enumberMainSby": "E000000020",
"enumberBcpAct": "E000000030",
"enumberBcpSby": "E000000040",
"wnumberMainAct": "W000000001",
"wnumberMainSby": "W000000002",
"wnumberBcpAct": "W000000003",
"wnumberBcpSby": "W000000004",
"office": "事業所A",
"internetType": "TYPE4",
"type4Id": "TY412345",
"applianceType": "INTERNET_FW",
"vpnVnCode": "BA1234",
"vnName": "TEST_1",
"vnConnectName": "TEST_L3_1",
"isAssociate": true,
"l2VnCode": "CA1234",
"l3VpnVnCode": "BA1234",
"cloudServiceMenu": "AWS",
"isMsPeering": true,
"domain": "cpx.121212",
"total": 1,
"trafficInfoList": [{"trafficDateTime": "2021-12-01T23:59:59+09:00",
"receiveAverage": "1000",
"receiveMax": "1000",
"receiveNonTfAverage": "1000",
"receiveNonTfMax": "1000",
"sendAverage": "1000",
"sendMax": "1000"
}
]
}

トラフィック情報 CSVダウンロードAPI

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  トラフィック、セッション、統計のグラフのCSVを取得し、zip圧縮の上で返却する

トラフィック、セッション、統計のグラフのCSVを取得

検索条件が指定されない場合、CSVは取得出来ない。

Request Body schema: application/json

lineType required	string (lineType1) Enum: "ACCESS" "INTERNET" "VN" "CLOUD" "VNL2L3" "MULTICLOUD" "CPA_5GSA" 項目和名：回線種別備考　　：ACCESS ：アクセス回線(enumber、aplianceTypeを指定) 　　　　　INTERNET ：インターネット回線(type4Id(Type4の場合のみ)、applianceTypeを指定) 　　　　　VN ：VNコネクト(wnumberを指定) 　　　　　CLOUD ：クラウド接続(wnumberを指定) 　　　　　VNL2L3 ：VN L2/L3コネクト(wnumberを指定) 　　　　　MULTICLOUD：マルチクラウド種別(クラウド帯域単位の場合はenumber、cloudServiceMenuを指定、VNコネクト単位の場合はwnumberを指定、VPN/VNコード単位の場合はvpnVnCode、applianceTypeを指定) 　　　　　CPA_5GSA ：CPA 5GSA(wnumberを指定)
outputType	string (outputType) Enum: "TRAFFIC" "SESSION" "STATISTICS" "TRAFFIC_SESSION" "SESSION_STATISTICS" "TRAFFIC_STATISTICS" 項目和名：CSV出力するファイル種別備考　　：TRAFFIC ：トラフィック情報を出力　　　　　SESSION ：セッション情報を出力　　　　　STATISTICS ：統計情報を出力　　　　　TRAFFIC_SESSION ：トラフィック情報、セッション情報を出力　　　　　SESSION_STATISTICS：セッション情報、統計情報を出力　　　　　TRAFFIC_STATISTICS：トラフィック情報、統計情報を出力　　　　　※CSV出力するファイル種別を指定しない場合は、全情報を一括取得トラフィック情報は回線種別にアクセス回線、インターネット回線、VNコネクト、クラウド接続、VN L2/L3コネクト、マルチクラウド種別、リモートアクセスGWが指定可能セッション情報は回線種別にアクセス回線、インターネット回線、マルチクラウド種別が指定可能統計情報は回線種別にインターネット回線が指定可能
	Array of objects 項目和名：CSVファイル生成時の検索条件備考　　： -
statisticReportType	string Enum: "APPLICATION" "SOURCE_ADDRESS_SESSIONS_BYTE" "DESTINATION_ADDRESS" "DESTINATION" "THREAT" "SOURCE_ADDRESS_DETECTIONS" "BLOCK_SOURCE_ADDRESS" "BLOCK_URL" "VIRUS" 項目和名：統計情報レポート種別備考： APPLICATION ：アプリケーション SOURCE_ADDRESS_SESSIONS_BYTE：通信元アドレス(セッション数、バイト数) DESTINATION_ADDRESS ：通信先アドレス DESTINATION ：通信先(国別) THREAT ：脅威 SOURCE_ADDRESS_DETECTIONS ：通信元アドレス(検知回数) BLOCK_SOURCE_ADDRESS ：ブロック通信元アドレス BLOCK_URL ：ブロックURL VIRUS ：ウイルス
sortPattern	string Enum: "SESSION" "BYTE" 項目和名：ソート順パターン備考： SESSION：セッション数でソート BYTE：バイト数でソート statisticReportTypeがAPPLICATION, SOURCE_ADDRESS_SESSIONS_BYTE, DESTINATION_ADDRESS, DESTINATIONの場合に選択可能
displayRange required	string (displayRange) Enum: "DAILY" "WEEKLY" "MONTHLY" "YEARLY" 項目和名：表示範囲備考　　：DAILY ：日次(periodDateとperiodTimeを指定) 　　　　　WEEKLY ：週次(periodDateを指定) 　　　　　MONTHLY：月次(periodDateを指定) 　　　　　YEARLY ：年次(指定なし)
periodDate	string (periodDate) 項目和名：表示終端年月日備考：表示開始の年月日表示範囲がYEARLYの場合NULLを設定する統計情報の場合は、表示終端年月日＝統計情報取得日として扱う
periodTime	string <time> (periodTime) 項目和名：表示終端時刻備考：表示開始の時刻(時分を指定する) 表示範囲がWEEKLY、MONTHLY、YEARLYの場合NULLを設定する統計情報の場合は、時刻は無視される

Responses

Request samples

Payload
Curl

Content type

application/json

{"lineType": "ACCESS",
"outputType": "TRAFFIC",
"searchKeyCsv": [{"enumberMainAct": "E000000010",
"wnumberMainAct": "W000000001",
"internetType": "TYPE4",
"type4Id": "TY412345",
"cloudServiceMenu": "AWS",
"applianceType": "INTERNET_FW",
"vpnVnCode": "BA1234"
}
],
"statisticReportType": "APPLICATION",
"sortPattern": "SESSION",
"displayRange": "DAILY",
"periodDate": "2021-12-01",
"periodTime": "23:59"
}

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

トラフィック、セッション、統計のグラフのCSVを取得

検索条件が指定されない場合、CSVは取得出来ない。

Request Body schema: application/json

lineType required	string (lineType1) Enum: "ACCESS" "INTERNET" "VN" "CLOUD" "VNL2L3" "MULTICLOUD" "CPA_5GSA" 項目和名：回線種別備考　　：ACCESS ：アクセス回線(enumber、aplianceTypeを指定) 　　　　　INTERNET ：インターネット回線(type4Id(Type4の場合のみ)、applianceTypeを指定) 　　　　　VN ：VNコネクト(wnumberを指定) 　　　　　CLOUD ：クラウド接続(wnumberを指定) 　　　　　VNL2L3 ：VN L2/L3コネクト(wnumberを指定) 　　　　　MULTICLOUD：マルチクラウド種別(クラウド帯域単位の場合はenumber、cloudServiceMenuを指定、VNコネクト単位の場合はwnumberを指定、VPN/VNコード単位の場合はvpnVnCode、applianceTypeを指定) 　　　　　CPA_5GSA ：CPA 5GSA(wnumberを指定)
outputType	string (outputType) Enum: "TRAFFIC" "SESSION" "STATISTICS" "TRAFFIC_SESSION" "SESSION_STATISTICS" "TRAFFIC_STATISTICS" 項目和名：CSV出力するファイル種別備考　　：TRAFFIC ：トラフィック情報を出力　　　　　SESSION ：セッション情報を出力　　　　　STATISTICS ：統計情報を出力　　　　　TRAFFIC_SESSION ：トラフィック情報、セッション情報を出力　　　　　SESSION_STATISTICS：セッション情報、統計情報を出力　　　　　TRAFFIC_STATISTICS：トラフィック情報、統計情報を出力　　　　　※CSV出力するファイル種別を指定しない場合は、全情報を一括取得トラフィック情報は回線種別にアクセス回線、インターネット回線、VNコネクト、クラウド接続、VN L2/L3コネクト、マルチクラウド種別、リモートアクセスGWが指定可能セッション情報は回線種別にアクセス回線、インターネット回線、マルチクラウド種別が指定可能統計情報は回線種別にインターネット回線が指定可能
	Array of objects 項目和名：CSVファイル生成時の検索条件備考　　： -
statisticReportType	string Enum: "APPLICATION" "SOURCE_ADDRESS_SESSIONS_BYTE" "DESTINATION_ADDRESS" "DESTINATION" "THREAT" "SOURCE_ADDRESS_DETECTIONS" "BLOCK_SOURCE_ADDRESS" "BLOCK_URL" "VIRUS" 項目和名：統計情報レポート種別備考： APPLICATION ：アプリケーション SOURCE_ADDRESS_SESSIONS_BYTE：通信元アドレス(セッション数、バイト数) DESTINATION_ADDRESS ：通信先アドレス DESTINATION ：通信先(国別) THREAT ：脅威 SOURCE_ADDRESS_DETECTIONS ：通信元アドレス(検知回数) BLOCK_SOURCE_ADDRESS ：ブロック通信元アドレス BLOCK_URL ：ブロックURL VIRUS ：ウイルス
sortPattern	string Enum: "SESSION" "BYTE" 項目和名：ソート順パターン備考： SESSION：セッション数でソート BYTE：バイト数でソート statisticReportTypeがAPPLICATION, SOURCE_ADDRESS_SESSIONS_BYTE, DESTINATION_ADDRESS, DESTINATIONの場合に選択可能
displayRange required	string (displayRange) Enum: "DAILY" "WEEKLY" "MONTHLY" "YEARLY" 項目和名：表示範囲備考　　：DAILY ：日次(periodDateとperiodTimeを指定) 　　　　　WEEKLY ：週次(periodDateを指定) 　　　　　MONTHLY：月次(periodDateを指定) 　　　　　YEARLY ：年次(指定なし)
periodDate	string (periodDate) 項目和名：表示終端年月日備考：表示開始の年月日表示範囲がYEARLYの場合NULLを設定する統計情報の場合は、表示終端年月日＝統計情報取得日として扱う
periodTime	string <time> (periodTime) 項目和名：表示終端時刻備考：表示開始の時刻(時分を指定する) 表示範囲がWEEKLY、MONTHLY、YEARLYの場合NULLを設定する統計情報の場合は、時刻は無視される

Responses

Request samples

Payload
Curl

Content type

application/json

{"lineType": "ACCESS",
"outputType": "TRAFFIC",
"searchKeyCsv": [{"enumberMainAct": "E000000010",
"wnumberMainAct": "W000000001",
"internetType": "TYPE4",
"type4Id": "TY412345",
"cloudServiceMenu": "AWS",
"applianceType": "INTERNET_FW",
"vpnVnCode": "BA1234"
}
],
"statisticReportType": "APPLICATION",
"sortPattern": "SESSION",
"displayRange": "DAILY",
"periodDate": "2021-12-01",
"periodTime": "23:59"
}

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

超過・復旧情報取得API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  閾値超過・復旧情報一覧を取得する。

閾値超過・復旧情報一覧を取得する

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/report/traffic/threshold/alarmInfo

Response samples

200
401
403
404
500

Content type

application/json

{"total": 1,
"alarmInfoList": [{"lineType": "ACCESS",
"enumber": "E202271120",
"wnumber": "W123456780",
"internetType": "TYPE1",
"type4Id": "TY412345",
"cloudServiceMenu": "AWS",
"applianceType": "INTERNET_FW",
"direction": "SEND",
"exceedThresholdDateTime": "2021-12-01T23:59:59+09:00",
"restorationDateTime": "2021-12-01T23:59:59+09:00",
"alarmType": "EXCESS"
}
]
}

閾値超過・復旧情報一覧を取得する

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v2/report/traffic/threshold/alarmInfo

Response samples

200
401
403
404
500

Content type

application/json

{"total": 1,
"alarmInfoList": [{"lineType": "ACCESS",
"enumber": "E202271120",
"wnumber": "W123456780",
"internetType": "TYPE1",
"type4Id": "TY412345",
"cloudServiceMenu": "AWS",
"applianceType": "INTERNET_FW",
"direction": "SEND",
"exceedThresholdDateTime": "2021-12-01T23:59:59+09:00",
"restorationDateTime": "2021-12-01T23:59:59+09:00",
"alarmType": "EXCESS"
}
]
}

閾値情報設定API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  閾値超過通知設定を取得、更新する。

閾値超過通知設定を取得する

query Parameters

lineType required	string Enum: "ACCESS" "INTERNET" "VN" "CLOUD" "VNL2L3" "MULTICLOUD" "CPA_5GSA" 項目和名：回線種別備考　　：ACCESS ：アクセス回線(E番号を指定) 　　　　　INTERNET ：インターネット回線(インターネット回線種別、E番号(Type1の場合のみ)、W番号(Type4の場合のみ)、Type4ID(Type4の場合のみ)、アプライアンス種別を指定) 　　　　　VN ：VNコネクト(W番号を指定) 　　　　　CLOUD ：クラウド接続(W番号を指定) 　　　　　VNL2L3 ：VN L2/L3コネクト(W番号を指定) 　　　　　MULTICLOUD：マルチクラウド種別(クラウド帯域単位の場合はE番号、クラウドサービスメニューを指定、VNコネクト単位の場合はW番号を指定) 　　　　　CPA_5GSA ：CPA 5GSA(W番号を指定) 　　　　　トラフィック情報回線検索APIから取得
enumber	string^E[0-9]{8}0$ Example: enumber=E202271120 項目和名：E番号備考　　：主キー　　　　　アクセス回線(アプライアンス種別の指定無)、インターネット回線(Type1)、マルチクラウド（クラウド帯域単位）の場合、必須とする。　　　　　ただし、アクセス回線(アプライアンス種別の指定有)の場合、任意とする。　　　　　トラフィック情報回線検索APIから取得
wnumber	string^W[0-9]{9}$ Example: wnumber=W123456780 項目和名：W番号備考　　：主キー　　　　　インターネット回線(Type4)、VNコネクト、クラウド接続、VNL2L3コネクト、マルチクラウド（VNコネクト単位）、リモートアクセスGWの場合、必須とする。　　　　　トラフィック情報回線検索APIから取得
internetType	string Enum: "TYPE1" "TYPE4" Example: internetType=TYPE1 項目和名：インターネット回線種別備考　　：回線種別がインターネット回線の場合、指定する。　　　　　TYPE1 ：インターネットType1 　　　　　TYPE4 ：インターネットType4 　　　　　トラフィック情報回線検索APIから取得
type4Id	string^TY4[0-9]{5}$ Example: type4Id=TY412345 項目和名：Type4ID 備考　　：インターネット回線種別がインターネットType4の場合、指定する。　　　　　トラフィック情報回線検索APIから取得
cloudServiceMenu	string(^AWS\|^MS[1-9][0-9]{0,9}$\|^GCP\|^Oracle\|^IBM) Example: cloudServiceMenu=AWS 項目和名：クラウドサービスメニュー備考　　：クラウド回線の主キー　　　　　マルチクラウドの場合のみ設定　　　　　その他の回線種別の場合はnull 　　　　　トラフィック情報回線検索APIから取得　　　　　以下の値を指定可能　　　　　AWS 　　　　　MS1 (数字は1～9999999999まで指定可能) 　　　　　GCP 　　　　　Oracle 　　　　　IBM
applianceType	string Enum: "INTERNET_FW" "UTM" "INTRANET_FW" 項目和名：アプライアンス種別備考　　：INTERNET_FW：インターネットFW 　　　　　UTM：UTM 　　　　　INTRANET_FW：イントラネットFW 　　　　　※回線種別がアクセス回線の場合、イントラネットFWが選択可能　　　　　　回線種別がインターネット回線の場合、インターネットFW, UTMが選択可能　　　　　　アプライアンス設定が無い場合はnull 　　　　　トラフィック情報回線検索APIから取得

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v1/report/traffic/threshold?lineType=SOME_STRING_VALUE&enumber=E202271120&wnumber=W123456780&internetType=TYPE1&type4Id=TY412345&cloudServiceMenu=AWS&applianceType=SOME_STRING_VALUE'

Response samples

200
400
401
403
500

Content type

application/json

{"sendThreshold": {"value": 100,
"unit": "KBPS"
},
"receiveThreshold": {"value": 100,
"unit": "KBPS"
},
"mailAddressList": ["test@kddi.com"
],
"thresholdKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

閾値超過通知設定を設定する

Request Body schema: application/json

	object (sendThreshold) 項目和名：送信閾値備考　　：GET時に登録された送信閾値が存在しない場合は「0」を指定する。　　　　　POST時にnullの場合、閾値設定を削除する。
	object (receiveThreshold) 項目和名：受信閾値備考　　：GET時に登録された受信閾値が存在しない場合は「0」を指定する。　　　　　POST時にnullの場合、閾値設定を削除する。
mailAddressList required	Array of strings <= 5 items [ items <= 127 characters ([a-zA-Z0-9!#$%&+\-/=?^_`{\|}~]+[.]{0,1})[a-... ] 項目和名：メールアドレスリスト備考　　：通知先リスト　　　　　空の場合は空配列
thresholdKeyId required	string 項目和名：閾値設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。
required	object (lineInfo)

Responses

Request samples

Payload
Curl

Content type

application/json

{"sendThreshold": {"value": 100,
"unit": "KBPS"
},
"receiveThreshold": {"value": 100,
"unit": "KBPS"
},
"mailAddressList": ["test@kddi.com"
],
"thresholdKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d",
"lineInfo": {"lineType": "ACCESS",
"enumber": "E202271120",
"wnumber": "W123456780",
"internetType": "TYPE1",
"type4Id": "TY412345",
"cloudServiceMenu": "AWS",
"applianceType": "INTERNET_FW"
}
}

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

閾値超過通知設定を取得する

query Parameters

lineType required	string Enum: "ACCESS" "INTERNET" "VN" "CLOUD" "VNL2L3" "MULTICLOUD" "CPA_5GSA" 項目和名：回線種別備考　　：ACCESS ：アクセス回線(E番号を指定) 　　　　　INTERNET ：インターネット回線(インターネット回線種別、E番号(Type1の場合のみ)、W番号(Type4の場合のみ)、Type4ID(Type4の場合のみ)、アプライアンス種別を指定) 　　　　　VN ：VNコネクト(W番号を指定) 　　　　　CLOUD ：クラウド接続(W番号を指定) 　　　　　VNL2L3 ：VN L2/L3コネクト(W番号を指定) 　　　　　MULTICLOUD：マルチクラウド種別(クラウド帯域単位の場合はE番号、クラウドサービスメニューを指定、VNコネクト単位の場合はW番号を指定) 　　　　　CPA_5GSA ：CPA 5GSA(W番号を指定) 　　　　　トラフィック情報回線検索APIから取得
enumber	string^E[0-9]{8}0$ Example: enumber=E202271120 項目和名：E番号備考　　：主キー　　　　　アクセス回線(アプライアンス種別の指定無)、インターネット回線(Type1)、マルチクラウド（クラウド帯域単位）の場合、必須とする。　　　　　ただし、アクセス回線(アプライアンス種別の指定有)の場合、任意とする。　　　　　トラフィック情報回線検索APIから取得
wnumber	string^W[0-9]{9}$ Example: wnumber=W123456780 項目和名：W番号備考　　：主キー　　　　　インターネット回線(Type4)、VNコネクト、クラウド接続、VNL2L3コネクト、マルチクラウド（VNコネクト単位）、リモートアクセスGWの場合、必須とする。　　　　　トラフィック情報回線検索APIから取得
internetType	string Enum: "TYPE1" "TYPE4" Example: internetType=TYPE1 項目和名：インターネット回線種別備考　　：回線種別がインターネット回線の場合、指定する。　　　　　TYPE1 ：インターネットType1 　　　　　TYPE4 ：インターネットType4 　　　　　トラフィック情報回線検索APIから取得
type4Id	string^TY4[0-9]{5}$ Example: type4Id=TY412345 項目和名：Type4ID 備考　　：インターネット回線種別がインターネットType4の場合、指定する。　　　　　トラフィック情報回線検索APIから取得
cloudServiceMenu	string(^AWS\|^MS[1-9][0-9]{0,9}$\|^GCP\|^Oracle\|^IBM\|^... Example: cloudServiceMenu=AWS 項目和名：クラウドサービスメニュー備考　　：クラウド回線の主キー　　　　　マルチクラウドの場合のみ設定　　　　　その他の回線種別の場合はnull 　　　　　トラフィック情報回線検索APIから取得　　　　　以下の値を指定可能　　　　　AWS 　　　　　MS1 (数字は1～9999999999まで指定可能) 　　　　　GCP 　　　　　Oracle 　　　　　IBM 　　　　　SFDC
applianceType	string Enum: "INTERNET_FW" "UTM" "INTRANET_FW" 項目和名：アプライアンス種別備考　　：INTERNET_FW：インターネットFW 　　　　　UTM：UTM 　　　　　INTRANET_FW：イントラネットFW 　　　　　※回線種別がアクセス回線の場合、イントラネットFWが選択可能　　　　　　回線種別がインターネット回線の場合、インターネットFW, UTMが選択可能　　　　　　アプライアンス設定が無い場合はnull 　　　　　トラフィック情報回線検索APIから取得

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v2/report/traffic/threshold?lineType=SOME_STRING_VALUE&enumber=E202271120&wnumber=W123456780&internetType=TYPE1&type4Id=TY412345&cloudServiceMenu=AWS&applianceType=SOME_STRING_VALUE'

Response samples

200
400
401
403
500

Content type

application/json

{"sendThreshold": {"value": 100,
"unit": "KBPS"
},
"receiveThreshold": {"value": 100,
"unit": "KBPS"
},
"mailAddressList": ["test@kddi.com"
],
"thresholdKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

閾値超過通知設定を設定する

Request Body schema: application/json

	object (sendThreshold) 項目和名：送信閾値備考　　：GET時に登録された送信閾値が存在しない場合は「0」を指定する。　　　　　POST時にnullの場合、閾値設定を削除する。
	object (receiveThreshold) 項目和名：受信閾値備考　　：GET時に登録された受信閾値が存在しない場合は「0」を指定する。　　　　　POST時にnullの場合、閾値設定を削除する。
mailAddressList required	Array of strings <= 5 items [ items <= 127 characters ([a-zA-Z0-9!#$%&+\-/=?^_`{\|}~]+[.]{0,1})[a-... ] 項目和名：メールアドレスリスト備考　　：通知先リスト　　　　　空の場合は空配列
thresholdKeyId required	string 項目和名：閾値設定排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。
required	object (lineInfoVer2)

Responses

Request samples

Payload
Curl

Content type

application/json

{"sendThreshold": {"value": 100,
"unit": "KBPS"
},
"receiveThreshold": {"value": 100,
"unit": "KBPS"
},
"mailAddressList": ["test@kddi.com"
],
"thresholdKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d",
"lineInfo": {"lineType": "ACCESS",
"enumber": "E202271120",
"wnumber": "W123456780",
"internetType": "TYPE1",
"type4Id": "TY412345",
"cloudServiceMenu": "AWS",
"applianceType": "INTERNET_FW"
}
}

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

セッション情報API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  アクセス回線、インターネット回線、マルチクラウド(VNコネクト単位)のセッション情報を取得する。

セッション情報取得を取得する。

query Parameters

lineType required	string Enum: "ACCESS" "INTERNET" "MULTICLOUD" Example: lineType=ACCESS 項目和名：回線種別備考　　：ACCESS ：アクセス回線　　　　　INTERNET ：インターネット回線　　　　　MULTICLOUD：マルチクラウド種別
internetType	string Enum: "TYPE1" "TYPE4" Example: internetType=TYPE4 項目和名：インターネット回線種別備考　　：TYPE1 ：インターネットTYPE1 　　　　　TYPE4 ：インターネットTYPE4
type4Id	string <= 8 characters ^TY4[0-9]{5}$ Example: type4Id=TY412345 項目和名：Type4ID 備考　　：internetTypeがTYPE4の場合、指定する。
applianceType required	string Enum: "INTERNET_FW" "UTM" "INTRANET_FW" "NAT" Example: applianceType=INTERNET_FW 項目和名：アプライアンス種別備考　　：アプライアンス契約がある場合のみ以下のとおり設定する。　　　　　アクセス回線：イントラネットFW 　　　　　インターネット回線：インターネットFW、UTM、NATのいずれか　　　　　マルチクラウド種別：NAT 　　　　　INTERNET_FW：インターネットFW 　　　　　UTM：UTM 　　　　　INTRANET_FW：イントラネットFW 　　　　　NAT：NAT
vpnVnCode	string <= 6 characters ^[BCD][A-Z][0-9]{4}$ Example: vpnVnCode=BA1234 項目和名：VPN/VNコード備考　　：回線種別がマルチクラウドの場合、VPN/VNコードを指定。
displayRange required	string Enum: "DAILY" "WEEKLY" "MONTHLY" "YEARLY" 項目和名：表示範囲備考　　：DAILY ：日次(periodDateとperiodTimeを指定) 　　　　　WEEKLY ：週次(periodDateを指定) 　　　　　MONTHLY：月次(periodDateを指定) 　　　　　YEARLY ：年次(指定なし)
periodDate	string Example: periodDate=2021-12-01 項目和名：表示終端年月日備考　　：表示終端の年月日表示範囲がWEEKLY、MONTHLY、YEARLYの場合NULLを設定する
periodTime	string <time> Example: periodTime=23:59 項目和名：表示終端時刻備考　　：表示終端の時刻表示範囲がYEARLYの場合NULLを設定する

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v1/report/session?lineType=ACCESS&internetType=TYPE4&type4Id=TY412345&applianceType=INTERNET_FW&vpnVnCode=BA1234&displayRange=SOME_STRING_VALUE&periodDate=2021-12-01&periodTime=23%3A59'

Response samples

Content type

application/json

{"lineType": "ACCESS",
"enumberMainAct": "E000000010",
"enumberMainSby": "E000000020",
"enumberBcpAct": "E000000030",
"enumberBcpSby": "E000000040",
"wnumberMainAct": "W000000001",
"wnumberMainSby": "W000000002",
"wnumberBcpAct": "W000000003",
"wnumberBcpSby": "W000000004",
"office": "事業所A",
"internetType": "TYPE4",
"type4Id": "TY412345",
"applianceType": "INTERNET_FW",
"vpnVnCode": "BA1234",
"vnName": "TEST_1",
"vnConnectName": "TEST_L3_1",
"total": 1,
"sessionInfoList": [{"sessionDateTime": "2021-12-01T23:59:59+09:00",
"averageCount": 782,
"maxCount": 1564
}
]
}

統計情報API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  インターネット回線の統計情報を取得する。

統計情報取得

query Parameters

internetType required	string Enum: "TYPE1" "TYPE4" Example: internetType=TYPE1 項目和名：インターネット回線種別備考　　：TYPE1 ：インターネットTYPE1 　　　　　TYPE4 ：インターネットTYPE4
type4Id	string <= 8 characters ^TY4[0-9]{5}$ Example: type4Id=TY412345 項目和名：Type4ID 備考　　：internetTypeがTYPE4の場合、指定する。
applianceType required	string Enum: "INTERNET_FW" "UTM" Example: applianceType=INTERNET_FW 項目和名：アプライアンス種別備考　　：以下のいずれかを設定する。　　　　　INTERNET_FW：インターネットFW 　　　　　UTM：UTM
statisticReportType required	string Enum: "APPLICATION" "SOURCE_ADDRESS_SESSIONS_BYTE" "DESTINATION_ADDRESS" "DESTINATION" "THREAT" "SOURCE_ADDRESS_DETECTIONS" "BLOCK_SOURCE_ADDRESS" "BLOCK_URL" "VIRUS" Example: statisticReportType=APPLICATION 項目和名：統計情報レポート種別備考： APPLICATION ：アプリケーション SOURCE_ADDRESS_SESSIONS_BYTE：通信元アドレス(セッション数、バイト数) DESTINATION_ADDRESS ：通信先アドレス DESTINATION ：通信先(国別) THREAT ：脅威 SOURCE_ADDRESS_DETECTIONS ：通信元アドレス(検知回数) BLOCK_SOURCE_ADDRESS ：ブロック通信元アドレス BLOCK_URL ：ブロックURL VIRUS ：ウイルス
sortPattern	string Enum: "SESSION" "BYTE" Example: sortPattern=SESSION 項目和名：ソート順パターン備考： SESSION：セッション数でソート BYTE：バイト数でソート統計情報レポート種別が以下の場合に指定を行う。それ以外の場合は検知数の降順でのソートとなるためNULLを設定する。　アプリケーション　通信先アドレス　通信先(国別)
targetDate required	string Example: targetDate=2021-12-01 項目和名：表示対象年月日備考：表示対象の年月日。過去日のみが指定可能。当日指定は不可。

Responses

Request samples

Curl

curl --request GET \
  --url 'https://wvs2.kddi.ne.jp/api/v1/report/statistics?internetType=TYPE1&type4Id=TY412345&applianceType=INTERNET_FW&statisticReportType=APPLICATION&sortPattern=SESSION&targetDate=2021-12-01'

Response samples

Content type

application/json

{"enumberMainAct": "E000000010",
"enumberMainSby": "E000000020",
"enumberBcpAct": "E000000030",
"enumberBcpSby": "E000000040",
"wnumberMainAct": "W000000001",
"wnumberMainSby": "W000000002",
"wnumberBcpAct": "W000000003",
"wnumberBcpSby": "W000000004",
"internetType": "TYPE1",
"type4Id": "TY412345",
"applianceType": "INTERNET_FW",
"vpnVnCode": "BA1234",
"vnName": "TEST_1",
"statisticReportType": "APPLICATION",
"sortPattern": "SESSION",
"total": 1,
"statisticsList": [{"risk": "1",
"applicationName": "アプリケーション名１",
"srcIpAddress": "192.168.1.1/29",
"dstIpAddress": "192.168.1.2/29",
"dstCountry": "Austria",
"threatName": "脅威名１",
"threatId": "1",
"threatType": "virus",
"blockUrl": "sample.com",
"categoryName": "streaming-media",
"sessionCount": 3633,
"byteCount": "599",
"detectCount": 599
}
]
}

お知らせ情報設定API

概要
1. インターフェースタイプ
  同期応答方式
2. 内容
  管理者ユーザがお知らせ情報の取得、登録、変更、削除を行う。

お知らせ情報一覧取得

Responses

Request samples

Curl

curl --request GET \
  --url https://wvs2.kddi.ne.jp/api/v1/support/notifications/admin

Response samples

200
401
403
500

Content type

application/json

{"total": 1,
"notificationInfoList": [{"noticeInfoSeq": "1",
"noticeType": "NOTIFICATION",
"postStartDate": "2021-12-01",
"postEndDate": "2021-12-01",
"noticeInfoTitle": "タイトル",
"noticeText": "メッセージ",
"mailSendType": {"isAllVnum": true,
"isInternetType1": false,
"isInternetType4": false,
"isUtm": false,
"isInternetFw": false
},
"failureDateTime": "2021-11-23T14:30:00+09:00",
"recoveryDateTime": "2021-11-23T14:30:00+09:00",
"isUnderInvestigation": false,
"recoveryType": "COMPLETE"
}
],
"adminNoticeKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

お知らせ情報登録

Request Body schema: application/json

noticeType required	string (noticeTypePost) Enum: "NOTIFICATION" "FAILURE_NOTIFICATION" "MAINTENANCE" "OTHERS" 項目和名：お知らせ種別備考　　：以下のいずれかを設定する。　　　　　NOTIFICATION: お知らせ　　　　　FAILURE_NOTIFICATION: お知らせ(障害) 　　　　　MAINTENANCE: メンテナンス　　　　　OTHERS: その他
postStartDate	string (postStartDatePost) ^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[12][0-9]\|3... 項目和名：掲載開始日備考　　：お知らせ種別が「その他」の場合はNULLを設定する。　　　　　他お知らせ種別の場合は必須とする。
postEndDate	string (postEndDatePost) ^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[12][0-9]\|3... 項目和名：掲載終了日備考　　：お知らせ種別が「その他」の場合はNULLを設定する。　　　　　他お知らせ種別の場合は必須とする。
noticeInfoTitle required	string (noticeInfoTitle) <= 100 characters 項目和名：お知らせタイトル名備考　　：-
noticeText required	string (noticeText) <= 2000 characters 項目和名：内容(本文) 備考　　：-
	object (mailSendTypePost) 項目和名：メール送付メニュー備考　　：WVS2全V番号フラグがtrueの場合、他フラグはfalseを設定する。　　　　　お知らせ種別が「その他」の場合、個別指定フラグはtrue、他フラグはfalseを設定する。
subjectEnum	string (subjectEnum) <= 10 characters ^E[0-9]{8}0$ 項目和名：対象回線番号備考　　：お知らせ種別が「その他」の場合は必須とする。　　　　　他お知らせ種別の場合はNULLを設定する。
failureDateTime	string <date-time> (failureDateTime1) 項目和名：障害発生日時備考　　：お知らせ種別が「お知らせ(障害)」以外の場合はNULLを設定する。　　　　　障害調査中フラグがtrueの場合はNULLを設定する。
recoveryDateTime	string <date-time> (recoveryDateTime1) 項目和名：障害復旧日時備考　　：お知らせ種別が「お知らせ(障害)」以外の場合はNULLを設定する。　　　　　障害復旧種別が「復旧未定」の場合はNULLを設定する。
isUnderInvestigation	boolean (isUnderInvestigation1) 項目和名：障害調査中フラグ備考　　：お知らせ種別が「お知らせ(障害)」以外の場合はNULLを設定する。
recoveryType	string (recoveryType1) Enum: "UNDECIDED" "PROSPECT" "COMPLETE" 項目和名：障害復旧種別備考　　：お知らせ種別が「お知らせ(障害)」以外の場合はNULLを設定する。　　　　　以下のいずれかを設定する。　　　　　UNDECIDED: 復旧未定　　　　　PROSPECT: 復旧見込み　　　　　COMPLETE: 復旧完了

Responses

Request samples

Payload
Curl

Content type

application/json

{"noticeType": "NOTIFICATION",
"postStartDate": "2021-12-01",
"postEndDate": "2021-12-01",
"noticeInfoTitle": "タイトル",
"noticeText": "メッセージ",
"mailSendType": {"isAllVnum": true,
"isInternetType1": false,
"isInternetType4": false,
"isUtm": false,
"isInternetFw": false,
"isIndividual": false
},
"subjectEnum": "E000000010",
"failureDateTime": "2021-11-23T14:30:00+09:00",
"recoveryDateTime": "2021-11-23T14:30:00+09:00",
"isUnderInvestigation": false,
"recoveryType": "COMPLETE"
}

Response samples

Content type

application/json

{"noticeInfoSeq": "1",
"adminNoticeKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

お知らせ情報変更

path Parameters

noticeInfoSeq

required

string <= 19 characters

Example: 1

項目和名：お知らせSEQ
備考　　：主キー

Request Body schema: application/json

postStartDate required	string (postStartDate1) ^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[12][0-9]\|3... 項目和名：掲載開始日備考　　：-
postEndDate required	string (postEndDate) ^[0-9]{4}-(0[1-9]\|1[0-2])-(0[1-9]\|[12][0-9]\|3... 項目和名：掲載終了日備考　　：-
noticeInfoTitle required	string (noticeInfoTitle) <= 100 characters 項目和名：お知らせタイトル名備考　　：-
noticeText required	string (noticeText) <= 2000 characters 項目和名：内容(本文) 備考　　：-
	object (mailSendType) 項目和名：メール送付メニュー備考　　：WVS2全V番号フラグがtrueの場合、他フラグはfalseを設定する。
failureDateTime	string <date-time> (failureDateTime1) 項目和名：障害発生日時備考　　：お知らせ種別が「お知らせ(障害)」以外の場合はNULLを設定する。　　　　　障害調査中フラグがtrueの場合はNULLを設定する。
recoveryDateTime	string <date-time> (recoveryDateTime1) 項目和名：障害復旧日時備考　　：お知らせ種別が「お知らせ(障害)」以外の場合はNULLを設定する。　　　　　障害復旧種別が「復旧未定」の場合はNULLを設定する。
isUnderInvestigation	boolean (isUnderInvestigation1) 項目和名：障害調査中フラグ備考　　：お知らせ種別が「お知らせ(障害)」以外の場合はNULLを設定する。
recoveryType	string (recoveryType1) Enum: "UNDECIDED" "PROSPECT" "COMPLETE" 項目和名：障害復旧種別備考　　：お知らせ種別が「お知らせ(障害)」以外の場合はNULLを設定する。　　　　　以下のいずれかを設定する。　　　　　UNDECIDED: 復旧未定　　　　　PROSPECT: 復旧見込み　　　　　COMPLETE: 復旧完了
adminNoticeKeyId required	string (adminNoticeKeyId) 項目和名：お知らせ情報排他情報備考　　：排他確認用パラメータ　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"postStartDate": "2021-12-01",
"postEndDate": "2021-12-01",
"noticeInfoTitle": "タイトル",
"noticeText": "メッセージ",
"mailSendType": {"isAllVnum": true,
"isInternetType1": false,
"isInternetType4": false,
"isUtm": false,
"isInternetFw": false
},
"failureDateTime": "2021-11-23T14:30:00+09:00",
"recoveryDateTime": "2021-11-23T14:30:00+09:00",
"isUnderInvestigation": false,
"recoveryType": "COMPLETE",
"adminNoticeKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}

お知らせ情報削除

path Parameters

noticeInfoSeq

required

string <= 19 characters

Example: 1

項目和名：お知らせSEQ
備考　　：主キー

Request Body schema: application/json

adminNoticeKeyId

required

string (adminNoticeKeyId)

項目和名：お知らせ情報排他情報
備考　　：排他確認用パラメータ
　　　　　設定変更を行う場合にはGETメソッドにて通知した内容をそのまま渡すこと。

Responses

Request samples

Payload
Curl

Content type

application/json

{"adminNoticeKeyId": "9a2c47d97b9975452f7d582264e9fc16d108ed8252ac6816239a3b58cef5c53d"
}

Response samples

Content type

application/json

{"errorCode": "<エラーコード>",
"errorMessage": "<エラーメッセージ>"
}