1)请求URI
请求URI由如下部分组成:
参数 | 描述 | 是否必选 |
---|---|---|
URI-scheme | 用于传输请求的协议,当前所有API均采用HTTPS协议 | 是 |
Endpoint | 当前资源池或者通用的域名 | 是 |
resource-path | 资源路径,也即API访问路径。从具体API的URI模块获取,例如“获取用户1信息”API的resource-path为“/users/1” | 是 |
query-string | 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“?userID=1”,表示查询用户ID为1的数据 | 是 |
2)请求方法
方法 | 说明 |
---|---|
GET | 请求服务器返回指定资源 |
PUT | 请求服务器更新指定资源 |
POST | 请求服务器新增资源或执行特殊操作 |
DELETE | 请求服务器删除指定资源,如删除对象等 |
HEAD | 请求服务器资源头部 |
PATCH | 请求服务器更新资源的部分内容。当资源不存在的时候,PATCH可能会去创建一个新的资源 |
3)请求消息头
附加请求头字段,主要是用于鉴权的公共字段。
字段 | 描述 | 是否必选 | 示例 |
---|---|---|---|
Content-Type | 消息体的类型(格式),统一为:application/json | 是 | application/json |
Eop-Authorization | 公钥,为ctyun-eop-ak的值 | 是 | 3d98d123d633xxxxxxxxxxx5a60d4bb3 |
Header | 待签名的header参数列表,以分号分割,如:Header=eop-date;host | 是 | Header=eop-date;host |
Signature | 计算得到的用于鉴权的签名,生成方式参见鉴权章节 | 是 | ctyun-eop-ak Header=eop-date;host Signature=xad01/ada |