すべてのプロダクト
Search

このプロダクト

    Microservices Engine:AddGatewayAuth

    ドキュメントセンター

    Microservices Engine:AddGatewayAuth

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

    create

    *Gateway

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Name

    string

    任意

    認証名。

    test
    Type

    string

    任意

    認証方式。有効な値：

    • JWT

    • OIDC

    • IDaaS

    • ExternalAuthZ (カスタム認証サービス)

    JWT
    Issuer

    string

    任意

    このパラメーターは、`Type` が `JWT` または `OIDC` の場合に適用されます。

    • JWT 認証の場合、JWT クレームの発行者 (`iss`) を指定します。

    • OIDC 認証の場合、OIDC クレームの発行者 (`iss`) を指定します。

    https://example.com/auth
    Jwks

    string

    任意

    JSON Web Key Set (JWKS) 形式の JWT 公開鍵。

    {"keys":[{"e":"AQAB","kid":"DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ","kty":"RSA","n":"xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ"}]}
    TokenPosition

    string

    任意

    JWT の場所を指定します。有効な値：

    • HEADER：トークンはリクエストヘッダー内にあります。

    デフォルトでは、トークンは `Authorization` ヘッダーから読み取られ、`Bearer ` というプレフィックスを付ける必要があります。例：`Authorization: Bearer <token>`。

    HEADER
    TokenName

    string

    任意

    JWT を含むリクエストヘッダーの名前。

    デフォルト値は `Authorization` です。

    Authorization
    TokenNamePrefix

    string

    任意

    ヘッダー内のトークン値のプレフィックス。

    デフォルト値は `Bearer ` です (末尾のスペースにご注意ください)。

    Bearer

    TokenPass

    boolean

    任意

    認証成功後、トークンをバックエンドサービスに渡すかどうかを指定します。

    true
    IsWhite

    boolean

    任意

    認証モードを指定します。

    • true：ホワイトリストモード。指定されたホストとパスに一致するリクエストは認証をバイパスできます。その他すべてのリクエストには認証が必要です。

    • false：ブラックリストモード。指定されたホストとパスに一致するリクエストには認証が必要です。その他すべてのリクエストは認証をバイパスできます。

    true
    Status

    boolean

    任意

    このパラメーターは内部使用向けであり、設定しないでください。作成時、認証ルールはデフォルトで無効になっています。

    false
    RedirectUrl

    string

    任意

    認証成功後にユーザーがリダイレクトされる URL。このパラメーターは、`Type` が `OIDC` または `IDaaS` の場合に必須です。URL は、OIDC または IDaaS プロバイダーで設定されたリダイレクト URL と一致する必要があります。

    https://test-.com/oauth2/callback
    ClientId

    string

    任意

    ID プロバイダーに登録されているアプリケーションのクライアント ID。このパラメーターは、`Type` が `OIDC` または `IDaaS` の場合に必須です。

    23460e2fdd9bf9ad106****
    ClientSecret

    string

    任意

    ID プロバイダーに登録されているアプリケーションのクライアントシークレット。このパラメーターは、`Type` が `OIDC` または `IDaaS` の場合に必須です。

    123****
    CookieDomain

    string

    任意

    Cookie ドメイン。認証成功後、ゲートウェイはこのドメインに Cookie を送信して、ユーザーのサインイン状態を維持します。

    例えば、Cookie-domain=a.example.com と設定した場合、Cookie は a.example.com ドメインに送信されます。`Cookie-domain=.example.com` と設定した場合、Cookie は example.com とそのサブドメインに送信されます。

    test.com
    ScopesList

    array

    任意

    OIDC スコープ。このパラメーターは、`Type` が `OIDC` の場合に必須です。

    string

    任意

    OIDC スコープ。

    openid
    LoginUrl

    string

    任意

    IDaaS インスタンスのユーザーログインページの URL。このパラメーターは、`Type` が `IDaaS` の場合に必須です。

    https://daxxxxcn.aliyunidaas.com/
    Sub

    string

    任意

    JWT クレームのサブジェクト (`sub`)。このパラメーターは、`Type` が `JWT` の場合に使用されます。このパラメーターの値が JWT ペイロードの `sub` フィールドと一致することを確認してください。このパラメーターが設定されていないか、空のままの場合、その値はデフォルトで `Issuer` パラメーターの値になります。

    testing@secure.istio.io
    ExternalAuthZJSON

    object

    任意

    カスタム認証サービスの設定。

    ServiceId

    integer

    任意

    認証サービスの ID。

    1343
    PrefixPath

    string

    任意

    認証サービスによって提供される認証 API のパス。パスはプレフィックスで照合されます。

    /auth
    TokenKey

    string

    任意

    トークンを含むリクエストヘッダー (`Authorization` や `Cookie` など)。

    Authorization
    AllowRequestHeaders

    array

    任意

    カスタム認証サービスに渡すリクエストヘッダー。

    string

    任意

    許可されるリクエストヘッダーの名前。

    x-req
    AllowUpstreamHeaders

    array

    任意

    カスタム認証サービスからバックエンドサービスに渡すレスポンスヘッダー。

    string

    任意

    許可されるレスポンスヘッダーの名前。

    x-resp
    Timeout

    integer

    任意

    カスタム認証サービスのタイムアウト (秒単位)。

    10
    IsRestrict

    boolean

    任意

    カスタム認証サービスが利用できない場合の動作を指定します：

    • true：Strict モード。認証サービスが利用できない場合 (接続障害や 5xx エラーなど)、ゲートウェイはクライアントリクエストを拒否します。

    • false：Permissive モード。認証サービスが利用できない場合、ゲートウェイはクライアントリクエストの通過を許可します。

    true
    WithRequestBody

    boolean

    任意

    カスタム認証サービスに送信されるリクエストにリクエストボディを含めるかどうかを指定します。

    true
    BodyMaxBytes

    integer

    任意

    カスタム認証サービスに送信できるリクエストボディの最大サイズ (バイト単位)。

    4000000
    WithRematchRoute

    boolean

    任意

    認証完了後にルートを再照合するかどうかを指定します。

    GatewayUniqueId

    string

    任意

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

    gw-*****9b04bb4474cae9d645be850e3d7
    AuthResourceMode

    integer

    任意

    認可リソースを設定するためのモード。有効な値：

    • 0：シンプルモード

    • 1：アドバンストモード

    1
    AuthResourceConfig

    string

    任意

    アドバンストモードの YAML 設定。

    AuthResourceList

    array<object>

    任意

    認可ルールのリスト。複数のルールは論理 OR で評価されます。単一のルール内では、複数の一致条件は論理 AND で評価されます。

    array<object>

    任意

    認可ルールの設定。

    DomainId

    integer

    任意

    ルールが適用されるドメイン名の ID。

    1765
    Path

    string

    任意

    照合するリクエストパス。

    /test
    MatchType

    string

    任意

    パスの一致タイプ。有効な値：

    • EQUAL：完全一致

    • PRE：プレフィックス一致

    • REGEX：正規表現一致

    EQUAL
    IgnoreCase

    boolean

    任意

    パスの照合で大文字と小文字を区別するかどうかを指定します。このパラメーターはカスタム認証ルールにのみ適用されます。他の認証方式では、パスの照合はデフォルトで大文字と小文字を区別します。

    • true：パスの照合で大文字と小文字を区別しません。

    • false：パスの照合で大文字と小文字を区別します。

    true
    AuthResourceHeaderList

    array<object>

    任意

    照合するリクエストヘッダー条件のリスト。このパラメーターはカスタム認証ルールにのみ適用されます。

    object

    任意

    HeaderKey

    string

    任意

    リクエストヘッダーの名前。

    x-req
    HeaderMethod

    string

    任意

    一致条件。有効な値：

    • EQUAL：等しい

    • NOT_EQUAL：等しくない

    • EXIST：存在する

    • NOT_EXIST：存在しない

    • INCLUDE：含む

    • EXCLUDE：含まない

    • PREFIX：プレフィックスを持つ

    • SUFFIX：サフィックスを持つ

    • REGEX：正規表現一致

    EQUAL
    HeaderValue

    string

    任意

    リクエストヘッダーの値。

    123
    AcceptLanguage

    string

    任意

    レスポンスの言語。有効な値：`zh` (中国語) および `en` (英語)。デフォルト値は `zh` です。

    zh

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    データ構造。

    RequestId

    string

    リクエスト ID。

    4279C00F-A5E1-53C6-A43B-751C1C524D0B
    HttpStatusCode

    integer

    HTTP ステータスコード。

    200
    Message

    string

    レスポンスメッセージ。

    OK
    Code

    integer

    レスポンスコード。値が `200` の場合は、`Success` が `true` であることを示します。

    200
    Success

    boolean

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

    • true：リクエストは成功しました。

    • false：リクエストは失敗しました。

    true
    Data

    integer

    作成された認証ルールの ID。

    333

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "4279C00F-A5E1-53C6-A43B-751C1C524D0B",
  "HttpStatusCode": 200,
  "Message": "OK",
  "Code": 200,
  "Success": true,
  "Data": 333
}

    エラーコード

    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

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

    変更履歴

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