Python安装指导

本文为您介绍火山引擎Python SDK的下载地址及安装方式。

前提条件

• 您已注册火山引擎账号并完成实名认证，具体步骤，请参见 账号注册 及 实名认证 。
• 要使用火山引擎Python SDK访问指定服务的API ，请确认您已在 火山引擎控制台 开通当前服务。
• 您已获取账号的AccessKey，具体步骤，请参见 获取AccessKey 。
• 您确认已安装Python 2.7或以上版本，执行python --version可以检查当前Python的版本信息。
• 如果您需要在您的内网环境使用火山引擎的Python SDK，请将pip源更换为火山引擎的 pip源 ，否则可能会调用失败。

SDK下载地址

Python SDK下载地址：volcengine-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。

使用Python SDK

本文以查看指定NAT网关的信息为例，为您介绍如何使用Python SDK。

创建测试文件test.py，参考 DescribeNatGatewayAttributes 的请求参数说明，添加如下代码。

# Example Code generated by Beijing Volcanoengine Technology.
from __future__ import print_function
import volcenginesdkcore
import volcenginesdknatgateway
from pprint import pprint
from volcenginesdkcore.rest import ApiException

if __name__ == '__main__':
    configuration = volcenginesdkcore.Configuration()
    # 设置您的ak
    configuration.ak = "AK"
    # 设置您的sk
    configuration.sk = "SK"
    # 设置您要访问的地域，本示例为北京地域
    configuration.region = "cn-beijing" 
    
    # 设置默认配置
    volcenginesdkcore.Configuration.set_default(configuration)

    # 使用全局默认配置
    api_instance = volcenginesdknatgateway.NATGATEWAYApi() 
    
    # 创建一个DescribeNatGatewayAttributes接口
    describe_nat_gateway_attributes_request = volcenginesdknatgateway.DescribeNatGatewayAttributesRequest(
        nat_gateway_id="ngw-2fesmko5zhdz459gp67sc****", # NAT网关的ID
    )

		# 发起请求并处理返回或异常
    try:
        resp = api_instance.describe_nat_gateway_attributes(describe_nat_gateway_attributes_request)
        pprint(resp)
    except ApiException as e:
        print("Exception when calling api: %s\n" % e)