Documentation Powered by ReDoc

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

Download OpenAPI specification:Download

URL: https://sdpf.ntt.com/ License: (c) 2020 NTT Communications Corporation All Rights Reserved. Terms of Service

概要

本APIでは、 Super OCN Flexible Connect が提供するリソースの参照・操作が可能です。 Commit リソースは以下のように自動で生成され、リソースステータスが変化します

  • Routing リソースがテナント内に初めて作成される時点で自動生成され、リソースステータスは inactive となる
  • 1つの Routing リソースが active な間は Commit リソースも active になる
  • 最後の Routing リソースが削除された時点で自動で inactive になる

commits

コミット帯域値の管理の API カテゴリ

Commits リソース 一覧 API

Commits リソース 一覧 API

注意点:

  • テナントあたり1つしか存在し得ないルール
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

OK

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "commits":
    [
    ]
}

Commits リソース 参照 API

Commits リソース 参照 API

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

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

commitId
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

OK

get/v1/tenants/{tenantId}/commits/{commitId}
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/commits/{commitId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "commitId": "ox0000000000",
  • "resourceStatus": "active",
  • "creationTime": "2019-05-21T10:05:48+09:00",
  • "updateTime": "2019-05-21T10:05:48+09:00",
  • "current": "10M",
  • "planned": "50M"
}

Commits リソース 変更 API

Commits リソース 変更 API

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

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

commitId
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

planned
required
string
Default: "10M"
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).

  • デフォルト 10M.
  • 100M までは 10M 刻み, 1G までは 100M 刻み, ...
  • 例外: 開通初月はこの値が current に即時反映される
  • 月末月初の計2日間は変更不可能
  • 2 Gbps 以上は営業とご相談の上でお申し込みください.

Responses

202

Accepted

put/v1/tenants/{tenantId}/commits/{commitId}
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/commits/{commitId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "planned": "50M"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "commitId": "ox0000000000",
  • "resourceStatus": "active",
  • "orderId": "097d4feec2f743f0873c3280b09e75be",
  • "orderStatus": "applied",
  • "creationTime": "2019-05-21T10:05:48+09:00",
  • "updateTime": "2019-05-21T10:05:48+09:00",
  • "current": "10M",
  • "planned": "50M"
}

orders

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

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

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

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

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

commitId
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

OK

get/v1/tenants/{tenantId}/commits/{commitId}/orders
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/commits/{commitId}/orders

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "orders":
    [
    ]
}

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

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

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

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

commitId
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

OK

get/v1/tenants/{tenantId}/commits/{commitId}/orders/{orderId}
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/commits/{commitId}/orders/{orderId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }