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

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

最終更新日:Sep 09, 2024

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

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))

戻り値

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

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)))

戻り値

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

client_country

重要

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

この関数は、クライアントの国コードと管理部門コードを照会します。 この関数の詳細を次の表に示します。

項目

説明

構文

client_country()

パラメーター

なし

例:

c_country = client_country()
c_region = client_region()
c_city = client_city()
c_isp = client_isp()
if c_country {
    say(concat('client_country:', c_country))
}
if c_region {
    say(concat('client_region:', c_region))
}
if c_city { 
    say(concat('client_city:', c_city)) 
}
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_city = client_city()
c_isp = client_isp()
if c_country {
    say(concat('client_country:', c_country))
}
if c_region {
    say(concat('client_region:', c_region))
}
if c_city { 
    say(concat('client_city:', c_city)) 
}
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_city = client_city()
c_isp = client_isp()
if c_country {
    say(concat('client_country:', c_country))
}
if c_region {
    say(concat('client_region:', c_region))
}
if c_city { 
    say(concat('client_city:', c_city)) 
}
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: IPアドレスを10進表記で指定します。

例:

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: IPアドレスを10進表記で指定します。

例:

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アドレスのISPコードを文字列で返します。 ISPコードの詳細については、「ISPコード」をごください。

req_uri

この機能の使用法のノート:

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

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

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

項目

説明

構文

req_uri([パターン])

パラメーター

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

  • ブルートフォースアルゴリズム: ブルートフォースアルゴリズムに基づいて値を比較します。 これはデフォルトの一致タイプです。

  • 正規表現: 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([パターン])

パラメーター

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

  • ブルートフォースアルゴリズム: ブルートフォースアルゴリズムに基づいて値を比較します。 これはデフォルトの一致タイプです。

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

例:

# 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([パターン])

パラメーター

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

  • ブルートフォースアルゴリズム: ブルートフォースアルゴリズムに基づいて値を比較します。 これはデフォルトの一致タイプです。

  • 正規表現: 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から始まり、段落が追加されると左端のインデックスから増加します。

  • Paragraph limit: 段落には最大128文字を含めることができます。 この制限を超える文字は削除されます。

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

項目

説明

構文

req_uri_seg([idx])

パラメーター

idx: 開始インデックスを指定します。 このパラメーターはオプションです。

例:

# req_uri_seg
def echo_each(k, v, u) {
    say(concat(get(u, 'msg'), ' : segs[', k, ']=', v))
}
# fetch all segments
segs = req_uri_seg()
foreach(segs, echo_each, ['msg'='req_uri_seg()'])
# fetch segments from 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)))
}

戻り値

データ型: dictionary。 関連する段落が含まれています。

説明

関数が指定されたインデックスに基づいて返された辞書から段落を取得すると、その段落が空であるかどうかがチェックされます。

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

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, [パターン])

パラメーター

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

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

    • ブルートフォースアルゴリズム: ブルートフォースアルゴリズムに基づいて値を比較します。 これはデフォルトの一致タイプです。

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

例:

# req_uri_arg
uid = req_uri_arg('uid')
if uid {
    say(concat('found uid ', uid))
} else {
    say('not found uid')
}
uid_chk = req_uri_arg('uid', '058334')
if uid_chk {
    say('check uid ok. plain mode')
} else {
    say('check uid fail. plain mode')
}
uid_chk = req_uri_arg('uid', 're:[0-9]+')
if uid_chk {
    say('check uid ok. regex mode')
} else {
    say('check uid fail. regex mode')
}

戻り値

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

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

    • 指定されたパラメーターは存在しません: falseの値を返します。

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

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

    • 指定されたパラメーターは存在しません: falseの値を返します。

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

Request: /path1/path2/path3/path4?mode=req4&uid
Response:
not found uid
check uid fail. plain mode
check uid fail. regex mode

Request: /path1/path2/path3/path4?mode=req4&uid=
Response:
found uid
check uid fail. plain mode
check uid fail. regex mode

Request: /path1/path2/path3/path4?mode=req4&uid=12345
Response:
found uid 12345
check uid fail. plain mode
check uid ok. regex mode

req_uri_query_string

この機能の使用法のノート:

  • リクエストにpatternパラメーターが含まれていない場合は、クエスチョンマーク (?) を除くリクエスト内のパラメーターが返されます。

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

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

項目

説明

構文

req_uri_query_string([パターン])

パラメーター

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

  • ブルートフォースアルゴリズム: ブルートフォースアルゴリズムに基づいて値を比較します。 これはデフォルトの一致タイプです。

  • 正規表現: 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')
} else {
    say('check uri query string fail. plain mode')
}
if req_uri_query_string('re:mode=[0-9a-z]+') {
    say('check uri query string ok. regex mode')
} else {
    say('check uri query string fail. regex mode')
}

戻り値

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

  • 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
check uri query string ok. regex mode

req_scheme

この機能の使用法のノート:

  • パターンパラメータが要求に含まれない場合に, 要求 schemeを返す.

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

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

項目

説明

構文

req_scheme([パターン])

パラメーター

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

  • ブルートフォースアルゴリズム: ブルートフォースアルゴリズムに基づいて値を比較します。 これはデフォルトの一致タイプです。

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

例:

# req_scheme
say(concat('req_scheme: ', req_scheme()))
if req_scheme('https') {
    say('check scheme ok. plain mode')
} else {
    say('check scheme fail. plain mode')
}
if req_scheme('re:https?') {
    say('check scheme ok. regex mode')
} else {
    say('check scheme fail. regex mode')
}

