文档

公共参数

更新时间:

公共参数包括公共请求参数和公共返回参数。

公共请求参数

公共请求参数是每个接口都需要使用到的请求参数,公共请求参数如下表所示。

名称

类型

是否必须

描述

Format

String

返回消息的格式。

取值:JSON(默认值)| XML

Version

String

API版本号,使用YYYY-MM-DD日期格式。

取值:2021-08-13

AccessKeyId

String

访问服务使用的密钥ID。

Signature

String

签名结果串。

SignatureMethod

String

签名方式。

取值:HMAC-SHA1

Timestamp

String

请求的时间戳,为日期格式。使用UTC时间按照ISO8601标准,格式为YYYY-MM-DDThh:mm:ssZ。

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

SignatureVersion

String

签名算法版本。

取值:1.0

SignatureNonce

String

唯一随机数,用于防止网络重放攻击。

在不同请求间要使用不同的随机数值。

公共返回参数

API返回结果采用统一格式,返回2xx HTTP状态码代表调用成功;返回4xx或5xx HTTP状态码代表调用失败。调用成功返回的数据格式有XML和JSON两种,可以在发送请求时指定返回的数据格式,默认为JSON格式。

每次调用接口,无论成功与否,系统都会返回一个唯一识别码RequestId

JSON格式

{"RequestId":"4C467B38-3910-447D-87BC-AC049166F216",/*返回结果数据*/}

  • 本页导读 (1)
文档反馈