IRR Objects - Super OCN Flexible Connect API リファレンス (1.1.0-BGP-1)

Download OpenAPI specification:Download

概要

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

irr-objects

Global AS のユーザーが広告する経路を本リソースで管理する。この情報から OCN 側の受信経路フィルタを動的に生成する

IRR オブジェクトリソース申込 API

path Parameters

tenantId

required

string ^[0-9a-f]{32}$

Example: 550e8400e29b41d4a716446655440000

SDPF のテナントに一意に与えられる ID. UUID 形式

header Parameters

Content-Type required	string Value: "application/json"
X-Auth-Token required	string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token

Request Body schema: application/json

request body

customerNote	string <= 64 characters 顧客が任意で付与できる識別子 (全角・半角・記号許容)
customerAsNumber required	integer OCN との接続に利用する, ユーザー自身のグローバル AS 番号.
objectType required	string Enum: "aut-num" "as-set" OCN が参照すべき IRR オブジェクトの種別.
objectName required	string OCN が参照すべき IRR オブジェクトの名称.
sources required	Array of strings [ 1 .. 3 ] items Items Enum: "JPIRR" "RADB" "NTTCOM" "APNIC" "RIPE" "ARIN" "LACNIC" "AFRINIC" OCN が参照すべき IRR データベース. 最大3つまで指定可能指定できる IRR データベースはスキーマを参照ユーザー自身の AS オブジェクトや AS-Set オブジェクトの参照先としてだけでなく, 配下のASの情報の確認にも利用するため, 複数指定を推奨するリソース作成時は JPIRR, RADB, NTTCOM のうち1つ以上を含めること (AS管理者確認プロセスのため). リソース作成後はこれらを除外する変更を行うことも許容される.

Responses

202

Accepted

post/v1/tenants/{tenantId}/irr-objects

http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/irr-objects

Request samples

Payload

Content type

application/json

Example

Copy

Expand all Collapse all


{"customerNote": "IRR Object example",
"customerAsNumber": 65001,
"objectType": "as-set",
"objectName": "AS-EXAMPLE-V4",
"sources": 
["RADB",
"JPIRR",
"NTTCOM"
]
}

Response samples

Content type

application/json

Example

Copy

Expand all Collapse all


{"tenantId": "550e8400e29b41d4a716446655440000",
"irrObjectId": "ox0000000001",
"resourceStatus": "inactive",
"orderId": "097d4feec2f743f0873c3280b09e75be",
"orderStatus": "applied",
"creationTime": "2019-05-21T10:05:48+09:00",
"updateTime": "2019-05-21T10:05:48+09:00",
"customerNote": "IRR Object example",
"customerAsNumber": 65001,
"objectType": "asSet",
"objectName": "AS-EXAMPLE-V4",
"sources": 
["RADB",
"JPIRR",
"NTTCOM"
]
}

IRR オブジェクトリソース一覧 API

path Parameters

tenantId

required

string ^[0-9a-f]{32}$

Example: 550e8400e29b41d4a716446655440000

SDPF のテナントに一意に与えられる ID. UUID 形式

header Parameters

X-Auth-Token

required

string ^[0-9a-f]{32}$

Example: dc03494823a841338430052e9ee95e07

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

Responses

200

get/v1/tenants/{tenantId}/irr-objects

http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/irr-objects

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"irrObjects": 
[
{"tenantId": "550e8400e29b41d4a716446655440000",
"irrObjectId": "ox0000000000",
"resourceStatus": "inactive",
"orderId": "62ec2b62646740b5809f695dea7b2bbf",
"orderStatus": "applied",
"creationTime": "2019-05-21T10:05:48+09:00",
"updateTime": "2019-05-21T10:05:48+09:00",
"serviceStartDate": "2020-01-15",
"customerNote": "project-A 用のリソース",
"customerAsNumber": 65001,
"objectType": "as-set",
"objectName": "AS-EXAMPLE-V4",
"sources": 
["JPIRR"
]
}
]
}

IRR オブジェクトリソース参照 API

path Parameters

