OpenResty Edge™ Python SDK 使用者手冊

歡迎查閱 OpenResty Edge™ Python SDK 的使用者手冊。

# 安裝

OpenResty Edge 的 Python SDK 依賴 Python3，請確保您已經安裝好 3.6 及以上版本的 Python3。 您可以像安裝其他 Python3 模組那樣安裝此 Python SDK：

1. 開啟 Linux 終端或 Windows 命令提示符視窗

2. 輸入以下命令安裝 Python SDK：

   pip3 install openresty-edge-sdk --index-url https://pypi.org/simple
   

如果您要安裝特定版本的 Python SDK，則可以在模組名稱後加上版本號：

pip3 install openresty-edge-sdk==1.2.39 --index-url https://pypi.org/simple

安裝命令執行成功後，您可以像下面這樣驗證是否已經正確安裝：

$ python3
>>> from edge2client import Edge2Client
>>> client = Edge2Client('https://EDGE_ADMIN_HOST:EDGE_ADMIN_PORT', 'USERNAME', 'PASSWORD')
>>> client.login()
True
>>> client.get_version()
{'waf': {'waf_version': '3.3.4-1' ...}
>>> exit()

鍵入在 client.login() 後，如果輸出 True，則表示已經正確安裝，如果您的 Edge Admin 使用的是自簽名證書（預設是自簽名證書），那麼你還需要在 client.login() 之前呼叫 client.set_ssl_verify(False)。 接著你還可以使用 client.get_version() 來檢視 OpenResty Edge 的版本資訊。

此外，你可以在這裡看到此 Python SDK 的變更日誌。

至此，安裝已經全部完成，您可以參考本文件中後續的內容，以實現更為複雜的功能。

# 概述

import sys
import time
from edge2client import Edge2Client

def get_client():
    client = Edge2Client(host, username, password)
    # 如果是自簽證書導致 SSL 校驗失敗，可以去掉下面的註釋
    # client.set_ssl_verify(False)
    ok = client.login()

    return client

if __name__ == '__main__':
    try:
        client = get_client()
    except Exception as e:
        print("failed to get client: ", str(e))
        sys.exit(1)

    try:
        app_ids = client.get_all_apps()
    except Exception as e:
        print("failed to get all apps: ", str(e))
        sys.exit(1)

    for app_id in app_ids:
        client.use_app(app_id)
        if client.pending_changes() > 0:
            ret = client.new_release()
            if ret:
                print('release ok app id: ' + str(app_id))
            else:
                print('release failed: ' + str(app_id))
            time.sleep(1)

# 方法列表

# 方法詳情

# Edge2Client

client = Edge2Client(host, username, password, api_token=None)

此方法用於初始化 SDK 客戶端。

引數

返回值

• 返回一個 edge2client.Edge2Client 物件。

示例

1. 當 Edge Admin 的地址為 https://127.0.0.1:443，且使用使用者名稱 username 和密碼 password 初始化 Edge2Client 物件時：

   from edge2client import Edge2Client
   
   client = Edge2Client('https://127.0.0.1:443', 'username', 'password')
   

2. 使用 API Token api_token 來初始化 Edge2Client 物件時：

   from edge2client import Edge2Client
   
   client = Edge2Client('https://127.0.0.1:443', None, None, "api_token")
   

# set_ssl_verify

set_ssl_verify(verify)

設定訪問 Edge Admin 時，是否進行 SSL 驗證，預設會進行驗證。 當您的 Edge Admin 使用的是自簽名的證書時，那麼需要把 SSL 驗證關閉。

引數

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.set_ssl_verify(False)
ok = client.login()

# login

ok = login()

此方法用於登入 OpenResty Edge，以便進行後續操作。

返回值

• True：表示登入成功。
• False：表示登入失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)

ok = client.login()

# use_app

ok = use_app(app_id)

此方法用於指定當前例項操作的應用 ID。

返回值

• True：應用 ID 指定成功。
• False：應用 ID 指定失敗。

示例

下面的示例演示如何將當前例項操作的應用 ID 更改為 10。

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 10
client.use_app(app_id)

# new_app

app_id = new_app(domains, label)

此方法用於新增 HTTP 應用。

引數

返回值

• app_id：返回新建應用的 ID，其資料型別為 number。

示例

以下示例展示瞭如何建立一個域名為 orig.foo.com，標籤為 origin site for foo.com 的 HTTP 應用，且該應用所在的叢集組為 [1]。

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = client.new_app(
    domains=['orig.foo.com'],
    label='origin site for foo.com',
    cluster_groups = [1])

# put_app

ok = put_app(app_id, domains, label, cluster_groups=None, offline=None)

此方法用於修改 HTTP 應用的基本資訊。

引數

返回值

• True：表示修改成功。
• False：表示修改失敗。

示例

以下示例展示瞭如何將已建立的應用（其域名為 orig.foo.com）的域名修改為 *.foo.com。

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 10
client.use_app(app_id)

ok = client.put_app(app_id, domains=['*.foo.com'], label='foo.com')

# get_app

data = get_app()

此方法用於獲取 HTTP 應用的相關資訊，包括域名、標籤以及所屬群組等。

返回值

• data：返回一個 dict 型別的資料。

示例

以下示例演示瞭如何獲取 app_id 為 1 的應用資訊。

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

data = client.get_app()

# put_app_config

put_app_config(app_id, limiter)

此方法用於修改 HTTP 應用的配置。

引數

返回值

• True：配置修改成功。
• False：配置修改失敗。

示例

以下示例展示瞭如何修改 app_id 為 1 的應用配置。

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1

res = client.put_app_config(app_id=app_id,
                            limiter={
                                        'max_uri_args': 130,
                                        'max_post_args': 140,
                                        'max_req_headers': 150,
                                        'check_post_args_type': True
                                    },
                            enable_websocket=True)

# get_app_config

data = get_app_config(app_id)

此方法用於獲取指定 HTTP 應用的配置資訊。

引數

返回值

• data：返回一個字典（dict）型別的資料。

示例

下例展示瞭如何獲取 id 為 1 的應用的配置資訊：

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1

data = client.get_app_config(app_id)

# del_app

success = del_app(app_id)

此方法根據提供的 app_id 刪除指定的 HTTP 應用。

引數

返回值

• True：表示應用刪除成功。
• False：表示應用刪除失敗。

示例

以下示例展示瞭如何刪除 app_id 為 1 的應用。

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1

success = client.del_app(app_id)

# search_app

data = search_app(app_domain)

此方法用於根據指定域名搜尋 HTTP 應用。

引數

返回值

• data：返回一個 list 型別的結果，其中每個元素都是應用的相關資訊。

示例

以下示例以 orig.foo.com 為域名來搜尋 HTTP 應用。

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

data = client.search_app(app_domain='orig.foo.com')

# search_http_app_by_keyword

data = search_http_app_by_keyword(keyword, page, pagesize)

此方法用於根據域名或應用名稱搜尋 HTTP 應用。

引數

返回值

• data：此返回值為 list 型別，每個元素包含應用的相關資訊。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

data = client.search_http_app_by_keyword('orig.foo.com')
data = client.search_http_app_by_keyword('orig.foo.com', 1, 2)
data = client.search_http_app_by_keyword('origin')

# search_upstream_by_ip

data = search_upstream_by_ip(ip, page=1, pagesize=20)

此方法用於透過 IP 地址搜尋上游資訊。

引數

返回值

• data：返回一個list型別的資料，列表中的每一個元素代表一個上游的詳細資訊。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

data = client.search_upstream_by_ip('1.1.1.1')

# search_k8s_upstream_by_ip

data = search_k8s_upstream_by_ip(ip, page, pagesize)

這個方法用於根據 IP 搜尋 Kubernetes 上游。

引數

返回值

• data：一個list型別的變數，其中包含了 Kubernetes 上游的資訊。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

data = client.search_k8s_upstream_by_ip('1.1.1.1')

# search_upstream_by_name

data = search_upstream_by_name(name, page, pagesize)

此方法用於根據名稱搜尋上游。

引數

返回值

• data：此為list 型別，每個元素都代表了一條上游資訊。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

data = client.search_upstream_by_name('test')

# search_k8s_upstream_by_name

data = search_k8s_upstream_by_name(name, page, pagesize)

此方法用於透過指定名稱搜尋 Kubernetes 上游。

引數

返回值

• data：此為 list 型別，包含多個 Kubernetes 上游的資訊。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

data = client.search_k8s_upstream_by_name('test')

# search_k8s_upstream

data = search_k8s_upstream(namespace, service, port, page, pagesize, type_list)

此方法允許使用者透過指定名稱空間，服務名稱和埠號來搜尋 Kubernetes 上游。

引數

返回值

• data：list 型別，列表中每個元素都是 Kubernetes 上游的資訊。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

data = self.client.search_k8s_upstream(port = 80, service = "test-hello", namespace = "default")

# search_k8s_upstream_history

data = search_k8s_upstream_history(page, pagesize, start_time, end_time)

此方法根據名稱空間、服務名稱和埠號搜尋 Kubernetes 上游歷史。

引數

返回值

• data：返回值為 list 型別，每個元素代表一個 Kubernetes 上游的更新歷史操作。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

