PolarDB-X 1.0-API参考-1.0(2017版本)-OpenAPI使用-公共参数

公共请求参数

PolarDB-X OpenAPI 所有的公共请求参数如下表所示:

名称 类型 是否必须 描述
Format String 返回值的类型,支持 JSON 与 XML。
Action String 调用接口名称。
Version String API 版本号,为日期形式:YYYY-MM-DD,当前版本对应为2017-10-16。
AccessKeyId String 阿里云颁发给用户的访问服务所用的密钥 ID。
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 唯一随机数,用于防止网络重放攻击。用户在不同请求间要使用不同的随机数值。
RegionId String PolarDB-X 所在的地域。
Signature String 签名结果串。关于签名的计算方法,请参见签名机制

公共返回参数

PolarDB-X OpenAPI 的公共返回参数:唯一识别码 RequestId。RequestId 标识了用户的每一次 API 调用请求,用于 API 方面的问题排查。

RequestId 的示例(XML 格式)


  1. xml version="1.0" encoding="utf-8"?>
  2. <接口名称+Response>

  3. 4C467B38-3910-447D-87BC-AC049166F216

  4. ...

返回结果

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

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

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

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

成功的返回结果

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

XML


  1. xml version="1.0" encoding="utf-8"?>
  2. <接口名称+Response>

  3. 4C467B38-3910-447D-87BC-AC049166F216

  4. ...

JSON


  1. {

  2. ID-->
  3. "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",

  4. /* 返回结果数据 */
  5. ...

  6. }
上一篇:机房收费系统——组合查询


下一篇:Python之pandas:数据类型变换之object、category、bool、int32、int64、float64以及数据类型标准化之详细攻略