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

Download OpenAPI specification:Download

Flexible InterConnect　> Support-Monitoring >　Tenants

概要

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

リソース一覧の取得・リソースの状態遷移通知の有効/無効の設定・参照等の操作に関するAPIドキュメントです。

Tenants

Show Tenants

指定したテナント情報を取得します。

path Parameters

tenantId

required

string

Example: 7884792c1e07424ba5e8ed44695ebbd4

テナント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}

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

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"tenantName": "YourTenantName",
"ports": 
[
{"portId": "F010123456789",
"name": "YourPortName",
"virtual": true,
"area": "JPEAST",
"getMacAddressStatus": "available",
"targetTypes": 
["XaaS"
],
"alertIds": 
[1
],
"relatedResources": 
[
{"resourceType": "port",
"resourceId": "F000000000032",
"resourceName": "YourPortName",
"targetType": "patternX"
}
]
}
],
"connections": 
[
{"connectionId": "F030123456789",
"name": "YourConnectionName",
"connectionClass": "router-to-port-connections",
"interactConnectTenantId": "7884792c1e07424ba5e8ed44695ebbd5",
"interactConnectTenantName": "YourDestinationTenantName",
"interactConnectActivate": true,
"sourceArea": "JPEAST",
"destinationArea": "JPEAST",
"clearBgpSessionStatus": "unavailable",
"createConnectionRouteInfoCsvStatus": "available",
"getConnectionLatestRouteCountStatus": "available",
"targetTypes": 
["XaaS"
],
"alertIds": 
[1
],
"relatedResources": 
[
{"resourceType": "router",
"resourceId": "F000000000061",
"resourceName": "ルーター識別名",
"routingGroup": "group_1"
}
],
"sourceDevice": "CR01-jpeast01",
"destinationDevice": "lxea01kensho1-chb-fic"
}
],
"routers": 
[
{"routerId": "F020123456789",
"name": "YourRouterName",
"fwId": "F040123456789",
"natId": "F050123456789",
"natRuleNames": 
["rule-F000000000061-f1t2-001",
"rule-F000000000061-f2t1-001"
],
"area": "JPEAST",
"targetTypes": 
["XaaS"
],
"alertIds": 
[1
],
"routingGroups": 
[
{"routingGroup": "group_1",
"alertIds": 
[1
]
}
],
"createRouterRouteInfoCsvStatus": "available",
"getRouterLatestRouteCountStatus": "available",
"maxprefix": 8000
}
],
"mailOnAlert": true
}

MailOnAlert

Show MailOnAlert

アラートメール設定情報を取得します。

path Parameters

tenantId

required

string

Example: 7884792c1e07424ba5e8ed44695ebbd4

テナント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}/mailOnAlert

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

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"mailOnAlert": true
}

Update MailOnAlert

アラートメール設定情報を更新します。

path Parameters

tenantId

required

string

Example: 7884792c1e07424ba5e8ed44695ebbd4

テナント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

Request Body schema: application/json

Responses

200

OK 成功しました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

put/v1/flexible-ic/tenants/{tenantId}/mailOnAlert

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

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"mailOnAlert": false
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"mailOnAlert": false
}