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.    
  4.    
  5.        4C467B38-3910-447D-87BC-AC049166F216
  6.    

  7.    
  8.    ...

返回结果

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

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

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

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

成功的返回结果

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

XML


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

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

  7.    
  8.    ...

JSON


  1. {

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

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

  6. }
相关文章
|
存储 开发框架 小程序
社区每周丨小程序 CLI 1.8.10 版本上线及基础API新增接口(7.3-7.7)
社区每周丨小程序 CLI 1.8.10 版本上线及基础API新增接口(7.3-7.7)
333 11
|
存储 机器学习/深度学习 API
Android API Level 到底是什么?和安卓什么关系?应用发布如何知道自己的版本?优雅草卓伊凡
Android API Level 到底是什么?和安卓什么关系?应用发布如何知道自己的版本?优雅草卓伊凡
2087 31
Android API Level 到底是什么?和安卓什么关系?应用发布如何知道自己的版本?优雅草卓伊凡
|
安全 API 开发者
鸿蒙NEXT-鸿蒙老版本迁移最新版本(API19,modelVersion5.1.1)
鸿蒙更新至API19,新增热更新支持、资源过滤、内存分析等功能。本文详解手动迁移步骤及上下文获取问题解决方案。
644 0
|
Java API PHP
【亲测有效,官方提供】php版本企查查api接口请求示例代码,php请求企查查api接口,thinkphp请求企查查api接口
【亲测有效,官方提供】php版本企查查api接口请求示例代码,php请求企查查api接口,thinkphp请求企查查api接口
1105 1
|
Cloud Native 关系型数据库 分布式数据库
云原生数据库 PolarDB系统权限策略参考
阿里云RAM提供系统策略和自定义策略,其中系统策略由阿里云维护,不可修改,用于快速入门。产品系统策略如AliyunPolardbFullAccess、AliyunPolardbReadOnlyAccess和AliyunPolardbReadOnlyWithSQLLogArchiveAccess分别提供全权、只读和只读加SQL日志归档访问权限。服务关联角色策略如AliyunServiceRolePolicyForPolarDB用于PolarDB访问其他资源。建议遵循最小授权原则。详情参考官方文档。
324 1
|
文字识别 算法 API
视觉智能开放平台产品使用合集之海外是否可以访问人物动漫化的api版本
视觉智能开放平台是指提供一系列基于视觉识别技术的API和服务的平台,这些服务通常包括图像识别、人脸识别、物体检测、文字识别、场景理解等。企业或开发者可以通过调用这些API,快速将视觉智能功能集成到自己的应用或服务中,而无需从零开始研发相关算法和技术。以下是一些常见的视觉智能开放平台产品及其应用场景的概览。
454 0
|
关系型数据库 分布式数据库 PolarDB
PolarDB产品使用合集之关于在Docker环境中部署和维护PolarDB-X,有相关文章可以参考吗
PolarDB产品使用合集涵盖了从创建与管理、数据管理、性能优化与诊断、安全与合规到生态与集成、运维与支持等全方位的功能和服务,旨在帮助企业轻松构建高可用、高性能且易于管理的数据库环境,满足不同业务场景的需求。用户可以通过阿里云控制台、API、SDK等方式便捷地使用这些功能,实现数据库的高效运维与持续优化。
|
Oracle Java 关系型数据库
JDK版本特性问题之在 JDK 11 中,HTTP Client API 的特点有哪些
JDK版本特性问题之在 JDK 11 中,HTTP Client API 的特点有哪些
|
缓存 JavaScript 前端开发
微信 JS-SDK Demo “分享信息设置” API 及数字签名生成方法(NodeJS版本)
微信 JS-SDK Demo “分享信息设置” API 及数字签名生成方法(NodeJS版本)更新时间(2020-10-29)
|
并行计算 算法 API
MindOpt优化器: 浅谈版本0.x和1.x之间API的差异
Mindopt是一款高性能优化求解器,专为解决从简单线性规划 (LP) 到更复杂的混合整数规划 (MIP) 、非线性规划(QP、SDP)的一系列问题而设计。其强大的算法旨在有效地找到最佳解决方案,使其成为运筹学,电力能源、工业制造、交通物流和其他领域的研究人员和专业人员的首选工具。

热门文章

最新文章

相关产品

  • 云原生分布式数据库 PolarDB-X