tenantId required	string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPF のテナントに一意に与えられる ID. UUID 形式
irrObjectId required	string ^ox[0-9]{10}$ Example: ox0000000000 リソースのID. 接頭辞 ox + 数字10桁

header Parameters

X-Auth-Token

required

string ^[0-9a-f]{32}$

Example: dc03494823a841338430052e9ee95e07

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

Responses

200

get/v1/tenants/{tenantId}/irr-objects/{irrObjectId}

http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/irr-objects/{irrObjectId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"tenantId": "550e8400e29b41d4a716446655440000",
"irrObjectId": "ox0000000001",
"resourceStatus": "active",
"creationTime": "2019-05-21T10:05:48+09:00",
"updateTime": "2019-05-30T11:00:00+09:00",
"serviceStartDate": "2020-05-30",
"customerNote": "IRR Object example",
"customerAsNumber": 65001,
"objectType": "as-set",
"objectName": "AS-EXAMPLE-V4",
"sources": 
["RADB",
"JPIRR",
"NTTCOM"
]
}

IRR オブジェクトリソース変更 API

path Parameters

tenantId required	string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPF のテナントに一意に与えられる ID. UUID 形式
irrObjectId required	string ^ox[0-9]{10}$ Example: ox0000000000 リソースのID. 接頭辞 ox + 数字10桁

header Parameters

Content-Type required	string Value: "application/json"
X-Auth-Token required	string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token

Request Body schema: application/json

request body

customerNote

string <= 64 characters

顧客が任意で付与できる識別子 (全角・半角・記号許容)

sources

Array of strings [ 1 .. 3 ] items

Items Enum: "JPIRR" "RADB" "NTTCOM" "APNIC" "RIPE" "ARIN" "LACNIC" "AFRINIC"

OCN が参照すべき IRR データベース.

最大3つまで指定可能
指定できる IRR データベースはスキーマを参照
ユーザー自身の AS オブジェクトや AS-Set オブジェクトの参照先としてだけでなく, 配下のASの情報の確認にも利用するため, 複数指定を推奨する
リソース作成時は JPIRR, RADB, NTTCOM のうち1つ以上を含めること (AS管理者確認プロセスのため).
リソース作成後はこれらを除外する変更を行うことも許容される.

Responses

202

Accepted

put/v1/tenants/{tenantId}/irr-objects/{irrObjectId}

http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/irr-objects/{irrObjectId}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"customerNote": "IRR Object example with new sources",
"sources": 
["RIPE",
"APNIC"
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"tenantId": "550e8400e29b41d4a716446655440000",
"irrObjectId": "ox0000000001",
"resourceStatus": "active",
"orderId": "097d4feec2f743f0873c3280b09e75be",
"orderStatus": "processing",
"creationTime": "2019-05-21T10:05:48+09:00",
"updateTime": "2019-05-30T11:00:00+09:00",
"serviceStartDate": "2020-05-30",
"customerNote": "IRR Object example with new sources",
"customerAsNumber": 65001,
"objectType": "asSet",
"objectName": "AS-EXAMPLE-V4",
"sources": 
["RIPE",
"APNIC"
]
}

IRR オブジェクトリソース削除 API

path Parameters

tenantId required	string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPF のテナントに一意に与えられる ID. UUID 形式
irrObjectId required	string ^ox[0-9]{10}$ Example: ox0000000000 リソースのID. 接頭辞 ox + 数字10桁

header Parameters

X-Auth-Token

required

string ^[0-9a-f]{32}$

Example: dc03494823a841338430052e9ee95e07

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

Responses

202

Accepted

delete/v1/tenants/{tenantId}/irr-objects/{irrObjectId}

http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/irr-objects/{irrObjectId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"tenantId": "550e8400e29b41d4a716446655440000",
"irrObjectId": "ox0000000001",
"resourceStatus": "active",
"orderId": "097d4feec2f743f0873c3280b09e75be",
"orderStatus": "processing"
}

orders

申込履歴に関する API カテゴリ

申込履歴情報を一覧参照する API

path Parameters

tenantId required	string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPF のテナントに一意に与えられる ID. UUID 形式
irrObjectId required	string ^ox[0-9]{10}$ Example: ox0000000000 リソースのID. 接頭辞 ox + 数字10桁

