各 API オペレーションでは、オペレーション固有のパラメーターに加えて、共通のリクエストパラメーターおよび応答パラメーターを使用します。
共通リクエストパラメーター
| 名前 | タイプ | 必須 | 説明 |
| Format | String | いいえ | 応答の形式。有効な値： JSON (デフォルト) | XML |
| Version | String | はい | API のバージョン。YYYY-MM-DD 形式で指定します。有効な値： 2020-04-20 |
| AccessKeyId | String | はい | サービスへのアクセスに使用する AccessKey ID。 |
| Signature | String | はい | リクエストの署名文字列。 |
| SignatureMethod | String | はい | 署名アルゴリズム。有効な値： HMAC-SHA1 |
| Timestamp | String | はい | UTC でのリクエストのタイムスタンプ。ISO 8601 形式 (YYYY-MM-DDThh:mm:ssZ) を使用します。 例えば、2013年1月10日 20:00:00 (UTC+8) は 2013-01-10T12:00:00Z と表します。 |
| SignatureVersion | String | はい | 署名アルゴリズムのバージョン。有効な値： 1.0 |
| SignatureNonce | String | はい | リプレイ攻撃を防ぐための一意の乱数。 リクエストごとに異なる乱数を使用してください。 |
| ResourceOwnerAccount | String | いいえ | リソースオーナーのログインユーザー名。 |
共通リクエストパラメーターの例
http://onsmqtt.[regionId].aliyuncs.com/?Action=[ApiName]
&TimeStamp=2020-05-19T10%3A33%3A56Z
&Format=xml
&AccessKeyId=testid
&SignatureMethod=Hmac-SHA1
&SignatureNonce=NwDAxvLU6tFE0DVb
&Version=2020-04-20
&SignatureVersion=1.0
&Signature=[Signature]共通応答パラメーター
API の応答は標準形式を使用します。成功した呼び出しは、データを XML または JSON 形式で返します。形式はリクエストで指定できます。デフォルトの形式は JSON です。すべての API 呼び出しは、成功したかどうかにかかわらず、一意の RequestId を返します。
- HTTP ステータスコードが
2xxの場合は、呼び出しが成功したことを示します。 - HTTP ステータスコードが
4xxまたは5xxの場合は、呼び出しが失敗したことを示します。
-
成功した応答の例
API 呼び出しが成功した場合、応答には応答パラメーターとリクエスト ID が含まれます。HTTP ステータスコードは 2xx です。
- XML 形式
<?xml version="1.0" encoding="utf-8"?> <!-- 結果のルートノード --> <APIName+Response> <!-- リクエスト ID --> <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId> <!-- 応答データ --> </APIName+Response> - JSON 形式
{ "RequestId":"4C467B38-3910-447D-87BC-AC049166F216", /* 応答データ */ }
- XML 形式
-
エラー応答の例
API 呼び出しが失敗した場合、応答にはエラーコード、エラーメッセージ、リクエスト ID が含まれます。HTTP ステータスコードは 4xx または 5xx です。エラーコードに基づいて問題をトラブルシューティングします。詳細については、「エラーコード」をご参照ください。問題を解決できない場合は、DingTalk グループ 116015007918 で ApsaraMQ for MQTT のテクニカルサポートにお問い合わせください。
- XML の例
<?xml version="1.0" encoding="UTF-8"?><!-- 結果のルートノード --> <Error> <RequestId>540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx</RequestId> <!-- リクエスト ID --> <Code>MissingParameter.CommandId</Code> <!-- エラーコード --> <Message>The input parameter“CommandId”that is mandatory for processing this request is not supplied.</Message> <!-- エラーメッセージ --> </Error> - JSON の例
{ "RequestId": "540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx", /* リクエスト ID */ "Code": "MissingParameter.CommandId", /* エラーコード */ "Message": "The input parameter“CommandId”that is mandatory for processing this request is not supplied." /* エラーメッセージ */ }
- XML の例