Documentation Powered by ReDoc

Cell - Flexible Secure Gateway API References (1.10.0)

Download OpenAPI specification:Download

URL: https://sdpf.ntt.com/ License: (c) NTT DOCOMO BUSINESS, Inc. All Rights Reserved. Terms of Service

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.

withGslbStatuses
boolean
Default: true

Whether gslbStatuses is displayed or not.

withServiceStatus
boolean
Default: true

Whether serviceStatus is displayed or not.

_limit
integer >= 1

The maximum number of items to return.

_offset
integer >= 0

The number of items to skip before starting to return results.

_order_by
Array of strings
Items Enum: "id" "name" "area" "zone" "plan" "cellGroupId" "configVersion" "tenantId" "defaultRoutePriority" "createdAt" "updatedAt"

Sort keys.

header Parameters
X-Auth-Token
required
string

The keystone token.

Responses

200

OK

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":
    [
    ]
}

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)

Cell create request schema.

Responses

202

OK

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

Content type
application/json
Copy
 Expand all Collapse all
{
  • "cell":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "cell":
    {
    }
}

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}$

The ID of the Cell.

header Parameters
X-Auth-Token
required
string

The keystone token.

Responses

200

OK

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

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}$

The ID of the Cell.

header Parameters
X-Auth-Token
required
string

The keystone token.

Request Body schema: application/json
cell
required
object (CellUpdateRequest)

Cell update request schema.

Responses

200

OK

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

Content type
application/json
Copy
 Expand all Collapse all
{
  • "cell":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "cell":
    {
    }
}

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}$

The ID of the Cell.

header Parameters
X-Auth-Token
required
string

The keystone token.

Responses

202

OK

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

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}$

The ID of the Cell.

header Parameters
X-Auth-Token
required
string

The keystone token.

Request Body schema: application/json
createFicConnection
object
attachFicConnection
null Nullable
detachFicConnection
null Nullable
deleteFicConnection
null Nullable
resize
object
updateVersion
null Nullable

Responses

202

OK

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

Content type
application/json
Example
Create FIC Connection Normal
Copy
 Expand all Collapse all
{
  • "createFicConnection":
    {
    }
}

Response samples

Content type
application/json
Example
Create FIC Connection Normal
Copy
 Expand all Collapse all
{
  • "createFicConnection":
    {
    }
}

Get an ActiveDirectory state

Get an ActiveDirectory state.

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}$

The ID of the Cell.

active_directory_id
required
string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$

The ID of the ActiveDirectory.

header Parameters
X-Auth-Token
required
string

The keystone token.

Responses

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

get/v1/cells/{cell_id}/actions/active-directories/{active_directory_id}/state
https://api.ntt.com/dsigw-erg/v1/cells/{cell_id}/actions/active-directories/{active_directory_id}/state

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "result": "Group Mapping((null), type: active-directory): group_mapping_1 \n\tBind DN : CN=panagent,CN=Users,DC=ad-test789b1234,DC=example789b0123456789c123456789d0123456789e0,DC=com\n\tBase : DC=ad-test789b1234,DC=example789b0123456789c123456789d0123456789e0,DC=com\n\tGroup Filter: (None)\n\tUser Filter: (None)\n\tServers : configured 1 servers\n\t\t10.0.10.12(389)\n\t\t\tLast Action Time: 1549 secs ago(took 0 secs)\n\t\t\tNext Action Time: In 2051 secs\n\tNumber of Groups: 1\n\tcn=admingroup,ou=第1チーム,ou=検証部門,ou=tokyo,ou=システム開発部,dc=ad-test789b1234,dc=example789b0123456789c123456789d0123456789e0,dc=com"
}