External VIP名称変更

API情報
API種別メソッドURI対象名称実行
設定PUT/:GisServiceCode/firewalls/:IfwServiceCode/external-vips/:IpAddress.jsonファイアウォール

External VIP名称変更

同期
  • 指定されたExternal VIPの名前を変更します
  • ファイアウォールがメンテナンス中の場合はメンテナンスが完了するまでExternal VIPの名前変更はできません


リクエストパラメータ

パラメータ必須意味
URLGisServiceCodeP2契約のサービスコードgis########

IfwServiceCodeファイアウォールのサービスコードifw########

IpAddressExternal VIPのアドレスIPv4アドレス
ボディExternalVipNameExternal VIPの名前

文字列

  • 文字数
    • 1文字以上50文字以下
  • 使用可能文字
    • 半角英字(大文字・小文字)
    • 半角数字
    • 半角記号: _
レスポンス
フィールドタイプ意味
CurrentObject変更後のExternalVip情報オブジェクト
Current.IPv4ObjectExternal VIPのIPv4情報オブジェクト
Current.IPv4.ExternalVipNameString変更後のExternal VIPの名前文字列
Current.IPv4.ExternalVipAddressStringExternal VIPのIPv4 アドレスIPv4アドレス
Current.IPv4.DomainNameStringExternal VIPのIPv4 アドレスの逆引き文字列
Current.IPv6ObjectExternal VIPのIPv6情報オブジェクト
Current.IPv6.ExternalVipNameString変更後のExternal VIPの名前文字列
Current.IPv6.ExternalVipAddressStringExternal VIPのIPv6 アドレスIPv6アドレス
PreviousObject変更前のExternalVip情報オブジェクト
Previous.IPv4ObjectExternal VIPのIPv4情報オブジェクト
Previous.IPv4.ExternalVipNameString変更前のExternal VIPの名前文字列
Previous.IPv4.ExternalVipAddressStringExternal VIPのIPv4 アドレスIPv4アドレス
Previous.IPv4.ExternalVipAddressStringExternal VIPのIPv4 アドレスの逆引き文字列
Previous.IPv6ObjectExternal VIPのIPv6情報オブジェクト
Previous.IPv6.ExternalVipNameString変更前のExternal VIPの名前文字列
Previous.IPv6.ExternalVipAddressStringExternal VIPのIPv6 アドレスIPv6アドレス
エラーコード
  • このAPIに関する個別エラーはありません。
  • 共通エラーコードはエラーレスポンスを参照して下さい


制限
  • 特になし


サンプル

リクエストボディ

{
    "ExternalVipName": "WEB_APP1"
}

レスポンス (JSON)

{
    "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
    "Current": {,
        "IPv4": {
            "ExternalVipName": "WEB_APP1",
            "ExternalVipAddress": "203.0.113.20",
            "DomainName": "20.113.0.203.rev.iijgio.jp"  # Globalのみ
        },
        "IPv6": {  # Globalのみ
            "ExternalVipName": "WEB_APP1_v6",
            "ExternalVipAddress": "2001:0db8:0000:0000:0000:0000:000b:0001"
        }
    },
    "Previous": {,
        "IPv4": {
            "ExternalVipName": "WEB_APP2",
            "ExternalVipAddress": "203.0.113.20",
            "DomainName": "20.113.0.203.rev.iijgio.jp"  # Globalのみ
        },
        "IPv6": {  # Globalのみ
            "ExternalVipName": "WEB_APP2_v6",
            "ExternalVipAddress": "2001:0db8:0000:0000:0000:0000:000b:0001"
        }
    },
}