FIC-Connection Super OCN Flexible Connect- Flexible InterConnect API リファレンス (2.0.0)

Download OpenAPI specification:Download

Flexible InterConnect

概要

本APIでは、Flexible InterConnectが提供するリソースの参照・操作が可能です。

Port to Super OCN Flexible Connectコネクションの購入・参照・変更・廃止等の操作に関するAPIドキュメントです。

Port-to-Super OCN Flexible Connect-Connection

List Port to Super OCN Flexible Connect Connections

Port to Super OCN Flexible Connectコネクション情報の一覧を取得します。

query Parameters

id	string ^F[0-9]{12}$ Example: id=F032000003659 コネクションID
name	string Example: name=YourConnectionName コネクション名
tenantId	string <uuid> ^[0-9a-f]{32}$ Example: tenantId=df6ff01b975f44359fd1124093f3ca27 テナントID
area	string Enum: "JPEAST" "JPWEST" Example: area=JPEAST エリア名 ‘JPEAST’または’JPWEST’
operationsStatus	string Enum: "Processing" "Completed" "Cancelled" Example: operationsStatus=Completed 処理ステータス ‘Processing/Completed/Cancelled’のいずれか
bandwidth	string Enum: "10M" "20M" "30M" "40M" "50M" "100M" "200M" "300M" "400M" "500M" "1G" "2G" "3G" "4G" "5G" "10G" Example: bandwidth=1G 接続帯域 ‘10M/20M/30M/40M/50M/100M/200M/300M/400M/500M/1G/2G/3G/4G/5G/10G’のいずれか

header Parameters

Content-Type required	string Value: "application/json"
X-Auth-Token required	string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK 成功しました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

409

Conflict 競合エラー

get/v1/port-to-ocnx-connections

https://api.ntt.com/fic-eri/v1/port-to-ocnx-connections

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"connections": 
[
{"id": "F032000003659",
"name": "YourConnectionName",
"redundant": false,
"area": "JPEAST",
"tenantId": "df6ff01b975f44359fd1124093f3ca27",
"operationStatus": "Processing",
"bandwidth": "100M",
"source": 
{"portId": "F012000000810",
"vlan": 113
},
"destination": 
{"interconnect": "tyo-a-01",
"qosType": "guarantee",
"ocnxResourceId": "cx00012345",
"ocnxTenantId": "df6ff01b975f44359fd1124093f3ca27"
}
}
]
}

Create Port to Super OCN Flexible Connect Connection

始点ポートおよび終点Super OCNを指定し、Port to Super OCN Flexible Connectコネクションを購入します。

サービス概要や、注意事項等の詳細情報に関しましてはこちらをご参照下さい。

事前にお客さまにご準備いただくものや、画面での操作に関しましてはこちらをご参照下さい。

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

connection

required

object

Responses

202

Accepted　要求は受け付けられました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

409

Conflict 競合エラー

post/v1/port-to-ocnx-connections

https://api.ntt.com/fic-eri/v1/port-to-ocnx-connections

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"name": "YourConnectionName",
"tenantId": "df6ff01b975f44359fd1124093f3ca27",
"source": 
{"portId": "F012000000810",
"vlan": 1041
},
"destination": 
{"interconnect": "tyo-a-01",
"qosType": "guarantee",
"ocnxTenantId": "df6ff01b975f44359fd1124093f3ca27",
"ocnxApiKey": "HYFazD19vifMMx2DcwNScwdroUzO63pN",
"ocnxApiSecretKey": "b2jvfsskp1IaAQpX"
},
"bandwidth": "100M"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"id": "F032000003659",
"name": "YourConnectionName",
"redundant": false,
"tenantId": "df6ff01b975f44359fd1124093f3ca27",
"area": "JPEAST",
"operationStatus": "Processing",
"bandwidth": "100M",
"source": 
{"portId": "F012000000810",
"vlan": 113
},
"destination": 
{"interconnect": "tyo-a-01",
"qosType": "guarantee",
"ocnxResourceId": "ox0000000225",
"ocnxTenantId": "df6ff01b975f44359fd1124093f3ca27"
},
"operationId": "415b294f8f7d480ebd0fcf4cc31c864c"
}
}

Show Port to Ocnx Connection

指定したPort to Super OCN Flexible Connectコネクションの詳細情報を取得します。

path Parameters

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

200

OK 成功しました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

get/v1/port-to-ocnx-connections/{id}

https://api.ntt.com/fic-eri/v1/port-to-ocnx-connections/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"id": "F032000003659",
"name": "YourConnectionName",
"redundant": false,
"tenantId": "df6ff01b975f44359fd1124093f3ca27",
"area": "JPEAST",
"operationStatus": "Processing",
"bandwidth": "100M",
"source": 
{"portId": "F012000000810",
"vlan": 113
},
"destination": 
{"interconnect": "tyo-a-01",
"qosType": "guarantee",
"ocnxResourceId": null,
"ocnxTenantId": "df6ff01b975f44359fd1124093f3ca27"
}
}
}

Update Port to Super OCN Flexible Connect Connection

指定したPort to Super OCN Flexible Connectコネクションを変更します。各種変更操作は同時実行できます。

path Parameters

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

connection

required

object

Responses

202

Accepted 要求は受け付けられました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

patch/v1/port-to-ocnx-connections/{id}

https://api.ntt.com/fic-eri/v1/port-to-ocnx-connections/{id}

Request samples

Payload

Content type

application/json

Example

Copy

Expand all Collapse all


{"connection": 
{"bandwidth": "200M"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"id": "F032000003659",
"name": "YourConnectionNam",
"redundant": false,
"tenantId": "df6ff01b975f44359fd1124093f3ca27",
"area": "JPEAST",
"operationStatus": "Processing",
"bandwidth": "100M",
"source": 
{"portId": "F012000000810",
"vlan": 113
},
"destination": 
{"interconnect": "tyo-a-01",
"qosType": "guarantee",
"ocnxResourceId": "ox0000000225",
"ocnxTenantId": "df6ff01b975f44359fd1124093f3ca27"
},
"operationId": "af9877d0fd8044b184b809e50d0cc44e"
}
}

Delete Port to Super OCN Flexible Connect Connection

指定したPort to Super OCN Flexible Connectコネクションを廃止します。

path Parameters

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

202

Accepted 要求は受け付けられました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

delete/v1/port-to-ocnx-connections/{id}

https://api.ntt.com/fic-eri/v1/port-to-ocnx-connections/{id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"connection": 
{"id": "F032000003659",
"name": "YourConnectionName",
"redundant": false,
"tenantId": "df6ff01b975f44359fd1124093f3ca27",
"area": "JPEAST",
"operationStatus": "Processing",
"bandwidth": "100M",
"source": 
{"portId": "F012000000810",
"vlan": 113
},
"destination": 
{"interconnect": "tyo-a-01",
"qosType": "guarantee",
"ocnxResourceId": null,
"ocnxTenantId": "df6ff01b975f44359fd1124093f3ca27"
},
"operationId": "7ca58fc55555416e9ed24468d6e63a0a"
}
}