List subnet pools#

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

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/subnetpools

HTTPステータスコード#

正常時:200

エラー時:401

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

名前 In Type デフォルト値
/必須指定
Description
fields query string 任意 属性を指定します。
省略した場合は、すべての属性が表示されます。
複数指定ができます。
例えば、「fields=id&fields=name」を指定すると、「id」と「name」の属性だけが表示されます。

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

名前 Type Description
subnetpools array subnetpoolオブジェクトのリスト
id string サブネットのID
name string リソース名
default_quota integer サブネットプールからプロジェクトのサブネットに適用される、割り当て可能なプレフィックススペースを定義するクォータ
デフォルトでは、クォータは適用されません。
default_quotaの単位は 「/32」です。プレフィックスクォータはサブネットを利用する全プロジェクトに適用されます。
tenant_id string プロジェクトのID
project_id string プロジェクトのID
created_at string リソースの作成日時
updated_at string ポートの更新日時
prefixes array サブネットプールに割り当てられるプレフィックスのリスト
APIは隣接するプレフィックスをマージして、1つのプレフィックスとして扱います。同じアドレス範囲に関わるサブネットプールの中で、各サブネットプレフィックスは一意である必要があります。
min_prefixlen integer サブネットプールが割り当てられる最短のプレフィックス長
address_scope_id string サブネットプールに割り当てるアドレス範囲
ip_version integer IPバージョン
shared boolean 管理者だけ参照可能
ネットワークは全プロジェクト間で共有されているかどうかを表現します。
default_prefixlen integer サブネット作成時にcidrまたはprefixlenの属性を省略した場合のプレフィックス長
デフォルトはmin_prefixlenの値です。
max_prefixlen integer サブネットプールが割り当てられる最長のプレフィックス長
description string リソースの説明
is_default boolean デフォルトのサブネットプールが使われているかどうかを表示します。
revision_number integer リソースの改訂番号

レスポンス例#

{
    "subnetpools": [
        {
            "min_prefixlen": "64",
            "address_scope_id": null,
            "default_prefixlen": "64",
            "id": "03f761e6-eee0-43fc-a921-8acf64c14988",
            "max_prefixlen": "64",
            "name": "my-subnet-pool-ipv6",
            "default_quota": null,
            "is_default": false,
            "project_id": "9fadcee8aa7c40cdb2114fff7d569c08",
            "tenant_id": "9fadcee8aa7c40cdb2114fff7d569c08",
            "prefixes": [
                "2001:db8:0:2::/64",
                "2001:db8::/63"
            ],
            "ip_version": 6,
            "shared": false,
            "description": "",
            "revision_number": 2
        },
        {
            "min_prefixlen": "24",
            "address_scope_id": null,
            "default_prefixlen": "25",
            "id": "f49a1319-423a-4ee6-ba54-1d95a4f6cc68",
            "max_prefixlen": "30",
            "name": "my-subnet-pool-ipv4",
            "default_quota": null,
            "is_default": false,
            "project_id": "9fadcee8aa7c40cdb2114fff7d569c08",
            "tenant_id": "9fadcee8aa7c40cdb2114fff7d569c08",
            "prefixes": [
                "10.10.0.0/21",
                "192.168.0.0/16"
            ],
            "ip_version": 4,
            "shared": false,
            "description": "",
            "revision_number": 2
        }
    ]
}