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

Download OpenAPI specification:Download

概要

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

NATのセッション数アラート設定情報の取得・更新等の操作に関するAPIドキュメントです。

NatCountAlert

Show NatCountAlerts

NATのセッション数アラート設定情報を取得します。

path Parameters
tenantId
required
string
Example: 7884792c1e07424ba5e8ed44695ebbd4

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

natId
required
string
Example: F029100002086

NAT ID (pattern: ^F[0-9]{12}$)

ruleName
required
string
Example: rule-F029100002086-f1t2-001

Rule名

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 リクエストが不正

404

Not Found 未検出エラー

500

Internal Server Error Unknownエラー

get/v1/flexible-ic/tenants/{tenantId}/nats/{natId}/natRules/{ruleName}/natCountAlert
https://api.ntt.com/fic-monitoring/v1/flexible-ic/tenants/{tenantId}/nats/{natId}/natRules/{ruleName}/natCountAlert

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "natId": "F029100002086",
  • "ruleName": "rule-F029100002086-f1t2-001",
  • "natCountThreshold": 1000
}

Update NatCountAlert

NATのセッション数アラート設定情報を更新します。

path Parameters
tenantId
required
string
Example: 7884792c1e07424ba5e8ed44695ebbd4

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

natId
required
string
Example: F029100002086

NAT ID (pattern: ^F[0-9]{12}$)

ruleName
required
string
Example: rule-F029100002086-f1t2-001

Rule名

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

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

Request Body schema: application/json
natCountThreshold
required
number [ 0 .. 10000000 ] Nullable

NATセション数の閾値 nullの場合はメール通知しない。

Responses

200

OK 成功しました

400

Bad Request リクエストが不正

404

Not Found 未検出エラー

500

Internal Server Error Unknownエラー

put/v1/flexible-ic/tenants/{tenantId}/nats/{natId}/natRules/{ruleName}/natCountAlert
https://api.ntt.com/fic-monitoring/v1/flexible-ic/tenants/{tenantId}/nats/{natId}/natRules/{ruleName}/natCountAlert

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "natCountThreshold": 1000
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "natId": "F029100002086",
  • "ruleName": "rule-F029100002086-f1t2-001",
  • "natCountThreshold": 1000
}