最佳实践

Python

最近更新时间:2021-09-09 14:28:16

简介

  • 欢迎使用腾讯云开发者工具套件(SDK)3.0,SDK 3.0 是云 API 3.0 平台的配套工具。SDK 3.0 实现了统一化,各个语言版本的 SDK 具备使用方法相同、接口调用方式相同、错误码和返回包格式相同等优点。
  • 本文以 Python SDK 3.0 为例,介绍如何使用、调试并接入腾讯云产品 API。
  • 目前已支持云服务器 CVM、私有网络 VPC 、云硬盘 CBS 等 腾讯云产品,后续会支持其他云产品接入。

依赖环境

  • Python 2.7,3.6至3.9版本。
  • 获取安全凭证。安全凭证包含 SecretId 及 SecretKey 两部分。SecretId 用于标识 API 调用者的身份,SecretKey 用于加密签名字符串和服务器端验证签名字符串的密钥。前往 API 密钥管理 页面,即可进行获取,如下图所示:
    注意:

    您的安全凭证代表您的账号身份和所拥有的权限,等同于您的登录密码,切勿泄露他人。

  • 获取调用地址。调用地址(endpoint)一般形式为*.tencentcloudapi.com,产品的调用地址有一定区别,例如,云服务器的调用地址为cvm.tencentcloudapi.com。具体调用地址可参考对应产品的 API 文档

安装 SDK

方式一、通过 Pip 安装(推荐)

可通过 pip 安装方式将腾讯云 Python SDK 安装至您的项目中。若您的项目环境未安装 pip,请前往 pip 官网 完成安装。
在命令行中执行以下命令,安装 Python SDK。

pip install --upgrade tencentcloud-sdk-python

注意:

若同时具备 python2 及 python3 环境,则需使用 pip3 命令进行安装。

中国大陆地区的用户可以使用国内镜像源提高下载速度,例如:pip install -i https://mirrors.tencent.com/pypi/simple/ --upgrade tencentcloud-sdk-python

说明:

  • 如果只想使用某个具体产品的包,例如云服务器 CVM,可以单独安装,但是注意不能和总包同时工作。pip install --upgrade tencentcloud-sdk-python-common tencentcloud-sdk-python-cvm
  • 更多 SDK 支持的云产品,请参见 云产品名列表

方式二、通过源码包安装

前往 Github 代码托管地址 下载最新代码,解压后:

$ cd tencentcloud-sdk-python
$ python setup.py install

使用 SDK

以查询实例列表接口为例。

from tencentcloud.common import credential
from tencentcloud.common.exception.tencent_cloud_sdk_exception import TencentCloudSDKException
from tencentcloud.cvm.v20170312 import cvm_client, models

try:
cred = credential.Credential("secretId", "secretKey")
client = cvm_client.CvmClient(cred, "ap-shanghai")

req = models.DescribeInstancesRequest()
resp = client.DescribeInstances(req)

print(resp.to_json_string())
except TencentCloudSDKException as err:
print(err)

Commont Client 调用方式

3.0.396开始,腾讯云 Python SDK 支持使用泛用型的API调用方式(Common Client)进行请求。您只需安装 tencentcloud-sdk-python-common 包,即可向任何产品发起调用。

说明:

您必须明确知道您调用的接口所需参数,否则可能会调用失败。

Common Client 请参见 example

更多示例

您可以在 Github 中 examples 目录下找到更详细的示例。

相关配置

代理

如果是有代理的环境下,可通过以下两种方式设置代理:

  • 在初始化 HttpProfile 时指定 proxy,参考 example
  • 需要设置系统环境变量https_proxy

否则可能无法正常调用,抛出连接超时的异常。

常见问题

证书问题

在 Mac 操作系统安装 Python 3.6 或以上版本时,可能会遇到证书错误:Error: [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: self signed certificate in certificate chain (_ssl.c:1056).

这是因为在 Mac 操作系统下,Python 不再使用系统默认的证书,且本身也不提供证书。在进行 HTTPS 请求时,需要使用certifi库提供的证书,但 SDK 不支持指定,所以只能使用sudo "/Applications/Python 3.6/Install Certificates.command"命令安装证书才能解决此问题。

虽然 Python 2 版本不应该有上述问题,但在个别用户环境上可能也会存在类似的情况,同样可以通过sudo /Applications/Python 2.7/Install Certificates.command解决。

目录