API docs by Redocly

docomo business SIGN ネットワーク接続 APIリファレンス (1.0.0)

Download OpenAPI specification:

URL: https://sdpf.ntt.com License: NTT DOCOMO BUSINESS, Inc. All Rights Reserved. Terms of Service

docomo business SIGN ネットワーク接続 APIリファレンス

Router

購入されたルーターの参照に関するAPI

ルーター一覧取得用API

購入されたルーターを一覧表示するAPI

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

Content type
application/json
{
  • "routers": [
    ]
}

FIC-Connection

テナント間の接続オーダー実行や、それらの状況の情報取得に関するAPI

FIC-Connectionの一覧取得用API

FIC-Connection情報の一覧を取得します。

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

query Parameters
ficType
string
Enum: "icms" "mec"
Example: ficType=icms

Queryパラメーターなしの場合、全種別のFIC-Connectionを取得

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

Content type
application/json
Example
{
  • "connections": [
    ]
}

FIC-Connection購入用API

FIC-Connectionの承認依頼から購入までを行うAPI。

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Request Body schema: application/json
name
required
string

コネクション名
SIGN-で始まる半角英数及び一部記号&()-_ 64文字

ficType
required
string (ficType)
Enum: "icms" "mec"

接続先のFIC-Connection種別

routerId
required
string (routerId) ^F[0-9]{12}$

ルーターID

bandwidth
required
string (bandwidth)
Enum: "10M" "20M" "30M" "40M" "50M" "100M" "200M" "300M" "400M" "500M" "1G" "2G" "3G" "4G" "5G" "10G"

接続帯域
'10M/20M/30M/40M/50M/100M/200M/300M/400M/500M/1G/2G/3G/4G/5G/10G'のいずれか

simGroupId
string (nsaSimGroupId)

MEC接続先のnsaSimGroupId
ficTypeが "mec" の場合に必須
ficTypeが "icms" の場合に指定するとリクエストエラー

Responses

Request samples

Content type
application/json
{
  • "name": "SIGN-XXX",
  • "ficType": "icms",
  • "routerId": "string",
  • "bandwidth": "10M",
  • "simGroupId": "25001758"
}

Response samples

Content type
application/json
Example
{
  • "approvalRequest": {
    }
}

FIC-Connectionの詳細取得用API

FIC-Connectionの詳細情報を取得します。

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

ficType
required
string
Enum: "icms" "mec"
Example: icms

取得対象のFIC-Connectionを指定

id
required
string

対象コネクションID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "ficType": "icms",
  • "name": "string",
  • "redundant": true,
  • "tenantId": "string",
  • "area": "JPEAST",
  • "operationStatus": "Processing",
  • "bandwidth": "10M",
  • "source": {
    },
  • "destination": {
    },
  • "interTenant": true,
  • "toPublicService": true,
  • "resourceGroup": {
    },
  • "operationid": "string"
}

FIC-Connectionの廃止用API

指定したFIC-Connectionを廃止します。

path Parameters
tenantId
required
string = 32 characters 0-9a-f
Example: 550e8400e29b41d4a716446655440000

テナントID

ficType
required
string
Enum: "icms" "mec"
Example: icms

取得対象のFIC-Connectionを指定

id
required
string

対象コネクションID

header Parameters
X-Auth-Token
required
string = 32 characters 0-9a-f
Example: 098e5cb2b91c4b63a64e47dfe17a5f76

ログイン時に取得するIDトークン

Responses

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "ficType": "icms",
  • "name": "string",
  • "redundant": true,
  • "tenantId": "string",
  • "area": "JPEAST",
  • "operationStatus": "Processing",
  • "bandwidth": "10M",
  • "source": {
    },
  • "destination": {
    },
  • "interTenant": true,
  • "toPublicService": true,
  • "resourceGroup": {
    },
  • "operationid": "string"
}