公共请求和返回头
本文列举了Web应用托管服务的API的公共请求头和公共返回头信息。
公共请求头部
公共请求参数是指每个接口都需要使用到的请求参数。
参数名称 | 示例 | 是否必选 | 说明 |
---|---|---|---|
Authorization | acs <yourAccessKeyId>:<yourSignature> | 是 | 用于验证请求合法性的认证信息,采用 AccessKeyId:Signature 的形式。
|
Content-Length | 0 | 是 | RFC 2616 中定义的 HTTP 请求内容长度。 |
Content-Type | application/json | 是 | RFC 2616 中定义的 HTTP 请求内容类型。 |
Content-MD5 | 0e30656xxxxxxxxx0bc6f70bbdfe | 是 | HTTP 协议消息体的 128-bit MD5 散列值转换成 BASE64 编码的结果。为了防止所有请求被篡改,建议所有请求都附加该信息。 |
Date | Fri, 16 Aug 2019 11:18:47 GMT | 是 | 请求的构造时间,目前只支持 GMT 格式。如果与 MNS 的服务器时间前后差异超过 15 分钟将返回本次请求非法。 |
Host | webplus.cn-hangzhou.aliyuncs.com | 是 | 请求的服务地址,例如:webplus.cn-hangzhou.aliyuncs.com。 |
Accept | application/json | 是 | 客户端需要的返回值类型,支持 application/json 和 application/xml。 |
x-acs-version | 1.0 | 是 | API 版本号。目前版本号为 2019-03-20。 |
x-acs-region-id | cn-hangzhou | 是 | 地域ID。 |
x-acs-signature-nonce | f63659d4-10ac-483b-99da-ea8fde61eae3 | 是 | 唯一随机数,用于防止网络重放攻击。您在不同请求间要使用不同的随机数值。 |
x-acs-signature-method | HMAC-SHA1 | 是 | 用户签名方式,目前只支持 HMAC-SHA1。 |
示例
GET /pop/v1/wam/appEnv HTTP/1.1
Host: webplus.cn-hangzhou.aliyuncs.com
Accept: application/json
UserAgent : Apache-HttpClient/4.5.7 (Java/1.8.0_152)
x-acs-signature-nonce: f63659d4-10ac-483b-99da-ea8fde61eae3
Authorization: acs <yourAccessKeyId>:<yourSignature>
x-acs-signature-version: 1.0
Date: Fri, 16 Aug 2019 11:18:47 GMT
x-acs-signature-method: HMAC-SHA1
Content-Type: application/json;charset=utf-8
X-Acs-Region-Id: cn-hangzhou
Content-Length: 0
公共返回头部
每次接口调用请求,无论成功与否,系统都会返回一个唯一识别码RequestId。调用API服务后返回数据采用统一格式。返回的HTTP状态码为 2xx
,代表调用成功;返回的HTTP状态码为 4xx
或 5xx
,代表调用失败。
XML 示例:
<?xml version="1.0" encoding="UTF-8"?>
<!—结果的根结点-->
<接口名称+Response>
| <!—返回请求标签-->
| <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
| <!—返回结果数据-->
</接口名称+Response>
JSON 示例:
{
"RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
/* 返回结果数据 */
}
版权声明
本文仅代表作者观点,不代表本站立场。
本文系作者授权发表,未经许可,不得转载。
评论