戻り値

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

  • 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([パターン])

パラメーター

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

  • ブルートフォースアルゴリズム: ブルートフォースアルゴリズムに基づいて値を比較します。 これはデフォルトの一致タイプです。

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

例:

# req_method
say(concat('req_method: ', req_method()))
if req_method('GET') {
    say('check method ok. plain mode')
} else {
    say('check method fail. plain mode')
}
if req_method('re:(GET|POST)') {
    say('check method ok. regex mode')
} 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([パターン])

パラメーター

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

  • ブルートフォースアルゴリズム: ブルートフォースアルゴリズムに基づいて値を比較します。 これはデフォルトの一致タイプです。

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

例:

# req_host
say(concat('req_host: ', req_host()))
if req_host('image.developer.aliyundoc.com') {
    say('check host ok. plain mode')
} else {
    say('check host fail. plain mode')
}
if req_host('re:.+\.y\.z\.com') {
    say('check host ok. regex mode')
} 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([パターン])

パラメーター

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

  • ブルートフォースアルゴリズム: ブルートフォースアルゴリズムに基づいて値を比較します。 これはデフォルトの一致タイプです。

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

例:

# req_user_agent
say(concat('req_user_agent: ', req_user_agent()))
if req_user_agent('Mozilla') {
    say('check user_agent ok. plain mode')
} else {
    say('check user_agent fail. plain mode')
}
if req_user_agent('re:^Mozilla') {
    say('check user_agent ok. regex mode')
} else {
    say('check user_agent fail. regex mode')
}

戻り値

  • リクエストに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([パターン])

パラメーター

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

  • ブルートフォースアルゴリズム: ブルートフォースアルゴリズムに基づいて値を比較します。 これはデフォルトの一致タイプです。

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

例:

# req_referer
say(concat('req_referer: ', req_referer()))
if req_referer('https://example.aliyundoc.com/******00003') {
    say('check referer ok. plain mode')
} else {
    say('check referer fail. plain mode')
}
if req_referer('re:https://foo\.bar\.cn/\*+[0-9]+') {
    say('check referer ok. regex mode')
} 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
check referer fail. regex mode

req_cookie

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

項目

説明

構文

req_cookie(name, [パターン])

パラメーター

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

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

    • ブルートフォースアルゴリズム: ブルートフォースアルゴリズムに基づいて値を比較します。 これはデフォルトの一致タイプです。

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

例:

# req_cookie
uid = req_cookie('uid')
if uid {
    say(concat('found cookie uid ', uid))
} else {
    say('not found cookie uid')
}
uid_chk = req_cookie('uid', '058334')
if uid_chk {
    say('check cookie uid ok. plain mode')
} else {
    say('check cookie uid fail. plain mode')
}
uid_chk = req_cookie('uid', 're:^[0-9]+')
if uid_chk {
    say('check cookie uid ok. regex mode')
} else {
    say('check cookie uid fail. regex mode')
}

戻り値

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

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

    • 指定されたパラメーターは存在しません: falseの値を返します。

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

    • 指定されたパラメーターexists: 値が一致条件と一致する場合、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

この機能の使用法のノート:

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

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

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

項目

説明

構文

req_first_x_forwarded_addr([パターン])

パラメーター

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

  • ブルートフォースアルゴリズム: ブルートフォースアルゴリズムに基づいて値を比較します。 これはデフォルトの一致タイプです。

  • 正規表現: 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')
} else {
    say('check first_x_forwarded fail. plain mode')
}
if req_first_x_forwarded('re:1.1.1.[0-9]') {
    say('check first_x_forwarded ok. regex mode')
} else {
    say('check first_x_forwarded fail. regex mode')
}

戻り値

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

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

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

Request: X-Forwarded-For: 1.1.1.1, 10.10.10.10, 172.16.0.1
Response:
req_first_x_forwarded: 1.1.1.1
check first_x_forwarded ok. plain mode
check first_x_forwarded ok. regex mode

req_header

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

項目

説明

構文

req_header(name, [パターン])

パラメーター

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

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

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

    • ブルートフォースアルゴリズム: ブルートフォースアルゴリズムに基づいて値を比較します。 これはデフォルトの一致タイプです。

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

例:

# req_header
uid = req_header('x_uid')
if uid {
    say(concat('found header x-uid ', uid))
} else {
    say('not found header x-uid')
}
uid_chk = req_header('x_uid', 'es developer')
if uid_chk {
    say('check header x-uid ok. plain mode')
} else {
    say('check header x-uid fail. plain mode')
}
uid_chk = req_header('x_uid', 're:es [a-z]+')
if uid_chk {
    say('check header x-uid ok. regex mode')
} else {
    say('check header x-uid fail. regex mode')
}

戻り値

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

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

    • 指定されたパラメーターは存在しません: falseの値を返します。

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

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

    • 指定されたパラメーターは存在しません: falseの値を返します。

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

Request: X-UID: es developer
Response:
found header x-uid es developer
check header x-uid ok. plain mode
check header x-uid ok. regex mode

req_id

この関数は、要求のEagle Eye IDを照会します。 各Eagle Eye IDは、要求を一意に識別する。 この関数の詳細を次の表に示します。

項目

説明

構文

req_id()

パラメーター

なし

例:

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

戻り値

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