公共参数是指所有接口调用都需要用到的参数,包含公共请求参数和公共返回参数。

公共请求参数

公共请求参数是每个接口都需要使用到的请求参数。

参数名称 示例 是否必选 说明
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 Wed, 16 Dec 2015 11:18:47 GMT 请求的构造时间,目前只支持GMT格式。如果与MNS的服务器时间前后差异超过15分钟将返回本次请求非法。
Host cs.aliyuncs.com 请求的服务地址,例如:elasticsearch.<RegionId>.aliyuncs.com
Accept application/json 客户端需要的返回值类型,支持application/jsonapplication/xml
x-acs-version 1.0 API版本号。目前版本号为2017-06-13
x-acs-region-id cn-beijing 地域ID。
x-acs-signature-nonce f63659d4-10ac-483b-99da-ea8fde61eae3 唯一随机数,用于防止网络重放攻击。您在不同请求间要使用不同的随机数值。
x-acs-signature-method HMAC-SHA1 用户签名方式,目前只支持HMAC-SHA1
示例如下。
GET /clusters HTTP/1.1
Host: cs.aliyuncs.com
Accept: application/json
User-Agent: cs-sdk-python/0.0.1 (Darwin/15.2.0/x86_64;2.7.10)
x-acs-signature-nonce: f63659d4-10ac-483b-99da-ea8fde******
Authorization: acs <yourAccessKeyId>:<yourSignature>
x-acs-signature-version: 1.0
Date: Wed, 16 Dec 2015 11:18:47 GMT
x-acs-signature-method: HMAC-SHA1
Content-Type: application/json;charset=utf-8
X-Acs-Region-Id: cn-beijing
Content-Length: 0

公共返回参数

每次接口调用请求,无论成功与否,系统都会返回一个唯一识别码RequestId。调用API服务后返回数据采用统一格式。返回的HTTP状态码为2xx,代表调用成功;返回的HTTP状态码为4xx5xx,代表调用失败。

调用成功返回的数据格式有XML和JSON两种,可以在发送请求时指定返回的数据格式,默认为JSON格式。

XML示例
<?xml version="1.0" encoding="UTF-8"?>
<!—结果的根结点-->
<接口名称+Response>
 | <!—返回请求标签-->
 | <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
 | <!—返回结果数据-->
</接口名称+Response>
JSON示例
{
    "RequestId": "4C467B38-3910-447D-87BC-AC049166F216"
    /* 返回结果数据 */
}