すべてのプロダクト
Search
ドキュメントセンター

CDN:リクエストロジック関数

最終更新日:May 12, 2025

このトピックでは、リクエストロジック関数の構文、パラメーター、および戻り値について説明します。また、これらの関数の例も示します。

server_addr

この関数は、現在のリクエストを受信するサーバーの IP アドレスをクエリします。次の表に、この関数の詳細を示します。

項目

説明

構文

server_addr()

パラメーター

なし

s_addr = server_addr()
say(concat('s_addr:', s_addr))

戻り値

サーバーの IP アドレスを文字列で返します。

server_port

この関数は、現在のリクエストを受信するサーバーポートをクエリします。次の表に、この関数の詳細を示します。

項目

説明

構文

server_port()

パラメーター

なし

s_addr = server_addr()
say(concat('s_addr:', s_addr))

戻り値

現在のリクエストを受信するサーバーポートを返します。データ型:数値。

client_addr

重要

注意:クライアントアドレスは、インターネットサービスプロバイダー( ISP )の NAT ルールによって変更される場合や、 IP アドレスが Alibaba Cloud CDN のアドレスプールにない場合があるため、戻り値が正確でない可能性があります。ご注意ください。

この関数は、クライアントの IP アドレスをクエリします。次の表に、この関数の詳細を示します。

項目

説明

構文

client_addr()

パラメーター

なし

c_addr = client_addr()
c_port = client_port()
say(concat('c_addr:', c_addr))
say(concat('c_port:', tostring(c_port)))

戻り値

指定されたクライアントの IP アドレスを文字列で返します。

client_port

この関数は、クライアントのポートをクエリします。次の表に、この関数の詳細を示します。

項目

説明

構文

client_port()

パラメーター

なし

c_addr = client_addr()
c_port = client_port()
say(concat('c_addr:', c_addr))
say(concat('c_port:', tostring(c_port)))

戻り値

指定されたクライアントのポートを返します。データ型:数値。

client_country

重要

注意:クライアントアドレスは、インターネットサービスプロバイダー( ISP )の NAT ルールによって変更される場合や、 IP アドレスが Alibaba Cloud CDN のアドレスプールにない場合があるため、戻り値が正確でない可能性があります。ご注意ください。

この関数は、クライアントの国コードと行政区画コードをクエリします。次の表に、この関数の詳細を示します。

項目

説明

構文

client_country()

パラメーター

なし

c_country = client_country()
c_region = client_region()
c_isp = client_isp()
if c_country {
    say(concat('client_country:', c_country))
}
if c_region {
    say(concat('client_region:', c_region))
}
if c_isp {
    say(concat('client_isp:', c_isp))
}

戻り値

指定されたクライアントの国コードと行政区画コードを文字列で返します。国コードと行政区画コードの詳細については、「国コード」をご参照ください。

client_region

重要

注意:クライアントアドレスは、インターネットサービスプロバイダー( ISP )の NAT ルールによって変更される場合や、 IP アドレスが Alibaba Cloud CDN のアドレスプールにない場合があるため、戻り値が正確でない可能性があります。ご注意ください。

この関数は、クライアントの行政区画コードをクエリします。次の表に、この関数の詳細を示します。

項目

説明

構文

client_region()

パラメーター

なし

c_country = client_country()
c_region = client_region()
c_isp = client_isp()
if c_country {
    say(concat('client_country:', c_country))
}
if c_region {
    say(concat('client_region:', c_region))
}
if c_isp {
    say(concat('client_isp:', c_isp))
}

戻り値

指定されたクライアントの行政区画コードを文字列で返します。行政区画コードの詳細については、「行政区画コード」をご参照ください。

client_isp

重要

注意:クライアントアドレスは、インターネットサービスプロバイダー( ISP )の NAT ルールによって変更される場合や、 IP アドレスが Alibaba Cloud CDN のアドレスプールにない場合があるため、戻り値が正確でない可能性があります。ご注意ください。

この関数は、クライアントの ISP コードをクエリします。次の表に、この関数の詳細を示します。

項目

説明

構文

client_isp()

パラメーター

なし

c_country = client_country()
c_region = client_region()
c_isp = client_isp()
if c_country {
    say(concat('client_country:', c_country))
}
if c_region {
    say(concat('client_region:', c_region))
}
if c_isp {
    say(concat('client_isp:', c_isp))
}

