全部产品
云市场

公共参数

更新时间:2018-08-13 07:53:08

公共请求参数

公共请求参数是指每个接口都需要使用到的请求参数。

名称 类型 是否必须 描述
Format String 返回值的类型,支持 JSON 与 XML。默认为 XML。(对于软电话SDK中所需要的返回值,需要为JSON格式)
Version String API 版本号,为日期形式:YYYY-MM-DD,本版本对应为 2017-07-05。
Timestamp String 请求的时间戳。日期格式按照 ISO8601 标准表示,并需要使用 UTC 时间。格式为:
YYYY-MM-DDThh:mm:ssZ
例如,2014-05-26T12:00:00Z(为北京时间 2014 年 5 月 26 日 20 点 0 分 0 秒)。
SignatureType String 认证方式,当前为 BEARERTOKEN
RegionId String 请求地域,当前为 cn-shanghai
SignatureNonce String 唯一随机数,用于防止网络重放攻击。用户在不同请求间要使用不同的随机数值,长度为45位
BearerToken String 访问令牌,也就是 access_token

示例

  1. https://ccc.cn-shanghai.aliyuncs.com/?SignatureVersion
  2. &Format=JSON
  3. &Version=2017-07-05
  4. &Timestamp=2018-07-09T03:20:26Z
  5. &SignatureType=BEARERTOKEN
  6. &RegionId=cn-shanghai
  7. &SignatureNonce=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3DiNM1dgI%3D1
  8. &BearerToken=eyJhbGciOiJSUzI1NiIsImsyaWQiOiJlNE92NnVOUDhsMEY2RmVUMVhvek5wb1NBcVZLblNGRyIsImtpZCI6IkpDOXd4enJocUowZ3RhQ0V0MlFMVWZldkVVSXdsdEZodWk0TzFiaDY3dFUifQ.Qm9ENTdnTkxWSlhUblVPUEJBYkJMV1dzNW45cFBOSWdNRElrQU9XZWNTcjFYOFFqMWhUYzdTL2p3SE9LcHBiZkorUGdvcm4wSC9sSjdHeldlQ1RQVndock1YV0dTem80dU0rUVFKdDFSY2V0bmFQcml5WFljTDhmNUZ2c1pFd3BhTDFOajVvRW9QVG83S1NVU3JpTFdKQmNnVHB1U094cUd4cGpCeEtRTDVTWXR0NzRzRkp4RTVlSFNzUm1Qa1FBVTVwS1lmaXE0QVFSd3lPQjdYSk1uUGFKU1BiSWhyRVdWNnFWOTIyMGd3PT0.Ludqa8TiD5PgeNJ590E_w2wgxvad11bD7uFnnp00q1fdIigxSy9t0WBGfv3oOnTogXNz-OHC-5Vbcyn8-m_cBy_BO2amop2i8o_RYmaTNMzznbslqpoPqRq9sRGhfaNgq3JWEYzjrN62GeUw1UAoVNyaUN4Cc_aZGkvmSfIPm6othSEYhd0h3wkkmZ3AMaBDjsYp4xvc_DCWgtc41oYJN3y8wfdy0OLFEyZ983LENqwzJp118r6PgKIDVq4CClf60IljwoCTusK3fCwq3BCENokmv6vTcw_Ij88_KqOrPyBrEZ0dLvFrRgq5X0rypKyjY1-DmCeeb8UBtGc5i-zd4Q
  9. ...

公共返回参数

用户发送的每次接口调用请求,无论成功与否,系统都会返回一个唯一识别码 RequestId 给用户。

示例

XML示例:

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

JSON示例:

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