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

Download OpenAPI specification:Download

Flexible InterConnect　> Support-Monitoring >　Alerts

概要

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

アラート情報の設定・取得・更新・削除等の操作に関するAPIドキュメントです。

Alerts

Show Alerts

アラート情報を取得します。

path Parameters

tenantId required	string
alertId required	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}/alerts/{alertId}

https://api.ntt.com/fic-monitoring/v1/flexible-ic/tenants/{tenantId}/alerts/{alertId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"tenantId": "7884792c1e07424ba5e8ed44695ebbd4",
"alertId": 1,
"conditions": 
[
{"resourceType": "router",
"routingGroup": "group_1",
"resourceId": "F020123456789",
"condition": "trafficIn",
"compare": "exceed",
"thresholdValue": 90
}
],
"actions": 
["sendMail"
],
"activated": false
}

Update Alerts

アラート情報を更新します。

path Parameters

tenantId required	string
alertId required	string

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

conditions required	Array of objects
actions required	Array of strings Items Value: "sendMail" アラートアクション 'sendMail'固定
activated required	boolean アラートフラグ 'false'(無効)または'true'(有効)

Responses

200

OK 成功しました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

patch/v1/flexible-ic/tenants/{tenantId}/alerts/{alertId}

https://api.ntt.com/fic-monitoring/v1/flexible-ic/tenants/{tenantId}/alerts/{alertId}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"conditions": 
[
{"resourceType": "router",
"routingGroup": "group_1",
"resourceId": "F020123456789",
"condition": "trafficIn",
"compare": "exceed",
"thresholdValue": 80
}
],
"actions": 
["sendMail"
],
"activated": true
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"tenantId": "7884792c1e07424ba5e8ed44695ebbd4",
"alertId": 1,
"conditions": 
[
{"resourceType": "router",
"routingGroup": "group_1",
"resourceId": "F020123456789",
"condition": "trafficIn",
"compare": "exceed",
"thresholdValue": 80
}
],
"actions": 
["sendMail"
],
"activated": true
}

Delete Alerts

アラート情報を削除します。

path Parameters

tenantId required	string
alertId required	string

header Parameters

Content-Type required	string Value: "application/json"
X-Auth-Token required	string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token

Responses

204

No Content 成功しました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

delete/v1/flexible-ic/tenants/{tenantId}/alerts/{alertId}

https://api.ntt.com/fic-monitoring/v1/flexible-ic/tenants/{tenantId}/alerts/{alertId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"tenantId": "7884792c1e07424ba5e8ed44695ebbd4",
"alertId": 1,
"conditions": 
[
{"resourceType": "router",
"routingGroup": "group_1",
"resourceId": "F020123456789",
"condition": "trafficIn",
"compare": "exceed",
"thresholdValue": 90
}
],
"actions": 
["sendMail"
],
"activated": false
}

Create Alerts

アラート情報を設定します。

path Parameters

tenantId

required

string

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

conditions required	Array of objects
actions required	Array of strings Items Value: "sendMail" アラートアクション 'sendMail'固定
activated required	boolean アラートフラグ 'false'(無効)または'true'(有効)

Responses

201

Created リソースは作成されました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

post/v1/flexible-ic/tenants/{tenantId}/alerts

https://api.ntt.com/fic-monitoring/v1/flexible-ic/tenants/{tenantId}/alerts

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"conditions": 
[
{"resourceType": "router",
"routingGroup": "group_1",
"resourceId": "F020123456789",
"condition": "trafficIn",
"compare": "exceed",
"thresholdValue": 90
}
],
"actions": 
["sendMail"
],
"activated": false
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"tenantId": "7884792c1e07424ba5e8ed44695ebbd4",
"alertId": 1,
"conditions": 
[
{"resourceType": "router",
"routingGroup": "group_1",
"resourceId": "F020123456789",
"condition": "trafficIn",
"compare": "exceed",
"thresholdValue": 90
}
],
"actions": 
["sendMail"
],
"activated": false
}