data = client.search_k8s_upstream_history(port = 80, service = "test-hello", namespace = "default")

# get_all_apps

data = get_all_apps(detail)

此方法用於獲取所有應用的資訊。

引數

返回值

• 當 detail 引數為 False 時，函式返回一個包含所有的 app id 的 list 型別的 Python 物件，包含所有應用的基本資訊。
• 當 detail 引數為 True 時，函式返回一個以 app id 作為鍵值的 dict 型別的 Python 物件，包含所有應用的詳細資訊。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

# 獲取基本資訊
apps = client.get_all_apps()

# 獲取詳細資訊
apps = client.get_all_apps(detail=True)

# new_upstream

up_id = new_upstream(**kwargs)

此方法用於新增上游，返回值為新增上游的 id。

引數

servers 引數

返回值

• up_id：表示建立成功的上游的 ID。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

up_id = client.new_upstream(
    name='origin-upstream',
    servers=[
        {'ip': '172.22.31.1', 'port': 80},
        {'ip': '172.22.31.2', 'port': 80, 'weight': 2}
    ])

# put_upstream

ok = put_upstream(**kwargs)

此方法用於修改上游資訊。

引數

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

up_id = 1
ok = client.put_upstream(up_id,
    name='origin-upstream',
    servers=[
        {'domain': 'test.com', 'port': 8080},
        {'ip': '172.22.31.2', 'port': 8080, 'weight': 1}
    ],
    health_checker={
        'type': 'http',
        'http_req_uri': '/status',
        'http_req_host': 'test.com',
        'interval': 3,
        'interval_unit': 'sec',
        'timeout': 1,
        'fall': 3,
        'rise': 2,
        'valid_statuses': [200, 302],
        'report_interval': 3,
        'report_interval_unit': 'min'
    })

# get_upstream

data = get_upstream(up_id)

此方法用於獲取上游資訊。

引數

返回值

• data：返回型別為 dict 的上游資訊。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

up_id = 1
data = client.get_upstream(up_id)

# del_upstream

del_upstream(up_id)

此方法用於刪除上游。

引數

返回值

• 返回 True：表示上游刪除成功。
• 返回 False：表示上游刪除失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

up_id = 1

ok = client.del_upstream(up_id)

在這個示例中，我們首先匯入了 Edge2Client，然後建立了一個 Edge2Client 物件，使用 host，username 和 password 進行登入。然後，我們嘗試用 del_upstream 方法刪除識別符號為 1 的上游。

# get_all_upstreams

upstreams = client.get_all_upstreams()

此方法用於獲取所有上游的詳細資訊。

返回值

• upstreams：返回一組list型別的資料，包含所有上游資訊。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

upstreams = client.get_all_upstreams()

# new_k8s_upstream

up_id = new_k8s_upstream(**kwargs)

本函式用於新增全域性 Kubernetes 上游，將返回新建立的 k8s 上游的 ID。

引數

k8s_services 引數

返回值

• up_id：新建立的 k8s 上游的 ID。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

k8s_up_id = client.new_k8s_upstream(
    name = 'k8s-upstream',
    k8s_services = [
        {
            'k8s' : 1,
            'k8s_namespace' : 'default',
            'k8s_service' : 'foo',
            'k8s_service_port' : 80,
        }
    ])

# copy_upstream_to_k8s_upstream

k8s_up_id = copy_upstream_to_k8s_upstream(up_id, k8s_services, rules)

此方法用於將一個常規上游複製為一個 Kubernetes 上游。

引數

返回值

• up_id：新建立的 Kubernetes 上游的 ID。

示例

示例一：

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = client.new_app(domains = ['orig.foo.com'], label = 'origin site for foo.com')

up_id = client.new_upstream(name = 'origin-upstream',
                            servers = [
                                {'ip': '172.22.31.1', 'port': 80},
                                {'ip': '172.22.31.2', 'port': 80, 'weight': 2}
                            ])

k8s_up_id = client.copy_upstream_to_k8s_upstream(up_id,
                            k8s_services = [
                                {
                                    'k8s' : 1,
                                    'k8s_namespace' : 'default',
                                    'k8s_service' : 'foo',
                                    'k8s_service_port' : 80,
                                }
                            ])

示例二：

client.use_app(app_id)

rules = client.get_all_rules()

k8s_up_id = client.copy_upstream_to_k8s_upstream(up_id = up_id,
                            k8s_services = [
                                {
                                    'k8s' : 1,
                                    'k8s_namespace' : 'default',
                                    'k8s_service' : 'foo',
                                    'k8s_service_port' : 80,
                                }
                            ],
                            rules = rules)

# put_k8s_upstream

ok = put_k8s_upstream(**kwargs)

此方法用於修改 Kubernetes 上游資訊。

引數

返回值

• True：表示修改成功。
• False：表示修改失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

up_id = 1
ok = client.put_k8s_upstream(up_id,
    name='k8s-upstream',
    k8s_services = [
        {
            'k8s' : 1,
            'k8s_namespace' : 'default',
            'k8s_service' : 'foo',
            'k8s_service_port' : 80,
        }
    ],
    health_checker={
        'type': 'http',
        'http_req_uri': '/status',
        'http_req_host': 'test.com',
        'interval': 3,
        'interval_unit': 'sec',
        'timeout': 1,
        'fall': 3,
        'rise': 2,
        'valid_statuses': [200, 302],
        'report_interval': 3,
        'report_interval_unit': 'min'
    })

# get_k8s_upstream

data = get_k8s_upstream(up_id)

此方法用於獲取 k8s 上游的資訊。

引數

返回值

• data：返回一個 dict 型別的資料。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

up_id = 1
data = client.get_k8s_upstream(up_id)

# del_k8s_upstream

success = del_k8s_upstream(upstream_id)

此方法用於刪除 k8s（Kubernetes）上游。

引數

返回值

• True：表示刪除成功。
• False：表示刪除失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

upstream_id = '1'
success = client.del_k8s_upstream(upstream_id)

# get_all_k8s_upstreams

upstreams = client.get_all_k8s_upstreams()

此方法用於獲取所有 Kubernetes 上游的資訊。

返回值

• upstreams：返回一個 list 型別的 Kubernetes 上游列表。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

upstreams = client.get_all_k8s_upstreams()

# new_rule

rule_id = new_rule(**kwargs)

此方法用於新建頁面規則，包含各種規則型別，如：通用規則，代理規則，WAF 規則和快取規則。你也可以指定規則執行的前提條件。

引數

condition 引數

conseq 引數

conseq 可以是 dict 型別或者 list 型別，如下是一個 dict 型別的例子。

waf 引數

proxy 引數

proxy 陣列的描述如下：

upstreams 引數

upstreams 與 backup_upstreams 陣列的描述如下：

cache 引數

返回值

• rule_id：新規則的 ID。

示例

示例一：使用 dict 型別的條件和動作來新建規則。

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

condition = [
    {
        'var': 'host',
        'val': 'test.openresty.com'
    },
    {
        'var': ['req-header', 'Referer'],
        'vals': [
            'foo.com',
            ['foo\d+', 'rx'],
            ['foo*', 'wc']
        ]
    }
]

conseq = {
    'enable-websocket': {},
    'redirect': {'url': '/cn/2017/', 'code': 302}
}

rule_id = client.new_rule(condition=condition, conseq=conseq)

由於 dict 型別不能自行排序，並且不能設定重複名稱的動作， 所以推薦下面這種使用 list 型別代替 dict 型別的方式。

示例二：使用 list 型別的條件和動作來新建規則。

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

condition = [
    {'var': 'host', 'val': 'test.openresty.com'},
    {'var': ['req-header', 'Referer'], 'vals': [['foo\d+', 'rx'], 'foo.com']}
]

conseq = [
    {'set-proxy-header': {
        'header': 'Foo',
        'value': 'default'
    }},
    {'set-proxy-header': {
        'header': 'Host',
        'value': "orig"
    }},
    {'print': {
        'msg': 'hello'
    }}
]

rule_id = client.new_rule(condition=condition, conseq=conseq)

示例三：啟用 WAF 規則。

建立自定義的 WAF 規則，並在應用中使用該規則。

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

global_waf_rule_id = client.new_global_waf_rule(
    name='foo',
    code="uri-arg('foo') => waf-mark-risk(level: 'definite', msg: 'found foo');")

condition = [{'var': 'uri', 'op': 'prefix', 'val': '/foo'}]

waf_rule = {
    'rule_sets': [global_waf_rule_id],
    'action': '403 Forbidden', 'threshold': 'low'}

rule_id = client.new_rule(condition=condition, waf=waf_rule)

示例四：啟用代理規則。

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

up_id = client.new_upstream(
    name='origin-upstream',
    servers=[
        {'ip': '172.22.31.1', 'port': 80},
        {'ip': '172.22.31.2', 'port': 80, 'weight': 2}
    ])

k8s_up_id = client.new_k8s_upstream(
    name='k8s-upstream',
    k8s_services = [
        {
            'k8s' : k8s_id,
            'k8s_namespace' : 'default',
            'k8s_service' : 'test-hello',
            'k8s_service_port' : 80,
        }
    ])

