公共参数

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

• 公共请求参数：每个接口都需要使用的请求参数。

• 公共返回参数：任何的接口调用，无论成功与否，系统都会返回的参数。

公共请求参数

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

公共返回参数

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

RequestId 的示例（XML 格式）

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

返回结果

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

• 返回的 HTTP 状态码为 2xx，代表调用成功；

• 返回 4xx 或 5xx 的 HTTP 状态码代表调用失败。

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

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

成功的返回结果

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

XML

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

JSON

{
    <!—返回的请求 ID-->
    "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
    /* 返回结果数据 */
    ...
}

错误的返回结果

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

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

• 一个 4xx 或 5xx 的 HTTP 状态码；

• 具体的错误代码及错误信息；

• 一个全局唯一的请求 ID；

• 一个您该次请求访问的站点 ID：HostId。

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

XML

<?xml version="1.0" encoding="UTF-8"?>
<Error>
       <RequestId>8906582E-6722-409AA6C4-0E7863B733A5</RequestId>
       <HostId>drds.aliyuncs.com</HostId>
       <Code>UnsupportedOperation</Code>
       <Message>The specified action is not supported.</Message>
</Error>

JSON

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