すべてのプロダクト
Search

このプロダクト

    Microservices Engine:GetPlugins

    ドキュメントセンター

    Microservices Engine:GetPlugins

    最終更新日:Apr 18, 2026

    プラグインマーケットプレイスからプラグインを取得します。

    今すぐお試しください

    この 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:GetPlugins

    get

    *Gateway

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    GatewayUniqueId

    string

    必須

    ゲートウェイの一意の ID です。

    gw-0adf3ad751284cc69fcf9669fba*****
    Category

    integer

    任意

    プラグインのカテゴリです。有効な値：

    • 0：ユーザー定義

    • 1：認証と権限付与

    • 2：セキュリティ保護

    • 3：トランスポートプロトコル

    • 4：トラフィックコントロール

    • 5：トラフィックモニタリング

    1
    EnableOnly

    boolean

    任意

    true の場合、有効なプラグインのみを返します。

    true
    Name

    string

    任意

    プラグインの名前です。

    key-auth
    AcceptLanguage

    string

    任意

    応答の言語です。

    有効な値：zh (中国語) および en (英語)。

    zh

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答データです。

    RequestId

    string

    リクエスト ID です。

    03A3E2F4-6804-5663-9D5D-2EC47A1*****

    Success

    boolean

    操作が成功したかどうかを示します。

    true
    Code

    integer

    応答コードです。

    200
    ErrorCode

    string

    エラーコードです。

    500
    HttpStatusCode

    integer

    HTTP ステータスコードです。

    200
    Message

    string

    応答メッセージです。

    success
    DynamicCode

    string

    動的エラーメッセージのプレースホルダーです。

    code
    DynamicMessage

    string

    動的エラーメッセージです。

    message
    Data

    array<object>

    プラグインのリストです。

    object

    プラグインの詳細です。

    Id

    integer

    プラグイン ID です。

    1
    PrimaryUser

    string

    作成者の ID です。

    123
    Category

    integer

    プラグインのカテゴリです。有効な値：

    0：ユーザー定義

    1：認証と権限付与

    2：セキュリティ保護

    3：トランスポートプロトコル

    4：トラフィックコントロール

    5：トラフィックモニタリング

    0
    Name

    string

    プラグイン名です。

    key-auth
    Version

    string

    プラグインのバージョンです。

    v1
    Summary

    string

    プラグインの概要です。

    这是一个插件
    SummaryEn

    string

    英語の概要です。

    Phase

    integer

    プラグインの実行フェーズです。有効な値：

    • 0：デフォルトフェーズ

    • 1：認証フェーズ

    • 2：権限付与フェーズ

    • 3：統計フェーズ

    1
    Priority

    integer

    プラグインの実行優先度です。値が大きいほど、優先度が高くなります。

    1
    ConfigCheck

    string

    設定検証スキーマです。

    # 配置必须字段的校验，如下例所示，要求插件配置必须存在 "name"、"age"、“friends” 字段 name: John age: 18 friends: - David - Anne

    WasmLang

    integer

    Wasm プラグインが実装されている言語です。有効な値：

    • 0：C++

    • 1：TinyGo

    • 2：Rust

    • 3：AssemblyScript

    • 4：Zig

    0
    PublishState

    integer

    公開ステータスです。有効な値：

    • 0：成功

    • 1：公開中

    • 2：失敗

    1
    WasmFile

    string

    Wasm プラグインの OSS URL です。

    https://mse-shared-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/cfg/import/1917515******/gw-0adf3ad751284cc69fcf9669fba*****/2022/11/02/4d390496-2c17-4b42-a479-f9068ba****/16673573***5.wasm
    Status

    string

    プラグインのステータスです。有効な値：

    • 0：無効

    • 1：有効

    1
    Mode

    integer

    プラグインのタイプです。有効な値：

    • 0：Wasm プラグイン

    • 2：Lua プラグイン

    0
    MaxVersion

    string

    最新バージョンです。

    1.0.0
    NewVersionPublishingFlag

    boolean

    最新バージョンが公開中であるかどうかを示します。

    false

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "03A3E2F4-6804-5663-9D5D-2EC47A1*****\n",
  "Success": true,
  "Code": 200,
  "ErrorCode": "500",
  "HttpStatusCode": 200,
  "Message": "success",
  "DynamicCode": "code",
  "DynamicMessage": "message",
  "Data": [
    {
      "Id": 1,
      "PrimaryUser": "123",
      "Category": 0,
      "Name": "key-auth",
      "Version": "v1",
      "Summary": "这是一个插件",
      "SummaryEn": "",
      "Phase": 1,
      "Priority": 1,
      "ConfigCheck": "# 配置必须字段的校验，如下例所示，要求插件配置必须存在 \"name\"、\"age\"、“friends” 字段\nname: John\nage: 18\nfriends:\n- David\n- Anne\n",
      "WasmLang": 0,
      "PublishState": 1,
      "WasmFile": "https://mse-shared-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/cfg/import/1917515******/gw-0adf3ad751284cc69fcf9669fba*****/2022/11/02/4d390496-2c17-4b42-a479-f9068ba****/16673573***5.wasm",
      "Status": "1",
      "Mode": 0,
      "MaxVersion": "1.0.0",
      "NewVersionPublishingFlag": false
    }
  ]
}

    エラーコード

    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

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

    変更履歴

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