戻り値

指定されたクライアントの ISP コードを文字列で返します。 ISP コードの詳細については、「ISP コード」をご参照ください。

ip_region

重要

注意:クライアントアドレスは、インターネットサービスプロバイダー( ISP )の NAT ルールによって変更される場合や、 IP アドレスが Alibaba Cloud CDN のアドレスプールにない場合があるため、戻り値が正確でない可能性があります。ご注意ください。

この関数は、指定された IP アドレスが属する市または県の行政区画コードをクエリします。次の表に、この関数の詳細を示します。

項目

説明

構文

ip_region(ipaddr)

パラメーター

ipaddr:ドット付き 10 進表記で IP アドレスを指定します。

c_country = ip_country('192.168.0.1')
c_region = ip_region('192.168.0.1')
c_city = ip_city('192.168.0.1')
c_isp = ip_isp('192.168.0.1')
if c_country {
    say(concat('ip_country:', c_country))
}
if c_region {
    say(concat('ip_region:', c_region))
}
if c_city {
    say(concat('ip_city:', c_city))
}
if c_isp {
    say(concat('ip_isp:', c_isp))
}

戻り値

指定された IP アドレスが属する市または県の行政区画コードを文字列で返します。行政区画コードの詳細については、「行政区画コード」をご参照ください。

ip_isp

重要

注意:クライアントアドレスは、インターネットサービスプロバイダー( ISP )の NAT ルールによって変更される場合や、 IP アドレスが Alibaba Cloud CDN のアドレスプールにない場合があるため、戻り値が正確でない可能性があります。ご注意ください。

この関数は、指定された IP アドレスの ISP コードをクエリします。次の表に、この関数の詳細を示します。

項目

説明

構文

ip_isp(ipaddr)

パラメーター

ipaddr: ドット付き 10 進表記で IP アドレスを指定します。

c_country = ip_country('192.168.0.1')
c_region = ip_region('192.168.0.1')
c_city = ip_city('192.168.0.1')
c_isp = ip_isp('192.168.0.1')
if c_country {
    say(concat('ip_country:', c_country)) // ip_country の値を出力
}
if c_region {
    say(concat('ip_region:', c_region)) // ip_region の値を出力
}
if c_city {
    say(concat('ip_city:', c_city)) // ip_city の値を出力
}
if c_isp {
    say(concat('ip_isp:', c_isp)) // ip_isp の値を出力
}

戻り値

指定された IP アドレスの ISP コードを文字列で返します。ISP コードの詳細については、「ISP コード」をご参照ください。

req_uri

この関数の使用上の注意:

  • リクエストに pattern パラメーターが含まれていない場合、リクエストの URI がパラメーターを除いて返されます。

  • リクエストに pattern パラメーターが含まれている場合、リクエストの URI が一致条件と比較されます。

次の表に、この関数の詳細を示します。

項目

説明

構文

req_uri([pattern])

パラメーター

pattern: 一致条件と比較されます。次の種類の一致がサポートされています。

  • 総当たりアルゴリズム: 総当たりアルゴリズムに基づいて値を比較します。これはデフォルトの一致の種類です。

  • 正規表現: re: で指定された先頭の正規表現に基づいて値を比較します。

# req_uri
say(concat('req_uri: ', req_uri()))
if req_uri('/path1/path2') {
    say('req_uri: plain match')
}
if req_uri('re:/path[0-9]/path[0-9]') {
    say('req_uri: regex match')
}

戻り値

  • リクエストに pattern パラメーターが含まれていない場合、リクエスト URI が返されます。データ型: 文字列。

  • リクエストに pattern パラメーターが含まれており、リクエストが一致条件と一致する場合、値 true が返されます。条件が一致しない場合、値 false が返されます。

この例では、次の値が返されます。

Request: /path1/path2?mode=ip   
Response:
req_uri: /path1/path2
req_uri: plain match
req_uri: regex match

req_uri_basename

この関数の使用上の注意:

  • リクエストに pattern パラメーターが含まれていない場合は、リクエスト URI 内のファイル名を返します。

  • リクエストに pattern パラメーターが含まれている場合は、リクエスト URI 内のファイル名と一致条件を比較します。

