ApsaraMQ for RabbitMQ では、HTTP、SDK、および OpenAPI Explorer を使用して API オペレーションを呼び出すことができます。
HTTP の使用
HTTP を使用して API オペレーションを呼び出すには、ApsaraMQ for RabbitMQ エンドポイントに HTTP GET リクエストを送信する必要があります。また、呼び出される API オペレーションに対応するリクエストパラメータを追加する必要があります。API オペレーションを呼び出すと、システムはレスポンスを返します。リクエストとレスポンスは UTF-8 でエンコードされます。ApsaraMQ for RabbitMQ API オペレーションは RPC プロトコルを使用します。HTTP GET リクエストを送信することで API オペレーションを呼び出すことができます。
次のリクエスト構文が使用されます。
https://Endpoint/?Action=xx&Parameters
パラメータの説明:
エンドポイント: ApsaraMQ for RabbitMQ API オペレーションにアクセスするために使用されるエンドポイント。詳細については、エンドポイントをご参照ください。
アクション: 呼び出される API オペレーション。たとえば、作成された ApsaraMQ for RabbitMQ インスタンスをクエリするには、このパラメータを ListInstances に設定します。
バージョン: ApsaraMQ for RabbitMQ API のバージョン番号。値を 2019-12-12 に設定します。
パラメータ: リクエストパラメータ。複数のパラメータはアンパサンド (&) で区切ります。
リクエストパラメータには、共通パラメータとオペレーション固有パラメータの両方が含まれます。共通パラメータには、API バージョン番号と認証情報が含まれます。詳細については、次のセクションをご参照ください。
共通パラメータ
共通リクエストパラメータ
パラメータ | タイプ | 必須 | 説明 |
フォーマット | 文字列 | いいえ | レスポンス形式。有効な値: JSON および XML。デフォルト値: JSON。 |
バージョン | 文字列 | はい | API のバージョン番号。バージョン番号は YYYY-MM-DD 形式で指定します。値を 2019-12-12 に設定します。 |
AccessKeyId | 文字列 | はい | ApsaraMQ for RabbitMQ にアクセスするために使用される AccessKey ID。 |
署名 | 文字列 | はい | 現在のリクエストの署名文字列。 |
署名メソッド | 文字列 | はい | 署名文字列の暗号化方式。このパラメータを HMAC-SHA1 に設定します。 |
タイムスタンプ | 文字列 | はい | リクエストのタイムスタンプ。値は ISO 8601 標準の YYYY-MM-DDThh:mm:ssZ 形式で指定します。時間は UTC でなければなりません。 例: 2013-01-10T20:00:00Z は、2013 年 1 月 10 日 20:00:00 (UTC+8) を指定します。 |
署名バージョン | 文字列 | はい | 署名アルゴリズムのバージョン。このパラメータを 1.0 に設定します。 |
署名ナンス | 文字列 | はい | リプレイ攻撃を防ぐために使用される一意の乱数。 異なるリクエストには異なる番号を使用する必要があります。汎用一意識別子 (UUID) を使用することをお勧めします。 |
リソースオーナーアカウント | 文字列 | いいえ | アクセスするリソースが属する Alibaba Cloud アカウント。 |
例
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 レスポンスは HTTP レスポンス形式を使用します。レスポンスは JSON または XML 形式で返すことができます。リクエストでレスポンス形式を指定できます。デフォルトのレスポンス形式は JSON です。すべてのリクエストは、リクエストが成功したかどうかにかかわらず、リクエスト ID パラメータで示される一意のリクエスト ID を返します。
2xx
HTTP ステータスコードは、リクエストが成功したことを示します。4xx
または5xx
HTTP ステータスコードは、リクエストが失敗したことを示します。
レスポンスの例
XML 形式
<?xml version="1.0" encoding="utf-8"?> <!--レスポンスのルートノード--> <Interface name+Response> <!--返されたリクエストタグ--> <RequestId>D6660A81-1A96-43F3-AC00-4EE473C70AEC</RequestId> <!--返されたデータ--> </Interface name+Response>
JSON 形式
{ "RequestId":"D6660A81-1A96-43F3-AC00-4EE473C70AEC", /*返されたデータ*/ }
SDK の使用
ApsaraMQ for RabbitMQ は、複数のプログラミング言語用の SDK を提供しています。SDK はリクエストに自動的に署名します。次の表に、さまざまなプログラミング言語の ApsaraMQ for RabbitMQ SDK のダウンロードリンクと関連ドキュメントを示します。
プログラミング言語 | ダウンロードリンク | リファレンス |
Java | ||
Go | ||
Python | ||
PHP |
OpenAPI Explorer の使用
OpenAPI Explorer は、API オペレーションを呼び出すための GUI ツールです。OpenAPI Explorer を使用して、Alibaba Cloud サービスの API オペレーションと Alibaba Cloud API Marketplace で提供される API オペレーションを呼び出すことができます。Web ページまたはコマンドラインインターフェース (CLI) で API オペレーションを呼び出すことができます。また、OpenAPI Explorer を使用して、各 API 呼び出しのリクエストパラメータとレスポンスパラメータを表示することもできます。OpenAPI Explorer は、さまざまな SDK のサンプルコードを動的に生成します。OpenAPI Explorer にアクセスするには、OpenAPI Explorer をクリックします。