すべてのプロダクト
Search

このプロダクト

    Microservices Engine:UpdateGatewayAuth

    ドキュメントセンター

    Microservices Engine:UpdateGatewayAuth

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

    update

    *Gateway。

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Name

    string

    任意

    認証名。

    test。
    Type

    string

    任意

    認証タイプ。有効な値:

    ExternalAuthZ。
    Issuer

    string

    任意

    認証タイプが JWT または OIDC の場合に使用されます。

    test。
    Jwks

    string

    任意

    JWT 公開鍵。JSON フォーマットがサポートされています。

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

    string

    任意

    JWT トークンタイプ。有効な値:

    HEADER。
    TokenName

    string

    任意

    JWT トークンが保存される場所。

    Authorization。
    TokenNamePrefix

    string

    任意

    JWT トークンのプレフィックス。

    Bearer。
    TokenPass

    boolean

    任意

    トークンをパススルーするかどうかを指定します。

    true。
    Status

    boolean

    任意

    有効化ステータス。有効な値:

    true。
    Id

    integer

    任意

    認証ルールの ID。

    719
    RedirectUrl

    string

    任意

    権限付与成功後のリダイレクト URL。このパラメーターは OIDC/IDaaS で使用され、OIDC/IDaaS で設定されたリダイレクト URL と一致している必要があります。

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

    string

    任意

    サービスに登録されたアプリケーション ID。このパラメーターは OIDC/IDaaS で使用されます。

    app_mnvxaavggw7hcdcnr6usi6***
    ClientSecret

    string

    任意

    OIDC 認証サービスに登録されたアプリケーションシークレット。

    CS6EYfx3k9yTRR9EtQ2MXWP97P6UAUwFg4teoWJ19Z****
    CookieDomain

    string

    任意

    Cookie のドメイン名。認証成功后、ログイン状態を維持するために指定されたドメイン名に Cookie が送信されます。

    test.com。
    ScopesList

    array

    任意

    OIDC 権限付与スコープ。このパラメーターは OIDC で使用されます。

    string

    任意

    OIDC 権限付与スコープ。このパラメーターは OIDC で使用されます。

    openid。
    LoginUrl

    string

    任意

    IDaaS インスタンスのユーザーログインページ URL。このパラメーターは IDaaS で使用されます。

    https://daxxxxcn.aliyunidaas.com/
    Sub

    string

    任意

    認証タイプが JWT の場合に使用されます。JWT クレーム内の sub (主題) で、プリンシパルを指定します。JWT ペイロード内の sub フィールドの値がここで設定した値と一致していることを確認してください。このパラメーターが設定されていないか空の場合、デフォルト値は Issuer パラメーターの値になります。

    example-app。
    ExternalAuthZJSON

    object

    任意

    カスタム認証情報。

    ServiceId

    integer

    任意

    認証サービスの ID。

    37396
    PrefixPath

    string

    任意

    認証サービスが提供する認証 API のパス。API パスはプレフィックスマッチを使用する必要があります。

    /auth。
    TokenKey

    string

    任意

    リクエストメッセージ内でトークンが配置されているヘッダー。一般的な値には Authorization や Cookie などがあります。

    Authorization。
    AllowRequestHeaders

    array

    任意

    許可されたリクエストヘッダー名。

    string

    任意

    許可されたリクエストヘッダー名。

    x-req。
    AllowUpstreamHeaders

    array

    任意

    許可されたレスポンスヘッダー名。

    string

    任意

    許可されたレスポンスヘッダー名。

    x-resp。
    Timeout

    integer

    任意

    認証サービスのタイムアウト期間。単位: 秒。

    10
    IsRestrict

    boolean

    任意

    カスタム認証モード。有効な値:

    true。
    WithRequestBody

    boolean

    任意

    本文の携带を許可するかどうかを指定します。

    true。
    BodyMaxBytes

    integer

    任意

    本文のバイト数の最大値。

    4000000
    WithRematchRoute

    boolean

    任意

    認証完了後にルートを再マッチングするかどうかを指定します。

    true。
    GatewayUniqueId

    string

    任意

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

    gw-9cdcf8e4f58144059e73ff4c5ef9****
    IsWhite

    boolean

    任意

    権限付与のブラックリスト/ホワイトリストモード。有効な値:

    true。
    AuthResourceMode

    integer

    任意

    権限付与リソースモード。有効な値:

    1
    AuthResourceConfig

    string

    任意

    複合モードの YAML 構成。

    ''
    AuthResourceList

    array<object>

    任意

    認証用の権限付与ルールリスト。複数のルール条件は OR 関係にあります。1 つのルール条件内の複数のマッチング項目は AND 関係にあります。

    array<object>

    任意

    認証用の権限付与ルールリスト。複数のルール条件は OR 関係にあります。1 つのルール条件内の複数のマッチング項目は AND 関係にあります。

    Id

    integer

    任意

    リソースレコードの ID。

    1
    DomainId

    integer

    任意

    ルール内のドメイン名の ID。

    1765
    Path

    string

    任意

    ルールのマッチングパス。

    /test。
    MatchType

    string

    任意

    リクエストパスのマッチング式。有効な値:

    EQUAL。
    IgnoreCase

    boolean

    任意

    パスで大文字小文字の秘密度を有効にするかどうかを指定します。このパラメーターはカスタム認証を作成する際に使用されます。他の認証タイプではデフォルトで大文字小文字が区別されます。有効な値:

    AuthResourceHeaderList

    array<object>

    任意

    ルールのリクエストヘッダー。現在はカスタム認証でのみ使用されます。

    object

    任意

    ルールのリクエストヘッダー。現在はカスタム認証でのみ使用されます。

    HeaderKey

    string

    任意

    リクエストヘッダー名。

    x-req。
    HeaderMethod

    string

    任意

    マッチング条件。有効な値:

    EQUAL。
    HeaderValue

    string

    任意

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

    123
    DeleteResourceIdList

    array

    任意

    削除するリソースレコードの ID のリスト。

    integer

    任意

    削除するリソースレコードの ID。

    2

    任意

    レスポンスの言語。有効な値: zh (デフォルト): 中国語。en: 英語。

    zh

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンススキーマ。

    RequestId

    string

    リクエスト ID。

    316F5F64-F73D-42DC-8632-01E308B6****
    HttpStatusCode

    integer

    HTTP ステータスコード。

    200
    Message

    string

    返されたメッセージ。

    OK
    Code

    integer

    レスポンスコード。値は success パラメーターと同期されます。

    200
    Success

    boolean

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

    true。
    Data

    integer

    認証ルールの ID。

    719

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "316F5F64-F73D-42DC-8632-01E308B6****",
  "HttpStatusCode": 200,
  "Message": "OK",
  "Code": 200,
  "Success": true,
  "Data": 719
}

    エラーコード

    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

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

    変更履歴

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