本文为您介绍 Web 应用防火墙 Python SDK 的下载地址、安装方式以及代码示例，帮助您快速了解如何使用 SDK 调用 OpenAPI。

前提条件 #

• 已注册火山引擎账号并完成实名认证。具体步骤，请参见账号注册及实名认证。
• 已获取账号的 Access Key。具体步骤，请参见获取Access Key。
• 已安装 Python 2.7 或以上版本。执行python --version可以检查当前 Python 的版本信息。

步骤一 下载 SDK #

前往volcengine-python-sdk下载 Web 应用防火墙 Python SDK 安装包。

步骤二 安装 SDK #

您可以使用以下任意一种方式安装SDK。

方式一 #

使用 pip 命令安装 SDK。

pip install volcengine-python-sdk

方式二 #

• 执行python setup.py install --user命令，为指定 user 安装 SDK。
• 执行sudo python setup.py install命令，为全部 user 安装 SDK。

步骤三 调用接口 #

以QueryLLMGenerate实时查询大模型生成结果为例，展示如何使用 Python SDK 调用。

from __future__ import print_function
import volcenginesdkcore
import volcenginesdkwaf
from volcenginesdkcore.rest import ApiException

def set_config():
    # 获取配置
    configuration = volcenginesdkcore.Configuration()
    configuration.ak = "****"    # 您的AK
    configuration.sk = "****"    # 您的SK
    configuration.region = "cn-shanghai" # 您所在的region
    configuration.client_side_validation = True
    configuration.host = "open.volcengineapi.com"
    # 设置配置
    volcenginesdkcore.Configuration.set_default(configuration)
    # 获取waf api 句柄
    global api_instance
    api_instance = volcenginesdkwaf.WAFApi()

# 查询大模型生成结果
    query_llm_generate_request = volcenginesdkwaf.QueryLLMGenerateRequest(
    msg_id=msg_id,
)

try:
 # 复制代码运行示例，请自行打印API返回值。
    response = api_instance.query_llm_generate(query_llm_generate_request)
    print(response)
except ApiException as e:
 # 复制代码运行示例，请自行打印API错误信息。
    print("Exception when calling api: %s\n" % e)

调用结果说明 #

复制代码运行示例，可打印 API 错误信息，以下为错误示例。

业务异常 #

Exception when calling api: (200)
Reason: {'Code': '10001', 'Message': '获取msg_id对应的请求信息失败'}

业务正常 #

{'suggest': 'hello'}