请求URI
请求URI由如下部分组成:
{URI-scheme}://{Endpoint}/{resource-path}?{query-string}
URI-scheme: 表示用于传输请求的协议,当前所有API均采用HTTPS协议。
Endpoint: 指定承载REST服务端点的服务器域名或IP,不同服务不同区域的Endpoint不同。
resource-path:资源路径,也即API访问路径。从具体API的URI模块获取。
query-string:查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“?pageNum=1&pageSize=10”,表示查询第一页的数据,一页返回10条数据。
请求方法
一般只读操作采用GET方法,写操作采用POST方法,具体请求方法参见个API接口说明。
请求消息头
附加请求头字段,主要是用于鉴权的公共字段。
字段 | 类型 | 描述 |
---|---|---|
Content-Type | String | 消息体的类型(格式),统一为:application/json |
Eop-Authorization | String | 公钥,为ctyun-eop-ak的值 |
Header | String | 待签名的header参数列表,以分号分割,如:Header=eop-date;host |
Signature | String | 计算得到的用于鉴权的签名,生成方式参见鉴权章节 |