ApsaraMQ for MQTT の API は、HTTP 経由、SDK を通じて、または OpenAPI Explorer から呼び出すことができます。
HTTP 呼び出し
ApsaraMQ for MQTT は、HTTP GET リクエストを送信することで呼び出す RPC スタイルの API を提供します。
リクエストの構造は次のとおりです：
http://Endpoint/?Action=xx&Parameters各項目は次のとおりです：
-
エンドポイント：ApsaraMQ for MQTT API のエンドポイントは onsmqtt.[regionId].aliyuncs.com です。[regionId] の詳細については、「サービスエンドポイント」をご参照ください。
-
アクション：実行する操作です。たとえば、ApplyToken を呼び出してトークンをリクエストします。
-
バージョン：使用する API のバージョンです。ApsaraMQ for MQTT の API バージョンは 2020-04-20 です。
-
パラメーター：アンパサンド (&) で区切られたリクエストパラメーターです。
リクエストパラメーターには、共通パラメーターと API 固有のパラメーターが含まれます。共通パラメーターには、API バージョンと認証情報が含まれます。詳細については、「共通パラメーター」をご参照ください。
SDK 呼び出し
Alibaba Cloud は、リクエスト署名を自動的に処理する複数言語の ApsaraMQ for MQTT SDK を提供しています。詳細については、「OpenAPI SDK の入手」をご参照ください。
OpenAPI Explorer 呼び出し
OpenAPI Explorer を使用すると、Web ページまたはコマンドラインから Alibaba Cloud プロダクトおよび API マーケットプレイスの API を呼び出すことができます。API のリクエストとレスポンスを表示し、サンプル SDK コードを生成できます。
OpenAPI Explorer にアクセスして直接 API を呼び出すか、API ドキュメントのデバッグ機能を使用できます。
サービスエンドポイント
ApsaraMQ for MQTT API のエンドポイントは onsmqtt.[regionId].aliyuncs.com です。ここで、[regionId] は、ApsaraMQ for MQTT インスタンスが所在するリージョンの ID です。
次の表に、サポートされている OpenAPI リージョンと、それぞれの リージョン ID および ドメイン名 を示します。
|
リージョン名 |
リージョン 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 |
|
China East 1 Finance |
cn-hangzhou-finance |
onsmqtt.cn-hangzhou-finance.aliyuncs.com |
|
South China 1 Finance Cloud |
cn-shenzhen-finance-1 |
onsmqtt.cn-shenzhen-finance-1.aliyuncs.com |
|
East China 2 Finance Cloud |
cn-shanghai-finance-1 |
onsmqtt.cn-shanghai-finance-1.aliyuncs.com |
|
China (Beijing) Alibaba Gov Cloud 1 |
cn-north-2-gov-1 |
onsmqtt.cn-north-2-gov-1.aliyuncs.com |