全部产品
阿里云办公

公共参数

更新时间:2018-07-20 19:52:04

公共参数包括两个部分:公共请求参数与公共返回参数。

  • 公共请求参数:每个接口都需要使用的请求参数。
  • 公共返回参数:任何的接口调用,无论成功与否,系统都会返回的参数。

公共请求参数

TSDB Open API 所有的公共请求参数如下表所示:

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

公共返回参数

TSDB Open API 的公共返回参数:唯一识别码RequestId

RequestId标识了用户的每一次 API 调用请求,用于 API 方面的问题排查。

RequestId 的示例(XML 格式)

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

返回结果

调用 API 服务后返回数据采用统一格式,

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

调用成功返回的数据格式主要有 XMLJSON 两种,外部系统可以在请求时传入参数来制定返回的数据格式,推荐使用 JSON 格式。

为了便于查看,本文中的返回示例做了格式化处理。实际返回结果是没有进行换行、缩进等处理的。

成功的返回结果

结果包括请求是否成功信息和具体的业务数据。

XML

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

JSON

  1. {
  2. /* 返回的请求 ID */
  3. "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
  4. /* 返回结果数据 */
  5. ...
  6. }

错误的返回结果

调用接口出错后,将不会返回结果数据。调用方可根据错误代码表来定位错误原因。

当调用出错时,HTTP 请求会返回4个信息:

  • 一个 4xx 或 5xx 的 HTTP 状态码;
  • 具体的错误代码及错误信息;
  • 一个全局唯一的请求 ID;
  • 一个您该次请求访问的站点 ID:HostId。

如果根据 API 的返回信息找不到错误原因,可以联系阿里云客服,并提供该 HostId 和 RequestId,以方便 TSDB 工作人员尽快解决问题。

XML

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

JSON

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