Documentation Powered by ReDoc

IP Addresses, JPNIC Group Contacts - Super OCN Flexible Connect API リファレンス (1.1.0-BGP-1)

Download OpenAPI specification:Download

URL: https://sdpf.ntt.com/ License: (c) 2020 NTT Communications Corporation All Rights Reserved. Terms of Service

概要

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

cidrs

ユーザーに関連付けられたすべての IP アドレスに関する API カテゴリ

アドレス一覧

アドレス 一覧

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPF のテナントに一意に与えられる ID. UUID 形式

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK

get/v1/tenants/{tenantId}/cidrs
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/cidrs

Response samples

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

ocn-assigned-addresses

OCNアドレス割当 申請 API

OCNアドレス割当 申請 API

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPF のテナントに一意に与えられる ID. 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

request body

customerNote
string <= 64 characters

顧客が任意で付与できる識別子 (全角・半角・記号許容)

addressType
required
string
Value: "ocnAssigned"

アドレスの種別.

  • ocnAssigned: OCN から割り当てる PA (Provider Aggregatable) アドレス
addressFamily
required
string
Enum: "IPv4" "IPv6"

IP アドレスバージョン

requestedPrefixLength
required
integer
Enum: 29 28 27 26 25 24 48

希望するアドレス総数に合致する prefix 長. 選択肢は以下の通り:

  • IPv4: 24 - 29
  • IPv6: 48
networkPlan
Array of objects

