公共參數(shù)
公共參數(shù)分為公共請(qǐng)求參數(shù)和公共返回參數(shù)。
公共請(qǐng)求參數(shù)
名稱 | 類型 | 是否必須 | 描述 |
Format | String | 否 | 返回消息的格式。取值:
|
Version | String | 是 | API版本號(hào),使用YYYY-MM-DD日期格式。取值:2019-01-08。 |
Signature | String | 是 | 消息簽名。 |
SignatureMethod | String | 是 | 簽名方式。取值:HMAC-SHA1。 |
SignatureNonce | String | 是 | 唯一隨機(jī)數(shù)。用于防止網(wǎng)絡(luò)重放攻擊。在不同請(qǐng)求間要使用不同的隨機(jī)數(shù)值。 |
SignatureVersion | String | 是 | 簽名算法版本。取值:1.0。 |
AccessKeyId | String | 是 | 訪問密鑰ID。 |
Timestamp | String | 是 | 請(qǐng)求的時(shí)間戳,為日期格式。使用UTC時(shí)間并按照ISO8601標(biāo)準(zhǔn),格式為:YYYY-MM-DDThh:mm:ssZ。 例如:北京時(shí)間2013年01月10日20點(diǎn)00分00秒,表示為2013-01-10T12:00:00Z。 |
公共請(qǐng)求參數(shù)示例如下:
https://config.aliyuncs.com/?Action=DescribeDiscoveredResource
&Format=JSON
&Version=2019-01-08
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dg****
&SignatureMethod=HMAC-SHA1
&SignatureNonce=1521552885****
&SignatureVersion=1.0
&AccessKeyId=LTAI4GENiH2u8MVj7Khh****
&Timestamp=2020-06-01T12:00:00Z
公共返回參數(shù)
API返回結(jié)果采用統(tǒng)一格式,調(diào)用成功返回的數(shù)據(jù)格式有XML和JSON兩種,可以在發(fā)送請(qǐng)求時(shí)指定返回的數(shù)據(jù)格式,默認(rèn)為XML格式。每次接口調(diào)用,無論成功與否,系統(tǒng)都會(huì)返回一個(gè)唯一識(shí)別碼RequestId。
返回
2xx
HTTP狀態(tài)碼表示調(diào)用成功。返回
4xx
或5xx
HTTP狀態(tài)碼表示調(diào)用失敗。
公共返回參數(shù)示例如下:
XML格式
<?xml version="1.0" encoding="utf-8"?> <!--結(jié)果的根結(jié)點(diǎn)--> <接口名稱+Response> <!--返回請(qǐng)求標(biāo)簽--> <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId> <!--返回結(jié)果數(shù)據(jù)--> </接口名稱+Response>
JSON格式
{ "RequestId":"4C467B38-3910-447D-87BC-AC049166F216" /*返回結(jié)果數(shù)據(jù)*/ }