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

Download OpenAPI specification:Download

概要

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

circuits

Circuitリソース参照API

参考: 全アクセスライン種別で共通な情報をトップレベルに、各種アクセスライン固有の情報はネストして表示, という表示形式をとっています

path Parameters

tenantId

required

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

Example: 550e8400e29b41d4a716446655440000

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

header Parameters

X-Auth-Token

required

string

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

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/tenants/{tenantId}/circuits

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

Response samples

Content type

application/json

Example

Copy

Expand all Collapse all


{"circuits": 
[
{"tenantId": "550e8400e29b41d4a716446655440000",
"circuitId": "ox0000000000",
"fic": 
{"tenantId": "550e8400e29b41d4a716446655440000",
"connectionId": "F123456789012"
},
"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",
"pop": "tyo-a",
"node": "tyo-a-03",
"rateLimit": "10M",
"customerNote": "project-A 用のリソース",
"type": "fic",
"accessLineId": "YJ0123P01"
}
]
}

Circuitリソース申し込みAPI

path Parameters

tenantId

required

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

Example: 550e8400e29b41d4a716446655440000

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

header Parameters

X-Auth-Token required	string クライアントが Keystone を利用して取得した認証 Token
Content-Type required	string

Request Body schema: application/json

customerNote	string 顧客が任意で付与できる識別子 (全角・半角・記号許容)
rateLimit required	string Enum: "10M" "20M" "30M" "40M" "50M" "60M" "70M" "80M" "90M" "100M" "200M" "300M" "400M" "500M" "600M" "700M" "800M" "900M" "1G" "2G" "3G" "4G" "5G" "6G" "7G" "8G" "9G" "10G" "20G" "30G" "40G" "50G" "60G" "70G" "80G" "90G" "100G" 上限帯域値 bps. physicalSpeedより大きい値にすることはできない。
node required	string Enum: "tyo-a-03" "tyo-a-04" "osa-a-03" "osa-a-04" 収容装置の識別子. ユーザ拠点住所, 品目, 設備側の収容状況, 等の条件によって選択肢が変動候補値は Pops API へ問い合わせて都度取得することも可能.
type required	string Enum: "com" "regional" "housing" 回線種別 com: イーサアクセス NTT Comタイプ, regional: イーサアクセス NTT東日本・西日本ワイドタイプ, housing: イーサアクセスハウジングタイプ
com	object typeをcomとした場合、必須.
regional	object typeをregionalとした場合、必須.
housing	object typeをhousingとした場合、必須.

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/v1/tenants/{tenantId}/circuits

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

Request samples

Payload

Content type

application/json

Example

Copy

Expand all Collapse all


{"customerNote": "project-A 用のリソース",
"rateLimit": "4G",
"node": "tyo-a-03",
"type": "com",
"com": 
{"physicalSpeed": "10G"
}
}

Response samples

Content type

application/json

Example

Copy

Expand all Collapse all


{"tenantId": "550e8400e29b41d4a716446655440000",
"circuitId": "ox0000000000",
"com": 
{"vlanId": 1000,
"pointOfInterface": "tyo-a-03-n-001",
"physicalSpeed": "100M"
},
"resourceStatus": "inactive",
"orderId": "62ec2b62646740b5809f695dea7b2bbf",
"orderStatus": "applied",
"creationTime": "2019-05-21T10:05:48+09:00",
"updateTime": "2019-05-21T10:05:48+09:00",
"pop": "tyo-a",
"node": "tyo-a-03",
"rateLimit": "10M",
"customerNote": "project-A 用のリソース",
"type": "com"
}

Circuit リソース参照 API

path Parameters

tenantId required	string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPF のテナントに一意に与えられる ID. UUID 形式
circuitId 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}/circuits/{circuitId}

http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/circuits/{circuitId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"tenantId": "550e8400e29b41d4a716446655440000",
"circuitId": "ox0000000000",
"circuitDeliveryId": "ox00000000",
"com": 
{"vlanId": 1000,
"pointOfInterface": "tyo-a-03-n-001",
"physicalSpeed": "100M"
},
"resourceStatus": "active",
"creationTime": "2019-05-21T10:05:48+09:00",
"updateTime": "2019-05-21T10:05:48+09:00",
"serviceStartDate": "2020-01-15",
"pop": "tyo-a",
"node": "tyo-a-03",
"rateLimit": "10M",
"customerNote": "project-A 用のリソース",
"type": "com",
"accessLineId": "YJ0123P01"
}

Circuit リソース変更 API

注意点:

変更のない key,value を付与しても良い。
配列の中身は差分だけではなく、全てのアイテムをリクエストに含める必要がある。

path Parameters

tenantId required	string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPF のテナントに一意に与えられる ID. UUID 形式
circuitId 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
Content-Type required	string

Request Body schema: application/json

request body

