GET contract

GET contract

API情報

HTTPメソッド	API名	目的
GET	contract	契約情報一覧取得

契約情報を取得します。

個別パラメータ

URL

なし

HTTPリクエストボディ

なし

レスポンス

フィールド	タイプ	意味
Result.PublicFqdn	String	契約FQDN
Result.CNAME	String	従来の設備の割り当てCNAME
Result.CNAMEV2	String	新設備の割り当てCNAME
Result.Https	String	HTTPS連携値: on, off
Result.DdoS	String	DDoSオプション値: on, off
Result.PrivateCache	String	占有キャッシュオプション値: on, off
Result.PrivateCacheVolumeCount	String	占有キャッシュ契約数
Result.PrivateCacheStatus	String	占有キャッシュの設定が完了していれば "ready" 契約数変更中は、 "changing" 契約がない場合は、"none
Result.Constructions	String	配信サーバの準備が完了した場合は"on" 値: on
Result.OriginAccessType	String	オリジンサーバへのアクセス方法 IPアドレスの場合は"ip" サーバホスト名の場合は "host" 値: host, ip
Result.Origin	String	オリジンサーバのFQDNまたはIP アドレス FQDNの場合は、最大1個 IPアドレスの場合は、最大256個オリジンサーバをIP アドレス指定した場合、従来の設備と新設備で動作に差異があるため注意従来の設備設定されたすべてのIPアドレスを利用されます。ラウンドロビンでアクセス新設備設定されたIPアドレスのうち最初の2個のみ利用されます。 1つ目のIPアドレスがアクティブ、2つ目のIPアドレスがスタンバイとしてアクセス 3つ目以降のIPアドレスは利用されません。
Result.OriginSendPublicFqdn	String	オリジンサーバへのコンテンツ取得時のHostヘッダの設定値指定されたサーバホスト名を使用する場合は"off" 契約FQDNを使用する場合は"on" OriginAccessTypeが"ip"に設定されている場合、このフィールドの値は常に"on"です。
Result.NextOriginAccessType	String	占有型契約時、オリジンサーバ情報変更を行った場合の変更予定の値オリジンサーバへのアクセス方法 IPアドレスの場合は"ip" サーバホスト名の場合は "host" 値: host, ip
Result.NextOrigin	String	占有型契約時、オリジンサーバ情報変更を行った場合の変更予定の値オリジンサーバのFQDNまたはIP アドレス FQDNの場合は、最大1個 IPアドレスの場合は、最大256個オリジンサーバをIP アドレス指定した場合、従来の設備と新設備で動作に差異があるため注意従来の設備設定されたすべてのIPアドレスを利用されます。ラウンドロビンでアクセス新設備設定されたIPアドレスのうち最初の2個のみ利用されます。 1つ目のIPアドレスがアクティブ、2つ目のIPアドレスがスタンバイとしてアクセス 3つ目以降のIPアドレスは利用されません。
Result.NextOriginSendPublicFqdn	String	占有型契約時、オリジンサーバへのコンテンツ取得時のHostヘッダの設定値が変更された後の変更予定の値指定されたサーバホスト名を使用する場合は"off" 契約FQDNを使用する場合は"on"
Result.CreatedAt	String	契約投入日 (YYYY/MM/DD)

エラーコード

このAPIに関する個別エラーはありません。
共通エラーコードはエラーレスポンスを参照してください。

制限

なし

サンプル

リクエスト

GET /r/(APIVersion)/(ServiceCode)/contract.json
Host: cac.api.iij.jp
Date: Mon, 20 Jan 2014 12:34:56 GMT
x-iijapi-Expire: (Expire)
x-iijapi-SignatureMethod: (SignatureMethod)
x-iijapi-SignatureVersion: (SignatureVersion)
Authorization: IIJAPI (AccessKeyId):(Signature)

レスポンスボディ

{
    "Result": {
        "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
        "ServiceCode": "cac########",
        "PublicFqdn": "xxxxxxxxxxxxxxxxxxxx",
        "CNAME": "xxxxxxxxxxxxxxxxxxxx",
        "Https": "off",
        "DdoS": "off",
　  　  "PrivateCache": "off",
        "PrivateCacheVolumeCount": "0",
        "PrivateCacheStatus": "none",
        "Constructions": "on",
        "OriginAccessType": "ip",
        "Origin": ["xxx.xxx.xxx.xxx"],
        "OriginSendPublicFqdn": "on",
        "NextOriginAccessType": "ip",
        "NextOrigin": ["xxx.xxx.xxx.xxx"],
        "NextOriginSendPublicFqdn": "on",
        "CreatedAt": "2014/06/02"
    }
}