GetContractInformation

API情報

API種別 Action 対象 名称 実行
契約 GetContractInformation 契約 契約情報取得  

リクエストパラメータ

パラメータ 必須 意味
GpServiceCode 対象GP契約のgpサービスコード
GcServiceCode ※1 対象仮想サーバのgcサービスコード
GlServiceCode ※1 対象FW+LBオプションのglサービスコード
GxServiceCode ※1 対象VLANオプションのgxサービスコード

レスポンス

フィールド タイプ 意味
GetContractInformationResponse.CustomerCode String 対象GP契約のカスタマーコード
GetContractInformationResponse.GpServiceCode String 対象GP契約のgpサービスコード
GetContractInformationResponse.GpServiceCodeLabel String 対象GP契約のラベル
GetContractInformationResponse.Status String 契約状態 (契約状態)
GetContractInformationResponse.StartDate String 契約日
GetContractInformationResponse.StopDate String 解約日
GetContractInformationResponse.VirtualMachineList Array 対象GP契約に含まれる仮想サーバのリスト
GetContractInformationResponse.VirtualMachineList.GcServiceCode String サービスコード
GetContractInformationResponse.VirtualMachineList.Label String ラベル
GetContractInformationResponse.VirtualMachineList.Status String 契約状態 (契約状態)
GetContractInformationResponse.VirtualMachineList.StartDate String 契約日
GetContractInformationResponse.VirtualMachineList.StopDate String 解約日
GetContractInformationResponse.VirtualMachineList.DiskOptionList Array 対象仮想サーバに含まれる追加ディスクオプションのリスト
GetContractInformationResponse.VirtualMachineList.DiskOptionList.DeviceName String 追加ディスクオプションのデバイス名
GetContractInformationResponse.VirtualMachineList.DiskOptionList.Status String 契約状態 (契約状態)
GetContractInformationResponse.VirtualMachineList.DiskOptionList.StartDate String 契約日
GetContractInformationResponse.VirtualMachineList.DiskOptionList.StopDate String 解約日
GetContractInformationResponse.VirtualMachineList.GlobalAddressOptionList Array 対象仮想サーバに含まれる追加グローバルアドレスオプションのリスト
GetContractInformationResponse.VirtualMachineList.GlobalAddressOptionList.Ipv4Address String 追加グローバルオプションのIPv4アドレス
GetContractInformationResponse.VirtualMachineList.GlobalAddressOptionList.Status String 契約状態 (契約状態)
GetContractInformationResponse.VirtualMachineList.GlobalAddressOptionList.StartDate String 契約日
GetContractInformationResponse.VirtualMachineList.GlobalAddressOptionList.StopDate String 解約日
GetContractInformationResponse.VirtualMachineList.MobileWebOptionList Array

対象仮想サーバに含まれるモバイルWebオプションのリスト

