PUT origin

API情報

HTTPメソッドAPI名目的
PUToriginオリジンサーバー情報変更
  • オリジンサーバーの情報を設定します。

個別パラメータ

URL
  • なし

HTTPリクエストボディ

フィールドタイプ意味
OriginAccessTypeString

オリジンサーバへのアクセス方法 (ホスト名, IPアドレス)

値: host, ip

OriginIPListArray

オリジンサーバのIP アドレス

  • 最大256個
  • 一般に予約アドレスと呼ばれるIPアドレスは登録できません。
  • OriginAccessTypeが"ip"の場合に指定します。
OriginFqdnString

オリジンサーバのホスト名

  • OriginAccessTypeが"host"の場合に指定します。
OriginSendPublicFqdnString

OriginAccessTypeを"host"に設定した場合において、コンテンツ取得時のHostヘッダに付与される値に

  • "off"の場合、オリジンサーバのホスト名を使用します(初期値)
  • "on"の場合、契約FQDNを使用します

OriginAccessTypeが"ip"に設定された場合、このフィールドの値は無視されます。

レスポンス

フィールドタイプ意味
Result.OriginAccessTypeString

オリジンサーバへのアクセス方法

値: host, ip

Result.OriginArray

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

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

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

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

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

Result.NextOriginAccessTypeString

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

オリジンサーバへのアクセス方法(ホスト名, IPアドレス)

値: host, ip

Result.NextOriginArray

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

オリジンサーバのホスト名またはIP アドレス

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

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

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

エラーコード

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

制限

  • 予約アドレスや本設備内で利用されているアドレスは登録できません。

サンプル 

リクエスト

PUT /r/(APIVersion)/(ServiceCode)/origin.json
Host: cac.api.iij.jp
Content-Type: application/json
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)

{
    "OriginAccessType": "host",
    "OriginFqdn": "www.example.co.jp",
    "OriginSendPublicFqdn": "off"
}

レスポンスボディ

{
    "Result": {
        "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
        "ServiceCode": "cac########",
        "OriginAccessType": "host",
        "Origin": ["www.example.co.jp"],
        "OriginSendPublicFqdn": "off",
        "NextOriginAccessType": "host",
        "NextOrigin": ["www.example.co.jp"],
        "NextOriginSendPublicFqdn": "off"
    }
}