Public Service - Flexible InterConnect API リファレンス (2.0.0)
Download OpenAPI specification:Download
本APIでは、Flexible InterConnectが提供するリソースの参照・操作が可能です。
FIC-Port(XaaS)/FIC-Router(XaaS)/FIC-Virtual Port(XaaS)【Pattern S】/FIC-Virtual Port(XaaS)【Pattern X】の公開サービス情報の登録・取得・変更・廃止等の操作に関するAPIドキュメントです。
List Public Services
FIC-Port(XaaS)/FIC-Router(XaaS)/FIC-Virtual Port(XaaS)【Pattern S】/FIC-Virtual Port(XaaS)【Pattern X】の公開サービス情報の一覧を取得します。
query Parameters
id | string ^X[0-9]{12}$ Example: id=X001234567890 公開サービスID |
name | string Example: name=YourPublicServiceName 公開サービス名 半角50文字以内 |
area | string Enum: "JPEAST" "JPWEST" Example: area=JPEAST エリア名 ‘JPEAST’または’JPWEST’ |
isPublic | boolean 情報公開フラグ create時は'false'(非公開)固定 |
header Parameters
Content-Type required | string Value: "application/json" |
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK 成功しました
Bad Request リクエストが不正
Unauthorized 認証エラー
Conflict 競合エラー
Response samples
- 200
{- "publicServices": [
- {
- "id": "X001234567890",
- "name": "YourPublicServiceName",
- "tenantId": "dcc51777b1c64829ad496a311cab3d59",
- "area": "JPEAST",
- "operationStatus": "Completed",
- "description": "PublicService-description",
- "keyRequired": false,
- "isPublic": false,
- "enabled": true,
- "seller": {
- "companyName": "Seller-companyName",
- "serviceInquiryMail": "serviceInquiry@domain",
- "serviceInquiryPhone": "03-1234-5678",
- "customerSupportMail": "customerSupport@domain",
- "customerSupportPhone": "03-8765-4321"
}, - "connectionSpec": {
- "source": {
- "resourceType": [
- "Port",
- "Router"
]
}, - "destination": {
- "resources": [
- {
- "id": "F010123456789",
- "publicName": "XaaS-PortName01",
- "enabled": false
}, - {
- "id": "F019876543210",
- "publicName": "XaaS-PortName02",
- "enabled": false
}
], - "asn": "65530",
- "resourceType": "Port"
}, - "redundant": true,
- "bgpCostType": "med",
- "availableBandwidth": [
- "10M",
- "20M",
- "30M",
- "40M",
- "50M",
- "100M",
- "200M",
- "300M",
- "400M",
- "500M",
- "1G",
- "2G",
- "3G",
- "4G",
- "5G",
- "10G"
], - "advertisedAddresses": [ ]
}
}
]
}
Create Public Service
FIC-Port(XaaS)/FIC-Router(XaaS)/FIC-Virtual Port(XaaS)【Pattern S】/FIC-Virtual Port(XaaS)【Pattern X】の公開サービス情報を登録します。
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
publicService required | object |
Responses
Accepted 要求は受け付けられました
Bad Request リクエストが不正
Unauthorized 認証エラー
Conflict 競合エラー
Request samples
- Payload
{- "publicService": {
- "name": "YourPublicServiceName",
- "area": "JPEAST",
- "description": "PublicService-description",
- "keyRequired": false,
- "seller": {
- "companyName": "Seller-companyName",
- "serviceInquiryMail": "serviceInquiry@domain",
- "serviceInquiryPhone": "03-1234-5678",
- "customerSupportMail": "customerSupport@domain",
- "customerSupportPhone": "03-8765-4321"
}, - "connectionSpec": {
- "source": {
- "resourceType": [
- "Port",
- "Router"
]
}, - "destination": {
- "resources": [
- {
- "id": "F010123456789",
- "publicName": "XaaS-PortName01",
- "enabled": false
}, - {
- "id": "F019876543210",
- "publicName": "XaaS-PortName02",
- "enabled": false
}
], - "asn": "65530"
}, - "redundant": true,
- "bgpCostType": "med",
- "availableBandwidth": [
- "10M",
- "20M",
- "30M",
- "40M",
- "50M",
- "100M",
- "200M",
- "300M",
- "400M",
- "500M",
- "1G",
- "2G",
- "3G",
- "4G",
- "5G",
- "10G"
]
}
}
}
Response samples
- 202
{- "publicService": {
- "id": "X001234567890",
- "name": "YourPublicServiceName",
- "tenantId": "dcc51777b1c64829ad496a311cab3d59",
- "area": "JPEAST",
- "operationStatus": "Processing",
- "description": "PublicService-description",
- "keyRequired": false,
- "isPublic": false,
- "enabled": true,
- "seller": {
- "companyName": "Seller-companyName",
- "serviceInquiryMail": "serviceInquiry@domain",
- "serviceInquiryPhone": "03-1234-5678",
- "customerSupportMail": "customerSupport@domain",
- "customerSupportPhone": "03-8765-4321"
}, - "connectionSpec": {
- "source": {
- "resourceType": [
- "Port",
- "Router"
]
}, - "destination": {
- "resources": [
- {
- "id": "F010123456789",
- "publicName": "XaaS-PortName01",
- "enabled": false
}, - {
- "id": "F019876543210",
- "publicName": "XaaS-PortName02",
- "enabled": false
}
], - "asn": "65530",
- "resourceType": "Port"
}, - "redundant": true,
- "bgpCostType": "med",
- "availableBandwidth": [
- "10M",
- "20M",
- "30M",
- "40M",
- "50M",
- "100M",
- "200M",
- "300M",
- "400M",
- "500M",
- "1G",
- "2G",
- "3G",
- "4G",
- "5G",
- "10G"
], - "advertisedAddresses": [ ]
}, - "operationId": "5e698fff5adb4e45ae00347771dd27a2"
}
}
Show Public Service
指定したFIC-Port(XaaS)/FIC-Router(XaaS)/FIC-Virtual Port(XaaS)【Pattern S】/FIC-Virtual Port(XaaS)【Pattern X】の公開サービス情報の詳細情報を取得します。
path Parameters
public-service_id required | string 対象公開サービスID |
header Parameters
Content-Type required | string Value: "application/json" |
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Responses
OK 成功しました
Bad Request リクエストが不正
Unauthorized 認証エラー
Not Found 未検出エラー
Conflict 競合エラー
Response samples
- 200
{- "publicService": {
- "id": "X001234567890",
- "name": "YourPublicServiceName",
- "tenantId": "dcc51777b1c64829ad496a311cab3d59",
- "area": "JPEAST",
- "operationStatus": "Processing",
- "description": "PublicService-description",
- "keyRequired": false,
- "isPublic": false,
- "enabled": true,
- "seller": {
- "companyName": "Seller-companyName",
- "serviceInquiryMail": "serviceInquiry@domain",
- "serviceInquiryPhone": "03-1234-5678",
- "customerSupportMail": "customerSupport@domain",
- "customerSupportPhone": "03-8765-4321"
}, - "connectionSpec": {
- "source": {
- "resourceType": [
- "Port",
- "Router"
]
}, - "destination": {
- "resources": [
- {
- "id": "F010123456789",
- "publicName": "XaaS-PortName01",
- "enabled": false
}, - {
- "id": "F019876543210",
- "publicName": "XaaS-PortName02",
- "enabled": false
}
], - "asn": "65530",
- "resourceType": "Port"
}, - "redundant": true,
- "bgpCostType": "med",
- "availableBandwidth": [
- "10M",
- "20M",
- "30M",
- "40M",
- "50M",
- "100M",
- "200M",
- "300M",
- "400M",
- "500M",
- "1G",
- "2G",
- "3G",
- "4G",
- "5G",
- "10G"
], - "advertisedAddresses": [ ]
}
}
}
Update Public Service
指定したFIC-Port(XaaS)/FIC-Router(XaaS)/FIC-Virtual Port(XaaS)【Pattern S】/FIC-Virtual Port(XaaS)【Pattern X】のサービス情報および公開情報を変更します。
path Parameters
public-service_id required | string 対象公開サービスID |
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
publicService required | object |
Responses
Accepted 要求は受け付けられました
Bad Request リクエストが不正
Unauthorized 認証エラー
Not Found 未検出エラー
Conflict 競合エラー
Request samples
- Payload
{- "publicService": {
- "description": "PublicService-descriptionUpdate",
- "keyRequired": true,
- "isPublic": true,
- "enabled": true,
- "seller": {
- "companyName": "Seller-companyNameUpdate",
- "serviceInquiryMail": "serviceInquiryUpdate@domain",
- "serviceInquiryPhone": "03-1234-5679",
- "customerSupportMail": "customerSupportUpdate@domain",
- "customerSupportPhone": "03-8765-4322"
}, - "connectionSpec": {
- "source": {
- "resourceType": [
- "Port"
]
}, - "destination": {
- "resources": [
- {
- "id": "F010123456789",
- "publicName": "XaaS-PortName01Update",
- "enabled": true
}
]
}, - "availableBandwidth": [
- "10M",
- "100M",
- "500M"
]
}
}
}
Response samples
- 202
{- "publicService": {
- "id": "X001234567890",
- "name": "YourPublicServiceName",
- "tenantId": "dcc51777b1c64829ad496a311cab3d59",
- "area": "JPEAST",
- "operationStatus": "Processing",
- "description": "PublicService-descriptionUpdate",
- "keyRequired": true,
- "isPublic": true,
- "enabled": true,
- "seller": {
- "companyName": "Seller-companyNameUpdate",
- "serviceInquiryMail": "serviceInquiryUpdate@domain",
- "serviceInquiryPhone": "03-1234-5679",
- "customerSupportMail": "customerSupportUpdate@domain",
- "customerSupportPhone": "03-8765-4322"
}, - "connectionSpec": {
- "source": {
- "resourceType": [
- "Port"
]
}, - "destination": {
- "resources": [
- {
- "id": "F010123456789",
- "publicName": "XaaS-PortName01Update",
- "enabled": true
}
], - "asn": "65530",
- "resourceType": "Port"
}, - "redundant": true,
- "bgpCostType": "med",
- "availableBandwidth": [
- "10M",
- "100M",
- "500M"
], - "advertisedAddresses": [ ]
}, - "operationId": "bb16e2c4153b11e9ab14d663bd873d93"
}
}
Delete Public Service
指定したFIC-Port(XaaS)/FIC-Router(XaaS)/FIC-Virtual Port(XaaS)【Pattern S】/FIC-Virtual Port(XaaS)【Pattern X】の公開サービス情報を廃止します。
公開サービス情報にコネクションが紐づいている場合や、公開サービス情報の情報公開フラグおよびリソース収容可否フラグがfalseでない場合は廃止出来ません。
ただし、resourcesがFIC-Port(XaaS)の場合は、紐づくFIC-Virtual Port(XaaS)【Pattern X】が無い場合、ports.vlanRangeDetails.purpose: "PublicServiceEndpoint" に接続connectionが存在しなければ削除可能となります。(purpose: Ownのみに接続connectionが存在する場合は削除可能。)
紐づくFIC-Virtual Port(XaaS)【Pattern X】がある場合は、ports.vlanRangeDetails.purpose: "PublicServiceEndpoint"のvlanのうち、FIC-Virtual Port (XaaS)に払い出しているvlan以外に接続connectionが存在しなければ削除可能とする。
(FIC-Virtual Port(XaaS)【Pattern X】に払い出しているvlanのみに接続connectionがあっても削除可能。) (purpose: Ownのみに接続connectionが存在する場合は削除可能。)
path Parameters
public-service_id required | string 対象公開サービスID |
header Parameters
Content-Type required | string Value: "application/json" |
X-Auth-Token required | string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token |
Responses
Accepted 要求は受け付けられました
Bad Request リクエストが不正
Unauthorized 認証エラー
Not Found 未検出エラー
Conflict 競合エラー
Response samples
- 202
{- "publicService": {
- "id": "X001234567890",
- "name": "YourPublicServiceName",
- "tenantId": "dcc51777b1c64829ad496a311cab3d59",
- "area": "JPEAST",
- "operationStatus": "Processing",
- "description": "PublicService-description",
- "keyRequired": false,
- "isPublic": false,
- "enabled": true,
- "seller": {
- "companyName": "Seller-companyName",
- "serviceInquiryMail": "serviceInquiry@domain",
- "serviceInquiryPhone": "03-1234-5678",
- "customerSupportMail": "customerSupport@domain",
- "customerSupportPhone": "03-8765-4321"
}, - "connectionSpec": {
- "source": {
- "resourceType": [
- "Port",
- "Router"
]
}, - "destination": {
- "resources": [
- {
- "id": "F010123456789",
- "publicName": "XaaS-PortName01",
- "enabled": false
}, - {
- "id": "F019876543210",
- "publicName": "XaaS-PortName02",
- "enabled": false
}
], - "asn": "65530",
- "resourceType": "Port"
}, - "redundant": true,
- "bgpCostType": "med",
- "availableBandwidth": [
- "10M",
- "20M",
- "30M",
- "40M",
- "50M",
- "100M",
- "200M",
- "300M",
- "400M",
- "500M",
- "1G",
- "2G",
- "3G",
- "4G",
- "5G",
- "10G"
], - "advertisedAddresses": [ ]
}, - "operationId": "5e698fff5adb4e45ae00347771dd27a2"
}
}