Documentation Powered by ReDoc

Orders - 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 が提供するリソースの参照・操作が可能です。

orders

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

申込履歴 一覧 API

申込履歴 一覧 API

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

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

query Parameters
statusCategory
string
Enum: "applied" "processing" "completed" "canceled" "aborted" "rejected"
Example: statusCategory=processing

order のステータスカテゴリでフィルタ。

  • rejected は明示しない限り hit せず、無指定の場合は他のカテゴリー値のオーダーのみ返却
  • キーバリューペアを繰り返し指定することで最大N個まで Routings リソースを指定可能 (例: statusCategory=processing&statusCategory=completed)
  • 候補値
    • applied: 未処理のオーダー
    • processing: 未処理〜処理中のオーダー
    • completed: 正常終了
    • canceled: ユーザーからのキャンセルで、対象オーダーがこれ以上変化しない状態
    • aborted: システムからの強制キャンセルで、対象オーダーがこれ以上変化しない状態
    • rejected: リクエスト送信段階で内容の不整合などでエラーとなったもの。これ以上変化しない状態
limit
integer >= 0

ページあたりの表示件数の指定

offset
integer >= 0

表示するページ番号の指定 (デフォルト0)

header Parameters
X-Auth-Token
required
string ^[a-f0-9]{32}$
Example: dc03494823a841338430052e9ee95e07

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

Responses

200

OK

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "total": 100,
  • "offset": 0,
  • "orders":
    [
    ]
}

申込履歴 参照 API

申込履歴 参照 API

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

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

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}/orders/{orderId}
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/orders/{orderId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "resourceId": "ox0000000000",
  • "orderId": "62ec2b62646740b5809f695dea7b2bbf",
  • "resource": "circuits",
  • "operation": "create",
  • "orderStatus": "applied",
  • "orderStatusCategory": "applied",
  • "creationTime": "2019-05-21T10:05:48+09:00",
  • "updateTime": "2019-05-21T10:05:48+09:00",
  • "request": { },
  • "response":
    {
    }
}

申込内容 変更 API

申込内容 変更 API

注意点:

  • リソースの状態によってはこのオペレーションが実行不可能な場合があります（既に元の申込内容で処理中である場合、対象申込が処理済みである場合など）
path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

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

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

request
required
object

申込内容に対する変更内容. 変更点のみ入力

Responses

202

Accepted

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

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "request":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "resourceId": "ox0000000000",
  • "orderId": "62ec2b62646740b5809f695dea7b2bbf",
  • "resource": "circuits",
  • "operation": "create",
  • "orderStatus": "applied",
  • "orderStatusCategory": "applied",
  • "creationTime": "2019-05-21T10:05:48+09:00",
  • "updateTime": "2019-05-21T10:05:48+09:00",
  • "request": { },
  • "response":
    {
    }
}

申込内容 取り消し API

申込内容 取り消し API

注意点:

  • リソースの状態によってはこのオペレーションが実行不可能な場合があります（既に元の申込内容で処理中である場合、対象申込が処理済みである場合など）
path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

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

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}/orders/{orderId}
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/orders/{orderId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "resourceId": "ox0000000000",
  • "orderId": "62ec2b62646740b5809f695dea7b2bbf",
  • "resource": "circuits",
  • "operation": "create",
  • "orderStatus": "applied",
  • "orderStatusCategory": "applied",
  • "creationTime": "2019-05-21T10:05:48+09:00",
  • "updateTime": "2019-05-21T10:05:48+09:00",
  • "request": { },
  • "response":
    {
    }
}