GetContractInformationResponse.VirtualMachineList.MobileWebOptionList.Status String 契約状態 (契約状態)
GetContractInformationResponse.VirtualMachineList.MobileWebOptionList.StartDate String 契約日
GetContractInformationResponse.VirtualMachineList.MobileWebOptionList.StopDate String 解約日
GetContractInformationResponse.VirtualMachineList.SecureMailOptionList Array 対象仮想サーバに含まれるセキュアメールオプションのリスト
GetContractInformationResponse.VirtualMachineList.SecureMailOptionList.Status String 契約状態 (契約状態)
GetContractInformationResponse.VirtualMachineList.SecureMailOptionList.StartDate String 契約日
GetContractInformationResponse.VirtualMachineList.SecureMailOptionList.StopDate String 解約日
GetContractInformationResponse.NASBOptionList Array 対象GP契約に含まれるNAS/Bオプションのリスト
GetContractInformationResponse.NASBOptionList.GnbServiceCode String サービスコード
GetContractInformationResponse.NASBOptionList.Label String ラベル
GetContractInformationResponse.NASBOptionList.Status String 契約状態 (契約状態)
GetContractInformationResponse.NASBOptionList.StartDate String 契約日
GetContractInformationResponse.NASBOptionList.StopDate String 解約日
GetContractInformationResponse.VLANOptionList Array 対象GP契約に含まれるVLANオプションのリスト
GetContractInformationResponse.VLANOptionList.GxServiceCode String サービスコード
GetContractInformationResponse.VLANOptionList.Status String 契約状態 (契約状態)
GetContractInformationResponse.VLANOptionList.StartDate String 契約日
GetContractInformationResponse.VLANOptionList.StopDate String 解約日
GetContractInformationResponse.FWLBOptionList Array 対象GP契約に含まれるFW+LBオプションのリスト
GetContractInformationResponse.FWLBOptionList.GlServiceCode String サービスコード
GetContractInformationResponse.FWLBOptionList.Label String ラベル
GetContractInformationResponse.FWLBOptionList.Status String 契約状態 (契約状態)
GetContractInformationResponse.FWLBOptionList.StartDate String 契約日
GetContractInformationResponse.FWLBOptionList.StopDate String 解約日
GetContractInformationResponse.VPNTypeMOptionList Array 対象GP契約に含まれるVPN Type-Mオプションのリスト
GetContractInformationResponse.VPNTypeMOptionList.GvmServiceCode String サービスコード
GetContractInformationResponse.VPNTypeMOptionList.Status String 契約状態 (契約状態)
GetContractInformationResponse.VPNTypeMOptionList.StartDate String 契約日
GetContractInformationResponse.VPNTypeMOptionList.StopDate String 解約日
GetContractInformationResponse.VPNTypeSOptionList Array 対象GP契約に含まれるVPN Type-Sオプションのリスト
GetContractInformationResponse.VPNTypeSOptionList.GvsServiceCode String サービスコード
GetContractInformationResponse.VPNTypeSOptionList.Status String 契約状態 (契約状態)
GetContractInformationResponse.VPNTypeSOptionList.StartDate String 契約日
GetContractInformationResponse.VPNTypeSOptionList.StopDate String 解約日
GetContractInformationResponse.SMMOptionList String 対象GP契約に含まれるシステム運用管理オプションのリスト
GetContractInformationResponse.SMMOptionList.GomServiceCode String サービスコード
GetContractInformationResponse.SMMOptionList.Status String 契約状態 (契約状態)
GetContractInformationResponse.SMMOptionList.StartDate String 契約日
GetContractInformationResponse.SMMOptionList.StopDate String 解約日

エラーコード

制限

サンプル

リクエスト

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

レスポンス (JSON)

