欢迎使用腾讯云开发者工具套件(SDK)3.0,SDK3.0是云 API3.0 平台的配套工具。目前已经支持cvm、vpc、cbs等产品,后续所有的云服务产品都会接入进来。新版SDK实现了统一化,具有各个语言版本的SDK使用方法相同,接口调用方式相同,统一的错误码和返回包格式这些优点。 为方便 Python 开发者调试和接入腾讯云产品 API,这里向您介绍适用于 Python 的腾讯云开发工具包,并提供首次使用开发工具包的简单示例。让您快速获取腾讯云 Python SDK 并开始调用。
- 依赖环境:Python 2.7, 3.6-3.9 版本。
- 从 腾讯云控制台 开通相应产品。
- 获取 SecretID、SecretKey 以及调用地址(endpoint),endpoint 一般形式为*.tencentcloudapi.com,如CVM 的调用地址为 cvm.tencentcloudapi.com,具体参考各产品说明。
安装 Python SDK 前,先获取安全凭证。在第一次使用云 API 之前,用户首先需要在 腾讯云控制台 上申请安全凭证,安全凭证包括 SecretID 和 SecretKey, SecretID 是用于标识 API 调用者的身份,SecretKey 是用于加密签名字符串和服务器端验证签名字符串的密钥。SecretKey 必须严格保管,避免泄露。
您可以通过 pip 安装方式将腾讯云 API Python SDK 安装到您的项目中,如果您的项目环境尚未安装 pip,请详细参见 pip官网 安装。
通过pip方式安装或更新请在命令行中执行以下命令:
pip install --upgrade tencentcloud-sdk-python
**大陆地区的用户可以使用国内镜像源提高下载速度,例如pip install -i https://mirrors.tencent.com/pypi/simple/ --upgrade tencentcloud-sdk-python
。
请注意,如果同时有 python2 和 python3 环境, python3 环境需要使用 pip3 命令安装。
如果只想使用某个具体产品的包,例如云服务器 CVM,可以单独安装,但是注意不能和总包同时工作。pip install --upgrade tencentcloud-sdk-python-common tencentcloud-sdk-python-cvm
前往 Github 仓库 或者 Gitee 仓库 下载最新代码,解压后
$ cd tencentcloud-sdk-python
$ python setup.py install
以查询实例列表接口为例。
import os
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")
cred = credential.Credential(
os.environ.get("TENCENTCLOUD_SECRET_ID"),
os.environ.get("TENCENTCLOUD_SECRET_KEY"))
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)
# -*- coding: utf-8 -*-
import os
import sys
import logging
from tencentcloud.common import credential
from tencentcloud.common.exception.tencent_cloud_sdk_exception import TencentCloudSDKException
# 导入对应产品模块的client models。
from tencentcloud.cvm.v20170312 import cvm_client, models
# 导入可选配置类
from tencentcloud.common.profile.client_profile import ClientProfile
from tencentcloud.common.profile.http_profile import HttpProfile
try:
# 实例化一个认证对象,入参需要传入腾讯云账户secretId,secretKey。
# 为了保护密钥安全,建议将密钥设置在环境变量中或者配置文件中,请参考本文凭证管理章节。
# 硬编码密钥到代码中有可能随代码泄露而暴露,有安全隐患,并不推荐。
# cred = credential.Credential("secretId", "secretKey")
cred = credential.Credential(
os.environ.get("TENCENTCLOUD_SECRET_ID"),
os.environ.get("TENCENTCLOUD_SECRET_KEY"))
cred = credential.Credential("SecretId", "SecretKey")
# 实例化一个http选项,可选的,没有特殊需求可以跳过。
httpProfile = HttpProfile()
# 如果需要指定proxy访问接口,可以按照如下方式初始化hp
# httpProfile = HttpProfile(proxy="http://用户名:密码@代理IP:代理端口")
httpProfile.protocol = "https" # 在外网互通的网络环境下支持http协议(默认是https协议),建议使用https协议
httpProfile.keepAlive = True # 状态保持,默认是False
httpProfile.reqMethod = "GET" # get请求(默认为post请求)
httpProfile.reqTimeout = 30 # 请求超时时间,单位为秒(默认60秒)
httpProfile.endpoint = "cvm.ap-shanghai.tencentcloudapi.com" # 指定接入地域域名(默认就近接入)
# 实例化一个client选项,可选的,没有特殊需求可以跳过。
clientProfile = ClientProfile()
clientProfile.signMethod = "TC3-HMAC-SHA256" # 指定签名算法
clientProfile.language = "en-US" # 指定展示英文(默认为中文)
clientProfile.httpProfile = httpProfile
# 实例化要请求产品(以cvm为例)的client对象,clientProfile是可选的。
client = cvm_client.CvmClient(cred, "ap-shanghai", clientProfile)
# 打印日志按照如下方式,也可以设置log_format,默认为 '%(asctime)s %(process)d %(filename)s L%(lineno)s %(levelname)s %(message)s'
# client.set_stream_logger(stream=sys.stdout, level=logging.DEBUG)
# client.set_file_logger(file_path="/log", level=logging.DEBUG) 日志文件滚动输出,最多10个文件,单个文件最大512MB
# client.set_default_logger() 去除所有log handler,默认不输出
# 实例化一个cvm实例信息查询请求对象,每个接口都会对应一个request对象。
req = models.DescribeInstancesRequest()
# 填充请求参数,这里request对象的成员变量即对应接口的入参。
# 你可以通过官网接口文档或跳转到request对象的定义处查看请求参数的定义。
respFilter = models.Filter() # 创建Filter对象, 以zone的维度来查询cvm实例。
respFilter.Name = "zone"
respFilter.Values = ["ap-shanghai-1", "ap-shanghai-2"]
req.Filters = [respFilter] # Filters 是成员为Filter对象的列表
# python sdk支持自定义header如 X-TC-TraceId、X-TC-Canary,可以按照如下方式指定,header必须是字典类型的
headers = {
"X-TC-TraceId": "ffe0c072-8a5d-4e17-8887-a8a60252abca"
}
req.headers = headers
# 通过client对象调用DescribeInstances方法发起请求。注意请求方法名与请求对象是对应的,headers为可选参数。
# 返回的resp是一个DescribeInstancesResponse类的实例,与请求对象对应。
resp = client.DescribeInstances(req)
# 输出json格式的字符串回包
print(resp.to_json_string(indent=2))
# 也可以取出单个值。
# 你可以通过官网接口文档或跳转到response对象的定义处查看返回字段的定义。
print(resp.TotalCount)
except TencentCloudSDKException as err:
print(err)
从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
解决。
腾讯云 Python SDK 目前支持以下几种方式进行凭证管理:
- 环境变量
默认读取环境变量 TENCENTCLOUD_SECRET_ID
和 TENCENTCLOUD_SECRET_KEY
获取 secretId 和 secretKey。相关代码如下:
from tencentcloud.common import credential
cred = credential.EnvironmentVariableCredential().get_credential()
- 配置文件
配置文件路径要求为:
- Windows:
c:\Users\NAME\.tencentcloud\credentials
- Linux:
~/.tencentcloud/credentials
或/etc/tencentcloud/credentials
配置文件格式如下,要求是 .ini 格式的文件:
[default]
secret_id = xxxxx
secret_key = xxxxx
相关代码如下:
from tencentcloud.common import credential
cred = credential.ProfileCredential().get_credential()
- 角色扮演
有关角色扮演的相关概念请参阅:腾讯云角色概述
要使用此种方式,您必须在腾讯云访问管理控制台上创建了一个角色,具体创建过程请参阅:腾讯云角色创建
在您拥有角色后,可以通过如下方式获取临时凭证,相关代码如下:
from tencentcloud.common import credential
cred = credential.STSAssumeRoleCredential("SecretId", "SecretKey", "RoleArn", "RoleSessionName")
有关角色扮演的详细使用方式可以参考示例:使用角色
- 实例角色
有关实例角色的相关概念请参阅:腾讯云实例角色
在您为实例绑定角色后,您可以在实例中访问相关元数据接口获取临时凭证,SDK 会自动刷新临时凭证。相关代码如下:
from tencentcloud.common import credential
cred = credential.CVMRoleCredential().get_credential()
- 凭证提供链
腾讯云 Python SDK 提供了凭证提供链,它会默认以环境变量->配置文件->实例角色
的顺序尝试获取凭证,并返回第一个获取到的凭证。相关代码如下:
from tencentcloud.common import credential
cred = credential.DefaultCredentialProvider().get_credentials()