本文档列举了云企业网API的公共请求参数和公共返回参数。

公共请求参数

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

表 1. 公共请求参数
名称 类型 是否必须 描述
Format String 返回消息的格式。取值:

JSON (默认值) | XML

Version String API版本号,使用YYYY-MM-DD日期格式。取值:

2017-09-12

AccessKeyId String 访问服务使用的密钥ID。
Signature String 签名结果串。
SignatureMethod String 签名方式,取值:

HMAC-SHA1

Timestamp String 请求的时间戳,为日期格式。使用UTC时间按照 ISO8601标,格式为YYYY-MM-DDThh:mm:ssZ

例如,北京时间2013年1月10日20点0分0秒,表示为2013-01-10T12:00:00Z。

SignatureVersion String 签名算法版本,取值:

1.0

SignatureNonce String 唯一随机数,用于防止网络重放攻击。

在不同请求间要使用不同的随机数值。

示例
https://cbn.aliyuncs.com/?Action=DescribeCens
&TimeStamp=2014-05-19T10%3A33%3A56Z
&Format=xml
&AccessKeyId=testid
&Action=DescribeCens
&SignatureMethod=Hmac-SHA1
&CenId=CenID
&SignatureNonce=NwDAxvLU6tFE0DVb
&Version=2016-04-28
&SignatureVersion=1.0
&Signature=Signature

公共返回参数

API返回结果采用统一格式,返回2xx HTTP状态码代表调用成功;返回4xx或5xx HTTP状态码代表调用失败。调用成功返回的数据格式有XML和JSON两种,可以在发送请求时指定返回的数据格式,默认为JSON格式。

每次接口调用,无论成功与否,系统都会返回一个唯一识别码 RequestId