ファイル名の例:

  • 例 1: /document_detail/30360.html の場合、ファイル名は 30360 です。

  • 例 2: /M604/guopei_mp4/ZYJY2017BJGL0101/2-1_g.mp4 の場合、ファイル名は 2-1_g です。

  • 例 3: /tarball/foo.tar.bz2 の場合、ファイル名は foo です。

次の表に、この関数の詳細を示します。

項目

説明

構文

req_uri_basename([pattern])

パラメーター

pattern: 一致条件と比較されます。次のマッチタイプがサポートされています。

  • 総当たりアルゴリズム: 総当たりアルゴリズムに基づいて値を比較します。これはデフォルトのマッチタイプです。

  • 正規表現: re: で指定された先頭の正規表現に基づいて値を比較します。

# req_uri_basename
# req_uri_basename
basename = req_uri_basename()
say(concat('req_uri_basename: ', basename, ' ', len(basename)))
if req_uri_basename('foo') {
    say('req_uri_basename: プレーンテキスト一致')  // plain match
}
if req_uri_basename('re:^f.*') {
    say('req_uri_basename: 正規表現一致') // regex match
}

戻り値

  • リクエストに pattern パラメーターが含まれていない場合は、リクエスト URI 内のファイル名を返します。データ型: 文字列。

  • リクエストに pattern パラメーターが含まれており、リクエストが一致条件に一致する場合は、値 true が返されます。一致する条件がない場合は、値 false が返されます。

この例では、次の値が返されます。

Request: /path1/path2/foo.tar.bz2
Response:
req_uri_basename: foo 3
req_uri_basename: plain match
req_uri_basename: regex match

req_uri_ext

この関数の使用上の注意:

  • リクエストに pattern パラメーターが含まれていない場合は、リクエスト URI の拡張子を返します。

  • リクエストに pattern パラメーターが含まれている場合は、リクエスト URI の拡張子を一致条件と比較します。

拡張子の例:

  • 例 1: /document_detail/30360.html の場合、拡張子は .html です。

  • 例 2: /M604/guopei_mp4/ZYJY2017BJGL0101/2-1_g.mp4 の場合、拡張子は .mp4 です。

  • 例 3: /tarball/foo.tar.bz2 の場合、拡張子は .tar.bz2 です。

次の表に、この関数の詳細を示します。

項目

説明

構文

req_uri_ext([pattern])

パラメーター

pattern: 一致条件と比較されます。次のマッチタイプがサポートされています:

  • 総当たりアルゴリズム: 総当たりアルゴリズムに基づいて値を比較します。これはデフォルトのマッチタイプです。

  • 正規表現: re: で指定された先頭の正規表現に基づいて値を比較します。

# req_uri_ext
ext = req_uri_ext()
say(concat('req_uri_ext: ', ext, ' ', len(ext)))
if req_uri_ext('.tar.bz2') {
    say('req_uri_ext: プレーンテキスト一致') // plain match
}
if req_uri_ext('re:\.tar\.bz[0-2]') {
    say('req_uri_ext: 正規表現一致') // regex match
}

戻り値

  • リクエストに pattern パラメーターが含まれていない場合は、リクエスト URI の拡張子を返します。データ型: 文字列。

  • リクエストに pattern パラメーターが含まれており、リクエストが一致条件に一致する場合、true の値が返されます。一致する条件がない場合は、false の値が返されます。

この例では、次の値が返されます:

Request: /path1/path2/foo.tar.bz2
Response:
req_uri_ext: .tar.bz2 8
req_uri_ext: プレーンテキスト一致  // plain match
req_uri_ext: 正規表現一致 // regex match

req_uri_seg

この関数の使用上の注意:

  • レスポンス パラメーターでは、セグメントはスラッシュ (/) で区切られます。

    • リクエストに idx パラメーターが含まれていない場合は、すべてのセグメントを返します。

    • リクエストに idx パラメーターが含まれている場合は、指定されたインデックスの後にあるセグメント (インデックスを含む) を返します。

  • パラグラフのインデックス: インデックスは 1 から始まり、パラグラフが追加されると左端のインデックスから増加します。

  • パラグラフの制限: パラグラフには最大 128 文字を含めることができます。この制限を超える文字は削除されます。

次の表に、この関数の詳細を示します。

項目

説明

構文

req_uri_seg([idx])

パラメーター

idx: 開始インデックスを指定します。このパラメーターは省略可能です。

