すべてのプロダクト
Search
ドキュメントセンター

:AddCustomAuthPermission

最終更新日:Dec 21, 2025

Topic に対する権限を付与します。この API 操作を呼び出す前に、コンソールで親 Topic を作成する必要があります。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

mq:AddCustomAuthPermission

create

*Instance

acs:mq:{#regionId}:{#accountId}:{#InstanceId}

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

InstanceId

string

必須

ApsaraMQ for MQTT インスタンスの ID。

mqtt-cn-0pp12gl****

IdentityType

string

必須

ID タイプ。有効な値:USER、CLIENT。

USER

Identity

string

必須

ユーザー名またはクライアント ID。

test

PermitAction

string

必須

付与する権限。

PUB_SUB

Effect

string

必須

アクセスの許可または拒否。

ALLOW

Topic

string

必須

権限を付与する Topic。複数レベルの Topic とワイルドカード文字に対応しています。

test/t1

レスポンスフィールド

フィールド

説明

object

スキーマオブジェクト。

RequestId

string

リクエスト ID。

82B9E503-F4A1-4F30-976F-C6999FF9****

Code

integer

HTTP ステータスコード。200 は成功を示します。

200

Success

boolean

リクエストが成功したかどうか。有効な値:true、false。

True

Message

string

返されるエラーメッセージ。

operation success.

成功レスポンス

JSONJSON

{
  "RequestId": "82B9E503-F4A1-4F30-976F-C6999FF9****",
  "Code": 200,
  "Success": true,
  "Message": "operation success."
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 InstancePermissionCheckFailed An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.
400 InvalidParameter.%s An error occurred while validating the parameter. The parameter may be missing or invalid.
400 Customauth.over.capacity Over custom auth capacity.
404 ApiNotSupport The specified API is not supported.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。