Cell - Distributed Secure Internet GateWay API References (1.5.0)
Download OpenAPI specification:Download
Cells are an actual components that realize DSIGW service. Cells always belong to Cell-Groups and are connected to the customer network via FIC connection.
Get Cell
Get Cell 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. |
area | string The Area of the Cell deployed. |
zone | string The Zone of the Cell deployed. |
plan | string A Plan name of the Cell. |
cellGroupId | string The Cell-Group ID which the resource belongs. |
configVersion | integer Config version of Cell (incremental). |
proxyHostname | string A hostname of the proxy. |
utmHostname | string A hostname of the utm. |
configStatus | string The status of config synchronization. |
tenantId | string The tenant ID which the resource belongs. |
defaultRoutePriority | integer [ 0 .. 255 ] Priority of default route. The smaller has priority. |
defaultRouteEffectiveStatus | string Enum: "ACTIVE" "STANDBY" A status of default route. |
header Parameters
X-Auth-Token required | string The keystone token. |
Responses
OK
Bad Request
Unauthorized
Internal Server Error
Response samples
- 200
- 400
- 401
- 500
{- "cells": [
- {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "name": "cell_1",
- "description": "cell_1_description",
- "area": "JPEAST",
- "zone": "JP5-zone1-groupb",
- "plan": "50M-BE",
- "cloudType": "ECL",
- "cellGroupId": "12345678-1234-1234-1234-1234567890ab",
- "cellVersionId": "12345678-1234-1234-1234-1234567890ab",
- "cidr": "192.0.2.0/26",
- "proxy": {
- "hostname": "7890a1-pxy",
- "nameServerIp": "192.0.2.38",
- "proxyServerIp": "192.0.2.39"
}, - "utm": {
- "hostname": "7890a1-utm",
- "internalIp": "192.0.2.17",
- "natIps": [
- "203.0.113.1/32"
]
}, - "ficConnection": { },
- "logForwarderSourceIp": "192.0.2.40",
- "configVersion": 5,
- "operationId": "12345678-1234-1234-1234-1234567890ab",
- "tenantId": "1234567890abcdef1234567890abcdef",
- "configStatus": "OUT_OF_SYNC",
- "gslbStatuses": [
- {
- "targetCellId": "12345678-1234-1234-1234-1234567890a1",
- "status": "UP"
}, - {
- "targetCellId": "12345678-1234-1234-1234-1234567890a2",
- "status": "UP"
}
], - "serviceStatus": "UP",
- "defaultRoutePriority": 1,
- "defaultRouteEffectiveStatus": "ACTIVE",
- "operationStatus": "COMPLETE",
- "createdAt": "2020-01-01T01:23:45Z",
- "updatedAt": "2020-01-01T01:23:45Z"
}, - {
- "id": "12345678-1234-1234-1234-1234567890a2",
- "name": "cell_2",
- "description": "cell_2_description",
- "area": "JPEAST",
- "zone": "JP5-zone1-groupb",
- "plan": "50M-BE",
- "cloudType": "ECL",
- "cellGroupId": "12345678-1234-1234-1234-1234567890ab",
- "cellVersionId": "12345678-1234-1234-1234-1234567890ab",
- "cidr": "192.0.2.128/26",
- "proxy": {
- "hostname": "7890a2-pxy",
- "nameServerIp": "192.0.2.166",
- "proxyServerIp": "192.0.2.167"
}, - "utm": {
- "hostname": "7890a2-utm",
- "internalIp": "192.0.2.145",
- "natIps": [
- "203.0.113.2/32"
]
}, - "ficConnection": { },
- "logForwarderSourceIp": "192.0.2.168",
- "configVersion": 6,
- "tenantId": "1234567890abcdef1234567890abcdef",
- "configStatus": "OUT_OF_SYNC",
- "gslbStatuses": [
- {
- "targetCellId": "12345678-1234-1234-1234-1234567890a1",
- "status": "UP"
}, - {
- "targetCellId": "12345678-1234-1234-1234-1234567890a2",
- "status": "UP"
}
], - "serviceStatus": "UP",
- "defaultRoutePriority": null,
- "defaultRouteEffectiveStatus": null,
- "operationStatus": "COMPLETE",
- "createdAt": "2020-01-01T02:23:45Z",
- "updatedAt": "2020-01-01T02:23:45Z"
}
]
}
Create Cell
Create a Cell resource.
Authorizations:
header Parameters
X-Auth-Token required | string The keystone token. |
Request Body schema: application/json
cell required | object (CellCreateRequest) |
Responses
OK
Bad Request
Unauthorized
Forbidden
Conflict
Internal Server Error
Request samples
- Payload
{- "cell": {
- "name": "cell_1",
- "description": "cell_1_description",
- "area": "JPEAST",
- "plan": "50M-BE",
- "cloudType": "ECL",
- "cellGroupId": "12345678-1234-1234-1234-1234567890ab",
- "cidr": "192.0.2.0/26"
}
}
Response samples
- 202
- 400
- 401
- 403
- 409
- 500
{- "cell": {
- "id": "12345678-1234-1234-1234-1234567890ab",
- "name": "cell_1",
- "description": "cell_1_description",
- "area": "JPEAST",
- "zone": "JP5-zone1-groupb",
- "plan": "50M-BE",
- "cloudType": "ECL",
- "cellGroupId": "12345678-1234-1234-1234-1234567890ab",
- "cellVersionId": "12345678-1234-1234-1234-1234567890ab",
- "cidr": "192.0.2.0/26",
- "proxy": {
- "hostname": "7890ab-pxy",
- "nameServerIp": "192.0.2.38",
- "proxyServerIp": "192.0.2.39"
}, - "utm": {
- "hostname": "7890ab-utm",
- "internalIp": "192.0.2.17",
- "natIps": [ ]
}, - "ficConnection": { },
- "logForwarderSourceIp": "192.0.2.40",
- "configVersion": 0,
- "defaultRoutePriority": null,
- "operationId": "12345678-1234-1234-1234-1234567890ab",
- "tenantId": "1234567890abcdef1234567890abcdef",
- "configStatus": "OUT_OF_SYNC",
- "createdAt": "2020-01-01T01:23:45Z",
- "updatedAt": "2020-01-01T01:23:45Z"
}
}
Get Cell Details
Get a Cell resource.
Authorizations:
path Parameters
cell_id required | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ |
header Parameters
X-Auth-Token required | string The keystone token. |
Responses
OK
Bad Request
Unauthorized
Not Found
Internal Server Error
Response samples
- 200
- 400
- 401
- 404
- 500
{- "cell": {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "name": "cell_1",
- "description": "cell_1_description",
- "area": "JPEAST",
- "zone": "JP5-zone1-groupb",
- "plan": "50M-BE",
- "cloudType": "ECL",
- "cellGroupId": "12345678-1234-1234-1234-1234567890ab",
- "cellVersionId": "12345678-1234-1234-1234-1234567890ab",
- "cidr": "192.0.2.0/26",
- "proxy": {
- "hostname": "7890a1-pxy",
- "nameServerIp": "192.0.2.38",
- "proxyServerIp": "192.0.2.39"
}, - "utm": {
- "hostname": "7890a1-utm",
- "internalIp": "192.0.2.17",
- "natIps": [
- "203.0.113.1/32"
]
}, - "ficConnection": { },
- "logForwarderSourceIp": "192.0.2.40",
- "configVersion": 5,
- "operationId": "12345678-1234-1234-1234-1234567890ab",
- "tenantId": "1234567890abcdef1234567890abcdef",
- "configStatus": "OUT_OF_SYNC",
- "gslbStatuses": [
- {
- "targetCellId": "12345678-1234-1234-1234-1234567890a1",
- "status": "UP"
}, - {
- "targetCellId": "12345678-1234-1234-1234-1234567890a2",
- "status": "UP"
}
], - "serviceStatus": "UP",
- "defaultRoutePriority": 1,
- "defaultRouteEffectiveStatus": "ACTIVE",
- "operationStatus": "COMPLETE",
- "createdAt": "2020-01-01T01:23:45Z",
- "updatedAt": "2020-01-01T01:23:45Z"
}
}
Update Cell
Update a Cell resource.
Authorizations:
path Parameters
cell_id required | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ |
header Parameters
X-Auth-Token required | string |
Request Body schema: application/json
cell required | object (CellUpdateRequest) |
Responses
OK
Bad Request
Unauthorized
Not Found
Internal Server Error
Request samples
- Payload
{- "cell": {
- "name": "cell_1_updated",
- "description": "cell_1_description_updated",
- "defaultRoutePriority": 5
}
}
Response samples
- 200
- 400
- 401
- 404
- 500
{- "cell": {
- "id": "12345678-1234-1234-1234-1234567890ab",
- "name": "cell_1_updated",
- "description": "cell_1_description_updated",
- "area": "JPEAST",
- "zone": "JP5-zone1-groupb",
- "plan": "50M-BE",
- "cloudType": "ECL",
- "cellGroupId": "12345678-1234-1234-1234-1234567890ab",
- "cellVersionId": "12345678-1234-1234-1234-1234567890ab",
- "cidr": "192.0.2.0/26",
- "proxy": {
- "hostname": "7890ab-pxy",
- "nameServerIp": "192.0.2.38",
- "proxyServerIp": "192.0.2.39"
}, - "utm": {
- "hostname": "7890ab-utm",
- "internalIp": "192.0.2.17",
- "natIps": [
- "203.0.113.1/32"
]
}, - "ficConnection": { },
- "logForwarderSourceIp": "192.0.2.40",
- "configVersion": 0,
- "defaultRoutePriority": 5,
- "operationId": "12345678-1234-1234-1234-1234567890ab",
- "tenantId": "1234567890abcdef1234567890abcdef",
- "configStatus": "OUT_OF_SYNC",
- "createdAt": "2020-01-01T01:23:45Z",
- "updatedAt": "2020-01-01T01:23:45Z"
}
}
Delete Cell
Delete a Cell resource.
Authorizations:
path Parameters
cell_id required | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ |
header Parameters
X-Auth-Token required | string |
Responses
OK
Bad Request
Unauthorized
Not Found
Conflict
Internal Server Error
Response samples
- 202
- 400
- 401
- 404