本文列举了运维事件中心的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 | Wed, 16 Dec 2015 11:18:47 GMT | 是 | 请求的构造时间,目前只支持GMT格式。如果与MNS的服务器时间前后差异超过15分钟将返回本次请求非法。 |
Host | gemp.cn-shanghai.aliyuncs.com | 是 | 请求的服务地址,例如:elasticsearch.<RegionId>.aliyuncs.com。 |
Accept | application/json | 是 | 客户端需要的返回值类型,支持application/json和application/xml。 |
x-acs-version | 1.0 | 是 | API版本号。目前版本号为2017-06-13。 |
x-acs-region-id | cn-shanghai | 是 | 地域ID。 |
x-acs-signature-nonce | f63659d4-10ac-483b-99da-ea8fde61eae3 | 是 | 唯一随机数,用于防止网络重放攻击。您在不同请求间要使用不同的随机数值。 |
x-acs-signature-method | HMAC-SHA1 | 是 | 用户签名方式,目前只支持 HMAC-SHA1。 |
示例
Action /config/all HTTP/1.1
Host: gemp.cn-shanghai.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-ea8fde61eae3
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-shanghai
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"
/* 返回结果数据 */
}
HTTP 状态码 | 错误代码 | 错误信息 |
---|---|---|
403 | ServiceNotOpen | Service not opened |
400 | ServiceStoped | Service stoped |
400 | InvalidParameter | The specified parameter is not valid. |
403 | NoPermission | account have no permission |
500 | InternalError | Internal Error |
404 | ResourceNotFound | The specified Resource is not found. |
404 | UserTypeNotExisted | User type does not existed |
403 | StsTokenNoPermission | Sts token have not permission |
403 | StsTokenNoWritePermission | Sts token have not write permission |
403 | UserNotAdded | The user did not added to system |
404 | ResourceEmpty | The resource ID is empty |
403 | ResourceIdNotBelongTenant | The resource ID does not belong to the tenant ID |
404 | TenantNotExisted | The specified tenant does not exist. |