ok = client.put_upstream(up_id,
    name='origin-upstream',
    servers=[
      {'ip': '172.22.31.1', 'port': 8080},
      {'ip': '172.22.31.2', 'port': 8080, 'weight': 1}
    ])

backup_up_id = client.new_upstream(
    name='backup-upstream',
    servers=[
        {'ip': '172.22.31.3', 'port': 80},
        {'ip': '172.22.31.4', 'port': 80, 'weight': 3}
    ])

proxy_rule = {
    'upstreams': [{'upstream': up_id, 'weight': 2}],
    'backup_upstreams': [{'upstream': backup_up_id}],
    'upstream_el_code': '',
    'retries': 2,
    "retry_condition": ["invalid_header", "http_500"],
    "balancer_algorithm": "hash",
    "balancer_vars": [
        {"name":"uri"},
        {
            "name":"uri-arg",
            "args":"foo"
        }
    ]
}

rule_id = client.new_rule(proxy = proxy_rule)

k8s_proxy_rule = {
    'upstreams': [{'k8s_upstream': k8s_up_id, 'weight': 2}],
    'upstream_el_code': '',
    'retries': 2,
    "retry_condition": ["invalid_header", "http_500"],
    "balancer_algorithm": "hash",
    "balancer_vars": [
        {"name":"uri"},
        {
            "name":"uri-arg",
            "args":"foo"
        }
    ]
}

k8s_rule_id = client.new_rule(proxy = k8s_proxy_rule)

示例五：啟用快取。

在該示例中，當訪問來源的 IP 位於中國（CN）時，將會實施快取規則。具體的快取 key 包含 URL、查詢字串以及客戶端來源的城市。

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

condition = [{'var': 'client-country', 'op': 'eq', 'val': 'CN'}]
# cache_key = ['uri', 'query-string', 'client-city']
# or
cache_key = [
    {'name': 'uri'},
    {'name':'query-string'},
    {'name': 'client-city', 'args': 'first-x-forwarded-addr'}
]

default_ttls = [
    {
        'ttl_unit': "min", 'status': 200, 'ttl': 1
    }, {
        'ttl_unit': "min", 'status': 301, 'ttl': 1
    }
]
cache_rule = {'cache_key': cache_key, 'default_ttls': default_ttls}

rule_id = client.new_rule(condition=condition, cache=cache_rule)

# put_rule

ok = put_rule(**kwargs)

此方法用於修改頁面規則。

引數

返回值

• True：表示成功。
• False：表示失敗。

示例

from edge2client import Edge2Client
from edge2client.constants import OFF, ON

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

conseq = {
    'enable-websocket': {},
    'redirect': {'url': '/cn/2017/', 'code': 302},
    'user-code': {'el': 'true => say(\"hello\");'}
}

conseq['redirect']['url'] = '/cn/2018/'

ok = client.put_rule(rule_id=rule_id, condition=condition, conseq=conseq)

# 關閉頁面規則中的條件
ok = client.put_rule(rule_id=rule_id, condition=OFF, conseq=conseq)

# get_rule

data = get_rule(rule_id)

此方法用於根據規則 ID 獲取頁面規則。

引數

返回值

• data：返回一個 dict 型別的頁面規則資訊。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

rule_id = 1
data = client.get_rule(rule_id)

# del_rule

success = del_rule(rule_id)

此方法用於刪除與 rule_id 對應的頁面規則。

引數

返回值

• True：表示頁面規則成功刪除。
• False：表示頁面規則刪除失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

rule_id = 1
success = client.del_rule(rule_id)

# get_all_rules

rules = get_all_rules(app_id)

此方法用於獲取指定應用 ID (app_id) 的所有頁面規則。

引數

返回值

• 返回一個規則列表，該列表中的每個元素的型別與 get_rule 函式的返回值型別一致。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

data = client.get_all_rules()

# reorder_rules

ok = reorder_rules(orders)

此方法用於調整規則的順序。

引數

返回值

• True：如果成功調整規則順序。
• False：如果調整規則順序失敗。

示例

以下示例展示瞭如何調換規則 ID 2 和 3 的順序。

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

new_orders = {
    1: 1,
    2: 3,
    3: 2,
}
data = client.reorder_rules(new_orders)

# get_all_rules_by_app_domain

rules = get_all_rules_by_app_domain(domain)

此方法用於根據指定的應用域名獲取對應的頁面規則。

引數

返回值

• rules：list 型別的規則列表。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

data = client.get_all_rules_by_app_domain('orig.foo.com')

# get_all_rules_by_upstream_ip

rules = get_all_rules_by_upstream_ip(upstream_ip)

此方法用於根據上游 IP 地址來檢索所有關聯的頁面規則。

引數

返回值

• rules：這是一個包含所有相關規則的 list 型別列表。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

upstream_ip = '1.2.3.4'
data = client.get_all_rules_by_upstream_ip(upstream_ip)

for app_id, rules in data.items():
    print(app_id)

# get_all_waf_rules

rules = get_all_waf_rules(app_id)

此方法用於根據特定的應用 id (app_id) 獲取對應的 WAF 規則。

引數

返回值

• rules：返回一種 list 型別的規則列表。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

data = client.get_all_waf_rules()

# get_global_actions_used_in_app

rule_ids = get_global_actions_used_in_app(app_id)

此方法用以獲取與應用 ID (app_id) 相關聯的自定義規則 ID。

引數

返回值

• rule_ids：返回一個列表，其中元素為各自規則的唯一 ID。如果需要獲取規則的詳細資訊，可以依據這些規則 ID 進行進一步查詢，詳情請參閱 get_global_rule() 方法。

示例

以下示例展示瞭如何獲取所有全域性規則的 ID。

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
rule_ids = client.get_global_actions_used_in_app(app_id)

# set_cert_key

cert_id = set_cert_key(**kwargs)

此方法用於新增 SSL 證書並提供手動上傳證書的選項。

引數

返回值

• cert_id：返回新新增的證書的 ID。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

key_file = os.path.join('tests', 'key.pem')
cert_file = os.path.join('tests', 'cert.pem')

with open(key_file) as f:
    key = f.read()
with open(cert_file) as f:
    cert = f.read()

cert_id = client.set_cert_key(key=key, cert=cert)

# set_le_cert

cert_id = set_le_cert(**kwargs)

此方法用於新增 Let’s Encrypt 證書或其他證書提供商（如 ZeroSSL）的證書。

引數

返回值

• cert_id：新建立的 Let’s Encrypt 證書的 ID

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

cert_id = client.set_le_cert(domains=["orig.foo.com"])

# put_cert_key

ok = put_cert_key(**kwargs)

此方法用於更新 SSL 證書（手動上傳方式）。

引數

返回值

• True：表示更新成功。
• False：表示更新失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

new_key_file = os.path.join('tests', 'new_key.pem')
new_cert_file = os.path.join('tests', 'new_cert.pem')
with open(new_key_file) as f:
    new_key = f.read()
with open(new_cert_file) as f:
    new_cert = f.read()

cert_id = 1
ok = client.put_cert_key(cert_id=cert_id, key=new_key, cert=new_cert)

# put_le_cert

ok = put_le_cert(**kwargs)

此方法用於更新 Let’s Encrypt 證書或其他證書提供商（如 ZeroSSL）提供的證書。

引數

返回值

• True：表示成功。
• False：表示失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

cert_id = 1
ok = client.put_le_cert(cert_id=cert_id, domains=["xx.foo.com"], resign=False)

# get_le_cert

data = get_le_cert(cert_id)

此方法用於獲取 Let’s Encrypt 證書的簽發狀態。

引數

返回值

• data：返回一個 dict 型別的資料，包含以下欄位：

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

cert_id = 1
data = client.get_le_cert(cert_id)

# get_cert_key

cert_data = get_cert_key(cert_id)

此方法用於獲取 SSL 證書內容。

引數

返回值

• 返回值為 cert_data，表示證書的內容，資料型別為 dict。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

cert_id = 1
data = client.get_cert_key(cert_id)

# get_all_cert_keys

cert_data = get_all_cert_keys()

此方法用於獲取當前應用的全部證書資訊。

返回值

• cert_data：以 dict 型別返回的證書資料。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

data = client.get_all_cert_keys()

# del_cert_key

success = del_cert_key(certificate_id)

刪除與給定的 certificate_id 相關聯的證書資訊。

引數

返回值

• True：刪除成功。
• False：刪除失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

application_id = 1
client.use_application(application_id)

certificate_id = 1
success = client.del_cert_key(certificate_id)

# new_el

ok = new_el(**kwargs)

此方法用於新增自定義的 edge 語言程式碼。

引數

返回值

• True：表示成功。
• False：表示失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

code = "true => print('hello, world');"

ok = client.new_el(phase='req-rewrite', code=code, pre=True)

# new_release

ok = new_release()

此方法用於釋出當前應用的更新。

返回值

• True：表示更新成功。
• False：表示更新失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

ok = client.new_release()

此示例展示瞭如何使用 Edge2Client 的 new_release 方法來發布應用的更新。

# pending_changes

changes = pending_changes()

