公共参数

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

相关参数说明

名称	类型	是否必须	描述
Format	String	否	返回值的类型，支持JSON与XML。默认为XML
Version	String	是	API版本号，为日期形式：YYYY-MM-DD，本版本对应为2014-08-15
AccessKeyId	String	是	阿里云颁发给用户的访问服务所用的密钥ID
Signature	String	是	签名结果串，关于签名的计算方法，请参见签名机制。
SignatureMethod	string	是	签名方式，目前支持HMAC-SHA1
Timestamp	String	是	请求的时间戳。日期格式按照ISO8601标准表示，并需要使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ;例如，2013-08-15T12:00:00Z（为北京时间2013年8月15日20点0分0秒）
SignatureVersion	String	是	签名算法版本，目前版本是1.0
SignatureNonce	String	是	唯一随机数，用于防止网络重放攻击。用户在不同请求间要使用不同的随机数值

示例

1. [backcolor=transparent]https://rds.aliyuncs.com/
2. [backcolor=transparent]?Format=xml
3. [backcolor=transparent]&Version=2014-08-15
4. [backcolor=transparent]&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
5. [backcolor=transparent]&SignatureMethod=HMAC-SHA1
6. [backcolor=transparent]&SignatureNonce=15215528852396
7. [backcolor=transparent]&SignatureVersion=1.0
8. [backcolor=transparent]&AccessKeyId=key-test
9. [backcolor=transparent]&OwnerId=12345678
10. [backcolor=transparent]&Timestamp=2014-10-10T12:00:00Z

公共返回参数


用户发送的每次接口调用请求，无论成功与否，系统都会返回一个唯一识别码RequestId给用户。

示例

1. [backcolor=transparent]<?[backcolor=transparent]xml version[backcolor=transparent]=[backcolor=transparent]"1.0"[backcolor=transparent] encoding[backcolor=transparent]=[backcolor=transparent]"utf-8"[backcolor=transparent]?>[backcolor=transparent]
2. [backcolor=transparent]<!—结果的根结点-->
3. [backcolor=transparent]<接口名称+Response>
4. [backcolor=transparent]    <!—返回请求标签-->
5. [backcolor=transparent]    [backcolor=transparent]<RequestId>[backcolor=transparent]4C467B38-3910-447D-87BC-AC049166F216[backcolor=transparent]</RequestId>
6. [backcolor=transparent]    <!—返回结果数据-->
7. [backcolor=transparent]</接口名称+Response>

返回结果


调用API服务后返回数据采用统一格式，返回的HTTP状态码为2xx，代表调用成功；返回4xx或5xx的HTTP状态码代表调用失败。调用成功返回的数据格式主要有XML和JSON两种，外部系统可以在请求时传入参数来制定返回的数据格式，默认为XML格式。本文档中的返回示例为了便于用户查看，做了格式化处理，实际返回结果是没有进行换行、缩进等处理的。

成功结果


XML返回结果包括请求是否成功信息和具体的业务数据。示例如下：

1. [backcolor=transparent]<?[backcolor=transparent]xml version[backcolor=transparent]=[backcolor=transparent]"1.0"[backcolor=transparent] encoding[backcolor=transparent]=[backcolor=transparent]"utf-8"[backcolor=transparent]?>[backcolor=transparent]
2. [backcolor=transparent]<!—结果的根结点-->
3. [backcolor=transparent]<接口名称+Response>
4. [backcolor=transparent]    <!—返回请求标签-->
5. [backcolor=transparent]    [backcolor=transparent]<RequestId>[backcolor=transparent]4C467B38-3910-447D-87BC-AC049166F216[backcolor=transparent]</RequestId>
6. [backcolor=transparent]    <!—返回结果数据-->
7. [backcolor=transparent]</接口名称+Response>

JSON示例：

1. [backcolor=transparent]{
2. [backcolor=transparent]    [backcolor=transparent]"RequestId"[backcolor=transparent]:[backcolor=transparent] [backcolor=transparent]"4C467B38-3910-447D-87BC-AC049166F216"[backcolor=transparent],
3. [backcolor=transparent]    [backcolor=transparent]/* 返回结果数据 */
4. [backcolor=transparent]}

错误结果


调用接口出错后，将不会返回结果数据。调用方可根据附表 错误代码表 来定位错误原因。当调用出错时，HTTP请求返回一个4xx或5xx的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。另外还包含一个全局唯一的请求ID：RequestId和一个您该次请求访问的站点ID：HostId。在调用方找不到错误原因，可以联系阿里云客服，并提供该HostId和RequestId，以便我们尽快帮您解决问题。

1. [backcolor=transparent]<?[backcolor=transparent]xml version[backcolor=transparent]=[backcolor=transparent]"1.0"[backcolor=transparent] encoding[backcolor=transparent]=[backcolor=transparent]"UTF-8"[backcolor=transparent]?>
2. [backcolor=transparent]<Error>
3. [backcolor=transparent]   [backcolor=transparent]<RequestId>[backcolor=transparent]8906582E-6722-409A-A6C4-0E7863B733A5[backcolor=transparent]</RequestId>
4. [backcolor=transparent]   [backcolor=transparent]<HostId>[backcolor=transparent]rds.aliyuncs.com[backcolor=transparent]</HostId>
5. [backcolor=transparent]   [backcolor=transparent]<Code>[backcolor=transparent]UnsupportedOperation[backcolor=transparent]</Code>
6. [backcolor=transparent]   [backcolor=transparent]<Message>[backcolor=transparent]The specified action is not supported.[backcolor=transparent]</Message>
7. [backcolor=transparent]</Error>

JSON示例：

1. [backcolor=transparent]{
2. [backcolor=transparent]    [backcolor=transparent]"RequestId"[backcolor=transparent]:[backcolor=transparent] [backcolor=transparent]"7463B73D-35CC-4D19-A010-6B8D65D242EF"[backcolor=transparent],
3. [backcolor=transparent]    [backcolor=transparent]"HostId"[backcolor=transparent]:[backcolor=transparent] [backcolor=transparent]"rds.aliyuncs.com"[backcolor=transparent],
4. [backcolor=transparent]    [backcolor=transparent]"Code"[backcolor=transparent]:[backcolor=transparent] [backcolor=transparent]"UnsupportedOperation"[backcolor=transparent],
5. [backcolor=transparent]    [backcolor=transparent]"Message"[backcolor=transparent]:[backcolor=transparent] [backcolor=transparent]"The specified action is not supported."
6. [backcolor=transparent]}