公共参数是指所有接口在调用时都需要用到的参数，包含公共请求参数和公共返回参数。

公共请求参数

名称 类型 是否必选 描述
Format String 否 返回值的类型，支持JSON和XML，默认为XML。
Version String 是 OpenAPI版本号，版本号为日期格式：YYYY-MM-DD。当前版本号为2020-01-01。
AccessKeyID String 是 阿里云颁发给用户的访问服务所用的密钥ID。
Signature String 是 签名结果串。
SignatureMethod String 是 签名方式，目前仅支持HMAC-SHA1。
Timestamp String 是 请求的时间戳，格式为yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
SignatureVersion String 是 签名算法版本，目前版本为1.0。
SignatureNonce String 是 唯一随机数，用于防止网络重放攻击。不同的请求需使用不同的随机数值。

公共返回参数

用户发送的每次接口调用请求，无论成功与否，系统都会返回一个唯一识别码（RequestId）给用户，可用来跟踪请求的执行情况。

返回示例

DTS OpenAPI使用标准的HTTP状态码表示请求处理的结果，具体状态码如下所示：

  • 返回的HTTP状态码为2xx，代表调用成功。
  • 返回的HTTP状态码为4xx或5xx，代表调用失败。

数据格式主要有XML和JSON两种，默认为XML格式，外部系统可以在请求时指定返回的数据格式。为便于查看，本文档中的返回示例做了格式化处理，实际返回结果是没有进行换行、缩进等处理的。

成功结果

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

错误结果

调用出错后，HTTP请求会返回一个4xx或5xx的HTTP状态码。返回的消息中包含具体的错误代码及错误信息，还包含一个全局唯一的请求ID（RequestId）和一个本次请求访问的站点ID（HostId）。

说明 您可以根据返回的错误码来定位错误原因，详情请参见错误码。若您无法定位错误原因，请联系阿里云客服人员，并提供调用出错返回的HostId和RequestId，以便我们能尽快帮您解决问题。
  • XML示例 
    <?xml version="1.0" encoding="UTF-8"?>
<Error>
   <RequestId>8906582E-6722-409A-A6C4-0E7863B733A5</RequestId>
   <HostId>dts.aliyuncs.com</HostId>
   <Code>UnsupportedOperation</Code>
   <Message>The specified action is not supported.</Message>
</Error>
  • JSON示例 
    {
    "RequestId": "7463B73D-35CC-4D19-A010-6B8D65D242EF",
    "HostId": "dts.aliyuncs.com",
    "Code": "UnsupportedOperation",
    "Message": "The specified action is not supported."
}