PUT redirect_setting

API情報

HTTPメソッドAPI名目的
PUTredirect_settingHTTPリダイレクト設定情報変更
  • HTTPリダイレクト機能の設定情報を変更します。

個別パラメータ

URL
  • なし
HTTPリクエストボディ
フィールドタイプ意味
RedirectString

設定: 有効又は無効

省略した場合はonになります

offに設定する場合、他の項目を省略可能です

値: on, off

RedirectModeString

リダイレクト先の指定方法

(default: パスはそのままでhttpsにリダイレクト、url: 指定したURLにリダイレクト)

値: default, url

RedirectUrlString

リダイレクト先となるURL

RedirectModeがurlの場合のみ設定できます

最大256 文字

RedirectStatusString

リダイレクト時のステータスコード

省略した場合は301になります

値: 301, 302

レスポンス

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

設定: 有効又は無効

値: on, off

Result.RedirectModeString

リダイレクト先の指定方法

(default: パスはそのままでhttpsにリダイレクト、url: 指定したURLにリダイレクト)

値: default, url

Result.RedirectUrlString

リダイレクト先となるURL

Result.RedirectModeがurlの場合のみ設定されています

Result.RedirectStatusString

リダイレクト時のステータスコード

値: 301, 302

エラーコード

  • なし

制限

  • HTTPS配信機能を利用している場合のみ設定できます

サンプル 

リクエスト

PUT /r/(APIVersion)/(ServiceCode)/http/redirect_setting.json HTTP1.1
Host: cac.api.iij.jp
Content-Type:application/json
Date: Thu, 03 Feb 2021 12:34:56 GMT
x-iijapi-Expire: (Expire)
x-iijapi-SignatureMethod: (SignatureMethod)
x-iijapi-SignatureVersion: (SignatureVersion)
Authorization: IIJAPI (AccessKeyId):(Signature)

{
    "Redirect": "on",
    "RedirectMode": "default"
}

レスポンスボディ

{
    "Result": {
        "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
        "ServiceCode": "cac########",
        "Redirect": "on",
        "RedirectMode": "default",
        "RedirectStatus": "301",
        "RedirectUrl": ""
    }
}