# req_uri_seg
def echo_each(k, v, u) {
    say(concat(get(u, 'msg'), ' : segs[', k, ']=', v))
}
# すべてのセグメントを取得
segs = req_uri_seg()
foreach(segs, echo_each, ['msg'='req_uri_seg()'])
# idx 3 からセグメントを取得
segs = req_uri_seg(3)
if get(segs, 3) {
    say(concat('req_uri_seg(3): segs[3]=', get(segs, 3)))
}
if get(segs, 4) {
    say(concat('req_uri_seg(3): segs[4]=', get(segs, 4)))
}
if get(segs, 5) {
    say(concat('req_uri_seg(3): segs[5]=', get(segs, 5)))
}

戻り値

データ型: 辞書。関連するパラグラフが含まれます。

説明

関数が指定されたインデックスに基づいて返された辞書からパラグラフを取得する場合、関数はパラグラフが空かどうかを確認します。

この例では、次の値が返されます。

Request: /path1/path2/path3/path4?mode=req2
Response:
req_uri_seg() : segs[1]=path1
req_uri_seg() : segs[2]=path2
req_uri_seg() : segs[3]=path3
req_uri_seg() : segs[4]=path4
req_uri_seg(3): segs[3]=path3
req_uri_seg(3): segs[4]=path4

req_uri_arg

この関数は、指定されたパラメーターの値をクエリします。リクエストに pattern パラメーターが含まれている場合、指定されたパラメーターの値が一致条件と比較されます。次の表に、この関数の詳細を示します。

項目

説明

構文

req_uri_arg(name, [pattern])

パラメーター

  • name: パラメーターの名前。

  • pattern: 一致条件と比較されます。次のマッチタイプがサポートされています:

    • 総当たりアルゴリズム: 総当たりアルゴリズムに基づいて値を比較します。これはデフォルトのマッチタイプです。

    • 正規表現: re: で指定された先頭の正規表現に基づいて値を比較します。

# req_uri_arg
uid = req_uri_arg('uid')
if uid {
    say(concat('found uid ', uid)) // uid を見つけた
} else {
    say('not found uid') // uid を見つけられなかった
}
uid_chk = req_uri_arg('uid', '058334')
if uid_chk {
    say('check uid ok. plain mode') // uid チェックOK。プレーンモード
} else {
    say('check uid fail. plain mode') // uid チェック失敗。プレーンモード
}
uid_chk = req_uri_arg('uid', 're:[0-9]+')
if uid_chk {
    say('check uid ok. regex mode') // uid チェックOK。正規表現モード
} else {
    say('check uid fail. regex mode') // uid チェック失敗。正規表現モード
}

戻り値

  • リクエストに pattern パラメーターが含まれていない場合

    • 指定されたパラメーターが存在する: name パラメーターで指定されたパラメーターの値を文字列で返します。

    • 指定されたパラメーターが存在しない: false の値を返します。

  • リクエストに pattern パラメーターが含まれている場合

    • 指定されたパラメーターが存在する: 値が一致条件と一致する場合は true の値を返します。それ以外の場合は、false の値が返されます。

    • 指定されたパラメーターが存在しない: false の値を返します。

この例では、次の値が返されます。

Request: /path1/path2/path3/path4?mode=req4&uid
Response:
not found uid // uid を見つけられなかった
check uid fail. plain mode // uid チェック失敗。プレーンモード
check uid fail. regex mode // uid チェック失敗。正規表現モード

Request: /path1/path2/path3/path4?mode=req4&uid=
Response:
found uid // uid を見つけた
check uid fail. plain mode // uid チェック失敗。プレーンモード
check uid fail. regex mode // uid チェック失敗。正規表現モード

Request: /path1/path2/path3/path4?mode=req4&uid=12345
Response:
found uid 12345 // uid 12345 を見つけた
check uid fail. plain mode // uid チェック失敗。プレーンモード
check uid ok. regex mode // uid チェックOK。正規表現モード

req_uri_query_string

この関数の使用上の注意:

  • リクエストに pattern パラメーターが含まれていない場合、リクエスト内のパラメーターが疑問符 (?) を除いて返されます。

  • リクエストに pattern パラメーターが含まれている場合、リクエスト内のパラメーターは一致条件と比較されます。

次の表に、この関数の詳細を示します。

項目

説明

構文

req_uri_query_string([pattern])

パラメーター

