通过阅读本文,您可以了解到调用互动白板API使用的公共参数。

公共请求参数

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

参数 类型 是否必选 描述
Format String 返回值的类型,支持JSON与XML,默认为XML。
Version String API版本号,日期形式为:YYYY-MM-DD,本版本对应为2020-12-14。
AccessKeyId String 访问服务所用的密钥ID。
Signature String 签名结果串。详情请参见签名机制
SignatureMethod String 签名方式,取值:HMAC-SHA1。
Timestamp String 请求的时间戳。日期格式按照ISO8601标准表示,使用UTC时间,格式为yyyy-MM-ddTHH:mm:ssZ。

例如:2020-12-29T12:00:00Z为北京时间2020年12月29日的12点0分0秒。

SignatureVersion String 签名算法版本,取值:1.0。
SignatureNonce String 唯一随机数。在不同请求间使用不同的随机数值,防止网络重放攻击。

代码示例参见SignatureNonce

SecurityToken String STS临时授权的Token,默认为空。

相关概念详情请参见账号权限STS临时授权访问

请求示例

http://rtc-white-board.cn-shanghai.aliyuncs.com/
?Format=json 
&Version=2020-12-14
&Signature=L9o%3D**** 
&SignatureMethod=Hmac-SHA1
&SignatureNonce=9166ab59-f445-4005-911d-664c1570df0f
&SignatureVersion=1.0
&Action=createApp
&AccessKeyId=testid  
&Timestamp=2020-12-29T09%3A22%3A32Z
...   

公共返回参数

API返回结果采用统一格式,返回2xx HTTP状态码代表调用成功;返回4xx或5xx HTTP状态码代表调用失败,并返回RequestId、HostId、错误代码和错误信息。当您无法排查错误时,可以提交工单联系我们,并在工单中注明服务节点HostId和RequestId。返回的数据格式有XML和JSON两种,可以在发送请求时指定返回的数据格式,默认为JSON格式。

  • 调用成功

    XML格式

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

    JSON格式

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

    XML格式

    <?xml version="1.0" encoding="UTF-8"?> 
    <Error>
        <RequestId>8906582E-6722-409A-A6C4-0E7863B733A5</RequestId> 
        <HostId>rtc-white-board.cn-shanghai.aliyuncs.com</HostId> 
        <Code>UnsupportedOperation</Code>
        <Message>The specified action is not supported.</Message>
    </Error>

    JSON格式

    {
        "RequestId": "8906582E-6722-409A-A6C4-0E7863B733A5", 
        "HostId": "rtc-white-board.cn-shanghai.aliyuncs.com",
        "Code": "UnsupportedOperation",
        "Message": "The specified action is not supported."
    }