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.

Authentication

X-Auth-Token

Security Scheme Type	API Key
Header parameter name:	{keystone_token}

cell

Get Cell

Get Cell resources.

Authorizations:

X-Auth-Token

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

200

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/v1/cells

https://api.ntt.com/dsigw-erg/v1/cells

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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:

X-Auth-Token

header Parameters

X-Auth-Token

required

string

The keystone token.

Request Body schema: application/json

cell

required

object (CellCreateRequest)

Responses

202

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

500

Internal Server Error

post/v1/cells

https://api.ntt.com/dsigw-erg/v1/cells

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"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

Content type

application/json

Copy

Expand all Collapse all


{"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:

X-Auth-Token

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

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

get/v1/cells/{cell_id}

https://api.ntt.com/dsigw-erg/v1/cells/{cell_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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:

X-Auth-Token

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

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

patch/v1/cells/{cell_id}

https://api.ntt.com/dsigw-erg/v1/cells/{cell_id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"cell": 
{"name": "cell_1_updated",
"description": "cell_1_description_updated",
"defaultRoutePriority": 5
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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:

X-Auth-Token

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

202

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

delete/v1/cells/{cell_id}

https://api.ntt.com/dsigw-erg/v1/cells/{cell_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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",
"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": 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"
}
}

Cell action

Action to Cell resource.

Authorizations:

X-Auth-Token

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.

Request Body schema: application/json

createFicConnection	object
attachFicConnection	string Nullable
detachFicConnection	string Nullable
deleteFicConnection	string Nullable
resize	object
updateVersion	string Nullable

Responses

202

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

500

Internal Server Error

post/v1/cells/{cell_id}/action

https://api.ntt.com/dsigw-erg/v1/cells/{cell_id}/action

Request samples

Payload

Content type

application/json

Example

Copy

Expand all Collapse all


{"createFicConnection": 
{"routerId": "F123456789012",
"groupName": "group_1"
}
}

Response samples

Content type

application/json

Example

Copy

Expand all Collapse all


{"createFicConnection": 
{"operationId": "12345678-1234-1234-1234-1234567890ab"
}
}