此方法用於查詢待發布的更改數量。

返回值

• changes：這是一個整數，表示待發布的更改數量。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

changes = client.pending_changes()

在上述示例中，首先建立了一個 Edge2Client 例項並完成登入。隨後，將應用的 id 設定為 1，並透過 pending_changes 函式查詢待發布的更改數量。

# sync_status

total, synced = sync_status()

查詢當前的同步狀態。

返回值

• total：Edge Node 伺服器的總數量。
• synced：已成功同步的 Edge Node 伺服器的數量。

示例

建立多個規則，並確認它們是否已成功釋出到全網。

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

total, synced = client.sync_status()
if total == synced:
    print('新的釋出已同步到所有節點')

# node_sync_status

data = node_sync_status()

此方法用於獲取各節點的同步詳情。

返回值

• data：dict 型別，它返回每個節點的 node_id 以及該節點上一次釋出到現在的延遲時間。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

data = client.node_sync_status()
for node_id, delay in data.items():
    if delay > 0:
        print('警告：節點 id {}: 落後 {}'
        .format(str(node_id), str(delay)))

# get_healthcheck_status

data = get_healthcheck_status(node_id, page=1, page_size=1000)

這段程式碼用於獲取各節點的健康檢查資訊。

返回值

• data：這是一個dict型別的資料，它返回每個節點的 node_id 以及對應節點的健康狀態。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

data = client.node_sync_status()

for node_id, node_info in data.items():
    node_id = int(node_id)
    data = client.get_healthcheck_status(node_id, 1, 1000)

# add_app_user

user_id = add_app_user(name, read, write, release, dns_read, dns_write)

此方法用於新增應用級使用者。

引數

返回值

• user_id：新新增使用者的 ID。

請注意：此處的 user_id 與全域性使用者的 user_id 不同。

示例

以下示例展示瞭如何新增一個應用級使用者，使用者名稱為 only_reader，並且沒有寫許可權和釋出更動許可權。

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

user_id = client.add_app_user(name='only_reader', write=False, release=False)

# update_app_user

success = update_app_user(id, name, read, write, release, dns_read, dns_write)

此方法用於更新應用級的使用者資訊。

引數

返回值

• True：使用者資訊更新成功。
• False：使用者資訊更新失敗。

示例

以下示例展示瞭如何使用此方法更新 id 為 1 的使用者的許可權，將使用者名稱設定為 master，並賦予寫入和釋出更改的許可權。

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

uid = 1
success = client.update_app_user(id=uid, name='master', write=True, release=True)

# get_app_user

data = get_app_user(id=None, name=None, app_id=None, user_id=None)

此方法用於獲取應用級別的使用者資訊，包括使用者名稱、許可權等。

引數

返回值

• data：返回一個字典型別的資料，包含使用者名稱、許可權等使用者資訊。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

username = 'only_reader'
data = client.get_app_user(name=username)

# del_app_user

ok = del_app_user(id, name, app_id, user_id)

此方法用於刪除特定應用的使用者。

引數

返回值

• 如果操作成功，則返回 True。
• 如果操作失敗，則返回 False。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

username = 'only_reader'
ok = client.del_app_user(name=username)

在這個例子中，我們首先建立了一個 Edge2Client 例項並登入。然後，我們選擇了一個應用，最後我們透過傳入使用者名稱來刪除應用的使用者。

# get_all_app_users

data = get_all_app_users(app_id)

此方法用於獲取所有當前應用級別的使用者，也可以透過指定 app_id 來獲取特定應用的使用者。

引數

返回值

• data：返回值為list型別，列表中的每個元素都是 dict 型別。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

data = client.get_all_app_users()

# add_user_for_all_apps

ok = add_user_for_all_apps(name, read, write, release, dns_read, dns_write)

此方法用於為所有應用新增使用者。

引數

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

# 利用 add_global_user() 函式建立名為 'write' 的使用者。
username='write'

data = client.add_user_for_all_apps(name=username)

# add_all_users_for_app

ok = add_all_users_for_app(app_id, read, write, release, dns_read, dns_write)

此方法用於將所有全域性使用者新增到指定應用。

引數

返回值

• True：表示新增成功。
• False：表示新增失敗。

示例

以下示例展示瞭如何為 ID 為 1 的應用新增使用者，其中所有全域性使用者都將新增在該應用下，且 release (釋出更動) 許可權為 True，其他許可權保持預設值。

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

data = client.add_all_users_for_app(release=True)

# new_cache_purge_task

task_id = client.new_cache_purge_task(condition=condition)

此方法用於新增條件重新整理任務。任務的觸發條件以陣列形式傳遞，支援設定多個觸發條件。只有當所有設定的條件同時滿足時，才會觸發對應的重新整理任務。

引數

返回值

• task_id：返回已建立的重新整理任務的 ID，可透過此 ID 查詢重新整理任務的執行詳情。

示例

以下示例中，新建的條件重新整理任務的觸發條件設定為：“當訪問的 Host 為 con.foo.com，並且請求頭中 Referer 的值匹配到正規表示式 foo\d+ 時。”

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

condition = [
    {'var': 'host', 'val': 'con.foo.com'},
    {'var': ['req-header', 'Referer'], 'vals': [['foo\d+', 'rx'], 'foo.com']}
]

rule_id = client.new_cache_purge_task(condition=condition)

# get_cache_purge_task

data = client.get_cache_purge_task(task_id)

此方法透過指定的重新整理任務 id 來查詢任務的詳細資訊。

引數

返回值

• data：返回的是一個包含任務詳情的字典（dict）型別的資料。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

task_id = 1

data = client.get_cache_purge_task(task_id)

# get_all_cache_purge_tasks

data = client.get_all_cache_purge_tasks()

此方法用於獲取所有快取重新整理任務的詳細資訊。

返回值

• data：返回一個包含所有重新整理任務的列表。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

data = client.get_all_cache_purge_tasks()

# del_cache_purge_task

ok = client.del_cache_purge_task(task_id)

此方法用於刪除指定 ID 的重新整理任務。

引數

返回值

• True：表示成功刪除。
• False：表示刪除失敗。

示例

以下示例展示如何刪除 ID 為 1 的重新整理快取任務。

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

task_id = 1
ok = client.del_cache_purge_task(task_id)

# new_waf_whitelist

rule_id = new_waf_whitelist(**kwargs)

此方法用於新增 WAF 白名單規則。

引數

WAF Condition 引數

返回值

• rule_id：新建立的 WAF 白名單規則的 ID。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

condition = [
    {'var': 'host', 'val': 'con.foo.com'},
    {'var': ['req-header', 'Referer'], 'vals': [['foo\d+', 'rx'], 'foo.com']}
]

id = client.new_waf_whitelist(condition=condition, rule_sets=[1, 2])

# update_waf_whitelist

ok = update_waf_whitelist(**kwargs)

此方法用於更新 WAF 白名單規則。

引數

返回值

• 若成功，返回 True。
• 若失敗，返回 False。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

condition = [
    {'var': 'host', 'val': 'con.foo.com'},
    {'var': ['req-header', 'Referer'], 'vals': [['foo\d+', 'rx'], 'foo.com']}
]

waf_whitelist_id = 1
ok = client.update_waf_whitelist(
    whitelist_id=waf_whitelist_id, condition=condition, rule_sets=[1])

# get_waf_whitelist

data = get_waf_whitelist(whitelist_id)

此方法用於獲取 WAF 的白名單規則。

引數

返回值

• data：返回一個 dict 型別，包含 WAF 白名單的規則資料。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

data = client.get_waf_whitelist(waf_whitelist_id)

# del_waf_whitelist

ok = del_waf_whitelist(whitelist_id)

執行此操作會刪除指定的 WAF 白名單規則。

引數

返回值

• True：表示刪除成功。
• False：表示刪除失敗。

示例

from edge2client import Edge2Client

# 初始化客戶端並登入
client = Edge2Client(host, username, password)
client.login()

# 指定 APP ID
app_id = 1
client.use_app(app_id)

# 刪除特定 WAF 白名單規則
ok = client.del_waf_whitelist(waf_whitelist_id)

# get_all_waf_whitelists

data = get_all_waf_whitelists()

此方法用於獲取所有的 WAF 白名單規則。

返回值

• data：返回一個 list 型別的 WAF 白名單資料。

示例

from edge2client import Edge2Client

# 建立並登入客戶端
client = Edge2Client(host, username, password)
client.login()

# 選擇應用
app_id = 1
client.use_app(app_id)

# 獲取所有的 WAF 白名單
data = client.get_all_waf_whitelists()

# new_app_dymetrics

id = new_app_dymetrics(app_id=None, name=None, note=None, interval=60, sql=None)

建立新的應用動態指標。如果想要開啟 OpenResty Edge 的內建動態指標，可以從此文件獲取內建動態指標的名稱及 SQL。

引數

返回值

• id：新建立的動態指標的唯一識別符號。

示例

from edge2client import Edge2Client

# 建立並登入客戶端
client = Edge2Client(host, username, password)
client.login()

sql = 'select status, count(*) from reqs group by status'

dymetrics_id = client.new_app_dymetrics(app_id=1, name='test', sql=sql)