IPv4 のネットワーク利用計画.

  • 必要なサイズに対して、サブネットごとのサイズ・利用計画を記述（サブネット分割しないなら1エントリ）
  • IPv4 利用率: OCN では「割当後3ヶ月以内に 25% 以上 かつ 割当後1年以内 50% 以上」 を基準とする (JPNIC による規定: https://www.nic.ad.jp/doc/jpnic-01212.html#2-1 に準拠)
  • IPv6: OCN ではネットワーク利用計画自体の提示を不要としている. (JPNIC による規定: https://www.nic.ad.jp/doc/jpnic-01230.html)
remarks
string <= 1024 characters

備考. ネットワーク利用計画以外に、申請の正当性を主張する任意の情報を記述することができます。 特に、アドレス空間利用およびサブネット計画の根拠を示す詳しい説明があれば、極力ご記載ください。 当社および JPNIC において何らかの疑問が生じた場合に、利用用途や必要性を理解しやすくなるため、 それだけ早期に申請が処理されることになります。

reverseDnsPrimaryServerName
string <= 255 characters ^[a-z][a-z0-9.-]+$

逆引き DNS プライマリサーバ名.

  • 逆引き管理不要の場合は記入不要
reverseDnsSecondaryServerName
string <= 255 characters ^[a-z][a-z0-9.-]+$

逆引き DNS セカンダリサーバ名.

  • 逆引き管理不要の場合は記入不要
networkName
required
string <= 12 characters ^[A-Z0-9-]+$

JPNIC Whois 登録用の ネットワーク名.

  • 'SUBA' から始まる文字列は禁止 (サブアロケーションを意味する予約語のため)
orgNameJa
required
string <= 300 characters

JPNIC Whois 登録用の IPアドレス割当申請組織名（和名）.

  • 許容文字種別: 全角半角英数記号 (JIS X 0208-1997 + ASCII)
orgNameEn
required
string <= 300 characters

JPNIC Whois 登録用の IPアドレス割当申請組織名（英名）.

  • 許容文字種別: 半角英数記号
postCode
required
string 8 characters ^[0-9]{3}-[0-9]{4}$

JPNIC Whois 登録用の IPアドレス割当申請郵便番号.

  • 半角数字, ハイフン含める.
addressLineJa
required
string <= 300 characters

IPアドレス割当申請住所（和名）.

  • 許容文字種別: 全角半角英数記号 (JIS X 0208-1997 + ASCII)
addressLineEn
required
string <= 300 characters

JPNIC Whois 登録用の IPアドレス割当申請住所（英文）.

  • 半角英数字と一部記号
adminContactId
required
string ^ox[0-9]{10}$

JPNIC 管理担当グループ情報の ID.

  • JPNIC Whois 登録用の 管理者連絡先情報 に相当
  • JPNIC が裁判するグループハンドルではなく、本サービスで採番される ID である点に注意
techContactId
required
string ^ox[0-9]{10}$

JPNIC 技術担当グループ情報の ID.

  • JPNIC Whois 登録用の 技術担当者連絡先情報 に相当
  • JPNIC が裁判するグループハンドルではなく、本サービスで採番される ID である点に注意

Responses

202

Accepted

post/v1/tenants/{tenantId}/ocn-assigned-addresses
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/ocn-assigned-addresses

Request samples

Content type
application/json
Example
ipv4slash24
Copy
 Expand all Collapse all
{
  • "customerNote": "IPv4で/24の例",
  • "addressType": "ocnAssigned",
  • "addressFamily": "IPv4",
  • "requestedPrefixLength": 24,
  • "networkPlan":
    [
    ],
  • "remarks": "(1) 申請理由\n 株式会社 XXX が新規に構築する社内ネットワークへ割り当てを行います。\n(2) 必要アドレス数: network Plan 参照\n",
  • "reverseDnsPrimaryServerName": "ns1.customer.example.com",
  • "reverseDnsSecondaryServerName": "ns2.customer.example.com",
  • "networkName": "NTT-DUMMY",
  • "orgNameJa": "ＮＴＴダミー株式会社",
  • "orgNameEn": "NTT Dummys",
  • "postCode": "100-0003",
  • "addressLineJa": "東京都千代田区大手町2-3-1 大手町プレイスウェストタワー40F",
  • "addressLineEn": "Otemachi Place West Tower 40F, 2-3-1 Otemachi, Chiyoda-ku, Tokyo",
  • "adminContactId": "ox1234567890",
  • "techContactId": "ox1234567890"
}

Response samples

Content type
application/json
Example
ipv4slash24
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "cidrId": "ox0000000000",
  • "resourceStatus": "inactive",
  • "orderId": "097d4feec2f743f0873c3280b09e75be",
  • "orderStatus": "applied",
  • "creationTime": "2019-05-21T10:05:48+09:00",
  • "updateTime": "2019-05-21T10:05:48+09:00",
  • "customerNote": "IPv4で/24の例",
  • "addressType": "ocnAssigned",
  • "addressFamily": "IPv4",
  • "requestedPrefixLength": 24,
  • "networkPlan":
    [
    ],
  • "remarks": "(1) 申請理由\n 株式会社 XXX が新規に構築する社内ネットワークへ割り当てを行います。\n(2) 必要アドレス数: network Plan 参照\n",
  • "reverseDnsPrimaryServerName": "ns1.customer.example.com",
  • "reverseDnsSecondaryServerName": "ns2.customer.example.com",
  • "networkName": "NTT-DUMMY",
  • "orgNameJa": "ＮＴＴダミー株式会社",
  • "orgNameEn": "NTT Dummys",
  • "postCode": "100-0003",
  • "addressLineJa": "東京都千代田区大手町2-3-1 大手町プレイスウェストタワー40F",
  • "addressLineEn": "Otemachi Place West Tower 40F, 2-3-1 Otemachi, Chiyoda-ku, Tokyo",
  • "adminContactId": "ox1234567890",
  • "techContactId": "ox1234567890"
}

OCN割当アドレス情報 一覧 API

OCN割当アドレス情報 一覧 API

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPF のテナントに一意に与えられる ID. UUID 形式

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK

get/v1/tenants/{tenantId}/ocn-assigned-addresses
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/ocn-assigned-addresses

Response samples

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

OCN割当アドレス情報 参照 API

OCN割当アドレス情報 参照 API

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPF のテナントに一意に与えられる ID. UUID 形式

cidrId
required
string ^ox[0-9]{10}$
Example: ox0000000000

リソースのID. 接頭辞 ox + 数字10桁

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK

get/v1/tenants/{tenantId}/ocn-assigned-addresses/{cidrId}
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/ocn-assigned-addresses/{cidrId}

Response samples

Content type
application/json
Example
ipv4slash24
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "cidrId": "ox0000000000",
  • "resourceStatus": "active",
  • "creationTime": "2019-05-21T10:05:48+09:00",
  • "updateTime": "2019-05-21T10:05:48+09:00",
  • "serviceStartDate": "2020-01-15",
  • "cidr": "203.0.113.0/24",
  • "customerNote": "IPv4で/24の例",
  • "addressType": "ocnAssigned",
  • "addressFamily": "IPv4",
  • "requestedPrefixLength": 24,
  • "networkPlan":
    [
    ],
  • "remarks": "(1) 申請理由\n 株式会社 XXX が新規に構築する社内ネットワークへ割り当てを行います。\n(2) 必要アドレス数: network Plan 参照\n",
  • "reverseDnsPrimaryServerName": "ns1.customer.example.com",
  • "reverseDnsSecondaryServerName": "ns2.customer.example.com",
  • "networkName": "NTT-DUMMY",
  • "orgNameJa": "ＮＴＴダミー株式会社",
  • "orgNameEn": "NTT Dummys",
  • "postCode": "100-0003",
  • "addressLineJa": "東京都千代田区大手町2-3-1 大手町プレイスウェストタワー40F",
  • "addressLineEn": "Otemachi Place West Tower 40F, 2-3-1 Otemachi, Chiyoda-ku, Tokyo",
  • "adminContactId": "ox1234567890",
  • "techContactId": "ox1234567890"
}

