python sdk-凯发k8国际娱乐官网入口
本章节介绍新版python sdk,您可以参考本章节进行快速集成开发。
准备工作
- 注册华为帐号并开通华为云,并完成实名认证,帐号不能处于欠费或冻结状态。
- 已具备开发环境,支持python3及以上版本。
- 登录“ > 访问秘钥”页面,依据界面操作指引获取access key(ak)和secret access key(sk)。下载的访问秘钥为credentials.csv文件,包含ak/sk信息。
- 登录“”页面,获取“iam用户名”、“帐号名”以及待使用区域的“项目id”。调用服务时会用到这些信息,请提前保存。
本样例以“华北-北京四”区域为例,获取对应的项目id(project_id)。
图1 我的凭证
安装sdk
支持python3及以上版本,执行python --version检查当前python的版本信息。
使用sdk前,需要安装“huaweicloudsdkcore”和“huaweicloudsdkocr”,有两种安装方式,分别如下。
- 使用pip安装
#回显successfully installed xxx表示安装成功 # 安装核心库 pip install huaweicloudsdkcore # 安装ocr服务库 pip install huaweicloudsdkocr
- 使用源码安装
sdk版本可通过查询。
# 安装核心库 cd huaweicloudsdkcore-${version} python setup.py install # 安装ocr服务库 cd huaweicloudsdkocr-${version} python setup.py install
开始使用
- 导入依赖模块
from huaweicloudsdkcore.auth.credentials import basiccredentials from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcore.http.http_config import httpconfig # 导入指定云服务的库 huaweicloudsdk{service} from huaweicloudsdkocr.v1.region.ocr_region import ocrregion from huaweicloudsdkocr.v1 import *
- 配置客户端连接参数
- 默认配置
# 使用默认配置,如出现'httpconfig' is not defined报错,请检查是否已正确安装sdk config = httpconfig.get_default_config()
- 网络代理(可选)
# 根据需要配置网络代理 config.proxy_protocol = 'http' config.proxy_host = 'proxy.huaweicloud.com' config.proxy_port = 80 config.proxy_user = 'username' config.proxy_password = 'password'
- 超时配置(可选)
# 默认连接超时时间为60秒,读取超时时间为120秒,支持统一指定超时时长timeout=timeout,或分别指定超时时长timeout=(connect timeout, read timeout) config.timeout = 120
- ssl配置(可选)
# 根据需要配置是否跳过ssl证书校验 config.ignore_ssl_verification = true # 配置服务器端ca证书,用于sdk验证服务端证书合法性 config.ssl_ca_cert = ssl_ca_cert
客户端连接参数配置完成后需在初始化客户端client中配置“with_http_config(config)”相应的代码,详情请参见4.初始化客户端(二选一)中的client后的代码。
- 默认配置
- 配置认证信息
配置ak、sk、project_id信息。华为云通过ak识别用户的身份,通过sk对请求数据进行签名验证,用于确保请求的机密性、完整性和请求者身份的正确性。有两种认证方式,分别如下。
- 初始化认证信息:
ak = os.environ.get("huaweicloud_sdk_ak") sk = os.environ.get("huaweicloud_sdk_sk")
- 使用永久ak和sk
credentials = basiccredentials(ak, sk, project_id)
- 使用临时ak和sk
credentials = basiccredentials(ak, sk, project_id).with_security_token(security_token)
- 认证用的 ak 和sk 硬编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全。
- 本示例以 ak 和 sk 保存在环境变量中来实现身份验证为例,运行本示例前请先在本地环境中设置环境变量huaweicloud_sdk_ak和huaweicloud_sdk_sk。
认证参数说明:
- 初始化认证信息:
- 初始化客户端(二选一)
- 指定region方式(推荐)
# 增加region依赖 from huaweicloudsdkocr.v1.region.ocr_region import ocrregion # 初始化指定云服务的客户端 {service}client ,以初始化ocr服务的 ocrclient 为例 client = ocrclient.new_builder() \ .with_http_config(config) \ .with_credentials(credentials) \ .with_region(ocrregion.value_of("cn-north-4")) \ .build()
- 指定云服务endpoint方式
# 指定终端节点,以 ocr 服务北京四的 endpoint 为例 endpoint = "https://ocr.cn-north-4.myhuaweicloud.com" # 初始化指定云服务的客户端 {service}client ,以初始化ocr服务的 ocrclient 为例 client = ocrclient.new_builder() \ .with_http_config(config) \ .with_credentials(credentials) \ .with_endpoint(endpoint) \ .build()
endpoint是华为云各服务应用区域和各服务的终端节点,详情请查看 。
- 指定region方式(推荐)
- 发送请求并查看响应
# 以调用通用表格识别接口 recognizegeneraltable 为例 request = recognizegeneraltablerequest() request.body = generaltablerequestbody( url="图片的url" ) response = client.recognize_general_table(request) print(response)
- 异常处理
表1 异常处理 一级分类
一级分类说明
二级分类
二级分类说明
connectionexception
连接类异常
hostunreachableexception
网络不可达、被拒绝。
sslhandshakeexception
ssl认证异常。
requesttimeoutexception
响应超时异常
calltimeoutexception
单次请求,服务器处理超时未返回。
retryoutageexception
在重试策略消耗完成后,仍无有效的响应。
serviceresponseexception
服务器响应异常
serverresponseexception
服务端内部错误,http响应码:[500,]。
clientrequestexception
请求参数不合法,http响应码:[400, 500)
# 异常处理 try: request = recognizegeneraltablerequest() response = client.recognize_general_table(request) print(response) except exceptions.clientresponseexception as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg)
使用异步客户端,配置日志等操作,请参见、,sdk使用方法可参考。
代码示例自动生成
提供api检索及平台调试,支持全量快速检索、可视化调试、帮助文档查看、在线咨询。
您只需要在api explorer中修改接口参数,即可自动生成对应的代码示例。同时,可在集成开发环境cloudide中完成代码的构建、调试、运行等操作。
意见反馈
文档内容是否对您有帮助?
如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