ApplyToken - ApsaraMQ for MQTT - Alibaba Cloud ドキュメントセンター

一時的なアクセストークンを作成します。

シナリオ

MQTTクライアントの権限を確認した後、アプリケーションサーバーはこのメソッドを呼び出して、MQTTサーバーからこのクライアントのトークンをリクエストします。詳細については、「概要」をご参照ください。

制限

ユーザーごとのリクエスト制限は、1秒あたり500回です。特別なニーズがある場合は、作業指示書アプリケーションを送信してください。

デバッグ

OpenAPI Explorerは署名値を自動的に計算します。便宜上、OpenAPI Explorerでこの操作を呼び出すことをお勧めします。 OpenAPI Explorerは、さまざまなSDKの操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	はい	ApplyToken	実行する操作。値: ApplyToken
Actions	String	はい	R	トークンの権限タイプ。有効な値: R: 読み取り権限のみ使用可能です。 W: 書き込み権限のみ使用可能です。 R,W: WAFには読み取りと書き込みの両方の権限があります。R と W はカンマ (,) で区切る必要があります。
ExpireTime	Long	はい	1578399620000	トークンの有効期限が切れるタイムスタンプ。有効期限と有効期限の間の最小間隔は 60 秒です。最大間隔は 30 日です。値の有効期間が 30 日を超える場合、エラーは返されません。ただし、実際の有効期間は 30 日です。
InstanceId	String	はい	post-cn-0pp12gl****	MQTTインスタンスのID。クライアントが使用するインスタンスIDと一致する必要があります。コンソールのインスタンスの詳細ページにあります。
Region ID	String	はい	mq-internet-access	MQTTインスタンスのメッセージキューが配置されているリージョン。
Resources	String	はい	TopicA/+	MQTTトピックを示すリソース名。複数のトピックはカンマ (,) で区切ります。各トークンは最大 100 個のリソースを実行および操作できます。複数のトピックがある場合は、これらのトピックを辞書順に並べ替えます。トークンの申請時に登録されたリソースパラメーターは、MQTTワイルドカード構文をサポートしています。これには、1レベルのワイルドカード文字 (+) と複数レベルのワイルドカード文字 (#) が含まれます。たとえば、resources の値を「Topic1/+」と指定した場合、クライアントは「Topic1/xxx」の任意のトピックを操作できます。 resources に「Topic1/#」と指定した場合、コンシューマーは任意のレベルの「Topic1/xxx/xxx/xxx」トピックを操作できます。

説明これらのパラメーターの詳細については、「共通パラメーター」および「APIリクエストの作成」をご参照ください。

レスポンスパラメーター

パラメーター	タイプ	例	説明
RequestId	String	31782AAF-D0CC-44C3-ABFD-1B500276F8CD	リクエストのID。これは共通パラメーターです。各リクエストには一意のIDがあります。
Token	String	LzMT+XLFl5s/YWJ/MlDz4t/Lq5HC1iGU1P28HAMaxYxn8aQbALNtml7QZKl9L9kPe6LqUb95tEVo+zUqOogs9+jZwDUSzsd4X4qaD3n2TrBEuMOqKkk1Xdrvu9VBQQvIYbz7MJWZDYC3DlW7gLEr33Cuj54iIhagtBi3epStJitsssWs7otY9zhKOSZxhr49G3d0bh35mwyP18EMvDas8UlzeSozsSrujNUqZXOGK0PEBSd+rWMGDJlCt6GFmJgm2JFY7PJwf/7OOSmUYIYFs5o/PuPpoTMF+hcVXMs+0yDukIMTOzG9m3t8k36PVrghFmnK6pC3Rt3mibjW****ng==	サーバーから返されたトークン。説明返されたトークンコンテンツの長さ、形式、またはルールを想定しないでください。実際の戻り値

例

サンプルリクエスト

http(s)://onsmqtt.cn-hangzhou.aliyuncs.com/?Action=ApplyToken
&Actions=R
&ExpireTime=1578399620000
&InstanceId=post-cn-0pp12gl****
&RegionId=mq-internet-access
&Resources=TopicA/+
&<共通リクエストパラメーター>

サンプルの成功レスポンス

XML 形式

<RequestId>31782AAF-D0CC-44C3-ABFD-1B500276F8CD</RequestId>
<Token>LzMT+XLFl5s/YWJ/MlDz4t/Lq5HC1iGU1P28HAMaxYxn8aQbALNtml7QZKl9L9kPe6LqUb95tEVo+zUqOogs9+jZwDUSzsd4X4qaD3n2TrBEuMOqKkk1Xdrvu9VBQQvIYbz7MJWZDYC3DlW7gLEr33Cuj54iIhagtBi3epStJitsssWs7otY9zhKOSZxhr49G3d0bh35mwyP18EMvDas8UlzeSozsSrujNUqZXOGK0PEBSd+rWMGDJlCt6GFmJgm2JFY7PJwf/7OOSmUYIYFs5o/PuPpoTMF+hcVXMs+0yDukIMTOzG9m3t8k36PVrghFmnK6pC3Rt3mibjW****ng==</Token>

JSON 形式

{
  "RequestId": "31782AAF-D0CC-44C3-ABFD-1B500276F8CD",
  "Token": "LzMT+XLFl5s/YWJ/MlDz4t/Lq5HC1iGU1P28HAMaxYxn8aQbALNtml7QZKl9L9kPe6LqUb95tEVo+zUqOogs9+jZwDUSzsd4X4qaD3n2TrBEuMOqKkk1Xdrvu9VBQQvIYbz7MJWZDYC3DlW7gLEr33Cuj54iIhagtBi3epStJitsssWs7otY9zhKOSZxhr49G3d0bh35mwyP18EMvDas8UlzeSozsSrujNUqZXOGK0PEBSd+rWMGDJlCt6GFmJgm2JFY7PJwf/7OOSmUYIYFs5o/PuPpoTMF+hcVXMs+0yDukIMTOzG9m3t8k36PVrghFmnK6pC3Rt3mibjW****ng=="
}

エラーコード

HTTPステータスコード	エラー	エラーメッセージ	説明
404	ApiNotSupport	指定された API はサポートされていません。	現在のインターフェースはサポートされていません。確認してください。
400	ApplyTokenOverFlow	トークンを申請しすぎた回数です。後でもう一度お試しください。	トークン申請頻度が高すぎるため、システムフロー制御されています。後でもう一度お試しください。
400	CheckAccountInfoFailed	STSトークンによるアカウント情報の確認中にエラーが発生しました。	STSトークン内のアカウント情報の解析中にエラーが発生しました。
400	InstancePermissionCheckFailed	インスタンスの権限の検証中にエラーが発生しました。インスタンスを作成したアカウントとその権限設定を確認してください。	インスタンス権限の検証に失敗したため、エラーメッセージが返されました。 MQTTインスタンスの所有権と承認ポリシーを確認してください。
500	InternalError	リクエストの処理中にエラーが発生しました。後でもう一度お試しください。	MQTTバックエンドサービスが異常です。後でもう一度お試しください。
400	ParameterCheckFailed	パラメーターの検証中にエラーが発生しました。パラメーターが不足しているか無効です。	パラメーター検証に失敗しました。このパラメーターが不足しているか無効です。
400	PermissionCheckFailed	リソース権限の検証中にエラーが発生しました。インスタンス、トピック、およびグループIDを作成したアカウントを確認し、それらの権限設定を確認してください。	リソース権限の検証に失敗したため、エラーメッセージが返されました。インスタンス、トピック、およびグループ ID の権限と承認ポリシーを確認してください。
500	SystemOverFlow	リクエストの処理中にエラーが発生しました。もう一度お試しください。	システムがスロットリングされています。もう一度お試しください。
400	InvalidParameter.%s	パラメーターの検証中にエラーが発生しました。パラメーターが不足しているか無効です。	パラメーター検証に失敗しました。このパラメーターが不足しているか無効です。

エラーコードの一覧については、APIエラーセンターにアクセスしてください。