rateLimit	string Enum: "10M" "20M" "30M" "40M" "50M" "60M" "70M" "80M" "90M" "100M" "200M" "300M" "400M" "500M" "600M" "700M" "800M" "900M" "1G" "2G" "3G" "4G" "5G" "6G" "7G" "8G" "9G" "10G" "20G" "30G" "40G" "50G" "60G" "70G" "80G" "90G" "100G" 上限帯域値 bps. 100Mbps までは 10Mbps 刻み, 1Gbps までは 100Mbps 刻み,　10Gbpsまでは 1Gbps刻み, 100Gbpsまでは 10Gbps刻み
customerNote	string <= 64 characters 顧客が任意で付与できる識別子 (全角・半角・記号許容)

Responses

202

Accepted

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

put/v1/tenants/{tenantId}/circuits/{circuitId}

http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/circuits/{circuitId}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"rateLimit": "20M",
"customerNote": "project-B 用のリソース"
}

Response samples

Content type

application/json

Example

Copy

Expand all Collapse all


{"tenantId": "550e8400e29b41d4a716446655440000",
"circuitId": "ox0000000000",
"circuitDeliveryId": "ox00000000",
"regional": 
{"vlanId": 1000,
"pointOfInterface": "tyo-a-03-n-001",
"physicalSpeed": "100M"
},
"resourceStatus": "active",
"orderId": "62ec2b62646740b5809f695dea7b2bbf",
"orderStatus": "applied",
"creationTime": "2019-05-21T10:05:48+09:00",
"updateTime": "2019-05-21T10:05:48+09:00",
"serviceStartDate": "2020-01-15",
"pop": "tyo-a",
"node": "tyo-a-03",
"rateLimit": "10M",
"customerNote": "project-B 用のリソース",
"type": "regional",
"accessLineId": "YJ0123P01"
}

Circuit リソース削除 API

path Parameters

tenantId required	string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPF のテナントに一意に与えられる ID. UUID 形式
circuitId 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

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/v1/tenants/{tenantId}/circuits/{circuitId}

http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/circuits/{circuitId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"tenantId": "550e8400e29b41d4a716446655440000",
"circuitId": "ox0000000000",
"circuitDeliveryId": "ox00000000",
"com": 
{"vlanId": 1000,
"pointOfInterface": "tyo-a-03-n-001",
"physicalSpeed": "100M"
},
"resourceStatus": "active",
"orderId": "62ec2b62646740b5809f695dea7b2bbf",
"orderStatus": "applied",
"creationTime": "2019-05-21T10:05:48+09:00",
"updateTime": "2019-05-21T10:05:48+09:00",
"serviceStartDate": "2020-01-15",
"pop": "tyo-a",
"node": "tyo-a-03",
"rateLimit": "10M",
"customerNote": "project-A 用のリソース",
"type": "com",
"accessLineId": "YJ0123P01"
}

Circuitリソースアクティベート API

CircuitリソースアクティベートAPI

path Parameters

tenantId required	string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPF のテナントに一意に与えられる ID. UUID 形式
circuitId 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
Content-Type required	string

Request Body schema: application/json

request body

accessLineId

required

string ^Y[A-Z][0-8][0-9]{3}P[0-9][1-9]$|^[0-9]{9}$

アクセスラインID.

Responses

202

Accepted

400

Bad Request

put/v1/tenants/{tenantId}/circuits/{circuitId}/activation

http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/circuits/{circuitId}/activation

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"accessLineId": "YJ1234P01"
}

orders

Circuitリソースの申込履歴情報を一覧参照する API

path Parameters

tenantId required	string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPF のテナントに一意に与えられる ID. UUID 形式
circuitId 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}/circuits/{circuitId}/orders

http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/circuits/{circuitId}/orders

Response samples

Content type

application/json

No sample

Circuitリソースの申込履歴情報を参照する API

path Parameters

tenantId required	string ^[0-9a-f]{32}$ Example: 550e8400e29b41d4a716446655440000 SDPF のテナントに一意に与えられる ID. UUID 形式
circuitId 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}/circuits/{circuitId}/orders/{orderId}

http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/circuits/{circuitId}/orders/{orderId}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{ }

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

概要

circuits

Circuitリソース 参照API

path Parameters

header Parameters

Responses

Response samples

Circuitリソース 申し込みAPI

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Circuit リソース 参照 API

path Parameters

header Parameters

Responses

Response samples

Circuit リソース 変更 API

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Circuit リソース 削除 API

path Parameters

header Parameters

Responses

Response samples

Circuitリソース アクティベート API

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

orders

Circuitリソースの申込履歴情報を一覧参照する API

path Parameters

header Parameters

Responses

Response samples

Circuitリソースの申込履歴情報を参照する API

path Parameters

header Parameters

Responses

Response samples

Circuitリソース参照API

Circuitリソース申し込みAPI

Circuit リソース参照 API

Circuit リソース変更 API

Circuit リソース削除 API

Circuitリソースアクティベート API