pattern: 一致条件と比較されます。次の照合タイプがサポートされています。

  • 総当たりアルゴリズム: 総当たりアルゴリズムに基づいて値を比較します。これはデフォルトの照合タイプです。

  • 正規表現: re: で指定された先行正規表現に基づいて値を比較します。

# req_uri_query_string
say(concat('req_uri_query_string: ', req_uri_query_string()))
if req_uri_query_string('mode=') {
    say('check uri query string ok. plain mode') // URIクエリ文字列の確認 OK。プレーンモード
} else {
    say('check uri query string fail. plain mode') // URIクエリ文字列の確認 失敗。プレーンモード
}
if req_uri_query_string('re:mode=[0-9a-z]+') {
    say('check uri query string ok. regex mode') // URIクエリ文字列の確認 OK。正規表現モード
} else {
    say('check uri query string fail. regex mode') // URIクエリ文字列の確認 失敗。正規表現モード
}

戻り値

  • リクエストに pattern パラメーターが含まれていない場合、リクエスト内のパラメーターを返します。データ型: 文字列。

  • リクエストに pattern パラメーターが含まれており、リクエストが一致条件と一致する場合、true の値が返されます。一致する条件がない場合は、false の値が返されます。

この例では、次の値が返されます。

Request: /path1/path2/path3/path4?mode=req5&token=34Deasd#243
Response:
req_uri_query_string: mode=req5&token=34Deasd
check uri query string fail. plain mode // URIクエリ文字列の確認 失敗。プレーンモード
check uri query string ok. regex mode // URIクエリ文字列の確認 OK。正規表現モード

req_scheme

この関数の使用上の注意:

  • pattern パラメーターがリクエストに含まれていない場合は、リクエストスキームを返します。

  • pattern パラメーターがリクエストに含まれている場合は、リクエストスキームと一致条件を比較します。

次の表に、この関数の詳細を示します。

項目

説明

構文

req_scheme([pattern])

パラメーター

pattern: 一致条件と比較されます。次のマッチタイプがサポートされています。

  • 総当たりアルゴリズム: 総当たりアルゴリズムに基づいて値を比較します。これはデフォルトのマッチタイプです。

  • 正規表現: re: で指定された先頭の正規表現に基づいて値を比較します。

# req_scheme
say(concat('req_scheme: ', req_scheme()))
if req_scheme('https') {
    say('check scheme ok. plain mode') // スキーム確認OK。プレーンモード
} else {
    say('check scheme fail. plain mode') // スキーム確認失敗。プレーンモード
}
if req_scheme('re:https?') {
    say('check scheme ok. regex mode') // スキーム確認OK。正規表現モード
} else {
    say('check scheme fail. regex mode') // スキーム確認失敗。正規表現モード
}

戻り値

  • pattern パラメーターがリクエストに含まれていない場合は、リクエストスキームを返します。データ型: 文字列。

  • pattern パラメーターがリクエストに含まれており、リクエストが一致条件に一致する場合は、値 true が返されます。一致する条件がない場合は、値 false が返されます。

この例では、次の値が返されます。

Request: http://xx..
req_scheme: http
check scheme fail. plain mode
check scheme ok. regex mode

req_method

この関数の使用上の注意:

  • pattern パラメーターがリクエストに含まれていない場合は、リクエストメソッドを返します。

  • pattern パラメーターがリクエストに含まれている場合は、リクエストメソッドと一致条件を比較します。

次の表に、この関数の詳細を示します。

項目

説明

構文

req_method([pattern])

パラメーター

pattern: 一致条件と比較されます。次のマッチタイプがサポートされています。

  • 総当たりアルゴリズム: 総当たりアルゴリズムに基づいて値を比較します。これはデフォルトのマッチタイプです。

  • 正規表現: re: で指定された先頭の正規表現に基づいて値を比較します。

# req_method
say(concat('req_method: ', req_method()))
if req_method('GET') {
    say('check method ok. plain mode') // メソッド確認OK。プレーンモード
} else {
    say('check method fail. plain mode') // メソッド確認失敗。プレーンモード
}
if req_method('re:(GET|POST)') {
    say('check method ok. regex mode') // メソッド確認OK。正規表現モード
} else {
    say('check method fail. regex mode') // メソッド確認失敗。正規表現モード
}

