List IP Access Rules of all users#

APIへのアクセスが許可されたIPアドレスの一覧である許可IPリストを、ユーザー単位に一覧表示します。

APIエンドポイント#

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

HTTPメソッドとURI#

GET

/v1.0/access_rule

HTTPステータスコード#

正常時:200

エラー時:400, 401, 403, 500

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

名前 In Type デフォルト値
/必須指定
Description
X-Auth-Token header string 必須 認証のトークン
domain_id query string 必須 ドメインのID

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

名前 Type Description
access_rules array 許可IPリストの一覧
許可IPリストをユーザーごとにリスト形式で表示します。
user_id string ユーザーID
user_name string ユーザー名
allowed_ip_addresses array 対象ユーザーの許可IPリスト
対象ユーザーに許可IPアドレスが登録されていない場合はnullになります。
source_ip string 対象ユーザーの許可IPアドレス
登録した内容がそのまま表示されます。
- CIDRで登録した場合 : 「xxx.xxx.xxx.xxx/nn」
- 特定のIPアドレス1個を登録した場合 : 「xxx.xxx.xxx.xxx」または「xxx.xxx.xxx.xxx/32」
- グローバルIPアドレス未割り当ての仮想サーバからAPIの実行を許可する固定文字列を登録した場合
  - 東日本リージョン3 : 「JP_EAST3_SNAT_ADDRESS」
  - 西日本リージョン3 : 「JP_WEST3_SNAT_ADDRESS」
description string 「source_ip」の説明

レスポンス例#

{
    "access_rules": [
        {
            "user_id": "ec688fe82eb94cf399ff845c792e5c11",
            "user_name": "user1",
            "allowed_ip_addresses": [
                { "source_ip": "1.2.3.0/24", "description": "company network" },
                { "source_ip": "5.6.7.8", "description": "operation room" }
            ]
        },
        {
            "user_id": "199bb304df9f42248bc44233bfcbc8b5",
            "user_name": "user2",
            "allowed_ip_addresses": [
                { "source_ip": "10.20.30.0/24", "description": "" }
            ]
        },
        {
            "user_id": "838ca174b5304338809492ae42c5c1fa",
            "user_name": "user3",
            "allowed_ip_addresses": null
        }
    ]
}