Preferred-Cell - Distributed Secure Internet GateWay API References (1.5.0)

Download OpenAPI specification:Download

Preferred-cells describes that the specific Cell is preferred using IP Prefix.

Authentication

X-Auth-Token

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

preferred-cell

Get Preferred-Cells

Get Preferred-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,15}$ A name of the resource.
cellId	string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The ID of the Cell to which packets from the networks are mainly sent.
cellGroupId	string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The Cell-Group ID which the resource belongs.
sourceAddress	string ^(25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.(25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.(25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.(25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\/(3[0-2]\|2[0-9]\|1[0-9]\|[0-9])$ User networks to which apply this geo ip rule.

header Parameters

X-Auth-Token

required

string

The keystone token.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/v1/preferred-cells

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

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"preferredCells": 
[
{"id": "5be775de-aa0b-468c-ba69-6e35dc5c5c32",
"name": "test_pr_cell",
"cellId": "932b6296-9981-4247-883c-ab059c8e8148",
"cellGroupId": "86acc283-c60d-4c3f-a193-77e249a9c3ab",
"sourceAddress": "192.168.0.0/24",
"tenantId": "1234567890abcdef1234567890abcdef",
"createdAt": "2019-05-14T03:04:48Z",
"updatedAt": "2019-05-14T03:04:48Z"
}
]
}

Create Preferred-Cells

Create a Preferred-Cell resource.

Authorizations:

X-Auth-Token

header Parameters

X-Auth-Token

required

string

The keystone token.

Request Body schema: application/json

preferredCell

required

object (PreferredCellCreateRequest)

A Preferred-Cell object.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

post/v1/preferred-cells

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

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"preferredCell": 
{"name": "test_pr_cell",
"cellId": "932b6296-9981-4247-883c-ab059c8e8148",
"cellGroupId": "86acc283-c60d-4c3f-a193-77e249a9c3ab",
"sourceAddress": "192.168.0.0/24",
"tenantId": "1234567890abcdef1234567890abcdef"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"preferredCell": 
{"id": "5be775de-aa0b-468c-ba69-6e35dc5c5c32",
"name": "test_pr_cell",
"cellId": "932b6296-9981-4247-883c-ab059c8e8148",
"cellGroupId": "86acc283-c60d-4c3f-a193-77e249a9c3ab",
"sourceAddress": "192.168.0.0/24",
"operationId": "715ee526-1c17-44c4-822d-c3c044babfe8",
"tenantId": "1234567890abcdef1234567890abcdef",
"createdAt": "2019-05-14T03:04:48Z",
"updatedAt": "2019-05-14T03:04:48Z"
}
}

Get Preferred-Cell Details

Get a Preferred-Cell resource.

Authorizations:

X-Auth-Token

path Parameters

preferred_cell_id

required

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

The ID of the resource.

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/preferred-cells/{preferred_cell_id}

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

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"preferredCell": 
{"id": "5be775de-aa0b-468c-ba69-6e35dc5c5c32",
"name": "test_pr_cell",
"cellId": "932b6296-9981-4247-883c-ab059c8e8148",
"cellGroupId": "86acc283-c60d-4c3f-a193-77e249a9c3ab",
"sourceAddress": "192.168.0.0/24",
"tenantId": "1234567890abcdef1234567890abcdef",
"createdAt": "2019-05-14T03:04:48Z",
"updatedAt": "2019-05-14T03:04:48Z"
}
}

Update Preferred-Cell

Update a Preferred-Cell resource.

Authorizations:

X-Auth-Token

path Parameters

preferred_cell_id

required

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

The ID of the resource.

header Parameters

X-Auth-Token

required

string

The keystone token.

Request Body schema: application/json

preferredCell

required

object (PreferredCellUpdateRequest)

A Preferred-Cell object.

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

patch/v1/preferred-cells/{preferred_cell_id}

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

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"preferredCell": 
{"name": "pr_updated",
"sourceAddress": "192.168.128.0/24"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"preferredCell": 
{"id": "5be775de-aa0b-468c-ba69-6e35dc5c5c32",
"name": "pr_updated",
"cellId": "932b6296-9981-4247-883c-ab059c8e8148",
"cellGroupId": "86acc283-c60d-4c3f-a193-77e249a9c3ab",
"sourceAddress": "192.168.0.0/24",
"operationId": "715ee526-1c17-44c4-822d-c3c044babfe8",
"tenantId": "1234567890abcdef1234567890abcdef",
"createdAt": "2019-05-14T03:04:48Z",
"updatedAt": "2019-05-14T03:04:48Z"
}
}

Delete Preferred-Cell

Delete a Preferred-Cell resource.

Authorizations:

X-Auth-Token

path Parameters

preferred_cell_id

required

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

The ID of the resource.

header Parameters

X-Auth-Token

required

string

The keystone token.

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/v1/preferred-cells/{preferred_cell_id}

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

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"errorCode": 400,
"errorMessage": "Invalid request",
"moreInfo": "{{moreInfo}}"
}