本文介绍PolarDB-X 2.0每个接口都需要使用的请求参数和返回参数详情。
公共请求参数
| 名称 | 类型 | 是否必须 | 描述 |
| Format | String | 否 | 返回消息的格式。取值为JSON（默认值）或XML。 |
| Version | String | 是 | API版本号，使用YYYY-MM-DD日期格式，取值为2020-02-02。 |
| AccessKeyId | String | 是 | 访问服务使用的密钥ID。 |
| Signature | String | 是 | 签名结果串。 |
| SignatureMethod | String | 是 | 签名方式，取值为HMAC-SHA1。 |
| Timestamp | String | 是 | 请求的时间戳。使用UTC时间按照ISO8601标准，格式为YYYY-MM-DDThh:mm:ssZ。例如，北京时间2013年1月10日20点0分0秒，表示为2013-01-10T12:00:00Z。 |
| SignatureVersion | String | 是 | 签名算法版本，取值为1.0 |
| SignatureNonce | String | 是 | 唯一随机数，用于防止网络重放攻击，不同请求间会使用不同的随机数值。 |
| ResourceOwnerAccount | String | 否 | 本次API请求访问到的资源拥有者账户，即登录用户名。 |
公共返回参数
API返回结果采用统一格式，调用成功返回的数据格式有XML和JSON两种，可以在发送请求时指定返回的数据格式，默认为XML格式。每次接口调用，无论成功与否，系统都会返回一个唯一识别码RequestId。
- 返回
2xxHTTP状态码表示调用成功。 - 返回
4xx或5xxHTTP状态码表示调用失败。
公共返回参数示例如下：
- XML格式
<?xml version="1.0" encoding="utf-8"?> <!—结果的根结点--> <接口名称+Response> <!—返回请求标签--> <RequestId>4C467B38-3910-447D-87BC-AC0491******</RequestId> <!—返回结果数据--> </接口名称+Response>
- JSON格式
{
"RequestId":"4C467B38-3910-447D-87BC-AC0491",/返回结果数据/
}
