1. 服务地址
云直播服务使用的域名访问地址为:live.api.qcloud.com。
2. 通信协议
腾讯云 API 的所有接口均通过 HTTPS 进行通信,提供高安全性的通信通道。
3. 请求方法
同时支持 POST 和 GET 请求,需要注意不能混合使用。即如果使用 GET 方式,则参数均从 Querystring 取得;如果使用 POST 方式,则参数均从 Request Body 中取得,Querystring 中的参数将忽略。两种方式参数格式规则相同,一般使用 GET,当参数字符串过长时使用 POST,请见各接口详细描述。
4. 字符编码
均使用 UTF-8 编码。
5. API 请求结构
名称 | 描述 | 备注 |
API 入口 | API 调用的 WebService 入口 | https://live.api.qcloud.com/v2/index.php |
公共参数 | 每个接口都包含的通用参数 | 详见本文第六节公共参数部分 |
指令名称 | API 要执行的指令的名称,这里使用 Action 指定, 例如 Action=CreateLVBChannel | 完整的指令请参见 API 概览 |
指令参数 | 每个特定的指令需要的参数 | 详见每个指令的接口文档 |
6. 公共参数
公共参数是用于标识用户和接口鉴权目的的参数, 如非必要, 在每个接口单独的接口文档中不再对这些参数进行说明, 但每次请求均需要携带这些参数, 才能正常发起请求。
名称 | 类型 | 描述 | 必选 |
Action | String | 接口指令的名称,例如:DescribeDomains | 是 |
Region | String | 区域参数,用来标识希望操作哪个区域的实例。可选: bj:北京 gz:广州 sh:上海 hk:中国香港 ca:北美 | 是 |
Timestamp | UInt | 当前 UNIX 时间戳 | 是 |
Nonce | UInt | 随机正整数,与 Timestamp 联合起来, 用于防止重放攻击 | 是 |
SecretId | String | 由腾讯云平台上申请的标识身份的 SecretId 和 SecretKey, 其中 SecretKey 会用来生成 Signature | 是 |
Signature | String | 请求签名,用来验证此次请求的合法性, | 是 |
一个典型的接口请求如下, Action=DescribeInstance 表示查询云服务器实例的详情。
https://domain/v2/index.php?Action=DescribeInstances&SecretId=xxxxxxx&Region=gz&Timestamp=1402992826&Nonce=345122&Signature=mysignature&instanceId=101
其中 instanceId 为指令参数,其余为通用参数。