介紹每個接口都需要使用的請求參數和返回參數。

公共請求參數

表 1. 公共請求參數表
名稱 類型 是否必須 描述
Format String 返回消息的格式。取值:

JSON(默認值)

Version String API版本號,使用YYYY-MM-DD日期格式。取值:

2020-05-09

AccessKeyId String 訪問服務使用的密鑰ID。
Signature String 簽名結果串。
SignatureMethod String 簽名方式,取值:

HMAC-SHA1

Timestamp String 請求的時間戳,為日期格式。使用UTC時間按照 ISO8601標準,格式為YYYY-MM-DDThh:mm:ssZ。

例如,北京時間2013年1月10日20點0分0秒,表示為2013-01-10T12:00:00Z。

SignatureVersion String 簽名算法版本,取值:

1.0

SignatureNonce String 唯一隨機數,用于防止網絡重放攻擊。

在不同請求間要使用不同的隨機數值。

ResourceOwnerAccount String 本次API請求訪問到的資源擁有者賬戶,即登錄用戶名。
示例
http://baasdis.cn-hangzhou.aliyuncs.com/?Action=CreatePersonalDID
&TimeStamp=2020-06-23T11%3A19%3A12Z
&Format=JSON
&AccessKeyId=testid
&SignatureMethod=Hmac-SHA1
&SignatureNonce=NwDAxvLU6tFE0DVb
&Version=2020-05-09
&SignatureVersion=1.0
&Signature=Signature

公共返回參數

API返回結果采用統一格式,調用成功返回的數據格式只有JSON。每次接口調用,無論成功與否,系統都會返回一個唯一識別碼RequestId
  • 返回2xxHTTP狀態碼表示調用成功。
  • 返回4xx5xxHTTP狀態碼表示調用失敗。
公共返回參數示例如下:
  • JSON格式
    {
        "RequestId":"4C467B38-3910-447D-87BC-AC049166F216",
        /*返回結果數據*/
     }