公共参数

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

公共请求参数

公共请求参数表 。

名称

类型

是否必须

描述

Format

String

返回消息的格式。取值:

JSON (默认值) | XML

Version

String

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

2020-12-30

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请求访问到的资源拥有者账户,即登录用户名。

示例 。

http://cloudphone.aliyuncs.com/?Action=ListInstances
&TimeStamp=2014-05-19T10%3A33%3A56Z
&Format=xml
&AccessKeyId=testid
&SignatureMethod=Hmac-SHA1
&SignatureNonce=NwDAxvLU6tFE0DVb
&Version=2020-12-30
&SignatureVersion=1.0
&Signature= 
Signature

公共返回参数

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

RequestId

  • 返回2xxHTTP状态码表示调用成功。

  • 返回4xx5xxHTTP状态码表示调用失败。

公共返回参数示例如下:

  • XML格式

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

    {
        "RequestId":"4C467B38-3910-447D-87BC-AC049166F216",
        /*返回结果数据*/
        }