GetContractStatus

API情報

API種別 Action 対象 名称 実行
契約 GetContractStatus 契約 契約状態取得  

リクエストパラメータ

パラメータ 必須 意味
GpServiceCode 対象を含むGP契約のgpサービスコード
GcServiceCode ※1 仮想サーバのgcサービスコード
GlServiceCode ※1 FW+LBオプションのglサービスコード
GxServiceCode ※1 VLANオプションのgxサービスコード
DiskDeviceName ※1 追加ディスクオプションのデバイス名
IPv4Address ※1 追加グローバルアドレスオプションのIPv4アドレス

レスポンス

対象によりレスポンスが異なります

仮想サーバ

フィールド タイプ 意味
GetContractStatusResponse.GcServiceCode String 仮想サーバのサービスコード
GetContractStatusResponse.Status String 契約状態 (契約状態)

追加ディスクオプション

フィールド タイプ 意味
GetContractStatusResponse.GcServiceCode String 仮想サーバのサービスコード
GetContractStatusResponse.DiskDeviceName String 追加ディスクオプションのデバイス名
GetContractStatusResponse.Status String 契約状態 (契約状態)

追加グローバルアドレスオプション

フィールド タイプ 意味
GetContractStatusResponse.GcServiceCode String 仮想サーバのサービスコード
GetContractStatusResponse.IPv4Address String 追加グローバルアドレスオプションのIPv4アドレス
GetContractStatusResponse.Status String 契約状態 (契約状態)

FW+LBオプション

フィールド タイプ 意味
GetContractStatusResponse.GlServiceCode String FW+LBオプションのサービスコード
GetContractStatusResponse.Status String 契約状態 (契約状態)

VLANオプション

フィールド タイプ 意味
GetContractStatusResponse.GxServiceCode String VLANオプションのサービスコード
GetContractStatusResponse.Status String 契約状態 (契約状態)

エラーコード

制限

サンプル

リクエスト

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

レスポンス (JSON)

Json
{
    "GetContractStatusResponse": {
        "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
        "GcServiceCode": "gc########",
        "Status": "InService"
    }
}
Json
{
    "GetContractStatusResponse": {
        "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
        "GcServiceCode": "gc########",
        "DiskDeviceName": "/dev/xvdb",
        "Status": "InService"
    }
}
Json
{
    "GetContractStatusResponse": {
        "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
        "GcServiceCode": "gc########",
        "IPv4Address": "203.0.113.11",
        "Status": "InService"
    }
}
Json
{
    "GetContractStatusResponse": {
        "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
        "GlServiceCode": "gl########",
        "Status": "InService"
    }
}
Json
{
    "GetContractStatusResponse": {
        "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
        "GxServiceCode": "gx########",
        "Status": "InService"
    }
}

レスポンス (XML)

XML
<?xml version="1.0" encoding="UTF-8"?>
<GetContractStatusResponse>
  <RequestId>xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx</RequestId>
  <GcServiceCode>gc########</GcServiceCode>
  <Status>InService</Status>
</GetContractStatusResponse>
XML
<?xml version="1.0" encoding="UTF-8"?>
<GetContractStatusResponse>
  <RequestId>xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx</RequestId>
  <GcServiceCode>gc########</GcServiceCode>
  <DiskDeviceName>/dev/xvdb</DiskDeviceName>
  <Status>InService</Status>
</GetContractStatusResponse>
XML
<?xml version="1.0" encoding="UTF-8"?>
<GetContractStatusResponse>
  <RequestId>xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx</RequestId>
  <GcServiceCode>gc########</GcServiceCode>
  <IPv4Address>203.0.113.11</IPv4Address>
  <Status>InService</Status>
</GetContractStatusResponse>
XML
<?xml version="1.0" encoding="UTF-8"?>
<GetContractStatusResponse>
  <RequestId>xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx</RequestId>
  <GlServiceCode>gl########</GlServiceCode>
  <Status>InService</Status>
</GetContractStatusResponse>
XML
<?xml version="1.0" encoding="UTF-8"?>
<GetContractStatusResponse>
  <RequestId>xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx</RequestId>
  <GxServiceCode>gx########</GxServiceCode>
  <Status>InService</Status>
</GetContractStatusResponse>