戻り値

  • pattern パラメーターがリクエストに含まれていない場合は、リクエストメソッドを返します。データ型: 文字列。

  • pattern パラメーターがリクエストに含まれており、リクエストが一致条件に一致する場合は、値 true が返されます。一致する条件がない場合は、値 false が返されます。

この例では、次の値が返されます。

Request: POST /xxxx/xxx
Response:
req_method: POST
check method fail. plain mode
check method ok. regex mode

req_host

この関数の使用上の注意:

  • リクエストに pattern パラメーターが含まれていない場合は、Host リクエストヘッダーの値を返します。

  • リクエストに pattern パラメーターが含まれている場合は、Host リクエストヘッダーの値と一致条件を比較します。

次の表に、この関数の詳細を示します。

項目

説明

構文

req_host([pattern])

パラメーター

pattern: 一致条件と比較されます。次の照合タイプがサポートされています。

  • 総当たりアルゴリズム: 総当たりアルゴリズムに基づいて値を比較します。これはデフォルトの照合タイプです。

  • 正規表現: re: で指定された先頭の正規表現に基づいて値を比較します。

# req_host
say(concat('req_host: ', req_host()))
if req_host('image.developer.aliyundoc.com') {
    say('check host ok. plain mode') // ホストの確認 OK。プレーンモード
} else {
    say('check host fail. plain mode') // ホストの確認 失敗。プレーンモード
}
if req_host('re:.+\.y\.z\.com') {
    say('check host ok. regex mode') // ホストの確認 OK。正規表現モード
} else {
    say('check host fail. regex mode') // ホストの確認 失敗。正規表現モード
}

戻り値

  • リクエストに pattern パラメーターが含まれていない場合は、Host リクエストヘッダーの値を返します。データ型: 文字列。

  • リクエストに pattern パラメーターが含まれており、リクエストが一致条件に一致する場合は、true の値が返されます。一致する条件がない場合は、false の値が返されます。

この例では、次の値が返されます。

Request: Host: image.developer.aliyundoc.com
Response:
req_host: image.developer.aliyundoc.com
check host fail. plain mode
check host ok. regex mode

req_user_agent

この関数の使用上の注意:

  • リクエストに pattern パラメーターが含まれていない場合は、User-Agent リクエストヘッダーの値を返します。

  • リクエストに pattern パラメーターが含まれている場合は、User-Agent リクエストヘッダーの値を一致条件と比較します。

次の表に、この関数の詳細を示します。

項目

説明

構文

req_user_agent([pattern])

パラメーター

pattern: 一致条件と比較されます。次の照合タイプがサポートされています。

  • 総当たりアルゴリズム: 総当たりアルゴリズムに基づいて値を比較します。これはデフォルトの照合タイプです。

  • 正規表現: re: で指定された先頭の正規表現に基づいて値を比較します。

# req_user_agent
say(concat('req_user_agent: ', req_user_agent()))
if req_user_agent('Mozilla') {
    say('check user_agent ok. plain mode') // User-Agent の確認 OK。プレーンモード
} else {
    say('check user_agent fail. plain mode') // User-Agent の確認失敗。プレーンモード
}
if req_user_agent('re:^Mozilla') {
    say('check user_agent ok. regex mode') // User-Agent の確認 OK。正規表現モード
} else {
    say('check user_agent fail. regex mode') // User-Agent の確認失敗。正規表現モード
}

戻り値

  • リクエストに pattern パラメーターが含まれていない場合は、User-Agent リクエストヘッダーの値を返します。データ型: 文字列。

  • リクエストに pattern パラメーターが含まれており、リクエストが一致条件と一致する場合は、値 true が返されます。一致する条件がない場合は、値 false が返されます。

この例では、次の値が返されます。

Request: User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64)
Response:
req_user_agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64)
check user_agent fail. plain mode
check user_agent ok. regex mode

req_referer

この関数の使用上の注意:

  • pattern パラメーターがリクエストに含まれていない場合は、Referer リクエストヘッダーの値を返します。

  • pattern パラメーターがリクエストに含まれている場合は、Referer リクエストヘッダーの値を一致条件と比較します。

次の表に、この関数の詳細を示します。

項目

説明

構文

req_referer([pattern])

パラメーター

pattern: 一致条件と比較されます。次のマッチタイプがサポートされています:

  • 総当たりアルゴリズム: 総当たりアルゴリズムに基づいて値を比較します。これはデフォルトのマッチタイプです。

  • 正規表現: re: で指定された先頭の正規表現に基づいて値を比較します。

