API 操作を呼び出して、Optimization Solver コンソールの機能を使用できます。このトピックでは、API リクエストを実行する方法について説明します。
リクエスト構文
各 API 操作のサンプル リクエスト URL を提供しています。これらの URL はエンコードされていません。リクエストを開始する前に、リクエスト URL をエンコードする必要があります。SDK を使用して API リクエストを開始する場合、いくつかの共通パラメーターと API 固有のパラメーターを設定するだけで済みます。SDK はそれらを自動的にエンコードします。Optimization Solver の API 操作は、リモートプロシージャコール ( RPC ) プロトコルを使用します。 HTTP または HTTPS リクエストを送信することで、これらの API 操作を呼び出すことができます。次のリクエスト構文が使用されます。
http://Endpoint/?Action=xx&Parameters Endpoint：Optimization Solver サービスのエンドポイント。
Action：実行される API 操作の名前。たとえば、フローを実行するには、Action パラメーターを StartExecution に設定する必要があります。
Parameters：操作のリクエストパラメーター。複数のパラメーターはアンパサンド ( & ) で区切ります。リクエストパラメーターには、共通パラメーターと API 固有のパラメーターの両方が含まれます。
エンドポイント
エンドポイントは、ユーザーリソースにアクセスして管理するための URL です。エンドポイントは、Alibaba Cloud リージョンに関連付けられています。次の表に、現在利用可能な Optimization Solver のリージョンとエンドポイントを示します。
リージョン | エンドポイント |
|---|---|
中国 ( 北京 ) | opt.cn-beijing.aliyuncs.com |
プロトコル
HTTP または HTTPS を使用して API リクエストを実行できます。セキュリティ上の理由から、HTTPS を使用することをお勧めします。
メソッド
HTTP GET メソッドを使用してリクエストを実行できます。このメソッドを使用する場合は、リクエスト URL にリクエストパラメーターを指定する必要があります。
パラメーター
各リクエストで、Action パラメーター ( たとえば、パラメーターを GetOpenStatus に設定 )、共通リクエストパラメーター、および操作固有のリクエストパラメーターを設定する必要があります。
エンコーディング
すべてのリクエストとレスポンスは UTF-8 でエンコードされます。
SDK の使用
SDK を使用してリクエストを行うことをお勧めします。SDK を使用すると、HTTP パケットのカプセル化と署名の生成が不要になるためです。
GitHub でさまざまなプログラミング言語の SDK をダウンロードする方法については、「Optimization Solver コンソール SDK」をご参照ください。