CreatePluginConfig API で MSE ゲートウェイプラグインを構成 - MSE

プラグイン構成を作成します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

mse:CreatePluginConfig

create

*Gateway

acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
GatewayUniqueId	string	必須	ゲートウェイの一意の ID。	gw-ubuwqygbq4783gqb2y3f87q****
PluginId	integer	必須	ゲートウェイプラグインの ID。	20
ConfigLevel	integer	必須	プラグインの適用範囲。有効な値： 0：グローバル 1：ルート 2：ドメイン名	1
Config	string	任意	プラグインの構成。WebAssembly (Wasm) プラグインの構成内容は YAML フォーマットです。Lua プラグインの構成内容は Lua コードです。	status_code: 200 headers: - Content-Type=application/json body: "{\"rule\": \"global\"}"
Enable	boolean	必須	プラグインを有効にするかどうかを示します。	true
ResourceIdList	array	任意	ドメイン ID またはルート ID。ConfigLevel に基づいて区別されます。
	integer	任意	ID。	200
AcceptLanguage	string	任意	結果を表示する言語。有効な値：zh および en。zh は中国語を示し、デフォルト値です。en は英語を示します。	zh

レスポンスフィールド

フィールド	型	説明	例
	object	RestResult
RequestId	string	リクエスト ID。	03A3E2F4-6804-5663-9D5D-2EC47A1*****
PluginConfigID	integer	プラグイン構成の ID。	10

例

成功レスポンス

JSONJSON

{
  "RequestId": "03A3E2F4-6804-5663-9D5D-2EC47A1*****",
  "PluginConfigID": 10
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	IllegalRequest	Invalid request:%s
400	InvalidParameter	Parameter error:%s
500	InternalError	Console error. Try again later:%s
403	NoPermission	You are not authorized to perform this operation:%s
404	NotFound	Not found:%s

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

変更履歴

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