SetVirtualIpAddressName

API情報

API種別 Action 対象 名称 実行
設定 SetVirtualIpAddressName FW/LB LBグローバルアドレス名称変更  

リクエストパラメータ

パラメータ 必須 意味
GpServiceCode 対象FW+LBオプションを含むgpサービスコード
GlServiceCode 対象FW+LBオプションのglサービスコード
CurrentName 変更対象のグローバルアドレスの名称
NewName 新しいグローバルアドレスの名称

レスポンス

フィールド タイプ 意味
SetVirtualIpAddressNameResponse.GlServiceCode String 対象FW+LBオプションのglサービスコード
SetVirtualIpAddressNameResponse.Current Object 変更後のグローバルアドレス名称
SetVirtualIpAddressNameResponse.Current.IPv4.TrafficIpName String IPv4グローバルアドレス名称
SetVirtualIpAddressNameResponse.Current.IPv4.TrafficIpAddress String IPv4アドレス
SetVirtualIpAddressNameResponse.Current.IPv6.TrafficIpName String IPv6グローバルアドレス名称
SetVirtualIpAddressNameResponse.Current.IPv6.TrafficIpAddress String IPv6アドレス
SetVirtualIpAddressNameResponse.Previous Object 変更前のグローバルアドレス名称
SetVirtualIpAddressNameResponse.Previous.IPv4.TrafficIpName String IPv4グローバルアドレス名称
SetVirtualIpAddressNameResponse.Previous.IPv4.TrafficIpAddress String IPv4アドレス
SetVirtualIpAddressNameResponse.Previous.IPv6.TrafficIpName String IPv6グローバルアドレス名称
SetVirtualIpAddressNameResponse.Previous.IPv6.TrafficIpAddress String IPv6アドレス

エラーコード

制限

サンプル

リクエスト

※実際には一行で現します
https://gp.api.iij.jp/json
    ?APIVersion=20130901
    &AccessKeyId=XXXXXXXXXXXXXXXXXXXX
    &Action=SetVirtualIpAddressName
    &CurrentName=name1
    &Expire=2013-09-01T10%3A10%3A30Z
    &GlServiceCode=gl########
    &GpServiceCode=gp########
    &NewName=name2
    &SignatureMethod=HmacSHA256
    &SignatureVersion=2
    &Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

レスポンス (JSON)

Json
{
    "SetVirtualIpAddressNameResponse": {
        "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
        "GlServiceCode": "gl########",
        "Current": {
            "IPv4": {
                "TrafficIpName": "name2",
                "TrafficIpAddress": "203.0.113.21"
            },
            "IPv6": {
                "TrafficIpName": "name2_v6",
                "TrafficIpAddress": "2001:0db8:0000:0000:0000:0000:000b:0001"
            }
        },
        "Previous": {
            "IPv4": {
                "TrafficIpName": "name1",
                "TrafficIpAddress": "203.0.113.21"
            },
            "IPv6": {
                "TrafficIpName": "name1_v6",
                "TrafficIpAddress": "2001:0db8:0000:0000:0000:0000:000b:0001"
            }
        }
    }
}

レスポンス (XML)

XML
<?xml version="1.0" encoding="UTF-8"?>
<SetVirtualIpAddressNameResponse>
  <RequestId>xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx</RequestId>
  <GlServiceCode>gl########</GlServiceCode>
  <Current>
    <IPv4>
      <TrafficIpName>name2</TrafficIpName>
      <TrafficIpAddress>203.0.113.21</TrafficIpAddress>
    </IPv4>
    <IPv6>
      <TrafficIpName>name2_v6</TrafficIpName>
      <TrafficIpAddress>2001:0db8:0000:0000:0000:0000:000b:0001</TrafficIpAddress>
    </IPv6>
  </Current>
  <Previous>
    <IPv4>
      <TrafficIpName>name1</TrafficIpName>
      <TrafficIpAddress>203.0.113.21</TrafficIpAddress>
    </IPv4>
    <IPv6>
      <TrafficIpName>name1_v6</TrafficIpName>
      <TrafficIpAddress>2001:0db8:0000:0000:0000:0000:000b:0001</TrafficIpAddress>
    </IPv6>
  </Previous>
</SetVirtualIpAddressNameResponse>