List subnets#

サブネットを一覧表示します。

APIエンドポイント#

リージョン APIエンドポイント
西日本リージョン3の場合 https://networking.jp-west-3.cloud.global.fujitsu.com
東日本リージョン3の場合 https://networking.jp-east-3.cloud.global.fujitsu.com

HTTPメソッドとURI#

GET

/v2.0/subnets

HTTPステータスコード#

正常時:200

エラー時:401

リクエストパラメータの説明#

名前 In Type デフォルト値
/必須指定
Description
fields query string 任意 属性を指定します。
省略した場合は、すべての属性が表示されます。
複数指定ができます。
例えば、「fields=id&fields=name」を指定すると、「id」と「name」の属性だけが表示されます。
id query string 任意 リソースのIDで結果を絞り込みます。
tenant_id query string 任意 リソースの所有者のプロジェクトIDで結果を絞り込みます。
project_id query string 任意 リソースの所有者のプロジェクトIDで結果を絞り込みます。
name query string 任意 リソース名で結果を絞り込みます。
enable_dhcp query boolean 任意 DHCPの有効/無効で結果を絞り込みます。
network_id query string 任意 リソースが所属するネットワークのIDで結果を絞り込みます。
ip_version query integer 任意 IPバージョンで結果を絞り込みます。4または6を指定します。
gateway_ip query string 任意 ゲートウェイIPアドレスで結果を絞り込みます。
cidr query string 任意 リソースのCIDRで結果を絞り込みます。
description query string 任意 リソースの説明で結果を絞り込みます。
revision_number query integer 任意 リソースの改訂番号で結果を絞り込みます。
segment_id query string 任意 関連付けられているセグメントのIDで結果を絞り込みます。
subnetpool_id query string 任意 関連付けられているサブネットプールのIDで結果を絞り込みます。
tags query string 任意 タグで結果を絞り込みます。コンマで区切ります。
tags-any query string 任意 タグで結果を絞り込みます。コンマで区切ります。タグが1つでも一致する場合は、該当のリソースは返却されます。
not-tags query string 任意 タグで結果を絞り込みます。コンマで区切ります。タグがすべて一致する場合は、該当のリソースは返却されません。
not-tags-any query string 任意 タグで結果を絞り込みます。コンマで区切ります。タグが1つでも一致する場合は、該当のリソースは返却されません。
fields query string 任意 属性を指定します。
省略した場合は、すべての属性が表示されます。
複数指定ができます。
例えば、「fields=id&fields=name」と指定すると、「id」と「name」の属性だけが表示されます。

レスポンスボディ(正常系)の説明#

名前 Type Description
subnets array サブネットのオブジェクト
id string サブネットのID
tenant_id string プロジェクトのID
project_id string プロジェクトのID
name string リソース名
enable_dhcp boolean DHCPの有効/無効
network_id string リソースが所属するネットワークのID
dns_nameservers array サブネット用DNSネームサーバの一覧
例: ["8.8.8.7", "8.8.8.8"]
指定したIPアドレスは昇順にソートされた状態で表示されます。最後に表示されているIPアドレスがプライマリDNSアドレスです。
allocation_pools array 割り当てプールの開始アドレスと終了アドレス
host_routes array サブネット用のホストルート情報
destination string 宛先のCIDR
nexthop string 宛先に到達するために次に転送すべき隣接するIPアドレス
仮想ルータが接続しているサブネットに存在する必要があります。
ip_version integer IPバージョン
4が表示されます。
gateway_ip string ゲートウェイのIPアドレス
「null」の場合は、ゲートウェイが関連付けられていません。
cidr string サブネットのCIDR
created_at string サブネットの作成日時
description string リソースの説明
ipv6_address_mode string IPv6のアドレスの割り当て方法
ipv6_ra_mode string IPv6パケットを転送するかどうかを決定する基準
revision_number integer リソースの改訂番号
segment_id string 関連付けられているセグメントのID
service_types array 関連付けられているサービスのタイプ
subnetpool_id string 関連付けられているサブネットプールのID
updated_at string サブネットの更新日時

レスポンス例#

{
    "subnets": [
        {
            "name": "private-subnet",
            "enable_dhcp": true,
            "network_id": "db193ab3-96e3-4cb3-8fc5-05f4296d0324",
            "segment_id": null,
            "project_id": "26a7980765d0414dbc1fc1f88cdb7e6e",
            "tenant_id": "26a7980765d0414dbc1fc1f88cdb7e6e",
            "dns_nameservers": [],
            "allocation_pools": [
                {
                    "start": "10.0.0.2",
                    "end": "10.0.0.254"
                }
            ],
            "host_routes": [],
            "ip_version": 4,
            "gateway_ip": "10.0.0.1",
            "cidr": "10.0.0.0/24",
            "id": "08eae331-0402-425a-923c-34f7cfe39c1b",
            "created_at": "2016-10-10T14:35:34Z",
            "description": "",
            "ipv6_address_mode": null,
            "ipv6_ra_mode": null,
            "revision_number": 2,
            "service_types": [],
            "subnetpool_id": null,
            "updated_at": "2016-10-10T14:35:34Z"
        },
        {
            "name": "my_subnet",
            "enable_dhcp": true,
            "network_id": "d32019d3-bc6e-4319-9c1d-6722fc136a22",
            "segment_id": null,
            "project_id": "4fd44f30292945e481c7b8a0c8908869",
            "tenant_id": "4fd44f30292945e481c7b8a0c8908869",
            "dns_nameservers": [],
            "allocation_pools": [
                {
                    "start": "192.0.0.2",
                    "end": "192.255.255.254"
                }
            ],
            "host_routes": [],
            "ip_version": 4,
            "gateway_ip": "192.0.0.1",
            "cidr": "192.0.0.0/8",
            "id": "54d6f61d-db07-451c-9ab3-b9609b6b6f0b",
            "created_at": "2016-10-10T14:35:47Z",
            "description": "",
            "ipv6_address_mode": null,
            "ipv6_ra_mode": null,
            "revision_number": 2,
            "service_types": [],
            "subnetpool_id": null,
            "updated_at": "2016-10-10T14:35:47Z"
        }
    ]
}