Statuses - Flexible InterConnect API リファレンス (1.5.0)
Download OpenAPI specification:Download
Flexible InterConnect > Support-Monitoring > Statuses
本APIでは、Flexible InterConnectが提供するリソースの参照・操作が可能です。
FICリソースのステータス一覧の取得・FICリソースのステータス変化イベント履歴の取得操作に関するAPIドキュメントです。
List LatestStatuses
テナントに紐づくポートとコネクションの最新状態の一覧を取得します。
- "status" "adminStatus" "operStatus"の組み合わせによるステータス状態
statusの値 adminStatus operStatus up up up alert up以外 any down up up以外
path Parameters
tenantId required | any テナントID (pattern: ^[0-9a-fA-F]{32}$) |
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}/latestStatuses
https://api.ntt.com/fic-monitoring/v1/flexible-ic/tenants/{tenantId}/latestStatuses
Response samples
- 200
Content type
application/json
Copy
Expand all Collapse all {- "ports": [
- {
- "portId": "F010123456789",
- "status": "up",
- "adminStatus": "up",
- "operStatus": "up"
}
], - "connections": [
- {
- "connectionId": "F030123456789",
- "status": "up",
- "primaryStatus": "established",
- "secondaryStatus": "established"
}
]
}
List Statuses
テナントに紐づくポートとコネクションの状態変化履歴情報の一覧を取得します。ただし、最大取得数以上の履歴が存在する場合は期間内の時刻の降順で最大取得数までの履歴情報の一覧を取得します。
path Parameters
tenantId required | any テナントID (pattern: ^[0-9a-fA-F]{32}$) |
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) |
size | number 履歴の最大取得件数 デフォルト値:100 |
format | string Enum: "json" "csv" フォーマット 'json'または'csv'、デフォルト値:json |
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}/statuses
https://api.ntt.com/fic-monitoring/v1/flexible-ic/tenants/{tenantId}/statuses
Response samples
- 200
Content type
application/json
Copy
Expand all Collapse all {- "statuses": [
- {
- "eventId": "94HRFM",
- "time": "2019-04-02T04:08:43Z",
- "resourceType": "port",
- "resourceId": "F010123456789",
- "area": "JPEAST",
- "status": "up",
- "portAdminStatus": "up",
- "portOperStatus": "up",
- "connectionPrimaryStatus": "established",
- "connectionScondaryStatus": "established",
- "sourceDevice": "CR01-jpeast01",
- "destinationDevice": "lxea01kensho1-chb-fic",
- "isSynced": true
}
]
}