すべてのプロダクト
Search

このプロダクト

    Microservices Engine:GetGatewayConfig

    ドキュメントセンター

    Microservices Engine:GetGatewayConfig

    最終更新日:Jul 15, 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:GetGatewayConfig

    get

    *Gateway。

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    GatewayUniqueId

    string

    必須

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

    gw-61f465fa2dd044069e2208c4912*****
    AcceptLanguage

    string

    任意

    返される結果の言語。有効な値: zh (デフォルト): 中国語、en: 英語。

    zh

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RestResult

    RequestId

    string

    リクエスト ID。

    F6092602-C357-4750-89D9-E572FBEA****
    Success

    boolean

    リクエストが成功したかどうかを示します。有効な値:

    • true: リクエストが成功しました。

    • false: リクエストが失敗したことを示します。

    true
    Code

    integer

    Success パラメーターと同期される応答コード。

    200
    ErrorCode

    string

    エラーコード。

    Success
    HttpStatusCode

    integer

    HTTP 状態コード。

    200
    Message

    string

    応答メッセージ。

    OK
    DynamicCode

    string

    使用されていません。このパラメーターは無視してください。

    code
    DynamicMessage

    string

    使用されていません。このパラメーターは無視してください。

    The specified parameter is invalid.
    Data

    object

    データの概要。

    GatewayUniqueId

    string

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

    gw-61f465fa2dd044069e2208c4912*****
    EnableGenerateRequestId

    boolean

    リクエスト範囲に適用されます。有効にすると、リクエストトレースのためにリクエストヘッダーにリクエスト ID が生成されます。

    true
    EnableGzip

    boolean

    リクエスト位相および応答位相に適用されます。gzip を有効にすると、リクエストデータと応答データが圧縮され、ゲートウェイトラフィックは減少しますが、ゲートウェイの CPU 消費量は増加します。

    false
    EnableSlashMerge

    boolean

    リクエスト位相に適用されます。リクエスト内の冗長なスラッシュをマージするかどうかを指定します。有効にすると、www.a.com//b の冗長なスラッシュがマージされ、www.a.com/b と同等になります。

    true
    DownstreamIdleTime

    integer

    ゲートウェイ接続に適用されます。指定された期間内にリクエストを受信しない場合、クライアントとゲートウェイ間の接続は閉じられます。

    180
    PreserveHeaderFormat

    boolean

    リクエスト位相および応答位相に適用されます。リクエストヘッダーの元の大文字小文字を保持するかどうかを指定します。HTTP/1.1 仕様では、ヘッダーは大文字小文字を区別しません。HTTP/2 の互換性のため、デフォルトではヘッダーは小文字に変換されます。

    true
    DownstreamConnectionBufferLimits

    integer

    ゲートウェイ接続に適用されます。接続ごとのバッファーサイズです。この設定はスループットとゲートウェイのメモリ使用量に影響します。単位: バイト。

    32768
    EnableHardwareAccelerate

    boolean

    ハードウェアアクセラレーションを有効にするかどうかを指定します。お使いのリージョンがインフラストラクチャレベルでこれをサポートしていない場合、または購入時間にハードウェアアクセラレーションが指定されていない場合は、失敗する可能性があります。

    true
    XffTrustedNum

    integer

    リクエスト位相に適用されます。ゲートウェイの前にある信頼済みプロキシの数です。これは、ゲートウェイが x-forwarded-for や x-request-id などのクライアント生成リクエストヘッダーを使用するかどうかに関係します。

    0
    EnableHttp2

    boolean

    リクエスト位相に適用されます。サーバーとクライアント間のネゴシエーション中に HTTP/2 を使用するかどうかを指定します。変更は 1〜2 分以内に効果が現れます。

    false
    DownstreamHttp2MaxConcurrentStream

    integer

    リクエスト位相に適用されます。クライアントが HTTP/2 を使用している場合の単一接続上の最大同時ストリーム数です。

    100
    InitialStreamWindowSize

    integer

    リクエスト位相に適用されます。HTTP/2 使用時にゲートウェイとクライアント間でネゴシエートされる初期ストリームウィンドウサイズです。単位: バイト。

    65535
    InitialConnectionWindowSize

    integer

    リクエスト位相に適用されます。HTTP/2 使用時にゲートウェイとクライアント間でネゴシエートされる接続レベルの初期ウィンドウサイズです。単位: バイト。

    1048576
    XtraceDetails

    object

    トレーシング分析情報。

    TraceOn

    boolean

    トレース分析が有効になっているかどうかを示します。

    true
    Id

    integer

    トレース ID。

    255
    Sample

    integer

    トレース分析のサンプリングレート。単位：パーセンテージ (%)。

    100
    GatewayId

    integer

    ゲートウェイ ID。

    500
    GatewayUniqueId

    string

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

    gw-61f465fa2dd044069e2208c4912*****
    GmtCreate

    string

    トレース分析に関する情報が作成された時刻。

    2024-08-12T09:39:07.000+0000
    GmtModified

    string

    トレース分析に関する情報が変更された時刻。

    2024-08-12T09:39:07.000+0000
    TraceType

    string

    トレース分析のタイプ。有効な値：

    • XTRACE：Zipkin プロトコルを使用する OpenTelemetry 向けマネージドサービスが使用されます。

    • SKYWALKING：自己管理型の SkyWalking が使用されます。

    • OPENTELEMETRY：OpenTelemetry プロトコルを使用する OpenTelemetry 向けマネージドサービスが使用されます。

    • OTSKYWALKING：SkyWalking プロトコルを使用する OpenTelemetry 向けマネージドサービスが使用されます。

    OPENTELEMETRY
    ServiceId

    integer

    自己管理型の SkyWalking サービスの ID。

    333
    ServicePort

    string

    自己管理型の SkyWalking サービスのポート番号。

    8888
    SlsConfigDetails

    object

    log delivery 情報。

    LogOn

    boolean

    ログ配布が有効になっているかどうかを示します。

    true
    Id

    integer

    このパラメーターは使用できません。

    0
    ProjectName

    string

    ログ配布が有効になっているプロジェクトの名前。

    test
    LogStoreName

    string

    ログの配布先となる Logstore の名前。

    • NginxCompatible パラメーターが false に設定されている場合、Logstore 名は mse_gw_access_log です。

    • NginxCompatible パラメーターが true に設定されている場合、Logstore 名は nginx-ingress です。

    mse_gw_access_log
    GatewayUniqueId

    string

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

    gw-61f465fa2dd044069e2208c4912*****

    GatewayId

    integer

    ゲートウェイ ID。

    500
    GmtCreate

    string

    このパラメーターは使用できません。

    ""
    GmtModified

    string

    このパラメーターは使用できません。

    ""
    NginxCompatible

    boolean

    Microservices Engine (MSE) Ingress ゲートウェイが NGINX Ingress ゲートウェイと互換性があるかどうかを示します。

    false
    SupportWaf

    boolean

    ゲートウェイが WAF をサポートしているかどうかを示します。

    true
    EnableWaf

    boolean

    WAF が有効かどうかを示します。

    true
    AccessLogHeader

    string

    カスタムログフォーマット。

    {"requestMetadata":[],"responseHeaders":[],"requestHeaders":["x-test"],"responseMetadata":[]}
    EnableHttp3

    boolean

    HTTP/3 がサポートされているかどうかを示します。

    false
    UpstreamIdleTimeout

    integer

    アップストリーム接続のデフォルトのアアイドルタイムアウト時間。

    30
    ZipAlgorithm

    string

    圧縮が有効な場合に使用される圧縮アルゴリズム。brotli または gzip を選択できます。EnableGzip が有効になっていない場合、このパラメーターを設定すると自動的に有効になります。

    ["gzip"]
    PathWithEscapedSlashes

    string

    URI パスにエスケープ文字 %2F、%2f、%5C、または %5c が含まれるリクエストに対する操作を指定します。デフォルト値は KEEP_UNCHANGED です。

    有効な値:

    • KEEP_UNCHANGED

    • REJECT_REQUEST

    • UNESCAPE_AND_REDIRECT

    • UNESCAPE_AND_FORWARD

    KEEP_UNCHANGED
    NoSupportedConfigList

    string

    サポートされていない設定のリスト。

    "EnableProxyProtocol,EnableCustomAuthConfigPush"
    LogFilterConfig

    string

    使用できません。

    ""
    EnableProxyProtocol

    boolean

    Proxy プロトコルを有効にするかどうかを指定します。ゲートウェイの Ingress トラフィックが NLB 経由で受信される場合、このプロトコルを有効にしないとクライアントの送信元 IP アドレスを取得できません。これを有効にしても、非 Proxy プロトコルのリクエストには影響しません。

    true
    EnableCustomAuthConfigPush

    string

    セルフマネージド認証サービスを使用するシナリオに適用されます。有効にすると、認証ルールの変更による接続中断が発生しません。WebSocket やオンラインビジネスシナリオに適しています。

    false
    KeepaliveHeaderTimeout

    integer

    クライアントに返される Keep-Alive レスポンスヘッダーの生成に使用される値を指定し、接続のキープアライブ時間を示します。たとえば、10 にセットすると、レスポンスヘッダー keep-alive: timeout=10 が返されます。0 にセットすると、このレスポンスヘッダーは返されません。

    0
    WebsocketTermGracePeriod

    integer

    ゲートウェイインスタンスがアップグレードまたは再起動中に接続を閉じる必要がある場合に、WebSocket 接続に対して維持されるキープアライブ時間。単位: 秒。

    30
    EnableK8sSourceWorkloadFilter

    object

    Enable

    boolean

    LabelKey

    string

    LabelValue

    string

    FilterOpt

    string

    EnableXffTrustedCidrs

    object

    Enable

    boolean

    IpListContent

    string

    EnableGzipHardwareAccelerate

    boolean

    PreserveExternalRequestID

    boolean

    LiteMetrics

    boolean

    LogRequestResponseConfig

    string

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "F6092602-C357-4750-89D9-E572FBEA****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "Success",
  "HttpStatusCode": 200,
  "Message": "OK",
  "DynamicCode": "code",
  "DynamicMessage": "The specified parameter is invalid.",
  "Data": {
    "GatewayUniqueId": "gw-61f465fa2dd044069e2208c4912*****",
    "EnableGenerateRequestId": true,
    "EnableGzip": false,
    "EnableSlashMerge": true,
    "DownstreamIdleTime": 180,
    "PreserveHeaderFormat": true,
    "DownstreamConnectionBufferLimits": 32768,
    "EnableHardwareAccelerate": true,
    "XffTrustedNum": 0,
    "EnableHttp2": false,
    "DownstreamHttp2MaxConcurrentStream": 100,
    "InitialStreamWindowSize": 65535,
    "InitialConnectionWindowSize": 1048576,
    "XtraceDetails": {
      "TraceOn": true,
      "Id": 255,
      "Sample": 100,
      "GatewayId": 500,
      "GatewayUniqueId": "gw-61f465fa2dd044069e2208c4912*****",
      "GmtCreate": "2024-08-12T09:39:07.000+0000",
      "GmtModified": "2024-08-12T09:39:07.000+0000",
      "TraceType": "OPENTELEMETRY",
      "ServiceId": 333,
      "ServicePort": "8888"
    },
    "SlsConfigDetails": {
      "LogOn": true,
      "Id": 0,
      "ProjectName": "test",
      "LogStoreName": "mse_gw_access_log",
      "GatewayUniqueId": "gw-61f465fa2dd044069e2208c4912*****\n",
      "GatewayId": 500,
      "GmtCreate": "\"\"",
      "GmtModified": " \"\"",
      "NginxCompatible": false
    },
    "SupportWaf": true,
    "EnableWaf": true,
    "AccessLogHeader": "{\"requestMetadata\":[],\"responseHeaders\":[],\"requestHeaders\":[\"x-test\"],\"responseMetadata\":[]}",
    "EnableHttp3": false,
    "UpstreamIdleTimeout": 30,
    "ZipAlgorithm": "[\"gzip\"]",
    "PathWithEscapedSlashes": "KEEP_UNCHANGED",
    "NoSupportedConfigList": "\"EnableProxyProtocol,EnableCustomAuthConfigPush\"",
    "LogFilterConfig": " \"\"",
    "EnableProxyProtocol": true,
    "EnableCustomAuthConfigPush": "false",
    "KeepaliveHeaderTimeout": 0,
    "WebsocketTermGracePeriod": 30,
    "EnableK8sSourceWorkloadFilter": {
      "Enable": false,
      "LabelKey": "",
      "LabelValue": "",
      "FilterOpt": ""
    },
    "EnableXffTrustedCidrs": {
      "Enable": false,
      "IpListContent": ""
    },
    "EnableGzipHardwareAccelerate": false,
    "PreserveExternalRequestID": false,
    "LiteMetrics": false,
    "LogRequestResponseConfig": ""
  }
}

    エラーコード

    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

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

    変更履歴

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