全部产品
云市场

使用说明

更新时间:2019-06-24 20:32:32

简介

您可以基于服务端SDK编写代码来调用点播API,实现对点播产品和服务的快速操作。点播服务提供了多种主流语言的 SDK,让您不用复杂编程即可快捷访问点播服务。

功能介绍

  • SDK封装了对API的调用请求和响应,避免自行计算较为繁琐的 API签名

  • 支持所有 点播服务的API,并提供了相应的示例代码。

  • 支持7种开发语言,包括:Java、Python、PHP、.NET、Node.js、Go、C/C++。

通常在发布新的API后,我们会及时同步更新SDK,所以即便您没有找到对应API的示例代码,也可以参考旧的示例自行实现调用。

准备工作

服务开通

账号准备

准备好访问点播服务使用的Access Key,支持主账号、子账号、STS三种方式访问,相关概念和介绍请参考 账号和授权

  • 主账号访问:在阿里云 Access Key管理 创建主账号Access Key,使用主账号权限过大,一旦泄露风险巨大,强烈不推荐。
  • 子账号访问:在 RAM访问控制台 创建子账号,并授予VOD权限(如AliyunVODFullAccess)后进行相应操作,参考 RAM子账号访问,为确保账号安全,强烈推荐使用子账号访问点播服务。
  • STS方式:点播服务也支持使用STS方式访问,参考 STS临时授权访问

开发环境

服务端SDK支持Linux、Windows、Mac等多种平台和运行环境,请提前安装好对应开发语言的编译器或解释器,并完成相关环境配置,具体版本要求可参考各语言SDK的安装文档

仅C/C++版SDK暂不支持Windows,后续会支持。

SDK安装

版本说明

服务端SDK最新版为 2.15.5 ,更新日志和发布记录可参考 服务端SDK发布历史,请确保您安装的是最新版本,否则部分API可能无法直接使用。

  • Java、Python、PHP、.NET、Go等版本,每个API都会对应特定的请求类(Request)和响应类(Response),使用新的API或新功能需要保持更新。
  • Node.js、C/C++版本,实现的是通用库,未封装请求类和响应类,故不需要随API更新而更新SDK,但通用库可能会不定期更新。

安装操作

一般需要安装SDK核心库和VoD库,各语言SDK安装操作详见:

开发语言 安装文档 初始化文档 源码下载
Java SDK 安装 初始化 源码
Python SDK 安装 初始化 源码
PHP SDK 安装 初始化 源码
.NET SDK 安装 初始化 源码
Node.js SDK 安装 初始化 源码
Go SDK 安装 初始化 源码
C/C++ SDK 安装 初始化 源码

使用说明

安装完成后,可参考初始化文档使用Access Key初始化客户端实例。

访问域名

点播服务在全球提供了多个接入地址,详情参考 点播中心和访问域名,可以使用其中的 接入地址Region英文表示 来初始化客户端实例,如中国大陆为cn-shanghai,新加坡为ap-southeast-1

注意:接入地址的区域与存储区域是不一样的概念,接入区域表示API的接入点,存储区域对应OSS的区域,如API接入点在上海(cn-shanghai),但媒体文件可能存储在北京(cn-beijing)。

使用限制

点播服务对资源使用,以及API的调用次数等都有默认限制,详情参考 点播使用限制,如要提高限制,可联系售后,或提工单联系我们,并请详细说明使用场景和预期的阈值(如域名数、播放接口访问频次等)。

调用示例

各语言版本的SDK都提供了完整的API调用示例,参见安装文档同层级目录的示例文档,如媒体上传、音视频播放等。

常见错误

可以根据错误代码排查SDK使用中的问题,以下是各语言的常见错误:

实际上,各语言版本的SDK常见错误具有相通性,可以互相参考,大部分错误解决方法不需要局限于语言,如InvalidAccessKeyId.NotFound等错误,PHP也可以参考上述语言的方法解决。

提交反馈

如果您在使用SDK的过程中遇到任何问题,欢迎前往阿里云SDK 问答社区 提问,提问前请阅读反馈引导。详情请参见 提交反馈