vPort FIC Connection - Flexible Security Service API References (1.0.0)
Download OpenAPI specification:Download
FIC coonection connects Flexible Sercurity Service to FIC.
Get FIC connection
Get FIC connection resources.
Authorizations:
query Parameters
| id | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The ID of the resource. |
| name | string ^[a-zA-Z0-9-_]{1,255}$ A name of the resource. |
| resourceId | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The ID of the connection destination. |
| serviceGroupId | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The service ID of the resource. |
| tenantId | string ^[a-fA-F0-9]{32}$ ID of the tenant to which the resource belongs. |
| serviceType | string Value: "FRA" The resource type of the connection destination. |
Responses
200
OK
400
Bad Request
401
Unauthorized
500
Internal Server Error
503
Service Unavailable
get/v1/vport-fic-connections
https://api.ntt.com/fsec-ers/v1/vport-fic-connections
Response samples
- 200
- 400
- 401
- 500
- 503
Content type
application/json
Copy
Expand all Collapse all {- "ficConnections": [
- {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "name": "connection-name",
- "description": "connection-description",
- "serviceType": "FRA",
- "resourceId": "12345678-1234-1234-1234-1234567890a2",
- "ficRouterId": "F000000000000",
- "ficConnectionId": "F000000000000",
- "qos": "best-effort",
- "bandwidth": "100M",
- "operationStatus": "COMPLETE",
- "serviceGroupId": "12345678-1234-1234-1234-1234567890a4",
- "tenantId": "1234567890abcdef1234567890abcdef",
- "updatedAt": "2022-06-01T06:00:00.000Z",
- "createdAt": "2022-06-01T06:00:00.000Z"
}, - {
- "id": "12345678-1234-1234-1234-1234567890b1",
- "name": "connection-name2",
- "description": "connection-description2",
- "serviceType": "FRA",
- "resourceId": "12345678-1234-1234-1234-1234567890b2",
- "ficRouterId": "F000000000001",
- "ficConnectionId": "F000000000001",
- "qos": "guarantee",
- "bandwidth": "100M",
- "operationStatus": "COMPLETE",
- "serviceGroupId": "12345678-1234-1234-1234-1234567890b4",
- "tenantId": "1234567890abcdef1234567890abcde1",
- "updatedAt": "2022-06-01T06:00:00.000Z",
- "createdAt": "2022-06-01T06:00:00.000Z"
}
]
}Get FIC connection
Get FIC connection resources.
Authorizations:
Request Body schema: application/json
| ficConnection required | object (FicConnectionCreateRequest) |
Responses
202
OK
400
Bad Request
401
Unauthorized
500
Internal Server Error
503
Service Unavailable
post/v1/vport-fic-connections
https://api.ntt.com/fsec-ers/v1/vport-fic-connections
Request samples
- Payload
Content type
application/json
Copy
Expand all Collapse all {- "ficConnection": {
- "name": "connection-name",
- "description": "connection-description",
- "serviceType": "FRA",
- "resourceId": "12345678-1234-1234-1234-1234567890a2",
- "serviceGroupId": "12345678-1234-1234-1234-1234567890a4",
- "connectionOptions": {
- "name": "connectionName",
- "routerId": "F000000000000",
- "groupName": "group_1",
- "routeFilterIn": "fullRoute",
- "routeFilterOut": "fullRoute",
- "bandwidth": "100M",
- "qos": "best-effort",
- "primarySourceIpAddress": "10.0.0.1/30",
- "secondarySourceIpAddress": "10.0.1.1/30",
- "primaryDestinationIpAddress": "10.0.0.2/30",
- "secondaryDestinationIpAddress": "10.0.1.2/30"
}
}
}Response samples
- 202
- 400
- 401
- 500
- 503
Content type
application/json
Copy
Expand all Collapse all {- "ficConnection": {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "name": "connection-name",
- "description": "connection-description",
- "serviceType": "FRA",
- "resourceId": "12345678-1234-1234-1234-1234567890a2",
- "ficRouterId": "F000000000000",
- "ficConnectionId": null,
- "qos": "best-effort",
- "bandwidth": "100M",
- "operationStatus": "COMPLETE",
- "serviceGroupId": "12345678-1234-1234-1234-1234567890a4",
- "tenantId": "1234567890abcdef1234567890abcdef",
- "operationId": "12345678-1234-1234-1234-1234567890a5",
- "updatedAt": "2022-06-01T06:00:00.000Z",
- "createdAt": "2022-06-01T06:00:00.000Z"
}
}Get FIC connection
Get FIC connection resource.
Authorizations:
path Parameters
| fic_connection_id required | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ |
Responses
200
OK
400
Bad Request
401
Unauthorized
404
Not Found
500
Internal Server Error
503
Service Unavailable
get/v1/vport-fic-connections/{fic_connection_id}
https://api.ntt.com/fsec-ers/v1/vport-fic-connections/{fic_connection_id}
Response samples
- 200
- 400
- 401
- 404
- 500
- 503
Content type
application/json
Copy
Expand all Collapse all {- "ficConnection": {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "name": "connection-name",
- "description": "connection-description",
- "serviceType": "FRA",
- "resourceId": "12345678-1234-1234-1234-1234567890a2",
- "ficRouterId": "F000000000000",
- "ficConnectionId": "F000000000000",
- "qos": "best-effort",
- "bandwidth": "100M",
- "operationStatus": "COMPLETE",
- "serviceGroupId": "12345678-1234-1234-1234-1234567890a4",
- "tenantId": "1234567890abcdef1234567890abcdef",
- "updatedAt": "2022-06-01T06:00:00.000Z",
- "createdAt": "2022-06-01T06:00:00.000Z"
}
}Update FIC connection
Update FIC connection resource.
Authorizations:
path Parameters
| fic_connection_id required | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ |
Request Body schema: application/json
| ficConnection required | object (FicConnectionUpdateRequest) |
Responses
202
OK
400
Bad Request
401
Unauthorized
404
Not Found
500
Internal Server Error
503
Service Unavailable
patch/v1/vport-fic-connections/{fic_connection_id}
https://api.ntt.com/fsec-ers/v1/vport-fic-connections/{fic_connection_id}
Request samples
- Payload
Content type
application/json
Copy
Expand all Collapse all {- "ficConnection": {
- "name": "connectionName",
- "bandwidth": "100M"
}
}Response samples
- 202
- 400
- 401
- 404
- 500
- 503
Content type
application/json
Copy
Expand all Collapse all {- "ficConnection": {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "name": "connection-name",
- "description": "connection-description",
- "serviceType": "FRA",
- "resourceId": "12345678-1234-1234-1234-1234567890a2",
- "ficRouterId": "F000000000000",
- "ficConnectionId": "F000000000000",
- "qos": "best-effort",
- "bandwidth": "100M",
- "operationStatus": "COMPLETE",
- "serviceGroupId": "12345678-1234-1234-1234-1234567890a4",
- "tenantId": "1234567890abcdef1234567890abcdef",
- "operationId": "12345678-1234-1234-1234-1234567890a5",
- "updatedAt": "2022-06-01T06:00:00.000Z",
- "createdAt": "2022-06-01T06:00:00.000Z"
}
}Delete FIC connection
Delete FIC connection resource.
Authorizations:
path Parameters
| fic_connection_id required | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ |
Responses
202
OK
400
Bad Request
401
Unauthorized
404
Not Found
409
Conflict
500
Internal Server Error
503
Service Unavailable
delete/v1/vport-fic-connections/{fic_connection_id}
https://api.ntt.com/fsec-ers/v1/vport-fic-connections/{fic_connection_id}
Response samples
- 202
- 400
- 401
- 404
- 409
- 500
- 503
Content type
application/json
Copy
Expand all Collapse all {- "ficConnection": {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "name": "connection-name",
- "description": "connection-description",
- "serviceType": "FRA",
- "resourceId": "12345678-1234-1234-1234-1234567890a2",
- "ficRouterId": "F000000000000",
- "ficConnectionId": "F000000000000",
- "qos": "best-effort",
- "bandwidth": "100M",
- "operationStatus": "COMPLETE",
- "serviceGroupId": "12345678-1234-1234-1234-1234567890a4",
- "tenantId": "1234567890abcdef1234567890abcdef",
- "operationId": "12345678-1234-1234-1234-1234567890a5",
- "updatedAt": "2022-06-01T06:00:00.000Z",
- "createdAt": "2022-06-01T06:00:00.000Z"
}
}