Json
{
    "GetContractInformationResponse": {
        "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
        "CustomerCode": "SG#######",
        "CustomerCodeLabel": "XXXXX",
        "GpServiceCode": "gp########",
        "GpServiceCodeLabel": "XXXXX",
        "Status": "InService",
        "StartDate": "YYYYMMDD",
        "StopDate": "",
        "VirtualMachineList": [
            {
                "GcServiceCode": "gc#######1",
                "Label": "XXXXX",
                "Status": "InService",
                "StartDate": "YYYYMMDD",
                "StopDate": "",
                "DiskOptionList": [
                    {
                        "DeviceName": "/dev/sdb",
                        "Status": "InService",
                        "StartDate": "YYYYMMDD",
                        "StopDate": ""
                    },
                    {
                        "DeviceName": "/dev/sdc",
                        "Status": "InService",
                        "StartDate": "YYYYMMDD",
                        "StopDate": ""
                    }
                ],
                "GlobalAddressOptionList": [
                    {
                        "IPv4Address": "203.0.113.11",
                        "Status": "InService",
                        "StartDate": "YYYYMMDD",
                        "StopDate": ""
                    },
                    {
                        "IPv4Address": "203.0.113.12",
                        "Status": "InService",
                        "StartDate": "YYYYMMDD",
                        "StopDate": ""
                    }
                ],
                "MobileWebOptionList": [
                    {
                        "Status": "InService",
                        "StartDate": "YYYYMMDD",
                        "StopDate": ""
                    }
                ],
                "SecureMailOptionList": [
                    {
                        "Status": "InService",
                        "StartDate": "YYYYMMDD",
                        "StopDate": ""
                    }
                ]
            },
            {
                "GcServiceCode": "gc#######2",
                "Label": "XXXXX",
                "Status": "InService",
                "StartDate": "YYYYMMDD",
                "StopDate": "",
                "DiskOptionList": [],
                "GlobalAddressOptionList": [],
                "MobileWebOptionList": [],
                "SecureMailOptionList": []
            }
        ],
        "NASBOptionList": [
            {
                "GnbServiceCode": "gnb#######1",
                "Label": "XXXXX",
                "Status": "InService",
                "StartDate": "YYYYMMDD",
                "StopDate": ""
            },
            {
                "GnbServiceCode": "gnb#######2",
                "Label": "XXXXX",
                "Status": "InService",
                "StartDate": "YYYYMMDD",
                "StopDate": ""
            }
        ],
        "VLANOptionList": [
            {
                "GxServiceCode": "gx########",
                "Status": "InService",
                "StartDate": "YYYYMMDD",
                "StopDate": ""
            }
        ],
        "FWLBOptionList": [
            {
                "GlServiceCode": "gl#######1",
                "Label": "XXXXX",
                "Status": "InService",
                "StartDate": "YYYYMMDD",
                "StopDate": ""
            },
            {
                "GlServiceCode": "gl#######2",
                "Label": "XXXXX",
                "Status": "InService",
                "StartDate": "YYYYMMDD",
                "StopDate": ""
            }
        ],
        "VPNTypeMOptionList": [
            {
                "GvmServiceCode": "gvm########",
                "Status": "InService",
                "StartDate": "YYYYMMDD",
                "StopDate": ""
            }
        ],
        "VPNTypeSOptionList": [
            {
                "GvsServiceCode": "gvs########",
                "Status": "InService",
                "StartDate": "YYYYMMDD",
                "StopDate": ""
            }
        ],
        "SMMOptionList": [
            {
                "GomServiceCode": "gom########",
                "Status": "InService",
                "StartDate": "YYYYMMDD",
                "StopDate": ""
            }
        ]
    }
}

レスポンス (XML)