# put_app_dymetrics

ok = put_app_dymetrics(app_id=None, id=None, name=None, note=None, interval=60, sql=None)

此方法用於修改應用的動態指標。

引數

返回值

• True：表示修改成功。
• False：表示修改失敗。

示例

from edge2client import Edge2Client

# 建立並登入客戶端
client = Edge2Client(host, username, password)
client.login()

id=1
sql = 'select status, count(*) from reqs group by status'
data = client.put_app_dymetrics(app_id=1, id=id, name='test', sql=sql)

# del_app_dymetrics

ok = del_app_dymetrics(app_id, id)

此方法用於刪除指定應用的動態指標。

引數

返回值

• True：表示刪除成功。
• False：表示刪除失敗。

示例

from edge2client import Edge2Client

# 建立並登入客戶端
client = Edge2Client(host, username, password)
client.login()

ok = client.del_app_dymetrics(app_id, dymetrics_id)

# get_app_dymetrics

data = get_app_dymetrics(app_id, id)

此方法用於獲取指定應用的動態指標。

引數

返回值

• data：返回一個 dict 型別的動態指標資料。

示例

from edge2client import Edge2Client

# 建立並登入客戶端
client = Edge2Client(host, username, password)
client.login()

data = client.get_app_dymetrics(app_id, dymetrics_id)

# get_all_app_dymetrics

data = get_all_app_dymetrics(app_id)

此方法用於獲取指定應用的全部動態指標資訊。

引數

返回值

• data：返回的資料為一個包含所有動態指標資訊的 list 型別列表。

示例

from edge2client import Edge2Client

# 建立並登入客戶端
client = Edge2Client(host, username, password)
client.login()

data = client.get_all_app_dymetrics(app_id)

# get_app_dymetrics_data

data = get_app_dymetrics_data(app_id, id, chart_type='line', start_time=None, end_time=None, node_id=None)

此方法用於獲取應用的動態指標資料，預設返回最近 30 分鐘的資料。

引數

返回資料

• data：返回的動態指標資料，其資料型別為list。

示例

from edge2client import Edge2Client

# 建立並登入客戶端
client = Edge2Client(host, username, password)
client.login()

app_id = 1
dymetrics_id = 1
data = client.get_app_dymetrics_data(app_id, dymetrics_id)

# get_app_metrics

data = get_app_metrics(id, start_time=None, end_time=None)

此方法用於獲取應用的 HTTP 請求狀態指標和網路收發指標，預設情況下，它會獲取最近 30 分鐘的資料。

引數

返回值

• data：這是一個包含指標資料的 list 型別。

示例

from edge2client import Edge2Client

# 建立並登入客戶端
client = Edge2Client(host, username, password)
client.login()

data = client.get_app_metrics(app_id)

# new_ip_list

id = new_ip_list(name=None, type='ipv4', items=None)

新增新的應用級 IP 列表。

引數

items 引數

返回值

• id：新建立的 IP 列表的 ID。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

ok = client.new_ip_list(name = 'ip-list-1',
                        type = 'ipv4',
                        items = [
                            {'ip': '127.0.0.0/24'},
                            {'ip': '192.168.1.0/24'},
                            {'ip': '192.168.2.0/24', 'exptime': 1725000000},
                            {'ip': '192.168.3.0/24', 'exptime': 1735000000}
                        ])

# put_ip_list

ok = put_ip_list(rule_id=None, name=None, type='ipv4', items=None)

此方法用於修改指定的 IP 列表。

引數

返回值

• True：表示成功修改指定的 IP 列表。
• False：表示修改指定的 IP 列表失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

ok = client.put_ip_list(rule_id = 1, items = [ {'ip': '127.0.0.2'} ])

# del_ip_list

ok = del_ip_list(rule_id=None)

此方法用於刪除指定的 IP 列表。

引數

返回值

• True：表示刪除成功。
• False：表示刪除失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

ok = client.del_ip_list(rule_id=1)

在此示例中，我們首先使用 Edge2Client 的例項登陸，然後選擇應用程式，最後刪除指定 ID 的 IP 列表。

# get_ip_list

data = get_ip_list(rule_id=None)

此方法用於檢視特定的 IP 列表。

引數

返回值

• data：返回一個字典型別的 IP 列表資料。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

data = client.get_ip_list(rule_id=1)

# append_to_ip_list

ok = append_to_ip_list(rule_id, items)

此方法用於向指定的 IP 列表追加 IP。

引數

返回值

• True：表示成功修改指定的 IP 列表。
• False：表示修改指定的 IP 列表失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

ok = client.append_to_ip_list(rule_id = 1, items = [ {'ip': '127.0.0.3'} ])

ok = client.append_to_ip_list(rule_id = 1, items = [ {'ip': '127.0.0.3'} ], remove_expired = True)

# remove_from_ip_list

ok = remove_from_ip_list(rule_id, items)

此方法用於從指定的 IP 列表移除 IP。

引數

返回值

• True：表示成功修改指定的 IP 列表。
• False：表示修改指定的 IP 列表失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

app_id = 1
client.use_app(app_id)

ok = client.remove_from_ip_list(rule_id = 1, items = [ {'ip': '127.0.0.3'} ])

# node_monitor

data = node_monitor(node_id, start_time=None, end_time=None, step=60)

此方法用於獲取網路節點的 CPU 和記憶體負載相關資訊。

引數

返回值

• data：返回一個包含監控資料的列表。

示例

from edge2client import Edge2Client

# 建立並登入客戶端
client = Edge2Client(host, username, password)
client.login()

node_id = 1
data = client.node_monitor(node_id)

# new_global_dymetrics

id = new_global_dymetrics(name=None, note=None, interval=60, sql=None)

此方法用於建立全域性動態指標。

引數

返回值

• id：新建立的全域性動態指標的唯一識別符號 ID。

示例

from edge2client import Edge2Client

# 建立並登入客戶端
client = Edge2Client(host, username, password)
client.login()

sql = 'select status, count(*) from reqs group by status'

dymetrics_id = client.new_global_dymetrics(name='test', sql=sql)

# put_global_dymetrics

ok = put_global_dymetrics(id=None, name=None, note=None, interval=60, sql=None)

此方法用於修改全域性動態指標。

引數

返回值

• True：表示成功。
• False：表示失敗。

示例

from edge2client import Edge2Client

# 建立並登入客戶端
client = Edge2Client(host, username, password)
client.login()

id=1
sql = 'select status, count(*) from reqs group by status'
data = client.put_global_dymetrics(id=id, name='test', sql=sql)

# del_global_dymetrics

ok = del_global_dymetrics(id)

此方法用於刪除指定的全域性動態指標。

引數

返回值

• True：表示成功刪除全域性動態指標。
• False：表示刪除全域性動態指標失敗。

示例

from edge2client import Edge2Client

# 建立並登入客戶端
client = Edge2Client(host, username, password)
client.login()

ok = client.del_global_dymetrics(dymetrics_id)

# get_global_dymetrics

data = get_global_dymetrics(id)

此方法用於獲取指定的全域性動態指標。

引數

返回值

• data：返回的是一個型別為 dict 的全域性動態指標資訊。

示例

from edge2client import Edge2Client

# 建立並登入客戶端
client = Edge2Client(host, username, password)
client.login()

data = client.get_global_dymetrics(dymetrics_id)

# get_all_global_dymetrics

data = get_all_global_dymetrics()

此方法用於獲取所有全域性動態指標。

返回值

• data：返回一個包含全域性動態指標資訊的 list 型別資料。

示例

from edge2client import Edge2Client

# 建立並登入客戶端
client = Edge2Client(host, username, password)
client.login()

data = client.get_all_global_dymetrics()

# get_global_dymetrics_data

data = get_global_dymetrics_data(id, chart_type='line', start_time=None, end_time=None, node_id=None)

此方法用於獲取全域性動態指標資料，預設範圍為最近的 30 分鐘。

引數

返回值

• data：返回值是一個列表，包含全域性動態指標資料。

示例

from edge2client import Edge2Client

# 建立並登入客戶端
client = Edge2Client(host, username, password)
client.login()

dymetrics_id = 1
data = client.get_global_dymetrics_data(dymetrics_id)

# use_dns_app

ok = use_dns_app(dns_id)

此方法用於切換當前例項所操作的 DNS 應用。

引數

返回值

• True：表示切換成功。
• False：表示切換失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

dns_id = 1
client.use_dns_app(dns_id)

# new_dns_app

dns_id = new_dns_app(**kwargs)

此方法用於建立新的 DNS 應用。

引數

返回內容

• dns_id：返回新建立的 DNS 應用的 ID。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

authority = [
    {'domain': 'ns1.foo.com', 'ttl': '2 [hour]'},
    {'domain': 'ns2.foo.com', 'ttl': '1 [day]'}
]

soa_email = 'admin@foo.com'

dns_id = client.new_dns_app(
    authority=authority,
    soa_email=soa_email,
    zone='foo.com')

# put_dns_app

ok = put_dns_app(**kwargs)

此方法用於修改 DNS 應用的相關資訊。

引數

返回值

• True：表示資訊修改成功。
• False：表示資訊修改失敗。

