全部产品

概述

更新时间:2017-06-07 13:26:11   分享:   

在使用 Python SDK 或阅读本手册之前,请务必先阅读《OAS API参考手册》(以下简称 API 手册)第一章基本概念和第二章功能简介,了解 Vault、Archive、Mupltipart Upload、Job 等基础概念以及所支持的操作,这部分内容本手册将不再详述。

Python SDK 开发包包括 oascmd 和 SDK 两个部分,oascmd 通过一些简单的命令,无需任何额外的开发工作,即可满足基本的 归档存储 使用需求,oascmd的使用方法请移步 OAS命令行工具。有更高开发需求的用户请继续向下了解 SDK 部分。

Python SDK 接口分为两种形态,分别为低级接口和高级接口。其中,低级接口置于 oas 模块内,高级接口置于 oas.ease 模块内。

低级接口

低级接口封装了 归档存储 服务的签名验证,以及 HTTP 头部和 URL 生成。 低级接口是 归档存储 RESTful 接口的直接映射,每一个 RESTful 接口均对应于低级接口的一个方法。每个低级接口返回 HTTPResponse 原始对象,用户须根据 API 手册的说明进行解析。

在oascmd中,通过命令行参数,用户即可以方便地调用每一个低级接口。

高级接口

为了简化用户的开发流程,缩短学习曲线,SDK 在低级接口的基础上提供更抽象的高级接口。高级接口在低级接口的基础上,进一步封装了校验码生成、自动重试、断点续传等高级功能。用户在使用过程中不需要关心高级接口内部实际调用的是哪个RESTful接口,只需按照所需的业务类型调用接口即可,如上传、查询等。

使用建议

建议用户使用高级接口,这样会使得用户的程序逻辑更加简明。但当所需功能没有被包含在高级接口内时,建议用户参考高级接口的实现,在其基础上增加相应的定制功能,同时,欢迎用户把相关需求反映给 归档存储 开发团队,对于合理的需求,会在接下来的版本中得到实现。若用户需要更细粒度的操作,则可直接调用低级接口,根据实际使用场景进行封装。

Demo程序

参考《最佳实践-Python》

本文导读目录
本文导读目录
以上内容是否对您有帮助?