# req_referer
say(concat('req_referer: ', req_referer()))
if req_referer('https://example.aliyundoc.com/******00003') {
    say('check referer ok. plain mode') // リファラーチェックOK。プレーンモード
} else {
    say('check referer fail. plain mode') // リファラーチェック失敗。プレーンモード
}
if req_referer('re:https://foo\.bar\.cn/\*+[0-9]+') {
    say('check referer ok. regex mode') // リファラーチェックOK。正規表現モード
} else {
    say('check referer fail. regex mode') // リファラーチェック失敗。正規表現モード
}

戻り値

  • pattern パラメーターがリクエストに含まれていない場合は、Referer リクエストヘッダーの値を返します。データ型: 文字列。

  • pattern パラメーターがリクエストに含まれており、リクエストが一致条件に一致する場合は、true の値が返されます。一致する条件がない場合は、false の値が返されます。

この例では、次の値が返されます:

Request: Referer: https://example.aliyundoc.com/******00003
Response:
req_referer: https://example.aliyundoc.com/******00003
check referer ok. plain mode // リファラーチェックOK。プレーンモード
check referer fail. regex mode // リファラーチェック失敗。正規表現モード

req_cookie

この関数は、指定された Cookie の値を照会します。リクエストに pattern パラメーターが含まれている場合、指定された Cookie の値が一致条件と比較されます。次の表に、この関数の詳細を示します。

項目

説明

構文

req_cookie(name, [pattern])

パラメーター

  • name: Cookie の名前を指定します。

  • pattern: 一致条件と比較されます。次の照合タイプがサポートされています。

    • 総当たりアルゴリズム: 総当たりアルゴリズムに基づいて値を比較します。これはデフォルトの照合タイプです。

    • 正規表現: re: で指定された先行正規表現に基づいて値を比較します。

# req_cookie
uid = req_cookie('uid')
if uid {
    say(concat('found cookie uid ', uid)) // Cookie uid を検出しました
} else {
    say('not found cookie uid') // Cookie uid を検出できませんでした
}
uid_chk = req_cookie('uid', '058334')
if uid_chk {
    say('check cookie uid ok. plain mode') // Cookie uid の確認に成功しました。プレーンモード
} else {
    say('check cookie uid fail. plain mode') // Cookie uid の確認に失敗しました。プレーンモード
}
uid_chk = req_cookie('uid', 're:^[0-9]+')
if uid_chk {
    say('check cookie uid ok. regex mode') // Cookie uid の確認に成功しました。正規表現モード
} else {
    say('check cookie uid fail. regex mode') // Cookie uid の確認に失敗しました。正規表現モード
}

戻り値

  • リクエストに pattern パラメーターが含まれていない場合

    • 指定された Cookie が存在する: name パラメーターで指定された Cookie の値を文字列で返します。

    • 指定されたパラメーターが存在しない: false の値を返します。

  • リクエストに pattern パラメーターが含まれている場合

    • 指定されたパラメーターが存在する: 値が一致条件と一致する場合は true の値を返します。それ以外の場合は、false の値が返されます。

    • 指定されたパラメーターが存在しない: false の値を返します。

この例では、次の値が返されます。

Request: Cookie: uid=123456; token=value2
Response:
found cookie uid 123456
check cookie uid fail. plain mode
check cookie uid ok. regex mode

req_first_x_forwarded

この関数の使用上の注意:

  • pattern パラメーターがリクエストに含まれていない場合、X-Forwarded-For リクエストヘッダーの最初のアドレスを返します。

  • pattern パラメーターがリクエストに含まれている場合、X-Forwarded-For リクエストヘッダーの最初のアドレスと一致条件を比較します。

次の表に、この関数の詳細を示します。

項目

説明

構文

req_first_x_forwarded_addr([pattern])

パラメーター

pattern: 一致条件と比較されます。次のマッチタイプがサポートされています。

  • 総当たりアルゴリズム: 総当たりアルゴリズムに基づいて値を比較します。これはデフォルトのマッチタイプです。

  • 正規表現: re: で指定された先頭の正規表現に基づいて値を比較します。

