API协议和规则

通信协议

HTTP 协议

请求方法

POST 或 GET

字符编码

UTF-8

API请求结构

名称 描述 备注
域名 api.xycdn.com
接口 /v2 单入口,通过指令名参数区分不同的接口。
指令 API要执行的指令的名称,这里使用
action参数指定,例如
action=TestAction
行为名称一般是以行为加接口描述名称来命名行为名称,如:Describe都是用于展示数据行为接口,Set表示设置行为接口等等
指令参数 每个特定的指令需要的参数 详见每个指令的接口文档
返回格式 json

通用请求参数

参数名 类型 说明 是否必须
action string 接口指令的名称 Yes
access_key string 标识用户身份的access_key和access_secret, 其中access_secret会用来生成signature,后面鉴权部分会介绍 Yes
timestamp string RFC3339 格式的时间,如零时区的格式字符串为“YYYY-MM-DDThh:mm:ssZ” Yes
version string 版本号,这里只用于2.0版本,填写 “2.0” 即可 Yes
signature string 请求签名,用来验证此次请求的合法性,具体生成方式见后面鉴权部分。 Yes
signature_version string 签名方法版本号,填写为"1.0" Yes
signature_method string 签名方法所用哈希函数名,大小写敏感,目前只支持“hmac-sha1” Yes

注意接口的参数以大写字母开头。

通用响应字段

参数名 类型 说明 是否必须
code int 返回结果的错误码:
0:成功
1001:系统错误
1004:缺少参数
1005:参数出错
1006:授权码错误
1007 : 鉴权失败
5 0: 执行操作失败,具体错误参考errorMessage
6 0: 服务器内部错误
Yes
errorMessage string 返回结果的错误信息 No
result object 返回结果内容信息 No