Component-NAT - Flexible InterConnect API リファレンス (2.0.0)

Download OpenAPI specification:Download

概要

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

NAT情報の取得・変更等の操作と、アクティベート実行・ディアクティベート実行に加え、 グローバルIPアドレスセット情報の取得・購入・変更・廃止等の操作に関するAPIドキュメントです。

NAT-Component

List NATs

指定したルーターのNAT情報の一覧を取得します。

path Parameters
router_id
required
any

UUID

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

NAT ID

resourceGroup
string
Example: resourceGroup=FW01-jpeast01

故障やメンテナンスにて影響を受ける範囲毎に割り当てられたグループ

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/routers/{router_id}/nats
https://api.ntt.com/fic-eri/v1/routers/{router_id}/nats

Response samples

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

Show NAT

指定したNATの詳細情報を取得します。

path Parameters
nat_id
required
string
router_id
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/routers/{router_id}/nats/{nat_id}
https://api.ntt.com/fic-eri/v1/routers/{router_id}/nats/{nat_id}

Response samples

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

Update NAT

指定したNATを変更します。

path Parameters
nat_id
required
string
router_id
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
nat
required
object

Responses

202

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

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

put/v1/routers/{router_id}/nats/{nat_id}
https://api.ntt.com/fic-eri/v1/routers/{router_id}/nats/{nat_id}

Request samples

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

Response samples

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

Activate NAT

指定したルーターでNATのアクティベートを実行します。

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

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

path Parameters
router_id
required
any

UUID

nat_id
required
any

UUID

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

Responses

202

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

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

404

Not Found 未検出エラー

409

Conflict 競合エラー

post/v1/routers/{router_id}/nats/{nat_id}/activate
https://api.ntt.com/fic-eri/v1/routers/{router_id}/nats/{nat_id}/activate

Request samples

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

Response samples

Content type
application/json
Copy
Expand all Collapse all
{