公共参数 - API 参考| 阿里云

公共参数分为公共请求参数和公共返回参数。本文列举弹性容器实例API相关的公共参数。

公共请求参数

以下公共请求参数适用于通过URL发送GET请求调用弹性容器实例API。


名称	类型	是否必需	描述
Action	String	是	API的名称。取值请参见API概览。
AccessKeyId	String	是	访问服务使用的密钥ID。更多信息，请参见获取AccessKey。
Signature	String	是	您的签名。取值请参见签名机制。
SignatureMethod	String	是	签名方式。取值：HMAC-SHA1。
SignatureVersion	String	是	签名算法版本。取值：1.0。
SignatureNonce	String	是	签名唯一随机数。用于防止网络重放攻击，建议您每一次请求都使用不同的随机数。
Timestamp	String	是	请求的时间戳。按照ISO8601标准表示，并需要使用UTC +0时间，格式为yyyy-MM-ddTHH:mm:ssZ。例如：`2018-11-01T12:00:00Z` 表示北京时间2018年11月01日20点00分00秒。
Version	String	是	API版本号，格式为YYYY-MM-DD。取值：2018-08-08。
Format	String	否	返回参数的语言类型。取值范围： json xml 默认值：xml。

请求示例

说明本文中仅提供示例值，实际调用中请进行URL编码。具体操作，请参见构造规范化请求字符串。

https://eci.aliyuncs.com/?Action=<API Name>
&Format=xml
&Version=2018-08-08
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&Timestamp=2018-11-01T12:00:00Z
…

公共返回参数

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


名称	类型	描述
RequestId	String	请求ID。无论调用接口成功与否，都会返回该参数。

返回示例

公共返回参数示例如下：

XML格式

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

JSON格式

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