Access Lists - Super OCN Flexible Connect API リファレンス (1.0)

Download OpenAPI specification:Download

概要

本APIでは、 Super OCN Flexible Connect が提供するリソースの参照・操作が可能です。

access-lists

Access List 一覧を取得する API

Access List 一覧を取得する

path Parameters

tenantId

required

string

header Parameters

X-Auth-Token

required

string

クライアントが Keystone を利用して取得した認証 Token

Responses

200

get/v1/tenants/{tenantId}/access-lists

http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/access-lists

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"accessLists": 
[
{"accessListId": "ox0000000001",
"customerNote": "ACL設定1",
"orderId": "794437c066d711eca521acde48001122",
"rerourceStatus": "active",
"orderStatus": "processing",
"creationTime": "2019-05-21T10:05:48+09:00",
"updateTime": "2019-05-21T10:05:48+09:00",
"serviceStartDate": "2020-01-15",
"routingId": "ox1234567890",
"v4policies": 
{"defaultPolicy": "allow",
"policies": 
[
{"protocol": "tcp",
"sourcePrefix": "192.0.2.0/24",
"destinationPrefix": "198.51.100.0/24",
"sourcePort": "5000-10000",
"destinationPort": "80",
"fragment": false,
"action": "discard"
}
]
},
"v6policies": 
{"defaultPolicy": "allow",
"policies": 
[
{"protocol": "tcp",
"sourcePrefix": "2001:db8:1000::1/128",
"destinationPrefix": "2001:db8:1000::2/128",
"sourcePort": "5000-10000",
"destinationPort": "80",
"fragment": false,
"action": "discard"
}
]
}
}
]
}

Access List を作成する API

Access List を作成する

path Parameters

tenantId

required

string

header Parameters

X-Auth-Token

required

string

クライアントが Keystone を利用して取得した認証 Token

Request Body schema: application/json

customerNote	string <= 64 characters 顧客が任意で付与できる識別子 (全角・半角・記号許容)
v4policies	object IPv4 のポリシーリスト。指定しない場合はデフォルト allow のポリシーのみが作成される。
v6policies	object IPv6 のポリシーリスト。指定しない場合はデフォルト allow のポリシーのみが作成される。

Responses

202

Accepted

post/v1/tenants/{tenantId}/access-lists

http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/access-lists

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"customerNote": "ACL設定1",
"v4policies": 
{"defaultPolicy": "allow",
"policies": 
[
{"protocol": "tcp",
"sourcePrefix": "192.0.2.0/24",
"destinationPrefix": "198.51.100.0/24",
"sourcePort": "5000-10000",
"destinationPort": "80",
"fragment": false,
"action": "discard"
}
]
},
"v6policies": 
{"defaultPolicy": "allow",
"policies": 
[
{"protocol": "tcp",
"sourcePrefix": "2001:db8:1000::1/128",
"destinationPrefix": "2001:db8:1000::2/128",
"sourcePort": "5000-10000",
"destinationPort": "80",
"fragment": false,
"action": "discard"
}
]
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"accessListId": "ox0000000001",
"customerNote": "ACL設定1",
"orderId": "794437c066d711eca521acde48001122",
"rerourceStatus": "active",
"orderStatus": "processing",
"creationTime": "2019-05-21T10:05:48+09:00",
"updateTime": "2019-05-21T10:05:48+09:00",
"serviceStartDate": "2020-01-15",
"routingId": "ox1234567890",
"v4policies": 
{"defaultPolicy": "allow",
"policies": 
[
{"protocol": "tcp",
"sourcePrefix": "192.0.2.0/24",
"destinationPrefix": "198.51.100.0/24",
"sourcePort": "5000-10000",
"destinationPort": "80",
"fragment": false,
"action": "discard"
}
]
},
"v6policies": 
{"defaultPolicy": "allow",
"policies": 
[
{"protocol": "tcp",
"sourcePrefix": "2001:db8:1000::1/128",
"destinationPrefix": "2001:db8:1000::2/128",
"sourcePort": "5000-10000",
"destinationPort": "80",
"fragment": false,
"action": "discard"
}
]
}
}

Access List を取得する API

指定した ID の Access List を取得する

path Parameters

tenantId required	string
accessListId required	string

header Parameters

X-Auth-Token

required

string

クライアントが Keystone を利用して取得した認証 Token

Responses

200

get/v1/tenants/{tenantId}/access-lists/{accessListId}