header Parameters

X-Auth-Token

required

string ^[0-9a-f]{32}$

Example: dc03494823a841338430052e9ee95e07

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

Responses

200

get/v1/tenants/{tenantId}/irr-objects/{irrObjectId}/orders

http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/irr-objects/{irrObjectId}/orders

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"orders": 
[{ }
]
}

指定の申込履歴情報を参照する API

path Parameters

tenantId required	string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPF のテナントに一意に与えられる ID. UUID 形式
irrObjectId required	string ^ox[0-9]{10}$ Example: ox0000000000 リソースのID. 接頭辞 ox + 数字10桁
orderId required	string ^[0-9a-f]{32}$ Example: 62ec2b62646740b5809f695dea7b2bbf 関連するオーダーのID. orderStatus と同じ条件で対象のオーダーが引用される

header Parameters

X-Auth-Token

required

string ^[0-9a-f]{32}$

Example: dc03494823a841338430052e9ee95e07

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

Responses

200

get/v1/tenants/{tenantId}/irr-objects/{irrObjectId}/orders/{orderId}

http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/irr-objects/{irrObjectId}/orders/{orderId}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{ }

申込内容に変更を加える API

path Parameters

tenantId required	string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPF のテナントに一意に与えられる ID. UUID 形式
irrObjectId required	string ^ox[0-9]{10}$ Example: ox0000000000 リソースのID. 接頭辞 ox + 数字10桁
orderId required	string ^[0-9a-f]{32}$ Example: 62ec2b62646740b5809f695dea7b2bbf 関連するオーダーのID. orderStatus と同じ条件で対象のオーダーが引用される

header Parameters

Content-Type required	string Value: "application/json"
X-Auth-Token required	string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token

Request Body schema: application/json

request body

Responses

202

Accepted

put/v1/tenants/{tenantId}/irr-objects/{irrObjectId}/orders/{orderId}

http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/irr-objects/{irrObjectId}/orders/{orderId}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all

{ }

Response samples

Content type

application/json

Copy

Expand all Collapse all

{ }

指定の申込を取り消す API

path Parameters

tenantId required	string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPF のテナントに一意に与えられる ID. UUID 形式
irrObjectId required	string ^ox[0-9]{10}$ Example: ox0000000000 リソースのID. 接頭辞 ox + 数字10桁
orderId required	string ^[0-9a-f]{32}$ Example: 62ec2b62646740b5809f695dea7b2bbf 関連するオーダーのID. orderStatus と同じ条件で対象のオーダーが引用される

header Parameters

X-Auth-Token

required

string ^[0-9a-f]{32}$

Example: dc03494823a841338430052e9ee95e07

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

Responses

202

Accepted

delete/v1/tenants/{tenantId}/irr-objects/{irrObjectId}/orders/{orderId}

http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/irr-objects/{irrObjectId}/orders/{orderId}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{ }

as-admin-approval

AS 管理者確認プロセスに関する API カテゴリ

AS 管理者確認プロセスのステータスを参照する API

path Parameters

tenantId required	string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPF のテナントに一意に与えられる ID. UUID 形式
irrObjectId required	string ^ox[0-9]{10}$ Example: ox0000000000 リソースのID. 接頭辞 ox + 数字10桁

header Parameters

X-Auth-Token

required

string ^[0-9a-f]{32}$

Example: dc03494823a841338430052e9ee95e07

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

Responses

200

get/v1/tenants/{tenantId}/irr-objects/{irrObjectId}/approval

http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/irr-objects/{irrObjectId}/approval

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "pending",
"mailRecipients": 
["noc@example.ad.jp",
"admin@example.ad.jp"
],
"mailSentTime": "2019-05-21T10:05:48+09:00",
"expirationTime": "2019-05-21T10:05:48+09:00"
}

AS 管理者確認プロセスのステータスを更新する API

path Parameters

tenantId required	string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPF のテナントに一意に与えられる ID. UUID 形式
irrObjectId required	string ^ox[0-9]{10}$ Example: ox0000000000 リソースのID. 接頭辞 ox + 数字10桁