XML
<?xml version="1.0" encoding="UTF-8"?>
<GetContractInformationResponse>
  <RequestId>xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx</RequestId>
  <CustomerCode>SG#######</CustomerCode>
  <CustomerCodeLabel>XXXXX</CustomerCodeLabel>
  <GpServiceCode>gp########</GpServiceCode>
  <GpServiceCodeLabel>XXXXX</GpServiceCodeLabel>
  <Status>InService</Status>
  <StartDate>YYYYMMDD</StartDate>
  <StopDate></StopDate>
  <VirtualMachineList>
    <VirtualMachine>
      <GcServiceCode>gc#######1</GcServiceCode>
      <Label>XXXXX</Label>
      <Status>InService</Status>
      <StartDate>YYYYMMDD</StartDate>
      <StopDate></StopDate>
      <DiskOptionList>
        <DiskOption>
          <DeviceName>/dev/sdb</DeviceName>
          <Status>InService</Status>
          <StartDate>YYYYMMDD</StartDate>
          <StopDate></StopDate>
        </DiskOption>
        <DiskOption>
          <DeviceName>/dev/sdc</DeviceName>
          <Status>InService</Status>
          <StartDate>YYYYMMDD</StartDate>
          <StopDate></StopDate>
        </DiskOption>
      </DiskOptionList>
      <GlobalAddressOptionList>
        <GlobalAddressOption>
          <IPv4Address>203.0.113.11</IPv4Address>
          <Status>InService</Status>
          <StartDate>YYYYMMDD</StartDate>
          <StopDate></StopDate>
        </GlobalAddressOption>
        <GlobalAddressOption>
          <IPv4Address>203.0.113.12</IPv4Address>
          <Status>InService</Status>
          <StartDate>YYYYMMDD</StartDate>
          <StopDate></StopDate>
        </GlobalAddressOption>
      </GlobalAddressOptionList>
      <MobileWebOptionList>
        <MobileWebOption>
          <Status>InService</Status>
          <StartDate>YYYYMMDD</StartDate>
          <StopDate></StopDate>
        </MobileWebOption>
      </MobileWebOptionList>
      <SecureMailOptionList>
        <SecureMailOption>
          <Status>InService</Status>
          <StartDate>YYYYMMDD</StartDate>
          <StopDate></StopDate>
        </SecureMailOption>
      </SecureMailOptionList>
    </VirtualMachine>
    <VirtualMachine>
      <GcServiceCode>gc#######2</GcServiceCode>
      <Label>XXXXX</Label>
      <Status>InService</Status>
      <StartDate>YYYYMMDD</StartDate>
      <StopDate></StopDate>
      <DiskOptionList/>
      <GlobalAddressOptionList/>
      <MobileWebOptionList/>
      <SecureMailOptionList/>
    </VirtualMachine>
  </VirtualMachineList>
  <NASBOptionList>
    <NASBOption>
      <GnbServiceCode>gnb#######1</GnbServiceCode>
      <Label>XXXXX</Label>
      <Status>InService</Status>
      <StartDate>YYYYMMDD</StartDate>
      <StopDate></StopDate>
    </NASBOption>
    <NASBOption>
      <GnbServiceCode>gnb#######2</GnbServiceCode>
      <Label>XXXXX</Label>
      <Status>InService</Status>
      <StartDate>YYYYMMDD</StartDate>
      <StopDate></StopDate>
    </NASBOption>
  </NASBOptionList>
  <VLANOptionList>
    <VLANOption>
      <GxServiceCode>gx########</GxServiceCode>
      <Status>InService</Status>
      <StartDate>YYYYMMDD</StartDate>
      <StopDate></StopDate>
    </VLANOption>
  </VLANOptionList>
  <FWLBOptionList>
    <FWLBOption>
      <GlServiceCode>gl#######1</GlServiceCode>
      <Label>XXXXX</Label>
      <Status>InService</Status>
      <StartDate>YYYYMMDD</StartDate>
      <StopDate></StopDate>
    </FWLBOption>
    <FWLBOption>
      <GlServiceCode>gl#######2</GlServiceCode>
      <Label>XXXXX</Label>
      <Status>InService</Status>
      <StartDate>YYYYMMDD</StartDate>
      <StopDate></StopDate>
    </FWLBOption>
  </FWLBOptionList>
  <VPNTypeMOptionList>
    <VPNTypeMOption>
      <GvmServiceCode>gvm########</GvmServiceCode>
      <Status>InService</Status>
      <StartDate>YYYYMMDD</StartDate>
      <StopDate></StopDate>
    </VPNTypeMOption>
  </VPNTypeMOptionList>
  <VPNTypeSOptionList>
    <VPNTypeSOption>
      <GvsServiceCode>gvs########</GvsServiceCode>
      <Status>InService</Status>
      <StartDate>YYYYMMDD</StartDate>
      <StopDate></StopDate>
    </VPNTypeSOption>
  </VPNTypeSOptionList>
  <SMMOptionList>
    <SMMOption>
      <GomServiceCode>gom########</GomServiceCode>
      <Status>InService</Status>
      <StartDate>YYYYMMDD</StartDate>
      <StopDate></StopDate>
    </SMMOption>
  </SMMOptionList>
</GetContractInformationResponse>