本文介绍了SSL证书服务2018-07-13版本的API接口都包含的公共请求参数和返回数据格式。

公共请求参数

名称 类型 是否必选 描述
Format string 返回消息的格式。

取值:JSON(默认)、XML

Version String API版本号。使用YYYY-MM-DD的日期格式表示。

取值:2018-07-13

AccessKeyId String 访问服务使用的AccessKey ID。
Signature String 签名结果串。
SignatureMethod String 签名方式。

取值:HMAC-SHA1

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

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

SignatureVersion String 签名算法版本。

取值:1.0

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

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

ResourceOwnerAccount String 本次API请求访问到的资源拥有者账号,即登录用户名。
示例
https://cas.aliyuncs.com/
?Format=xml
&Version=2018-07-13
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&Timestamp=2012-06-01T12:00:00Z

公共返回数据

API返回结果采用统一格式,返回2xx HTTP状态码表示调用成功;返回4xx或5xx HTTP状态码表示调用失败。

调用成功返回的数据格式有XML和JSON两种。您可以在发送请求时指定返回的数据格式。默认为JSON格式。每次接口调用,无论成功与否,系统都会返回一个唯一识别码RequestId

示例

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