本章節(jié)為您介紹了調(diào)用阿里云RTC API使用的公共參數(shù)，公共參數(shù)包含請求參數(shù)和返回參數(shù)。

公共請求參數(shù)

公共請求參數(shù)是每個(gè)接口都需要使用到的請求參數(shù)。

參數(shù) 類型 是否必選 描述
Format String 否 返回值的類型，支持JSON與XML，默認(rèn)為XML。
Version String 是 API版本號，為日期形式：YYYY-MM-DD，本版本對應(yīng)為2018-01-11。
AccessKeyId String 是 訪問服務(wù)所用的密鑰ID。
Signature String 是 簽名結(jié)果串。詳情請參見：簽名機(jī)制。
SignatureMethod String 是 簽名方式，取值：HMAC-SHA1。
Timestamp String 是 請求的時(shí)間戳。日期格式按照ISO8601標(biāo)準(zhǔn)表示，使用UTC時(shí)間，格式為yyyy-MM-ddTHH:mm:ssZ。

例如：2019-12-29T12:00:00Z為北京時(shí)間2019年12月29日的20點(diǎn)0分0秒。
SignatureVersion String 是 簽名算法版本，取值：1.0。
SignatureNonce String 是 唯一隨機(jī)數(shù)。在不同請求間使用不同的隨機(jī)數(shù)值，防止網(wǎng)絡(luò)重放攻擊。

代碼示例參見SignatureNonce。

SecurityToken String 否 STS臨時(shí)授權(quán)的Token，默認(rèn)為空。

相關(guān)概念詳情請參見賬號權(quán)限、STS臨時(shí)授權(quán)訪問。

請求示例

http://rtc.aliyuncs.com/
?Format=json 
&Version=2018-01-11
&Signature=L9o%3D**** 
&SignatureMethod=Hmac-SHA1
&SignatureNonce=9166ab59-f445-4005-911d-664c1570df0f
&SignatureVersion=1.0
&Action=ModifyApp
&AccessKeyId=testid  
&Timestamp=2017-03-29T09%3A22%3A32Z
...

公共返回參數(shù)

API返回結(jié)果采用統(tǒng)一格式，返回2xx HTTP狀態(tài)碼代表調(diào)用成功；返回4xx或5xx HTTP狀態(tài)碼代表調(diào)用失敗。調(diào)用成功返回的數(shù)據(jù)格式有XML和JSON兩種，可以在發(fā)送請求時(shí)指定返回的數(shù)據(jù)格式，默認(rèn)為XML格式。

每次接口調(diào)用，無論成功與否，系統(tǒng)都會返回一個(gè)唯一識別碼RequestId。

  • XML格式

    <?xml version="1.0" encoding="UTF-8"?>
    <!--結(jié)果的根結(jié)點(diǎn)--> 
    <接口名稱+Response> 
      <!--返回請求標(biāo)簽-->
      <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
    <!--返回結(jié)果數(shù)據(jù)--> 
  </接口名稱+Response>

  • JSON格式

    {
   "RequestId": "4C467B38-3910-447D-87BC-AC049166F216", /* 返回結(jié)果數(shù)據(jù) */
}