Documentation Powered by ReDoc

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

Download OpenAPI specification:Download

URL: https://sdpf.ntt.com/

本ページでは、 Super OCN Flexible Connect の API の概要と利用方法をご覧いただけます。 関係する機能と API のエンドポイントは以下の3つです。

  • (SDPF 共通) Keystone: 全ての API の認証機能を提供する。エンドポイント: https://api.ntt.com/keystone
  • (SDPF 共通) 管理機能: ユーザーやテナント等の管理機能を提供する。エンドポイント: https://api.ntt.com/sss
  • Super OCN Flexible Connect: 本サービスの管理機能を提供する。エンドポイント: https://api.ntt.com/ocnx-transit

本ページではそれぞれについて説明します。

(SDPF 共通) API の認証機能

API へのアクセスには認証 Token 及び API 鍵 / API 秘密鍵の取得が必要です。以下のページを参考にご準備ください。

(SDPF 共通) 管理機能

ユーザーやテナント等、 Smart Data Platform 全体にかかる管理機能を提供するサービスです。ご利用方法の詳細は以下のページをご参照ください。

Super OCN Flexible Connect の API 利用方法

本ページでは Resource Overview API の仕様を詳細に記述しています。認証の準備が整ったら、試しにこの API を動作確認されることをおすすめします。

また、本 API は以下の点に注意してご利用ください。

  • API は機能追加・改修のためにバージョンアップが行われます。
  • 旧バージョンの API 廃止は、事前周知の上で行われます。
  • レスポンスボディにおいて、空配列、空オブジェクト、 null リテラルは再帰的にプロパティごと除去されます。 スキーマで required と定義されていないプロパティが対象となるので、その項目をご確認の上ご利用ください。
  • PUT リクエスト関連
    • 変更のない key,value を付与してもしなくても良い。
    • ただし配列は全体が上書きされるため、差分だけではなく全てのアイテムを含める必要がある。

license: name: (c) 2020 NTT Communications Corporation All Rights Reserved. url: 'https://www.ntt.com/'

overview-api

対象テナント全体に関わる情報を扱う API カテゴリ

Resource Overview API

対象テナントへのリソース提供状況の概要を取得する API.

注意点:

  • OCN-X で提供可能なリソース種別ごとに、利用リソース数を概観できます
  • 未使用のリソースも、カウント 0 として表示されます
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}
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "circuits":
    {
    },
  • "circuitsFic":
    {
    },
  • "jpnicGroupContacts":
    {
    },
  • "ocnAssignedAddresses":
    {
    },
  • "irrObjects":
    {
    },
  • "routings":
    {
    },
  • "commits":
    {
    }
}