Documentation Powered by ReDoc

Fws - Flexible InterConnect API リファレンス (1.5.0)

Download OpenAPI specification:Download

URL: https://sdpf.ntt.com/ License: © NTT Communications Corporation All Rights Reserved.

Flexible InterConnect　> Support-Monitoring >　Fws

概要

本APIでは、Flexible InterConnectが提供するリソースの参照・操作が可能です。

指定したファイアウォールログ（現状ドロップのみ）の一覧・指定したフィールドの値毎にファイアウォールログを集計しランキング情報の一覧・ファイアウォールログを一定の間隔で集計し時間帯ごとのログ件数情報の一覧等の取得操作に関するAPIドキュメントです。

FwDumps

List FwDumps

指定したファイアウォールログ（現状ドロップのみ）の一覧を取得します。

path Parameters
tenantId
required
any

テナントID (pattern: ^[0-9a-fA-F]{32}$)

fwId
required
any

ファイヤーウォールID (pattern: ^F[0-9]{12}$)

query Parameters
from
required
string
Example: from=2019-04-02T13:08:43+09:00

集計期間の開始時刻 (format: date-time)

to
required
string
Example: to=2019-04-02T13:18:43+09:00

集計期間の終了時刻 (format: date-time)

sourceAddress
string

送信元アドレス、カンマ区切りで複数指定可

sourcePort
string

送信元ポート番号、カンマ区切りで複数指定可

destinationAddress
string

宛先アドレス、カンマ区切りで複数指定可

destinationPort
string

宛先ポート番号、カンマ区切りで複数指定可

application
string

アプリケーション名、カンマ区切りで複数指定可

protocol
string

プロトコル番号、カンマ区切りで複数指定可

fromGroup
string

送信元グループ、カンマ区切りで複数指定可

toGroup
string

送信先グループ、カンマ区切りで複数指定可

serviceName
string

サービス名、カンマ区切りで複数指定可

policyName
string

ポリシー名、カンマ区切りで複数指定可

format
string
Enum: "json" "csv"

フォーマット 'json'または'csv'、デフォルト値:json

size
number

ログ取得数 デフォルト値:10000

header Parameters
Content-Type
required
string
Value: "application/json"
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK 成功しました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

get/v1/flexible-ic/tenants/{tenantId}/fws/{fwId}/dumps
https://api.ntt.com/fic-monitoring/v1/flexible-ic/tenants/{tenantId}/fws/{fwId}/dumps

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "logs":
    [
    ]
}

FwRankings

List FwRankings

指定したフィールドの値毎にファイアウォールログ（現状ドロップのみ）を集計しランキング情報の一覧を取得します。

path Parameters
tenantId
required
any

テナントID (pattern: ^[0-9a-fA-F]{32}$)

fwId
required
any

ファイヤーウォールID (pattern: ^F[0-9]{12}$)

query Parameters
from
required
string
Example: from=2019-04-02T13:08:43+09:00

集計期間の開始時刻 (format: date-time)

to
required
string
Example: to=2019-04-02T13:18:43+09:00

集計期間の終了時刻 (format: date-time)

size
string

ランキング最大サイズ (デフォルト値:10、最小値:1)

rankBy
required
string
Enum: "sourceAddress" "sourcePort" "destinationAddress" "destinationPort" "application" "protocol" "fromGroup" "toGroup" "serviceName" "policyName"

ランキング対象のフィールド名 ('sourceAddress/sourcePort/destinationAddress/destinationPort /application/protocol/fromGroup/toGroup/serviceName/policyName' のいずれか)

sourceAddress
string

送信元アドレス、カンマ区切りで複数指定可

sourcePort
string

送信元ポート番号、カンマ区切りで複数指定可

destinationAddress
string

宛先アドレス、カンマ区切りで複数指定可

destinationPort
string

宛先ポート番号、カンマ区切りで複数指定可

application
string

アプリケーション名、カンマ区切りで複数指定可

protocol
string

プロトコル番号、カンマ区切りで複数指定可

fromGroup
string

送信元グループ、カンマ区切りで複数指定可

toGroup
string

送信先グループ、カンマ区切りで複数指定可

serviceName
string

サービス名、カンマ区切りで複数指定可

policyName
string

ポリシー名、カンマ区切りで複数指定可

header Parameters
Content-Type
required
string
Value: "application/json"
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK 成功しました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

get/v1/flexible-ic/tenants/{tenantId}/fws/{fwId}/rankings
https://api.ntt.com/fic-monitoring/v1/flexible-ic/tenants/{tenantId}/fws/{fwId}/rankings

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "rankings":
    [
    ],
  • "totalCount": 100
}

FwCounts

List FwCounts

ファイアウォールログ（現状ドロップのみ）を一定の間隔で集計し時間帯ごとのログ件数情報の一覧を取得します。

path Parameters
tenantId
required
any

テナントID (pattern: ^[0-9a-fA-F]{32}$)

fwId
required
any

ファイヤーウォールID (pattern: ^F[0-9]{12}$)

query Parameters
from
required
string
Example: from=2019-04-02T13:08:43+09:00

集計期間の開始時刻 (format: date-time)

to
required
string
Example: to=2019-04-02T13:08:43+09:00

集計期間の終了時刻 (format: date-time)

interval
number

集計間隔(分) (デフォルト値:15)

sourceAddress
string

送信元アドレス、カンマ区切りで複数指定可

sourcePort
string

送信元ポート番号、カンマ区切りで複数指定可

destinationAddress
string

宛先アドレス、カンマ区切りで複数指定可

destinationPort
string

宛先ポート番号、カンマ区切りで複数指定可

application
string

アプリケーション名、カンマ区切りで複数指定可

protocol
string

プロトコル番号、カンマ区切りで複数指定可

fromGroup
string

送信元グループ、カンマ区切りで複数指定可

toGroup
string

送信先グループ、カンマ区切りで複数指定可

serviceName
string

サービス名、カンマ区切りで複数指定可

policyName
string

ポリシー名、カンマ区切りで複数指定可

header Parameters
Content-Type
required
string
Value: "application/json"
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK 成功しました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

get/v1/flexible-ic/tenants/{tenantId}/fws/{fwId}/counts
https://api.ntt.com/fic-monitoring/v1/flexible-ic/tenants/{tenantId}/fws/{fwId}/counts

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "counts":
    [
    ]
}