http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/access-lists/{accessListId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"accessListId": "ox0000000001",
"customerNote": "ACL設定1",
"orderId": "794437c066d711eca521acde48001122",
"rerourceStatus": "active",
"orderStatus": "processing",
"creationTime": "2019-05-21T10:05:48+09:00",
"updateTime": "2019-05-21T10:05:48+09:00",
"serviceStartDate": "2020-01-15",
"routingId": "ox1234567890",
"v4policies": 
{"defaultPolicy": "allow",
"policies": 
[
{"protocol": "tcp",
"sourcePrefix": "192.0.2.0/24",
"destinationPrefix": "198.51.100.0/24",
"sourcePort": "5000-10000",
"destinationPort": "80",
"fragment": false,
"action": "discard"
}
]
},
"v6policies": 
{"defaultPolicy": "allow",
"policies": 
[
{"protocol": "tcp",
"sourcePrefix": "2001:db8:1000::1/128",
"destinationPrefix": "2001:db8:1000::2/128",
"sourcePort": "5000-10000",
"destinationPort": "80",
"fragment": false,
"action": "discard"
}
]
}
}

Access List を更新する API

指定した ID の Access List を更新する

path Parameters

tenantId required	string
accessListId required	string

header Parameters

X-Auth-Token

required

string

クライアントが Keystone を利用して取得した認証 Token

Request Body schema: application/json

accessListId required	string ^ox[0-9]{10}$ リソースのID. 接頭辞 ox + 数字10桁
customerNote	string <= 64 characters 顧客が任意で付与できる識別子 (全角・半角・記号許容)
v4policies	object IPv4 のポリシーリスト。指定しない場合はデフォルト allow のポリシーのみが作成される。
v6policies	object IPv6 のポリシーリスト。指定しない場合はデフォルト allow のポリシーのみが作成される。

Responses

202

Accepted

put/v1/tenants/{tenantId}/access-lists/{accessListId}

http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/access-lists/{accessListId}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"accessListId": "ox0000000001",
"customerNote": "ACL設定1",
"v4policies": 
{"defaultPolicy": "allow",
"policies": 
[
{"protocol": "tcp",
"sourcePrefix": "192.0.2.0/24",
"destinationPrefix": "198.51.100.0/24",
"sourcePort": "5000-10000",
"destinationPort": "80",
"fragment": false,
"action": "discard"
}
]
},
"v6policies": 
{"defaultPolicy": "allow",
"policies": 
[
{"protocol": "tcp",
"sourcePrefix": "2001:db8:1000::1/128",
"destinationPrefix": "2001:db8:1000::2/128",
"sourcePort": "5000-10000",
"destinationPort": "80",
"fragment": false,
"action": "discard"
}
]
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"accessListId": "ox0000000001",
"customerNote": "ACL設定1",
"orderId": "794437c066d711eca521acde48001122",
"rerourceStatus": "active",
"orderStatus": "processing",
"creationTime": "2019-05-21T10:05:48+09:00",
"updateTime": "2019-05-21T10:05:48+09:00",
"serviceStartDate": "2020-01-15",
"routingId": "ox1234567890",
"v4policies": 
{"defaultPolicy": "allow",
"policies": 
[
{"protocol": "tcp",
"sourcePrefix": "192.0.2.0/24",
"destinationPrefix": "198.51.100.0/24",
"sourcePort": "5000-10000",
"destinationPort": "80",
"fragment": false,
"action": "discard"
}
]
},
"v6policies": 
{"defaultPolicy": "allow",
"policies": 
[
{"protocol": "tcp",
"sourcePrefix": "2001:db8:1000::1/128",
"destinationPrefix": "2001:db8:1000::2/128",
"sourcePort": "5000-10000",
"destinationPort": "80",
"fragment": false,
"action": "discard"
}
]
}
}

Access List を削除する API

指定した ID の Access List を削除する

path Parameters

tenantId required	string
accessListId required	string

header Parameters

X-Auth-Token

required

string

クライアントが Keystone を利用して取得した認証 Token

Responses

202

Accepted

delete/v1/tenants/{tenantId}/access-lists/{accessListId}

http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/access-lists/{accessListId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"accessListId": "ox0000000001",
"orderId": "794437c066d711eca521acde48001122"
}

Access List のオーダー履歴を取得する API

指定した ID の Access List のオーダー履歴を取得する

path Parameters

tenantId required	string
accessListId required	string

header Parameters

X-Auth-Token

required

string

クライアントが Keystone を利用して取得した認証 Token

Responses

200

get/v1/tenants/{tenantId}/access-lists/{accessListId}/orders

http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/access-lists/{accessListId}/orders

Response samples

Content type

application/json

No sample

Access List のオーダーを取得する API

指定した ID の Access List のオーダーを取得する

path Parameters

tenantId required	string
accessListId required	string
orderId required	string

header Parameters

X-Auth-Token

required

string

クライアントが Keystone を利用して取得した認証 Token

Responses

200

get/v1/tenants/{tenantId}/access-lists/{accessListId}/orders/{orderId}

http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/access-lists/{accessListId}/orders/{orderId}

Response samples

Content type

application/json

No sample