SetLbVirtualServerName

API情報

API種別 Action 対象 名称 実行
設定

SetLbVirtualServerName

FW/LB

LB仮想サービス名称変更

 

リクエストパラメータ

パラメータ 必須 意味
GpServiceCode 対象FW+LBオプションを含むgpサービスコード
GlServiceCode 対象FW+LBオプションのglサービスコード
CurrentVirtualServerName

変更するLB仮想サービスの現在の名称

NewVirtualServerName

変更するLB仮想サービスの新しい名称

レスポンス

フィールド タイプ 意味
SetLbVirtualServerNameResponse.GlServiceCode String 対象FW+LBオプションのglサービスコード
SetLbVirtualServerNameResponse.VirtualServerName String LB仮想サービスの変更後の名称
SetLbVirtualServerNameResponse.Port String LB仮想サービスのポート
SetLbVirtualServerNameResponse.Protocol String

LB仮想サービスのプロトコル

(ロードバランサで使用するプロトコルの表記)

SetLbVirtualServerNameResponse.Pool String LB仮想サービスが使用するプール
SetLbVirtualServerNameResponse.Enabled String

LB仮想サービスの状態 (有効, 無効)

値: Yes, No

SetLbVirtualServerNameResponse.TrafficNameList Array LB仮想サービスが使用するLBグローバルアドレスのリスト

エラーコード

制限

サンプル

リクエスト

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

レスポンス (JSON)

Json
{
    "SetLbVirtualServerNameResponse": {
        "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
        "GlServiceCode": "gl########",
        "VirtualServerName": "GIO_WEB_SERVICE2",
        "Port": "80",
        "Protocol": "http",
        "Pool": "GIO_WEB_POOL",
        "Enabled": "Yes",
        "TrafficIpNameList": [
            "GIO_TRAFFIC_IP",
            "GIO_TRAFFIC_IP6"
        ]
    }
}

レスポンス (XML)

XML
<?xml version="1.0" encoding="UTF-8"?>
<SetLbVirtualServerNameResponse>
  <RequestId>xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx</RequestId>
  <GlServiceCode>gl########</GlServiceCode>
  <VirtualServerName>GIO_WEB_SERVICE2</VirtualServerName>
  <Port>80</Port>
  <Protocol>http</Protocol>
  <Pool>GIO_WEB_POOL</Pool>
  <Enabled>Yes</Enabled>
  <TrafficIpNameList>
    <TrafficIpName>GIO_TRAFFIC_IP</TrafficIpName>
    <TrafficIpName>GIO_TRAFFIC_IP6</TrafficIpName>
  </TrafficIpNameList>
</SetLbVirtualServerNameResponse>