示例

以下示例展示如何修改 dns_id 為 1 的應用。

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

dns_id = 1

authority = [
    {'domain': 'ns1.foo.com', 'ttl': '4 [hour]'},
    {'domain': 'ns2.foo.com', 'ttl': '1 [day]'}
]

ok = client.put_dns_app(
    dns_id=dns_id,
    authority=authority,
    soa_email=soa_email,
    zone='foo.com')

# get_dns_app

data = get_dns_app(dns_id)

此方法用於獲取 DNS 應用的相關資訊。

引數

返回值描述

• data：一個 dict 型別的資料，包含 DNS 應用的詳細資訊。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

dns_id = 1

data = client.get_dns_app(dns_id)

# del_dns_app

ok = del_dns_app(dns_id)

此方法用於刪除指定的 DNS 應用。

引數

下表列出了此方法所需的引數。

返回值

• True：表示成功刪除了 DNS 應用。
• False：表示刪除 DNS 應用失敗。

示例

以下示例展示瞭如何刪除指定的 DNS 應用。

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

dns_id = 1

data = client.del_dns_app(dns_id)

# new_dns_record

record_id = new_dns_record(**kwargs)

此方法用於新增 DNS 記錄。

引數

返回值

• record_id：新增的 DNS 記錄的 ID。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

dns_id = 1
use_dns_app(dns_id)

record_id = client.new_dns_record(
    sub_domain='bar', record_type='TXT', text='text string')
client.new_dns_record(
    sub_domain='bar', record_type='A', ip='127.0.0.1')
client.new_dns_record(
    sub_domain='bar', record_type='CNAME', domain='test.com')
client.new_dns_record(
    sub_domain='bar', record_type='MX', domain='test.com', priority=3)

# put_dns_record

ok = put_dns_record(**kwargs)

此方法用於修改 DNS 記錄。

引數

返回值

• True：表示成功。
• False：表示失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

dns_id = 1
use_dns_app(dns_id)

record_id = 1

ok = client.put_dns_record(
    record_id=record_id,
    sub_domain='a.bar',
    record_type='TXT',
    text='text string')

# get_dns_record

data = get_dns_record(record_id)

此方法用於獲取 DNS 記錄。

引數

返回值

• data：返回一個 dict 型別的 DNS 記錄資訊。

示例

如需獲取 record_id 為 1 的 DNS 記錄資訊，可以參考以下步驟。

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

dns_id = 1
use_dns_app(dns_id)

record_id = 1

data = client.get_dns_record(record_id)

# del_dns_record

ok = del_dns_record(record_id)

此方法用於刪除 DNS 記錄。

引數

返回值

• 若成功刪除，則返回 True。
• 若刪除失敗，則返回 False。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

dns_id = 1
use_dns_app(dns_id)

record_id = 1

ok = client.del_dns_record(record_id)

在該示例中，我們首先建立了一個 Edge2Client 客戶端，並用特定的主機，使用者名稱和密碼進行登入。然後，我們選擇使用具有特定 id 的 DNS 應用。最後，我們嘗試使用該客戶端刪除具有特定 id 的 DNS 記錄，並將結果儲存在 ok 中。

# new_global_upstream

up_id = new_global_upstream(**kwargs)

此方法用於新增上游，並返回新建立的全域性上游的 id。

引數

返回值

• up_id：新建上游的 ID。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

up_id = client.new_global_upstream(
    name='origin-upstream',
    servers=[
        {'ip': '172.22.31.1', 'port': 80},
        {'ip': '172.22.31.2', 'port': 80, 'weight': 2}
    ])

# update_global_upstream

ok = update_global_upstream(**kwargs)

此方法用於更新全域性上游資訊。

引數

返回值

• True：操作成功。
• False：操作失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

up_id = 1

ok = client.update_global_upstream(up_id,
    name='origin-upstream',
    servers=[
        {'domain': 'test.com', 'port': 8080},
        {'ip': '172.22.31.2', 'port': 8080, 'weight': 1}
    ],
    health_checker={
        'type': 'http',
        'http_req_uri': '/status',
        'http_req_host': 'test.com',
        'interval': 3,
        'interval_unit': 'sec',
        'timeout': 1,
        'fall': 3,
        'rise': 2,
        'valid_statuses': [200, 302],
        'report_interval': 3,
        'report_interval_unit': 'min'
    })

# get_global_upstream

data = get_global_upstream(up_id)

此方法用於獲取全域性上游資訊。

引數

返回值

• True：當獲取資訊成功時。
• False：當獲取資訊失敗時。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

up_id = 1

data = client.get_global_upstream(up_id)

# del_global_upstream

del_global_upstream(up_id)

此方法用於刪除全域性上游。

引數

返回值

• True：表示刪除成功。
• False：表示刪除失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

up_id = 1

operation_status = client.del_global_upstream(up_id)

# get_all_global_upstreams

upstreams = client.get_all_global_upstreams()

此方法用於獲取全部的上游資訊。

返回值

• upstreams：返回一個包含所有全域性上游資訊的 list 型別變數。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

upstreams = client.get_all_global_upstreams()

# new_global_k8s_upstream

up_id = new_global_k8s_upstream(**kwargs)

此方法用於建立新的全域性 Kubernetes 上游，並返回新建立的上游的 ID。

引數

返回值

• up_id: 新建立的 k8s 上游的 ID。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

k8s_up_id = client.new_global_k8s_upstream(
    name = 'k8s-upstream',
    k8s_services = [
        {
            'k8s' : 1,
            'k8s_namespace' : 'default',
            'k8s_service' : 'foo',
            'k8s_service_port' : 80,
        }
    ])

# put_global_k8s_upstream

ok = put_global_k8s_upstream(**kwargs)

此方法用於修改全域性 Kubernetes 上游的資訊。

引數

返回值

• True：表示修改成功。
• False：表示修改失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

up_id = 1

ok = client.put_global_k8s_upstream(up_id,
    name='k8s-upstream',
    k8s_services = [
        {
            'k8s' : 1,
            'k8s_namespace' : 'default',
            'k8s_service' : 'foo',
            'k8s_service_port' : 80,
        }
    ],
    health_checker={
        'type': 'http',
        'http_req_uri': '/status',
        'http_req_host': 'test.com',
        'interval': 3,
        'interval_unit': 'sec',
        'timeout': 1,
        'fall': 3,
        'rise': 2,
        'valid_statuses': [200, 302],
        'report_interval': 3,
        'report_interval_unit': 'min'
    })

# fetch_global_k8s_upstream

data = fetch_global_k8s_upstream(up_id)

此方法用於獲取全域性 Kubernetes 上游的資訊。

引數

返回值

• data：返回一個包含 Kubernetes 上游資訊的字典型別值。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

up_id = '1'

data = client.fetch_global_k8s_upstream(up_id)

# del_global_k8s_upstream

del_global_upstream(up_id)

此方法用於刪除全域性 k8s 上游。

引數

返回值

• 如果刪除成功，返回 True。
• 如果刪除失敗，返回 False。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

up_id = '1'

ok = client.del_global_k8s_upstream(up_id)

# get_all_global_k8s_upstreams

upstreams = client.get_all_global_k8s_upstreams()

此方法用於獲取所有的 Kubernetes 上游資訊。

返回值

• upstreams：返回 Kubernetes 上游資訊的列表。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

upstreams = client.get_all_global_k8s_upstreams()

# set_global_cert_key

cert_id = set_global_cert_key(**kwargs)

用於新增全域性 SSL 證書。

引數

返回值

• cert_id：新建全域性證書的 ID。

示例

以下示例展示瞭如何上傳本地的 key.pem 和 cert.pem 檔案以建立全域性證書。

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

key_file = os.path.join('tests', 'key.pem')
cert_file = os.path.join('tests', 'cert.pem')
with open(key_file) as f:
    key = f.read()
with open(cert_file) as f:
    cert = f.read()

cert_id = client.set_global_cert_key(key=key, cert=cert)

# put_global_cert_key

ok = put_global_cert_key(**kwargs)

此方法用於修改全域性 SSL 證書。

引數

返回值

• True：表示成功。
• False：表示失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

cert_id = 1

new_key_file = os.path.join('tests', 'new_key.pem')
new_cert_file = os.path.join('tests', 'new_cert.pem')
with open(new_key_file) as f:
    new_key = f.read()
with open(new_cert_file) as f:
    new_cert = f.read()

ok = client.put_global_cert_key(cert_id=cert_id, key=new_key, cert=new_cert)

# get_global_cert_key

data = get_global_cert_key(cert_id)

此方法用於獲取與 cert_id 相關聯的 SSL 證書資訊。

引數

返回值

• data：返回一個 dict 型別資料，其中包含了全域性證書的所有資訊。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

cert_id = 1

data = client.get_global_cert_key(cert_id)

# del_global_cert_key

ok = del_global_cert_key(cert_id)

此方法用於刪除指定的全域性 SSL 證書。

引數

返回值

• True：表示刪除成功。
• False：表示刪除失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

cert_id = 1

ok = client.del_global_cert_key(cert_id)

# add_global_user

uid = add_global_user(name, pwd, gid)

此方法用於新增全域性使用者。