OCN割当アドレス情報 変更 API

OCN割当アドレス情報 変更 API

注意

  • 以下に挙げる項目は変更不可能（ただし変更ない値を送る分にはOK）であり、何かしらの変更が必要な場合は、新たなリソースの作成をすること。
    • 'addressType', 'addressFamily', 'requestedPrefixLength', 'networkPlan', 'remarks'
path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPF のテナントに一意に与えられる ID. UUID 形式

cidrId
required
string ^ox[0-9]{10}$
Example: ox0000000000

リソースのID. 接頭辞 ox + 数字10桁

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

request body

customerNote
string <= 64 characters

顧客が任意で付与できる識別子 (全角・半角・記号許容)

networkPlan
Array of objects

IPv4 のネットワーク利用計画.

  • 必要なサイズに対して、サブネットごとのサイズ・利用計画を記述（サブネット分割しないなら1エントリ）
  • IPv4 利用率: OCN では「割当後3ヶ月以内に 25% 以上 かつ 割当後1年以内 50% 以上」 を基準とする (JPNIC による規定: https://www.nic.ad.jp/doc/jpnic-01212.html#2-1 に準拠)
  • IPv6: OCN ではネットワーク利用計画自体の提示を不要としている. (JPNIC による規定: https://www.nic.ad.jp/doc/jpnic-01230.html)
remarks
string <= 1024 characters

備考. ネットワーク利用計画以外に、申請の正当性を主張する任意の情報を記述することができます。 特に、ネットワークトポロジや、アドレス空間利用およびサブネット計画の根拠を示す詳しい説明があれば、 当社および JPNIC において何らかの疑問点が生じたとしても、接続組織のネットワークに関する必要条件を理解しやすくなるため、 それだけ早期に申請が処理されることになります。

reverseDnsPrimaryServerName
string <= 255 characters ^[a-z][a-z0-9.-]+$

逆引き DNS プライマリサーバ名.

  • 逆引き管理不要の場合は記入不要
reverseDnsSecondaryServerName
string <= 255 characters ^[a-z][a-z0-9.-]+$

逆引き DNS セカンダリサーバ名.

  • 逆引き管理不要の場合は記入不要
networkName
string <= 12 characters ^[A-Z0-9-]+$

JPNIC Whois 登録用の ネットワーク名.

  • 'SUBA' から始まる文字列は禁止 (サブアロケーションを意味する予約語のため)
orgNameJa
string <= 300 characters

JPNIC Whois 登録用の IPアドレス割当申請組織名（和名）.

  • 許容文字種別: 全角半角英数記号 (JIS X 0208-1997 + ASCII)
orgNameEn
string <= 300 characters

JPNIC Whois 登録用の IPアドレス割当申請組織名（英名）.

  • 許容文字種別: 半角英数記号
postCode
string 8 characters ^[0-9]{3}-[0-9]{4}$

JPNIC Whois 登録用の IPアドレス割当申請郵便番号.

  • 半角数字, ハイフン含める.
addressLineJa
string <= 300 characters

IPアドレス割当申請住所（和名）.

  • 許容文字種別: 全角半角英数記号 (JIS X 0208-1997 + ASCII)
addressLineEn
string <= 300 characters

JPNIC Whois 登録用の IPアドレス割当申請住所（英文）.

  • 半角英数字と一部記号
adminContactId
string ^ox[0-9]{10}$

JPNIC 管理担当グループ情報の ID.

  • JPNIC Whois 登録用の 管理者連絡先情報 に相当
  • JPNIC が裁判するグループハンドルではなく、本サービスで採番される ID である点に注意
techContactId
string ^ox[0-9]{10}$

JPNIC 技術担当グループ情報の ID.

  • JPNIC Whois 登録用の 技術担当者連絡先情報 に相当
  • JPNIC が裁判するグループハンドルではなく、本サービスで採番される ID である点に注意

Responses

202

Accepted

put/v1/tenants/{tenantId}/ocn-assigned-addresses/{cidrId}
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/ocn-assigned-addresses/{cidrId}

Request samples

Content type
application/json
Example
update-ipv4-network-plan
Copy
 Expand all Collapse all
{
  • "networkPlan":
    [
    ],
  • "remarks": "(1) 申請理由\n 株式会社 XXX が新規に構築する社内ネットワークへ割り当てを行います。\n(2) 必要アドレス数: network Plan 参照\n"
}

Response samples

Content type
application/json
Example
update-ipv4-network-plan
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "cidrId": "ox0000000000",
  • "resourceStatus": "active",
  • "orderId": "097d4feec2f743f0873c3280b09e75be",
  • "orderStatus": "applied",
  • "creationTime": "2019-05-21T10:05:48+09:00",
  • "updateTime": "2019-05-21T10:05:48+09:00",
  • "customerNote": "IPv4で/24の例",
  • "addressType": "ocnAssigned",
  • "addressFamily": "IPv4",
  • "requestedPrefixLength": 24,
  • "networkPlan":
    [
    ],
  • "remarks": "(1) 申請理由\n 株式会社 XXX が新規に構築する社内ネットワークへ割り当てを行います。\n(2) 必要アドレス数: network Plan 参照\n",
  • "reverseDnsPrimaryServerName": "ns1.customer.example.com",
  • "reverseDnsSecondaryServerName": "ns2.customer.example.com",
  • "networkName": "NTT-DUMMY",
  • "orgNameJa": "ＮＴＴダミー株式会社",
  • "orgNameEn": "NTT Dummys",
  • "postCode": "100-0003",
  • "addressLineJa": "東京都千代田区大手町2-3-1 大手町プレイスウェストタワー40F",
  • "addressLineEn": "Otemachi Place West Tower 40F, 2-3-1 Otemachi, Chiyoda-ku, Tokyo",
  • "adminContactId": "ox1234567890",
  • "techContactId": "ox1234567890"
}

OCN割当アドレス 返却 API

OCN割当アドレス 返却 API

注意

  • JPNIC の仕様: 利用中の担当グループ情報が IPアドレス返却などを契機に Whois で参照されなくなると、JPNICにて自動で当該の担当グループ情報が無効化される (参考: https://www.nic.ad.jp/ja/ip/application-procedure/handle-accesscontrol/)
  • 当サービスでもそれに準ずる形で担当グループ情報リソースの自動廃止が行われる。 つまり、IPアドレスリソース削除申込を受け付けた際に、参照が完全になくなると判断される担当グループ情報リソースの削除を自動で行う。
  • IPアドレスリソース削除申込を契機とした担当グループ情報リソースの自動削除は取り消しができない点も注意が必要。
path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPF のテナントに一意に与えられる ID. UUID 形式

cidrId
required
string ^ox[0-9]{10}$
Example: ox0000000000

リソースのID. 接頭辞 ox + 数字10桁

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Responses

202

Accepted

delete/v1/tenants/{tenantId}/ocn-assigned-addresses/{cidrId}
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/ocn-assigned-addresses/{cidrId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "cidrId": "ox0000000000",
  • "resourceStatus": "active",
  • "orderId": "097d4feec2f743f0873c3280b09e75be",
  • "orderStatus": "applied",
  • "creationTime": "2019-05-21T10:05:48+09:00",
  • "updateTime": "2019-05-21T10:05:48+09:00",
  • "customerNote": "IPv4で/24の例",
  • "addressType": "ocnAssigned",
  • "addressFamily": "IPv4",
  • "requestedPrefixLength": 24,
  • "networkPlan":
    [
    ],
  • "remarks": "(1) 申請理由\n 株式会社 XXX が新規に構築する社内ネットワークへ割り当てを行います。\n(2) 必要アドレス数: network Plan 参照\n",
  • "reverseDnsPrimaryServerName": "ns1.customer.example.com",
  • "reverseDnsSecondaryServerName": "ns2.customer.example.com",
  • "networkName": "NTT-DUMMY",
  • "orgNameJa": "ＮＴＴダミー株式会社",
  • "orgNameEn": "NTT Dummys",
  • "postCode": "100-0003",
  • "addressLineJa": "東京都千代田区大手町2-3-1 大手町プレイスウェストタワー40F",
  • "addressLineEn": "Otemachi Place West Tower 40F, 2-3-1 Otemachi, Chiyoda-ku, Tokyo",
  • "adminContactId": "ox1234567890",
  • "techContactId": "ox1234567890"
}

ocn-assigned-addresses-orders

申込履歴情報を一覧参照する API

申込履歴情報を一覧参照する API

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPF のテナントに一意に与えられる ID. UUID 形式

cidrId
required
string ^ox[0-9]{10}$
Example: ox0000000000

リソースのID. 接頭辞 ox + 数字10桁

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK

get/v1/tenants/{tenantId}/ocn-assigned-addresses/{cidrId}/orders
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/ocn-assigned-addresses/{cidrId}/orders

Response samples

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

指定の申込履歴情報を参照する API

指定の申込履歴情報を参照する API

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPF のテナントに一意に与えられる ID. UUID 形式

cidrId
required
string ^ox[0-9]{10}$
Example: ox0000000000

リソースのID. 接頭辞 ox + 数字10桁

orderId
required
string ^[0-9a-f]{32}$
Example: 62ec2b62646740b5809f695dea7b2bbf

関連するオーダーのID. orderStatus と同じ条件で対象のオーダーが引用される

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK

get/v1/tenants/{tenantId}/ocn-assigned-addresses/{cidrId}/orders/{orderId}
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/ocn-assigned-addresses/{cidrId}/orders/{orderId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

申込内容に変更を加える API

申込内容に変更を加える API.

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPF のテナントに一意に与えられる ID. UUID 形式

cidrId
required
string ^ox[0-9]{10}$
Example: ox0000000000

リソースのID. 接頭辞 ox + 数字10桁

orderId
required
string ^[0-9a-f]{32}$
Example: 62ec2b62646740b5809f695dea7b2bbf

関連するオーダーのID. orderStatus と同じ条件で対象のオーダーが引用される

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

request body

Responses

202

Accepted

put/v1/tenants/{tenantId}/ocn-assigned-addresses/{cidrId}/orders/{orderId}
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/ocn-assigned-addresses/{cidrId}/orders/{orderId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

指定の申込を取り消す API

指定の申込を取り消す API

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPF のテナントに一意に与えられる ID. UUID 形式

cidrId
required
string ^ox[0-9]{10}$
Example: ox0000000000

リソースのID. 接頭辞 ox + 数字10桁

orderId
required
string ^[0-9a-f]{32}$
Example: 62ec2b62646740b5809f695dea7b2bbf

関連するオーダーのID. orderStatus と同じ条件で対象のオーダーが引用される

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Responses

202

Accepted

delete/v1/tenants/{tenantId}/ocn-assigned-addresses/{cidrId}/orders/{orderId}
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/ocn-assigned-addresses/{cidrId}/orders/{orderId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

jpnic-group-contacts

jpnic-group-contacts 申請に関する API カテゴリ

JPNIC担当グループ情報 登録 API

JPNICに登録される担当グループ情報の 登録 API. IPv4, IPv6 アドレス両方の割当を受ける場合, 最低2つの担当グループ情報の登録が必要となる. (JPNIC の仕様により Whois 登録では共用できないため)

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPF のテナントに一意に与えられる ID. 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

request body

customerNote
string <= 64 characters

顧客が任意で付与できる識別子 (全角・半角・記号許容)

groupNameJa
required
string <= 300 characters

担当グループ名 (和名).

  • 許容文字種別: 全角半角英数記号 (JIS X 0208-1997 + ASCII)
groupNameEn
required
string <= 300 characters

担当グループ名 (英文).

  • 半角英数字と一部記号.
email
required
string <= 255 characters

連絡先メールアドレス.

  • root@ で始まるものは不可
orgNameJa
required
string <= 300 characters

IPアドレス割当申請組織名（和名）.

  • 許容文字種別: 全角半角英数記号 (JIS X 0208-1997 + ASCII)
orgNameEn
required
string <= 300 characters

IPアドレス割当申請組織名（英名）.

  • 許容文字種別: 半角英数記号
postCode
required
string 8 characters ^[0-9]{3}-[0-9]{4}$

IPアドレス割当申請郵便番号.

  • 半角数字, ハイフン含める.
addressLineJa
required
string <= 300 characters

IPアドレス割当申請住所（和名）.

  • 許容文字種別: 全角半角英数記号 (JIS X 0208-1997 + ASCII)
addressLineEn
required
string <= 300 characters

IPアドレス割当申請住所（英文）.

  • 半角英数字と一部記号
divisionJa
string <= 300 characters

部署名 (和名).

  • 許容文字種別: 全角半角英数記号 (JIS X 0208-1997 + ASCII)
divisionEn
string <= 300 characters

部署名 (英名).

telephone
required
string <= 11 characters

電話番号

addressFamily
required
string
Enum: "IPv4" "IPv6"

IPアドレスのバージョン. IPv4, IPv6 アドレス間で連絡先を共用できないため区別が必要

Responses

202

Accepted

post/v1/tenants/{tenantId}/jpnic-group-contacts
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/jpnic-group-contacts

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "customerNote": "XXXチーム",
  • "groupNameJa": "エヌティティダミー",
  • "groupNameEn": "NTT Dummy",
  • "email": "user@example.jp",
  • "orgNameJa": "ＮＴＴダミー株式会社",
  • "orgNameEn": "NTT Dummys",
  • "postCode": "100-0003",
  • "addressLineJa": "東京都千代田区大手町2-3-1 大手町プレイスウェストタワー40F",
  • "addressLineEn": "Otemachi Place West Tower 35F, 2-3-1 Otemachi, Chiyoda-ku, Tokyo",
  • "divisionJa": "ネットワーク部",
  • "divisionEn": "Network Division",
  • "telephone": "05012345678",
  • "addressFamily": "IPv4"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "jpnicGroupContactId": "ox0000000000",
  • "resourceStatus": "inactive",
  • "orderId": "097d4feec2f743f0873c3280b09e75be",
  • "orderStatus": "applied",
  • "creationTime": "2019-05-21T10:05:48+09:00",
  • "updateTime": "2019-05-21T10:05:48+09:00",
  • "customerNote": "XXXチーム",
  • "groupNameJa": "エヌティティダミー",
  • "groupNameEn": "NTT Dummy",
  • "email": "user@example.jp",
  • "orgNameJa": "ＮＴＴダミー株式会社",
  • "orgNameEn": "NTT Dummys",
  • "postCode": "100-0003",
  • "addressLineJa": "東京都千代田区大手町2-3-1 大手町プレイスウェストタワー40F",
  • "addressLineEn": "Otemachi Place West Tower 35F, 2-3-1 Otemachi, Chiyoda-ku, Tokyo",
  • "divisionJa": "ネットワーク部",
  • "divisionEn": "Network Division",
  • "telephone": "05012345678"
}

JPNIC担当グループ情報 一覧 API

JPNICに登録される担当グループ情報の 一覧 API

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPF のテナントに一意に与えられる ID. UUID 形式

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Responses

200

Accepted

get/v1/tenants/{tenantId}/jpnic-group-contacts
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/jpnic-group-contacts

Response samples

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

JPNIC担当グループ情報 参照 API

JPNICに登録される担当グループ情報の 参照 API

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPF のテナントに一意に与えられる ID. UUID 形式

jpnicGroupContactId
required
string ^ox[0-9]{10}$
Example: ox0000000000

リソースのID. 接頭辞 ox + 数字10桁

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK

get/v1/tenants/{tenantId}/jpnic-group-contacts/{jpnicGroupContactId}
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/jpnic-group-contacts/{jpnicGroupContactId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "jpnicGroupContactId": "ox0000000000",
  • "resourceStatus": "active",
  • "creationTime": "2019-05-21T10:05:48+09:00",
  • "updateTime": "2019-05-21T10:05:48+09:00",
  • "serviceStartDate": "2020-01-15",
  • "jpnicGroupHandle": "JP00011523",
  • "customerNote": "XXXチーム",
  • "groupNameJa": "エヌティティダミー",
  • "groupNameEn": "NTT Dummy",
  • "email": "user@example.jp",
  • "orgNameJa": "ＮＴＴダミー株式会社",
  • "orgNameEn": "NTT Dummys",
  • "postCode": "100-0003",
  • "addressLineJa": "東京都千代田区大手町2-3-1 大手町プレイスウェストタワー40F",
  • "addressLineEn": "Otemachi Place West Tower 35F, 2-3-1 Otemachi, Chiyoda-ku, Tokyo",
  • "divisionJa": "ネットワーク部",
  • "divisionEn": "Network Division",
  • "telephone": "05012345678",
  • "addressFamily": "IPv4"
}

JPNIC担当グループ情報 変更 API

JPNIC担当グループ情報 変更 API

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPF のテナントに一意に与えられる ID. UUID 形式

jpnicGroupContactId
required
string ^ox[0-9]{10}$
Example: ox0000000000

リソースのID. 接頭辞 ox + 数字10桁

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

request body

customerNote
string <= 64 characters

顧客が任意で付与できる識別子 (全角・半角・記号許容)

groupNameJa
string <= 300 characters

担当グループ名 (和名).

  • 許容文字種別: 全角半角英数記号 (JIS X 0208-1997 + ASCII)
groupNameEn
string <= 300 characters

担当グループ名 (英文).

  • 半角英数字と一部記号.
email
string <= 255 characters

連絡先メールアドレス.

  • root@ で始まるものは不可
orgNameJa
string <= 300 characters

IPアドレス割当申請組織名（和名）.

  • 許容文字種別: 全角半角英数記号 (JIS X 0208-1997 + ASCII)
orgNameEn
string <= 300 characters

IPアドレス割当申請組織名（英名）.

  • 許容文字種別: 半角英数記号
postCode
string 8 characters ^[0-9]{3}-[0-9]{4}$

IPアドレス割当申請郵便番号.

  • 半角数字, ハイフン含める.
addressLineJa
string <= 300 characters

IPアドレス割当申請住所（和名）.

  • 許容文字種別: 全角半角英数記号 (JIS X 0208-1997 + ASCII)
addressLineEn
string <= 300 characters

IPアドレス割当申請住所（英文）.

  • 半角英数字と一部記号
divisionJa
string <= 300 characters

部署名 (和名).

  • 許容文字種別: 全角半角英数記号 (JIS X 0208-1997 + ASCII)
divisionEn
string <= 300 characters

部署名 (英名).

telephone
string <= 11 characters

電話番号

Responses

202

OK

put/v1/tenants/{tenantId}/jpnic-group-contacts/{jpnicGroupContactId}
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/jpnic-group-contacts/{jpnicGroupContactId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "customerNote": "project-A 用のリソース",
  • "groupNameJa": "オープンコンピュータネットワーク",
  • "groupNameEn": "Open Computer Network",
  • "email": "user@example.jp",
  • "orgNameJa": "ＮＴＴコミュニケーションズ株式会社",
  • "orgNameEn": "NTT Communications",
  • "postCode": "100-0003",
  • "addressLineJa": "東京都千代田区大手町2-3-1 大手町プレイスウェストタワー35F",
  • "addressLineEn": "Otemachi Place West Tower 35F, 2-3-1 Otemachi, Chiyoda-ku, Tokyo",
  • "divisionJa": "ネットワーク部",
  • "divisionEn": "Network Division",
  • "telephone": "05012345678"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "jpnicGroupContactId": "ox0000000000",
  • "resourceStatus": "inactive",
  • "orderId": "62ec2b62646740b5809f695dea7b2bbf",
  • "orderStatus": "applied",
  • "creationTime": "2019-05-21T10:05:48+09:00",
  • "updateTime": "2019-05-21T10:05:48+09:00",
  • "serviceStartDate": "2020-01-15",
  • "jpnicGroupHandle": "JP00011523",
  • "customerNote": "project-A 用のリソース",
  • "groupNameJa": "オープンコンピュータネットワーク",
  • "groupNameEn": "Open Computer Network",
  • "email": "user@example.jp",
  • "orgNameJa": "ＮＴＴコミュニケーションズ株式会社",
  • "orgNameEn": "NTT Communications",
  • "postCode": "100-0003",
  • "addressLineJa": "東京都千代田区大手町2-3-1 大手町プレイスウェストタワー35F",
  • "addressLineEn": "Otemachi Place West Tower 35F, 2-3-1 Otemachi, Chiyoda-ku, Tokyo",
  • "divisionJa": "ネットワーク部",
  • "divisionEn": "Network Division",
  • "telephone": "05012345678",
  • "addressFamily": "IPv4"
}

JPNIC担当グループ情報 削除 API

JPNICに登録される担当グループ情報の 削除 API.

注意

  • JPNIC の仕様: 利用中の担当グループ情報が IPアドレス返却などを契機に Whois で参照されなくなると、JPNICにて自動で当該の担当グループ情報が無効化される (参考: https://www.nic.ad.jp/ja/ip/application-procedure/handle-accesscontrol/)
  • 当サービスでもそれに準ずる形で担当グループ情報リソースの自動廃止が行われる。 つまり、IPアドレスリソース削除申込を受け付けた際に、参照が完全になくなると判断される担当グループ情報リソースの削除を自動で行う。
  • IPアドレスリソース削除申込を契機とした担当グループ情報リソースの自動削除は取り消しができない点も注意が必要。
path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPF のテナントに一意に与えられる ID. UUID 形式

jpnicGroupContactId
required
string ^ox[0-9]{10}$
Example: ox0000000000

リソースのID. 接頭辞 ox + 数字10桁

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Responses

202

Accepted

delete/v1/tenants/{tenantId}/jpnic-group-contacts/{jpnicGroupContactId}
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/jpnic-group-contacts/{jpnicGroupContactId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tenantId": "550e8400e29b41d4a716446655440000",
  • "jpnicGroupContactId": "ox0000000000",
  • "resourceStatus": "inactive",
  • "orderId": "62ec2b62646740b5809f695dea7b2bbf",
  • "orderStatus": "applied",
  • "creationTime": "2019-05-21T10:05:48+09:00",
  • "updateTime": "2019-05-21T10:05:48+09:00",
  • "serviceStartDate": "2020-01-15",
  • "jpnicGroupHandle": "JP00011523",
  • "customerNote": "project-A 用のリソース",
  • "groupNameJa": "オープンコンピュータネットワーク",
  • "groupNameEn": "Open Computer Network",
  • "email": "user@example.jp",
  • "orgNameJa": "ＮＴＴコミュニケーションズ株式会社",
  • "orgNameEn": "NTT Communications",
  • "postCode": "100-0003",
  • "addressLineJa": "東京都千代田区大手町2-3-1 大手町プレイスウェストタワー35F",
  • "addressLineEn": "Otemachi Place West Tower 35F, 2-3-1 Otemachi, Chiyoda-ku, Tokyo",
  • "divisionJa": "ネットワーク部",
  • "divisionEn": "Network Division",
  • "telephone": "05012345678",
  • "addressFamily": "IPv4"
}

jpnic-group-contacts-orders

申込履歴情報を一覧参照する API

申込履歴情報を一覧参照する API

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPF のテナントに一意に与えられる ID. UUID 形式

jpnicGroupContactId
required
string ^ox[0-9]{10}$
Example: ox0000000000

リソースのID. 接頭辞 ox + 数字10桁

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK

get/v1/tenants/{tenantId}/jpnic-group-contacts/{jpnicGroupContactId}/orders
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/jpnic-group-contacts/{jpnicGroupContactId}/orders

Response samples

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

指定の申込履歴情報を参照する API

指定の申込履歴情報を参照する API

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPF のテナントに一意に与えられる ID. UUID 形式

jpnicGroupContactId
required
string ^ox[0-9]{10}$
Example: ox0000000000

リソースのID. 接頭辞 ox + 数字10桁

orderId
required
string ^[0-9a-f]{32}$
Example: 62ec2b62646740b5809f695dea7b2bbf

関連するオーダーのID. orderStatus と同じ条件で対象のオーダーが引用される

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK

get/v1/tenants/{tenantId}/jpnic-group-contacts/{jpnicGroupContactId}/orders/{orderId}
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/jpnic-group-contacts/{jpnicGroupContactId}/orders/{orderId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

申込内容に変更を加える API

申込内容に変更を加える API

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPF のテナントに一意に与えられる ID. UUID 形式

jpnicGroupContactId
required
string ^ox[0-9]{10}$
Example: ox0000000000

リソースのID. 接頭辞 ox + 数字10桁

orderId
required
string ^[0-9a-f]{32}$
Example: 62ec2b62646740b5809f695dea7b2bbf

関連するオーダーのID. orderStatus と同じ条件で対象のオーダーが引用される

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

request body

Responses

202

Accepted

put/v1/tenants/{tenantId}/jpnic-group-contacts/{jpnicGroupContactId}/orders/{orderId}
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/jpnic-group-contacts/{jpnicGroupContactId}/orders/{orderId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

指定の申込を取り消す API

指定の申込を取り消す API

path Parameters
tenantId
required
string ^[0-9a-f]{32}$
Example: 550e8400e29b41d4a716446655440000

SDPF のテナントに一意に与えられる ID. UUID 形式

jpnicGroupContactId
required
string ^ox[0-9]{10}$
Example: ox0000000000

リソースのID. 接頭辞 ox + 数字10桁

orderId
required
string ^[0-9a-f]{32}$
Example: 62ec2b62646740b5809f695dea7b2bbf

関連するオーダーのID. orderStatus と同じ条件で対象のオーダーが引用される

header Parameters
X-Auth-Token
required
string ^[0-9a-f]{32}$
Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Responses

202

Accepted

delete/v1/tenants/{tenantId}/jpnic-group-contacts/{jpnicGroupContactId}/orders/{orderId}
http://api.ntt.com/ocnx-transit/v1/tenants/{tenantId}/jpnic-group-contacts/{jpnicGroupContactId}/orders/{orderId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

orders

申込履歴に関する API カテゴリ