GET contract

API情報

HTTPメソッドAPI名目的
GETcontract契約情報一覧取得
  • 契約情報を取得します。

個別パラメータ

URL
  • なし
HTTPリクエストボディ
  • なし

レスポンス

フィールドタイプ意味
Result.PublicFqdnString契約FQDN
Result.CNAMEString割り当てCNAME
Result.HttpsString

HTTPS連携

値: on, off

Result.DdoSString

DDoSオプション

値: on, off

Result.PrivateCacheString

占有キャッシュオプション

値: on, off

Result.PrivateCacheVolumeCountString

占有キャッシュ契約数

Result.PrivateCacheStatusString

占有キャッシュの設定が完了していれば "ready"

  • 契約数変更中は、 "changing"
  • 契約がない場合は、"none
Result.ConstructionsString

配信サーバの準備が完了した場合は"on"

値: on

Result.OriginAccessTypeString

オリジンサーバへのアクセス方法
IPアドレスの場合は"ip"
サーバホスト名の場合は "host"

値: host, ip

Result.OriginString

オリジンサーバ(FQDNまたはIP アドレス)

  • FQDNの場合は、最大1個
  • IPアドレスの場合は、最大256個
Result.OriginSendPublicFqdnString

オリジンサーバへのコンテンツ取得時のHostヘッダの設定値

  • 指定されたサーバホスト名を使用する場合は"off"
  • 契約FQDNを使用する場合は"on"

OriginAccessTypeが"ip"に設定されている場合、このフィールドの値は常に"on"です。

Result.NextOriginAccessTypeString

占有型契約時、オリジンサーバ情報変更を行った場合の変更予定の値

オリジンサーバへのアクセス方法
IPアドレスの場合は"ip"
サーバホスト名の場合は "host"

値: host, ip

Result.NextOriginString

占有型契約時、オリジンサーバ情報変更を行った場合の変更予定の値

オリジンサーバ(FQDNまたはIP アドレス)

  • FQDNの場合は、最大1個
  • IPアドレスの場合は、最大256個
Result.NextOriginSendPublicFqdnString

占有型契約時、オリジンサーバへのコンテンツ取得時のHostヘッダの設定値が変更された後の変更予定の値

  • 指定されたサーバホスト名を使用する場合は"off"
  • 契約FQDNを使用する場合は"on"
 Result.CreatedAtString契約投入日 (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"
    }
}