引數

返回值

• uid：新增的全域性使用者的唯一識別 ID。

注意：全域性使用者的 ID 與應用級別的使用者 ID 需要區分。

示例

以下示例展示瞭如何建立一個名為 global_demo_user，具有建立新應用許可權，且其角色為普通使用者的全域性使用者。

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

username='global_demo_user'

uid = client.add_global_user(name=username, pwd=pwd, gid=[1])

# search_global_user

user_info = search_global_user(name)

此方法用於根據使用者名稱搜尋全域性使用者資訊。

引數

返回值

• user_info：dict 型別，包含搜尋到的使用者資訊及其相關許可權資訊。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

username = 'global_demo_user'

data = client.search_global_user(username)
user_id = data.get('id')

# get_all_global_users

data = get_all_global_users(detail)

本函式用於獲取所有全域性使用者的資訊。

引數

返回值

• data：返回一個 list 型別的資料，其每一個元素均為 dict 型別，包含對應全域性使用者的資訊。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

data = client.get_all_global_users()
data = client.get_all_global_users(True)

# new_global_rule

rule_id = new_global_rule(**kwargs)

此方法用於新增全域性規則。

引數

返回值

• rule_id：成功建立的全域性規則的 ID。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

condition = [
    {'var': 'host', 'val': 'con.' + APEX},
    {'var': ['req-header', 'Referer'], 'vals': [['foo\d+', 'rx'], 'foo.com']}
]

conseq = {
    'enable-websocket': {},
    'redirect': {'url': '/cn/2017/', 'code': 302}
}

rule_id = client.new_global_rule(condition=condition, conseq=conseq,gid=[1])

# put_global_rule

ok = put_global_rule(**kwargs)

此方法用於修改全域性規則。

引數

返回值

• True：表示成功。
• False：表示失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

rule_id = 1

conseq['redirect']['url'] = '/cn/2018/'

ok = client.put_global_rule(
    rule_id=rule_id, condition=condition, conseq=conseq)

# get_global_rule

data = get_global_rule(rule_id)

此方法用於獲取全域性規則資訊。

引數

返回值

• data：返回值是一個dict型別，包含全域性規則的詳細資訊。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

rule_id = 1

data = client.get_global_rule(rule_id)

這個示例展示瞭如何使用 Edge2Client 的例項獲取特定 id 的全域性規則資訊。

# get_global_action_by_name

rule_id = get_global_action_by_name(name)

此方法用於根據給定的應用名來獲取相應的全域性自定義動作。

引數

返回值

• data：返回一個包含全域性規則資訊的 dict 型別資料。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

rule_name = 'test-actions'

rule_id = client.get_global_action_by_name(rule_name)

# get_all_global_rules

data = get_all_global_rules()

此方法用於獲取所有的全域性規則。

返回值

• data：這是一個 list 型別的全域性規則資訊列表。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

data = client.get_all_global_rules()

# del_global_rule

ok = del_global_rule(rule_id)

此方法用於刪除全域性規則。

引數

返回值

• 返回 True：表示規則成功刪除。
• 返回 False：表示規則刪除失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

rule_id = 1

ok = client.del_global_rule(rule_id)

此示例展示瞭如何使用 Edge2Client 物件的 del_global_rule 方法來刪除指定的全域性規則。

# new_global_var

var_id = new_global_var(**kwargs)

此方法用於新增全域性變數。

引數

返回值

• var_id：若建立成功，則返回新建變數的 ID。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

var_id = client.new_global_var(
    name='is-whitelist', var_type='string', default='no')

# put_global_var

ok = put_global_var(**kwargs)

此方法用於修改全域性變數。

返回值

• True：表示全域性變數修改成功。
• False：表示全域性變數修改失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

var_id = 1

ok = client.put_global_var(
    var_id=var_id,
    name='is-whitelist',
    var_type='string',
    default='yes',
    gid=[1])

在此示例中，我們首先建立了一個 Edge2Client 物件並進行登入。然後，使用 put_global_var() 函式，透過指定對應的引數，修改 ID 為 1 的全域性變數名稱為’is-whitelist’，型別為’string’，預設值為’yes’，並將其關聯到 ID 為 1 的使用者組。

# get_global_var

data = get_global_var(var_id)

此方法用於獲取全域性變數。

引數

返回值

• data：返回值為一個 dict 型別，包含全域性變數的資訊。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

var_id = 1

data = client.get_global_var(var_id)

# get_all_global_vars

data = get_all_global_vars()

此方法用於獲取所有全域性變數。

返回值

• data：此為一個 list 型別的物件，其中每一個元素都是一個 dict 型別，包含了全域性變數的相關資訊。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password) # 建立一個 Edge2Client 例項
client.login() # 登陸

data = client.get_all_global_vars() # 獲取所有全域性變數

# del_global_var

ok = del_global_var(var_id)

此方法用於根據全域性變數的 ID 進行刪除操作。

引數

| 名稱 | 資料型別 | 是否必須 | 描述資訊 | | var_id | number | 是 | 指定需要刪除的全域性變數的 ID |

返回值

• True：表示刪除成功。
• False：表示刪除失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

var_id = 1

ok = client.del_global_var(var_id)

# get_global_ngx_config

data = get_global_ngx_config()

此方法用於獲取全域性的 nginx 配置資訊。

返回值

• data：返回一個dict型別的全域性 ngx 配置資訊。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

data = client.get_global_ngx_config()

# set_global_ngx_config

data = set_global_ngx_config(opts)

此方法設定全域性的 nginx 配置資訊。

引數

access_log_formats 引數

返回值

• True：設定成功。
• False：設定失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

opts = {'keepalive_timeout': 10, 'enable_open_file_cache': False}
ok = client.set_global_ngx_config(opts)

# get_global_misc_config

data = get_global_misc_config()

此方法用於獲取全域性的雜項配置資訊。

返回值

• data：返回一個 dict 型別，其中包含了雜項的配置資訊。

示例

from edge2client import Edge2Client

# 建立客戶端並登陸
client = Edge2Client(host, username, password)
client.login()

# 獲取全域性雜項配置資訊
data = client.get_global_misc_config()

# set_global_misc_config

ok = set_global_misc_config(opts)

此方法用於設定全域性雜項配置資訊。

引數

| 引數名 | 資料型別 | 是否必須 | 描述 | | opts | 字典型別（dict） | 否 | 雜項（misc）配置項 |

返回值

• True：表示設定成功。
• False：表示設定失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

opts = {'enabled_req_id': True}
ok = client.set_global_misc_config(opts)

# get_request_id_status

status = get_request_id_status()

此方法用於查詢請求 id 的狀態。

返回值

• True：表示請求 id 已啟用。
• False：表示請求 id 已禁用。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

status = client.get_request_id_status()

# enable_request_id

ok = enable_request_id()

這個方法用於啟用請求 id 功能。

返回值

• True：表示啟用成功。
• False：表示啟用失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

ok = client.enable_request_id()

# disable_request_id

ok = disable_request_id()

此方法用於禁用請求 ID 功能。

返回值

• True：表示請求 ID 功能成功被禁用。
• False：表示請求 ID 功能禁用失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

ok = client.disable_request_id()

# new_global_waf_rule

rule_id = new_global_waf_rule(**kwargs)

此方法用於新增全域性 WAF 規則。

引數

返回值

• rule_id：返回新建立的全域性 WAF 規則集的唯一 ID。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

waf_rule_id = client.new_global_waf_rule(
    name='foo',
    code="uri-arg('foo') => waf-mark-risk(level: 'definite', msg: 'found foo');")

在這個例子中，我們首先建立了一個 Edge2Client 例項，然後使用 new_global_waf_rule 方法建立了一個新的全域性 WAF 規則，並將其規則 ID 儲存在 waf_rule_id 中。規則名稱為 ‘foo’，edge 語言程式碼為 “uri-arg(‘foo’) => waf-mark-risk(level: ‘definite’, msg: ‘found foo’);"。

# put_global_waf_rule

ok = put_global_waf_rule(**kwargs)

此方法用於修改全域性 WAF 規則。

引數

返回值

• True：表示修改成功。
• False：表示修改失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

waf_rule_id = 1

ok = client.put_global_waf_rule(
    rule_id=waf_rule_id,
    name='bar',
    code="uri-arg('bar') => waf-mark-risk(level: 'definite', msg: 'found bar');")

在此示例中，我們透過 put_global_waf_rule 函式修改了 id 為 1 的全域性 WAF 規則。

# get_global_waf_rule

data = get_global_waf_rule(rule_id)

此方法透過提供的規則集 ID（rule_id）來獲取全域性的 WAF 規則集。

引數

| 名稱 | 資料型別 | 是否必選 | 描述資訊 | | rule_id | number | 是 | WAF 規則集的唯一識別符號 |

返回值

• data：返回一個包含 WAF 規則集詳細資訊的字典。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

waf_rule_id = 1

data = client.get_global_waf_rule(waf_rule_id)

# del_global_waf_rule

ok = del_global_waf_rule(rule_id)

此方法用於刪除全域性 WAF 規則。

引數

