文档简介:
统计API请求结构
统计API请求结构
l 接入地址
接入地址为:oos-cn-mg.ctyunapi.cn。
l 通信协议
为了保证通信的安全性,统计支持HTTP和HTTPS。
l 请求方法
统计支持GET请求方法发送请求。
l 请求参数
每个请求都需要指定如下信息:
Ø 每个操作接口都需要包含的公共请求参数。
Ø 操作接口所特有的请求参数。
本节主要描述公共请求参数和请求结果。
说明:在后续提到具体API时,举例中都会有公共请求头、公共响应头,但是不对其进行描述和解释。
公共请求头
在每个请求中,都需要携带公共参数和对应的接口参数。公共请求参数如表所示:
名称 |
描述 |
是否必填 |
Host |
统计访问域名,访问域名是oos-cn-mg.ctyunapi.cn。 |
是 |
Authorization |
请求头签名。 支持用户签名验证V2和V4签名,建议使用V4签名。 类型:字符串。 |
是 |
x-Amz-Date |
日期和时间格式必须遵循ISO 8601标准,并且必须使用“yyyyMMddT HHmmssZ”格式进行格式化。例如,如果日期和时间是“08/01/2018 15:32:41.982-700”,则必须首先将其转换为UTC(协调世界时),然后提交为“20180801T083241Z”。 |
V4签名必填,V2签名可以填写x-Amz-Date或Date。 |
Date |
GMT时间 |
V4签名不必填,V2签名可以填写x-Amz-Date或Date |
状态响应码
每个统计都包含状态响应码。
名称 |
描述 |
HTTP/1.1 xxx |
状态码。 l 200 xx表示请求成功; l 4xx,5xx表示请求失败。 |
公共响应头
每个统计响应结果中都会包含公共响应头。
名称 |
描述 |
x-amz-request-id |
服务端生成的用于标识请求的ID。 |
Content-Type |
响应内容类型。 |
Date |
响应日期。 |
Server |
服务器名。 |