header Parameters

Content-Type required	string Value: "application/json"
X-Auth-Token required	string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token

Request Body schema: application/json

request body

passcode

required

string <= 254 characters

承認のためのワンタイム・パスコード

Responses

200

put/v1/tenants/{tenantId}/irr-objects/{irrObjectId}/approval

http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/irr-objects/{irrObjectId}/approval

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"passcode": "PcdY4JYFZjDsy4tzyFEj_Zgnei8ysNahb6ECwgVNVpkmXrd3h3LuZW93-wT9fEt2"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"status": "approved",
"mailRecipients": 
["noc@example.ad.jp",
"admin@example.ad.jp"
],
"mailSentTime": "2019-05-21T10:05:48+09:00",
"expirationTime": "2019-05-21T10:05:48+09:00"
}

irr-db-query

IRR DB への問い合わせに関する API カテゴリ

IRR DB を参照する API

path Parameters

tenantId

required

string ^[0-9a-f]{32}$

Example: 550e8400e29b41d4a716446655440000

SDPF のテナントに一意に与えられる ID. UUID 形式

query Parameters

customerAsNumber required	string
objectType required	string
objectName required	string
sources required	string

header Parameters

X-Auth-Token

required

string ^[0-9a-f]{32}$

Example: dc03494823a841338430052e9ee95e07

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

Responses

200

get/v1/tenants/{tenantId}/irr-db-query

http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/irr-db-query

Response samples

Content type

application/json

Example

Copy

Expand all Collapse all


{"customerAsNumber": 65000,
"objectType": "as-set",
"objectName": "AS65000",
"sources": 
["NTTCOM"
],
"irrIpv4Prefixes": 
["192.168.2.0/24",
"192.168.3.0/24"
],
"irrIpv6Prefixes": 
["2001:db8:2::/48",
"2001:db8:3::/48"
],
"summaryIpv4Prefixes": 
["192.168.2.0/23"
],
"summaryIpv6Prefixes": 
["2001:db8:2::/47"
],
"irrMemberAutNums": 
["AS65000"
],
"mntnerObject": 
["MAINT-AS65000"
],
"mntnerEmails": 
["aaa@example.com",
"bbb@example.com",
"ccc@example.com"
],
"rawIrrObject": 
{"aut-num": "AS65000",
"as-name": "EXAMPLE-NET",
"descr": 
["The AS for EXAMPLE-NET"
],
"admin-c": 
["XX00000JP"
],
"tech-c": 
["XX00000JP"
],
"notify": 
["admin@exmaple.ad.jp"
],
"mnt-by": 
["MAINT-AS65000"
],
"changed": 
["admin@example.ad.jp 20210224"
],
"source": "NTTCOM"
}
}

IRR Objects - Super OCN Flexible Connect API リファレンス (1.1.0-BGP-1)

概要

irr-objects

IRR オブジェクトリソース 申込 API

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

IRR オブジェクトリソース 一覧 API

path Parameters

header Parameters

Responses

Response samples

IRR オブジェクトリソース 参照 API

path Parameters

header Parameters

Responses

Response samples

IRR オブジェクトリソース 変更 API

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

IRR オブジェクトリソース 削除 API

path Parameters

header Parameters

Responses

Response samples

orders

申込履歴情報を一覧参照する API

path Parameters

header Parameters

Responses

Response samples

指定の申込履歴情報を参照する API

path Parameters

header Parameters

Responses

Response samples

申込内容に変更を加える API

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

指定の申込を取り消す API

path Parameters

header Parameters

Responses

Response samples

as-admin-approval

AS 管理者確認プロセスのステータスを参照する API

path Parameters

header Parameters

Responses

Response samples

AS 管理者確認プロセスのステータスを更新する API

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

irr-db-query

IRR DB を参照する API

path Parameters

query Parameters

header Parameters

Responses

Response samples

IRR オブジェクトリソース申込 API

IRR オブジェクトリソース一覧 API

IRR オブジェクトリソース参照 API

IRR オブジェクトリソース変更 API

IRR オブジェクトリソース削除 API