| 名稱 | 資料型別 | 是否必選 | 描述 | | rule_id | number | 是 | 規則集的 ID |

返回值

• True：刪除成功。
• False：刪除失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

waf_rule_id = 1

ok = client.del_global_waf_rule(waf_rule_id)

# get_all_global_waf_rules

data = get_all_global_waf_rules(detail=False)

此方法用於獲取所有全域性 WAF 規則。

引數

返回值

• data：返回一個 list 型別的 WAF 規則集資訊。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

data = client.get_all_global_waf_rules()

# new_global_action

rule_id = new_global_action(**kwargs)

此方法用於新增新的全域性自定義動作。

引數

返回值

• rule_id：返回新建立的全域性自定義動作的 ID。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

name = 'test'
condition = [
    {'var': 'req-method', 'vals': ['GET', 'POST', 'HEAD']}
]

conseq = [
    {
        'exit': {'code': 403}
    }
]

action_id = client.new_global_action(
    name=name, condition=condition, conseq=conseq, gid=[1, 2])

# put_global_action

ok = put_global_action(**kwargs)

此方法用於修改全域性自定義動作。

引數

返回值

• True：代表操作成功。
• False：代表操作失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

action_id = 1

ok = client.put_global_action(
    name=name,
    action_id=action_id,
    condition=condition,
    conseq=conseq,
    gid=[1])

# get_global_action

data = get_global_action(action_id)

此方法用於獲取全域性自定義動作。

引數

返回值

• data：返回的資料為字典型別，包含全域性自定義動作的相關資訊。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

action_id = 1

data = client.get_global_action(action_id)

# del_global_action

ok = del_global_action(action_id)

此方法用於刪除指定的全域性自定義動作。

引數

返回值

• 返回 True：表示刪除成功。
• 返回 False：表示刪除失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

action_id = 1

ok = client.del_global_action(action_id)

# count_global_actions

count = count_global_actions()

此方法用於獲取全域性自定義動作的總數。

返回值

• count：返回全域性自定義動作的總數。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

count = client.count_global_actions()

# get_all_global_actions

data = get_all_global_actions()

此方法用於獲取所有全域性自定義動作。

引數

返回值

• data：返回一個包含所有全域性自定義動作資訊的列表。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

data = client.get_all_global_actions()

# upload_static_file

file_id = upload_static_file(**kwargs)

此方法用於上傳靜態檔案。

引數

返回值

• file_id：返回新上傳的靜態檔案的 ID。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

file_id = client.upload_static_file(content='test_content', label='500.html', gid=[1])

# get_static_file

data = get_static_file(file_id)

此方法用於獲取指定的靜態檔案配置。

引數

返回值

• data：返回一個 dict 型別的物件，包含所獲取的靜態檔案的資訊。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

file_id = 1

data = client.get_static_file(file_id)

在這個示例中，我們首先從 edge2client 模組匯入了 Edge2Client 類，然後建立了一個 Edge2Client 物件並進行登入。之後，我們呼叫了其 get_static_file 方法，獲取了 ID 為 1 的靜態檔案的配置資訊，並將其儲存在 data 變數中。

# del_static_file

ok = del_static_file(file_id)

此方法用於刪除已上傳的靜態檔案。

引數

返回值

• True：表示檔案刪除成功。
• False：表示檔案刪除失敗。

示例

from edge2client import Edge2Client

# 建立 Edge2Client 例項
client = Edge2Client(host, username, password)

# 登入
client.login()

# 設定要刪除的檔案 ID
file_id = 1

# 刪除指定 ID 的靜態檔案
ok = client.del_static_file(file_id)

# new_cluster_group

group_id = new_cluster_group(group_name)

此方法用於新增新的叢集組。

引數

返回值

• id：返回新建的叢集組的唯一識別符號 ID。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

group_id = client.new_cluster_group('foo')

# put_cluster_group

ok = put_cluster_group(**kwargs)

此方法用於修改叢集組資訊。

引數

返回值

• True：表示成功修改叢集組資訊。
• False：表示修改叢集組資訊失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

group_id = 1

ok = client.put_cluster_group(group_id=group_id, group_name='bar')

此示例演示瞭如何使用 put_cluster_group 函式來修改具有指定 group_id 的叢集組名稱為 ‘bar’。

# get_cluster_group

data = get_cluster_group(group_id)

此方法用於獲取叢集組的詳細資訊。

引數

返回值

• data：返回一個dict型別的叢集組詳細資訊。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

group_id = 1

data = client.get_cluster_group(group_id)

# get_all_cluster_groups

data = get_all_cluster_groups()

此方法用於獲取所有叢集組的資訊。

返回值

• data：這是一個 list 型別，包含了所有叢集組的資訊。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

data = client.get_all_cluster_groups()

# del_cluster_group

ok = del_cluster_group(group_id)

此方法用於刪除叢集組資訊。

引數

返回值

• 返回 True：表示叢集組資訊刪除成功。
• 返回 False：表示叢集組資訊刪除失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

group_id = 1

ok = client.del_cluster_group(group_id)

在以上示例中，首先初始化一個 Edge2Client 物件並登陸，然後指定要刪除的叢集組的編號，並呼叫 del_cluster_group 方法進行刪除操作。

# put_proxy_rule

ok = put_proxy_rule(**kwargs)

此方法用於修改上游代理規則。

引數

返回值

• True：表示規則修改成功。
• False：表示規則修改失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

rule_id = 1
proxy_rule = []

ok = client.put_proxy_rule(rule_id=rule_id, proxy=proxy_rule)

# new_global_k8s

k8s_id = new_global_k8s(name=None, host=None, port=None, ssl_verify=True, token=None)

此方法用於新增新的 k8s 叢集連線引數。

引數

返回值

• k8s_id：新建立的 k8s 叢集的 ID。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

k8s_id = client.new_global_k8s(name = "k8s", host = "192.168.1.1", port = 443, token = "xxxxx")

# put_global_k8s

ok = put_global_k8s(**kwargs)

此方法用於修改 Kubernetes 叢集的連線引數。

引數

返回值

• 返回 True：表示成功。
• 返回 False：表示失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

ok = client.put_global_k8s(k8s_id = 1, name = "k8s", host = "192.168.1.1", port = 443, token = "xxxxx")

# get_global_k8s

data = get_global_k8s(k8s_id)

此方法用於獲取 Kubernetes 叢集的連線引數資訊。

引數

返回值

• data：返回一個 dict 型別的資料，包含 Kubernetes 叢集的詳細資訊。

示例

from edge2client import Edge2Client

# 建立一個 Edge2Client 例項
client = Edge2Client(host, username, password)

# 登入客戶端
client.login()

# 使用 get_global_k8s 方法獲取 Kubernetes 叢集資訊
data = client.get_global_k8s(k8s_id = 1)

# get_k8s_service_detail

data = get_k8s_service_detail()

此方法用於獲取 k8s 叢集中定義的服務相關資訊。

引數

返回值

• 返回一個 dict 型別的資料，包含 k8s 叢集的詳細資訊。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

data = client.get_k8s_service_detail(k8s_id = 1)

# get_all_global_k8s

data = get_all_global_k8s()

此方法用於獲取所有全域性 Kubernetes 叢集的 id。

返回值

• data：返回一個 list 型別的 Kubernetes 叢集資訊。

應用示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

data = client.get_all_k8s()

# del_global_k8s

ok = del_global_k8s(k8s_id)

此方法用於刪除 k8s 叢集的連線引數。

引數

返回值

• True：表示刪除成功。
• False：表示刪除失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

ok = client.del_global_k8s(k8s_id = 1)

以上程式碼展示瞭如何使用 Edge2Client 刪除特定的 k8s 叢集連線引數。

# update_proxy_rule

result = update_proxy_rule(**kwargs)

更新指定的上游代理規則。

引數

返回值

• True：代表成功更新代理規則。
• False：代表更新代理規則失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

rule_id = 1
proxy_rule = [...]

result = client.update_proxy_rule(rule_id=rule_id, proxy=proxy_rule)

此方法用於更新全域性級別的 IP 規則列表。

# new_global_ip_list

data = new_global_ip_list(name=None, type='ipv4', items=None)

此方法用於建立新的全域性 IP 列表。

引數

items 引數

返回值

• id：新建立的全域性 IP 列表的唯一標識 ID。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

ok = client.new_global_ip_list(name = 'ip-list-1',
                               type = 'ipv4',
                               items = [
                                    {'ip': '127.0.0.0/24'},
                                    {'ip': '192.168.1.0/24'},
                                    {'ip': '192.168.2.0/24', 'exptime': 1725000000},
                                    {'ip': '192.168.3.0/24', 'exptime': 1735000000}
                               ])

# put_global_ip_list

data = put_global_ip_list(rule_id=None, name=None, type='ipv4', items=None)

此方法用於修改指定的全域性級別 IP 列表。

引數

返回值

• True：表明修改成功。
• False：表明修改失敗。

示例

from edge2client import Edge2Client

client = Edge2Client(host, username, password)
client.login()

ok = client.put_global_ip_list(rule_id = 1, items = [ {'ip': '127.0.0.2'} ])

# del_global_ip_list

ok = del_global_ip_list(rule_id=None)