すべてのプロダクト
Search

このプロダクト

    Microservices Engine:GetPluginConfig

    ドキュメントセンター

    Microservices Engine:GetPluginConfig

    最終更新日: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:GetPluginConfig

    get

    *Gateway

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    GatewayUniqueId

    string

    必須

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

    gw-ubuwqygbq4783gqb2y3f87q****

    PluginId

    integer

    必須

    ゲートウェイプラグインの ID。

    123
    AcceptLanguage

    string

    任意

    応答の言語。有効な値：

    zh：中国語、en：英語。

    zh

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RestResult

    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

    object

    応答データ。

    Id

    integer

    プラグイン ID。

    1
    PrimaryUser

    string

    作成者の ID。

    123
    Type

    integer

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

    • 0：HTTP フィルター

    • 1：ネットワークフィルター

    0
    Category

    integer

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

    0：カスタム

    1：権限承認

    2：セキュリティ保護

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

    4：トラフィック制御

    5：トラフィック監視

    0
    Name

    string

    プラグイン名。

    name
    Version

    string

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

    v1
    Summary

    string

    プラグインの概要。

    这是一个插件。
    SummaryEn

    string

    プラグインの英語の概要。

    Readme

    string

    README のコンテンツ。

    read me
    ReadmeEn

    string

    英語の README コンテンツ。

    read me
    ConfigExample

    string

    プラグイン構成の例。

    Phase

    integer

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

    0：デフォルトフェーズ

    1：認証フェーズ

    2：承認フェーズ

    3：統計フェーズ

    0
    Priority

    integer

    実行優先度。値が大きいほど、優先度が高くなります。

    1
    ConfigCheck

    string

    構成チェック。

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

    integer

    モード。

    0
    WasmLang

    integer

    Wasm の実装言語。有効な値：

    0：C++

    1：TinyGo

    2：Rust

    3：AssemblyScript

    4：Zig

    0
    ImageName

    string

    イメージ名。

    name
    PublishState

    integer

    公開ステータス。

    1
    Status

    string

    ステータス。有効な値：

    0：無効

    1：有効

    1
    GatewayConfigList

    array<object>

    プラグインの構成リスト。

    array<object>

    プラグイン構成。

    Id

    integer

    プラグイン構成 ID。

    1
    GatewayId

    integer

    ゲートウェイ ID。

    1
    GatewayUniqueId

    string

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

    gw-ubuwqygbq4783gqb2y3f87q****
    PluginId

    integer

    ゲートウェイプラグイン ID。

    1
    Enable

    boolean

    プラグイン構成が有効かどうかを示します。

    true
    Config

    string

    プラグイン構成。

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

    integer

    プラグインの適用範囲。有効な値：

    0：グローバル

    1：ドメイン

    2：ルート

    0
    ResourceList

    array<object>

    リソースのリスト。ConfigLevel の値に応じて、ドメインまたはルートになります。

    object

    Id

    integer

    リソース ID。

    Name

    string

    リソースの名前。ドメイン名またはルート名です。

    test-route
    GmtCreate

    string

    作成時間。

    1667309705000
    GmtModified

    string

    変更時間。

    1667309705000
    RouteConfigStartIndex

    integer

    GatewayConfigList 配列内のルートレベルのルールの開始インデックス。ルートレベルのルールが存在しない場合、値は -1 です。

    0
    DomainConfigStartIndex

    integer

    GatewayConfigList 配列内のドメインレベルのルールの開始インデックス。ドメインレベルのルールが存在しない場合、値は -1 です。

    5
    GatewayConfigStartIndex

    integer

    GatewayConfigList 配列内のインスタンスレベルのルールのインデックス。インスタンスレベルのルールが存在しない場合、値は -1 です。

    7
    VersionJson

    string

    ゲートウェイプラグインのバージョンのリストを表す JSON 文字列。

    [{"id":1, "version": "1.0.0"}]

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "03A3E2F4-6804-5663-9D5D-2EC47A1*****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "500",
  "HttpStatusCode": 200,
  "Message": "success",
  "DynamicCode": "code",
  "DynamicMessage": "message",
  "Data": {
    "Id": 1,
    "PrimaryUser": "123",
    "Type": 0,
    "Category": 0,
    "Name": "name",
    "Version": "v1",
    "Summary": "这是一个插件。",
    "SummaryEn": "",
    "Readme": "read me",
    "ReadmeEn": "read me",
    "ConfigExample": "",
    "Phase": 0,
    "Priority": 1,
    "ConfigCheck": "# 配置必须字段的校验，如下例所示，要求插件配置必须存在 \"name\"、\"age\"、“friends” 字段\nname: John\nage: 18\nfriends:\n- David\n- Anne",
    "Mode": 0,
    "WasmLang": 0,
    "ImageName": "name",
    "PublishState": 1,
    "Status": "1",
    "GatewayConfigList": [
      {
        "Id": 1,
        "GatewayId": 1,
        "GatewayUniqueId": "gw-ubuwqygbq4783gqb2y3f87q****",
        "PluginId": 1,
        "Enable": true,
        "Config": "# 配置必须字段的校验，如下例所示，要求插件配置必须存在 \"name\"、\"age\"、“friends” 字段\nname: John\nage: 18\nfriends:\n- David\n- Anne",
        "ConfigLevel": 0,
        "ResourceList": [
          {
            "Id": 0,
            "Name": "test-route"
          }
        ],
        "GmtCreate": "1667309705000",
        "GmtModified": "1667309705000"
      }
    ],
    "RouteConfigStartIndex": 0,
    "DomainConfigStartIndex": 5,
    "GatewayConfigStartIndex": 7,
    "VersionJson": "[{\"id\":1, \"version\": \"1.0.0\"}]"
  }
}

    エラーコード

    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

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

    変更履歴

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