开发者社区> -技术小助手-> 正文
阿里云
为了无法计算的价值
打开APP
阿里云APP内打开

PolarDB-X 1.0-API参考-1.0(2019版本)-公共参数

简介: 本文介绍每个接口都需要使用的请求参数和返回参数。
+关注继续查看

公共请求参数

名称类型是否必须描述
FormatString返回消息的格式。取值为JSON(默认值)或XML。
VersionStringAPI版本号,使用YYYY-MM-DD日期格式,取值为2019-01-23。
AccessKeyIdString访问服务使用的密钥ID。
SignatureString签名结果串。
SignatureMethodString签名方式,取值为HMAC-SHA1。
TimestampString请求的时间戳。使用UTC时间按照ISO8601标准,格式为YYYY-MM-DDThh:mm:ssZ。

例如,北京时间2013年1月10日20点0分0秒,表示为2013-01-10T12:00:00Z。

SignatureVersionString签名算法版本,取值为1.0
SignatureNonceString唯一随机数,用于防止网络重放攻击,不同请求间会使用不同的随机数值。
ResourceOwnerAccountString本次API请求访问到的资源拥有者账户,即登录用户名。

公共返回参数

API返回结果采用统一格式,调用成功返回的数据格式有XML和JSON两种,可以在发送请求时指定返回的数据格式,默认为JSON格式。每次接口调用,无论成功与否,系统都会返回一个唯一识别码RequestId

  • 返回2xxHTTP状态码表示调用成功。
  • 返回4xx5xxHTTP状态码表示调用失败。

公共返回参数示例如下:

  • XML格式
<?xml version="1.0" encoding="utf-8"?> 
    <!—结果的根结点-->
    <接口名称+Response>
        <!—返回请求标签-->
        <RequestId>4C467B38-3910-447D-87BC-AC0491******</RequestId>
        <!—返回结果数据-->
    </接口名称+Response>
  • JSON格式
{
    "RequestId":"4C467B38-3910-447D-87BC-AC0491******",
    /*返回结果数据*/
    }

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
Asp.Net Web API 2第二课——CRUD操作
原文:Asp.Net Web API 2第二课——CRUD操作 Asp.Net Web API 导航     Asp.Net Web API第一课——入门http://www.cnblogs.com/aehyok/p/3432158.html 前言   CRUD代表着 Create、Read、Update、Delete,这是四个基本的数据库操作。
814 0
Asp.Net Web API 2第一课——入门
原文:Asp.Net Web API 2第一课——入门 前言   Http不仅仅服务于Web Pages。它也是一个创建展示服务和数据的API的强大平台。Http是简单的、灵活的、无处不在的。你能想象到几乎任何的平台都会有HTTP服务库。
996 0
使用ASP.NET Web Api构建基于REST风格的服务实战系列教程【外传】——Attribute Routing
原文:使用ASP.NET Web Api构建基于REST风格的服务实战系列教程【外传】——Attribute Routing 系列导航地址http://www.cnblogs.com/fzrain/p/3490137.html 题外话:由于这个技术点是新学的,并不属于原系列,但借助了原系列的项目背景,故命名外传系列,以后也可能在这个系列中附加一些新的技术。
985 0
返璞归真 asp.net mvc (11) - asp.net mvc 4.0 新特性之自宿主 Web API, 在 WebForm 中提供 Web API, 通过 Web API 上传文件, .net 4.5 带来的更方便的异步操作
原文:返璞归真 asp.net mvc (11) - asp.net mvc 4.0 新特性之自宿主 Web API, 在 WebForm 中提供 Web API, 通过 Web API 上传文件, .
1227 0
返璞归真 asp.net mvc (10) - asp.net mvc 4.0 新特性之 Web API
原文:返璞归真 asp.net mvc (10) - asp.net mvc 4.0 新特性之 Web API [索引页][源码下载] 返璞归真 asp.net mvc (10) - asp.net mvc 4.
926 0
使用ASP.NET Web Api构建基于REST风格的服务实战系列教程【八】——Web Api的安全性
原文:使用ASP.NET Web Api构建基于REST风格的服务实战系列教程【八】——Web Api的安全性 系列导航地址http://www.cnblogs.com/fzrain/p/3490137.html 前言 这一篇文章我们主要来探讨一下Web Api的安全性,到目前为止所有的请求都是走的Http协议(http://),因此客户端与服务器之间的通信是没有加密的。
1128 0
使用ASP.NET Web Api构建基于REST风格的服务实战系列教程【九】——API变了,客户端怎么办?
原文:使用ASP.NET Web Api构建基于REST风格的服务实战系列教程【九】——API变了,客户端怎么办? 系列导航地址http://www.cnblogs.com/fzrain/p/3490137.html 前言 一旦我们将API发布之后,消费者就会开始使用并和其他的一些数据混在一起。
727 0
【ASP.NET Web API教程】6.3 内容协商
原文:【ASP.NET Web API教程】6.3 内容协商 本文是Web API系列教程的第6.3小节 6.3 Content Negotiation 6.3 内容协商 摘自:http://www.
670 0
ASP.NET Web API使用示例
上篇博客讲解rest服务开发时,曾经提到过asp.net mvc中的rest api,由于篇幅原因,没有在上篇博客中进行讲解,这里专门拿出来进行讨论。
878 0
Web API 版本控制的几种方式
http://www.troyhunt.com/2014/02/your-api-versioning-is-wrong-which-is.html 这篇文章写得很好,介绍了三种实现web api版本化的三种方式。
798 0
文章
问答
来源圈子
更多
文章排行榜
最热
最新
相关电子书
更多
阿里云 API 精选手册(Alibaba Cloud API Playbook)
立即下载
API 网关实践
立即下载
API 平台的安全实践
立即下载