雲訊息佇列 RabbitMQ 版支援HTTP調用、SDK調用和OpenAPI Explorer調用。
HTTP調用
雲訊息佇列 RabbitMQ 版HTTP調用是向雲訊息佇列 RabbitMQ 版API的服務端地址發送HTTP請求,並按照介面說明在請求中加入相應請求參數,調用後系統會返回處理結果。請求及返回結果都使用UTF-8字元集進行編碼。雲訊息佇列 RabbitMQ 版的API是RPC風格,您可以通過發送HTTP GET請求調用雲訊息佇列 RabbitMQ 版的API。
其請求結構如下:
https://Endpoint/?Action=xx&Parameters
其中:
Endpoint: 雲訊息佇列 RabbitMQ 版API的服務接入地址。詳情請參見服務存取點。
Action:要執行的操作,如調用ListInstances查詢已建立的雲訊息佇列 RabbitMQ 版執行個體。
Version:要使用的API版本,雲訊息佇列 RabbitMQ 版的API版本是2019-12-12。
Parameters:請求參數,每個參數之間用“&”分隔。
請求參數由公用請求參數和API自訂參數組成。公用參數中包含API版本號碼、身分識別驗證等資訊。詳情請參見下文。
公用參數
公用請求參數
名稱 | 類型 | 是否必選 | 描述 |
Format | String | 否 | 返回訊息的格式。取值: JSON(預設值) | XML |
Version | String | 是 | API版本號碼,使用YYYY-MM-DD日期格式。取值: 2019-12-12 |
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-10T20:00:00Z。 |
SignatureVersion | String | 是 | 簽名演算法版本,取值: 1.0 |
SignatureNonce | String | 是 | 唯一隨機數,用於防止網路重放攻擊。 在不同請求間要使用不同的隨機數值,建議使用通用唯一識別碼(Universally Unique Identifier, UUID)。 |
ResourceOwnerAccount | String | 否 | 本次API請求訪問到的資源擁有者賬戶,即登入使用者名稱。 |
樣本
https://amqp-open.aliyuncs.com/?Action=ListInstances
&Format=JSON
&Version=2019-12-12
&Signature=xxxx%xxxx%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=e7b1f31150be45594905ce6d28561286
&SignatureVersion=1.0
&AccessKeyId=key-test
&TimeStamp=2020-02-10T08%3A43%3A05Z
…
公用返回參數
API返回結果採用統一格式,調用成功返回的資料格式有XML和JSON兩種,可以在發送請求時指定返回的資料格式,預設為JSON格式。每次介面調用,無論成功與否,系統都會返回一個唯一識別碼RequestId。
返回
2xx
HTTP狀態代碼表示調用成功。返回
4xx
或5xx
HTTP狀態代碼表示調用失敗。
公用返回參數樣本如下:
XML格式
<?xml version="1.0" encoding="utf-8"?> <!--結果的根結點--> <介面名稱+Response> <!--返回請求標籤--> <RequestId>D6660A81-1A96-43F3-AC00-4EE473C70AEC</RequestId> <!--返回結果資料--> </介面名稱+Response>
JSON格式
{ "RequestId":"D6660A81-1A96-43F3-AC00-4EE473C70AEC", /*返回結果資料*/ }
SDK調用
雲訊息佇列 RabbitMQ 版提供多語言SDK。阿里雲SDK免去您手動簽名的過程。SDK的下載地址及說明文檔如下。
語言 | 下載地址 | 說明文檔 |
Java | ||
Go | ||
Python | ||
PHP |
OpenAPI Explorer調用
OpenAPI Explorer是可視化的API調用工具。通過該工具,您可以通過網頁或者命令列調用各雲產品以及API市場上開放的API,查看每次的API請求和返回結果,並產生相應SDK調用樣本。您可以直接存取OpenAPI Explorer。