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

公共请求参数

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

公共返回参数

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

RequestId 的示例（XML 格式）

1. xml version="1.0" encoding="utf-8"?>
3. <接口名称+Response>
4. 
   
5.    
6.    
7.        4C467B38-3910-447D-87BC-AC049166F216
8.    
9. 
   
10.    
11.    ...

返回结果

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

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

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

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

成功的返回结果

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

XML

1. xml version="1.0" encoding="utf-8"?>
3. <接口名称+Response>
4. 
   
5.    
6.    
7.        4C467B38-3910-447D-87BC-AC049166F216
8.    
9. 
   
10.    
11.    ...

JSON

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