Virtual Port(XaaS)【Pattern S】 - Flexible InterConnect API リファレンス (1.1.0)

Download OpenAPI specification:Download

Flexible InterConnect > Port > Virtual Port PatternS

概要

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

Virtual Port(XaaS)【Pattern S】 の購入・参照・変更・廃止等の操作に関するAPIドキュメントです。

Virtual-Port-PatternS

List Virtual Port(XaaS)【Pattern S】

Virtual Port(XaaS)【Pattern S】情報の一覧を取得します。

query Parameters
id
string ^F[0-9]{12}$
Example: id=F010123456789

VirtualPort ID

name
string
Example: name=YourVirtualPortName

VirtualPort名

area
string
Enum: "JPEAST" "JPWEST"
Example: area=JPEAST

エリア名 ‘JPEAST’または’JPWEST’

tenantId
string <uuid> ^[0-9a-f]{32}$
Example: tenantId=f0dc3a0ff7cbc4f49b7ec70ac6af57104

テナントID

serviceName
string
Example: serviceName=ecl

接続先クラウド名

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/virtual-ports-patterns
https://api.ntt.com/fic-eri/v1/virtual-ports-patterns

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "virtualPortsPatternS":
    [
    ]
}

Create Virtual Port(XaaS)【Pattern S】

Virtual Port(XaaS)【Pattern S】を購入します。

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

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

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
virtualPortPatternS
required
object

Responses

202

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

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

409

Conflict 競合エラー

post/v1/virtual-ports-patterns
https://api.ntt.com/fic-eri/v1/virtual-ports-patterns

Request samples

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

Response samples

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

Show Virtual Port(XaaS)【Pattern S】

指定したVirtual Port(XaaS)【Pattern S】の詳細情報を取得します。

path Parameters
portId
required
string
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/virtual-ports-patterns/{portId}
https://api.ntt.com/fic-eri/v1/virtual-ports-patterns/{portId}

Response samples

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

Update Virtual Port(XaaS)【Pattern S】

指定したVirtual Port(XaaS)【Pattern S】を変更します。

path Parameters
portId
required
string
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
virtualPortPatternS
required
object

Responses

202

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

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

patch/v1/virtual-ports-patterns/{portId}
https://api.ntt.com/fic-eri/v1/virtual-ports-patterns/{portId}

Request samples

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

Response samples

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

Delete Virtual Port(XaaS)【Pattern S】

指定したVirtual Port(XaaS)【Pattern S】を廃止します。ただし、コネクションで使用されている場合は廃止出来ません。

path Parameters
portId
required
string
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/virtual-ports-patterns/{portId}
https://api.ntt.com/fic-eri/v1/virtual-ports-patterns/{portId}

Response samples

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