# req_first_x_forwarded
say(concat('req_first_x_forwarded: ', req_first_x_forwarded()))
if req_first_x_forwarded('1.1.1.1') {
    say('check first_x_forwarded ok. plain mode') // 第1転送先アドレス確認OK。プレーンモード
} else {
    say('check first_x_forwarded fail. plain mode') // 第1転送先アドレス確認失敗。プレーンモード
}
if req_first_x_forwarded('re:1.1.1.[0-9]') {
    say('check first_x_forwarded ok. regex mode') // 第1転送先アドレス確認OK。正規表現モード
} else {
    say('check first_x_forwarded fail. regex mode') // 第1転送先アドレス確認失敗。正規表現モード
}

戻り値

  • pattern パラメーターがリクエストに含まれていない場合、X-Forwarded-For リクエストヘッダーの最初のアドレスを返します。データ型: 文字列。

  • pattern パラメーターがリクエストに含まれており、リクエストが一致条件に一致する場合、true の値が返されます。一致する条件がない場合は、false の値が返されます。

この例では、次の値が返されます。

Request: X-Forwarded-For: 1.1.X.X, 10.10.10.10, 172.16.0.1
Response:
req_first_x_forwarded: 1.1.X.X
check first_x_forwarded ok. plain mode // 第1転送先アドレス確認OK。プレーンモード
check first_x_forwarded ok. regex mode // 第1転送先アドレス確認OK。正規表現モード

req_header

この関数は、指定されたリクエストヘッダーの値を照会します。 pattern パラメーターがリクエストに含まれている場合、指定されたリクエストヘッダーの値が一致条件と比較されます。次の表に、この関数の詳細を示します。

項目

説明

構文

req_header(name, [pattern])

パラメーター

  • name: リクエストヘッダーの名前を指定します。

    リクエストヘッダーのハイフン (-) をアンダースコア (_) に置き換えます。たとえば、X-USER-ID は x_user_id に変更する必要があります。

  • pattern: 一致条件と比較されます。次のマッチタイプがサポートされています。

    • 総当たりアルゴリズム: 総当たりアルゴリズムに基づいて値を比較します。これはデフォルトのマッチタイプです。

    • 正規表現: re: で指定された先頭の正規表現に基づいて値を比較します。

# req_header
uid = req_header('x_uid')
if uid {
    say(concat('found header x-uid ', uid)) // ヘッダー x-uid を見つけました
} else {
    say('not found header x-uid') // ヘッダー x-uid が見つかりません
}
uid_chk = req_header('x_uid', 'es developer')
if uid_chk {
    say('check header x-uid ok. plain mode') // ヘッダー x-uid チェックOK。プレーンモード
} else {
    say('check header x-uid fail. plain mode') // ヘッダー x-uid チェック失敗。プレーンモード
}
uid_chk = req_header('x_uid', 're:es [a-z]+')
if uid_chk {
    say('check header x-uid ok. regex mode') // ヘッダー x-uid チェックOK。正規表現モード
} else {
    say('check header x-uid fail. regex mode') // ヘッダー x-uid チェック失敗。正規表現モード
}

戻り値

  • リクエストに pattern パラメーターが含まれていない場合

    • 指定されたリクエストヘッダーが存在する: name パラメーターで指定されたリクエストヘッダーの値を文字列で返します。

    • 指定されたパラメーターが存在しない: false の値を返します。

  • リクエストに pattern パラメーターが含まれている場合

    • 指定されたパラメーターが存在する: 値が一致条件と一致する場合は true の値を返します。それ以外の場合は、false の値が返されます。

    • 指定されたパラメーターが存在しない: false の値を返します。

この例では、次の値が返されます。

Request: X-UID: es developer // リクエスト:X-UID: es developer
Response: // レスポンス:
found header x-uid es developer // ヘッダー x-uid es developer を見つけました
check header x-uid ok. plain mode // ヘッダー x-uid チェックOK。プレーンモード
check header x-uid ok. regex mode // ヘッダー x-uid チェックOK。正規表現モード

req_id

この関数は、リクエストの Eagle Eye ID を照会します。各 Eagle Eye ID は、リクエストを一意に識別します。次の表に、この関数の詳細を示します。

項目

説明

構文

req_id()

パラメーター

なし

# req_id
say(concat('req_id: ', req_id()))

戻り値

リクエスト ID を文字列で返します。この例では、リクエストの ID は req_id: 6451c43d15815890089411000e です。