文档

公共参数

更新时间:

介绍每个接口都需要使用的请求参数和返回参数。

公共请求参数表

名称

类型

是否必须

描述

Format

String

返回消息的格式,取值:JSON (默认值) 、XML

Version

String

API版本号,使用YYYY-MM-DD日期格式。取值: 2014-05-15

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

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

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

ResourceOwnerAccount

String

本次API请求访问到的资源拥有者账户,即登录用户名。 

公共返回参数

API返回结果采用统一格式,调用成功返回的数据格式为JSON或者XML。

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

Success:当前调用是否成功,true/false

Code: 调用返回的错误码,200/4XX/5XX

Message:错误信息

公共返回参数示例如下: 

  • JSON格式 

    {
        "RequestId":"59C3CCE4-24B1-4277-A4A0-C0EFE4C14E0A"
        "Success":"true",
        "Code":200,
        "Message":"success"
        /*返回结果数据*/
    }

  • XML格式

<CreateTaskResponse>

<RequestId>59C3CCE4-24B1-4277-A4A0-C0EFE4C14E0A</RequestId>

<Success>true</Success>

<Code>200</Code>

<Message>success</Message

</CreateTaskResponse>

  • 本页导读 (0)
文档反馈