ApsaraMQ for MQTT HTTP、SDK、または OpenAPI Explorer を使用して API を呼び出すことができます。
HTTP を使用した API オペレーションの呼び出し
ApsaraMQ for MQTT RPC 用の API は RPC 形式です。ApsaraMQ for MQTT API を呼び出すことができます。
リクエスト構造は次のとおりです。
http://Endpoint/?Action=xx&Parametersここで
エンドポイント: ApsaraMQ for MQTT [******] のサービスアクセスアドレスは onsmqtt.[regionId].aliyuncs.com です。[ regionId] については、エンドポイント をご参照ください。
アクション: 実行されるオペレーションの名前。たとえば、トークンを申請するには、Action パラメーターを ApplyToken に設定する必要があります。
バージョン: 使用する API のバージョン。ApsaraMQ for MQTT の API バージョンは 2020-04-20 です。
パラメーター: オペレーションのリクエストパラメーター。複数のパラメーターはアンパサンド (&) で区切ります。
リクエストパラメーターには、共通パラメーターとオペレーション固有パラメーターの両方が含まれます。共通リクエストパラメーターには、API バージョンと認証関連パラメーターが含まれます。詳細については、共通パラメーター をご参照ください。
SDK を使用した API オペレーションの呼び出し
ApsaraMQ for MQTT API は、複数のプログラミング言語の SDK をサポートしています。SDK はリクエストに自動的に署名します。詳細については、ApsaraMQ for MQTT API 用の SDK の取得 をご参照ください。
OpenAPI Explorer を使用した API オペレーションの呼び出し
OpenAPI Explorer は、API を呼び出すためのビジュアルツールです。OpenAPI Explorer を使用すると、Alibaba Cloud サービスの API と Alibaba Cloud Marketplace で提供される API を呼び出すことができます。これらの API は、Web ページまたはコマンドラインインターフェース ( CLI ) で呼び出すことができます。さらに、OpenAPI Explorer を使用すると、各 API 呼び出しのリクエストとレスポンスを表示し、SDK サンプルコードを動的に生成できます。
OpenAPI Explorer に直接アクセスするか、API ドキュメントのデバッグ機能を使用して、API オペレーションを呼び出すことができます。
エンドポイント
ApsaraMQ for MQTT の API アクセスアドレスは次のとおりです: onsmqtt.[regionId].aliyuncs.com。[regionId] は、ApsaraMQ for MQTT インスタンスが配置されているリージョンの ID です。
ApsaraMQ for MQTT でサポートされている OpenAPI リージョン、および対応する regionId と ドメイン を次の表に示します。
リージョン | リージョン ID | ドメイン |
インターネット | mq-internet-access | onsmqtt.mq-internet-access.aliyuncs.com |
中国 (成都) | cn-chengdu | onsmqtt.cn-chengdu.aliyuncs.com |
中国 (杭州) | cn-hangzhou | onsmqtt.cn-hangzhou.aliyuncs.com |
中国 (上海) | cn-shanghai | onsmqtt.cn-shanghai.aliyuncs.com |
中国 (青島) | cn-qingdao | onsmqtt.cn-qingdao.aliyuncs.com |
中国 (北京) | cn-beijing | onsmqtt.cn-beijing.aliyuncs.com |
中国 (張家口) | cn-zhangjiakou | onsmqtt.cn-zhangjiakou.aliyuncs.com |
中国 (フフホト) | cn-huhehaote | onsmqtt.cn-huhehaote.aliyuncs.com |
中国 (深圳) | cn-shenzhen | onsmqtt.cn-shenzhen.aliyuncs.com |
中国 (香港) | cn-hongkong | onsmqtt.cn-hongkong.aliyuncs.com |
シンガポール | ap-southeast-1 | onsmqtt.ap-southeast-1.aliyuncs.com |
マレーシア (クアラルンプール) | ap-southeast-3 | onsmqtt.ap-southeast-3.aliyuncs.com |
インドネシア (ジャカルタ) | ap-southeast-5 | onsmqtt.ap-southeast-5.aliyuncs.com |
日本 (東京) | ap-northeast-1 | onsmqtt.ap-northeast-1.aliyuncs.com |
ドイツ (フランクフルト) | eu-central-1 | onsmqtt.eu-central-1.aliyuncs.com |
米国 (シリコンバレー) | us-west-1 | onsmqtt.us-west-1.aliyuncs.com |
米国 (バージニア) | us-east-1 | onsmqtt.us-east-1.aliyuncs.com |
華東 1 ファイナンス | cn-hangzhou-finance | onsmqtt.cn-hangzhou-finance.aliyuncs.com |
華南 1 ファイナンス | cn-shenzhen-finance-1 | onsmqtt.cn-shenzhen-finance-1.aliyuncs.com |
華東 2 ファイナンス | cn-shanghai-finance-1 | onsmqtt.cn-shanghai-finance-1.aliyuncs.com |
華北 2 Ali Gov | cn-north-2-gov-1 | onsmqtt.cn-north-2-gov-1.aliyuncs.com |