すべてのプロダクト
Search

このプロダクト

    Microservices Engine:UpdateGatewayAuthConsumer

    ドキュメントセンター

    Microservices Engine:UpdateGatewayAuthConsumer

    最終更新日:Dec 16, 2025

    ゲートウェイで認証操作を実行する対象のコンシューマーを更新します。

    今すぐお試しください

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

    *Gateway

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    GatewayUniqueId

    string

    必須

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

    gw-90392d768a3847a7b804c505254d****
    EncodeType

    string

    任意

    暗号化タイプ。有効な値：

    • RSA

    • OCT

    RSA
    Jwks

    string

    任意

    JWT 公開鍵。JSON フォーマットをサポートしています。

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

    string

    任意

    各トークンを検証するために必要なパラメーターの名前。デフォルトでは、各トークンには `Bearer` というプレフィックスが付けられ、`Authorization: Bearer <トークンの内容>` のように `Authorization` ヘッダーに格納されます。

    Authorization
    TokenPass

    boolean

    任意

    パススルーを有効にするかどうかを指定します。

    true
    TokenPosition

    string

    任意

    各トークンを検証するために必要なパラメーターの位置。デフォルトでは、各トークンには `Bearer` というプレフィックスが付けられ、`Authorization: Bearer <トークンの内容>` のように `Authorization` ヘッダーに格納されます。

    HEADER
    TokenPrefix

    string

    任意

    各トークンを検証するために必要なパラメーターのプレフィックス。デフォルトでは、各トークンには `Bearer` というプレフィックスが付けられ、`Authorization: Bearer <トークンの内容>` のように `Authorization` ヘッダーに格納されます。

    Bearer

    KeyName

    string

    任意

    JWT ベースの身分認証に使用されるキーの名前。

    iss
    KeyValue

    string

    任意

    JWT ベースの身分認証に使用されるキーの値。

    abcd
    Description

    string

    任意

    コンシューマーの説明。

    Description

    Id

    integer

    必須

    コンシューマーの ID。

    63
    AcceptLanguage

    string

    任意

    応答の言語。有効な値：

    • zh: 中国語

    • en: 英語

    zh

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RestResult<List>

    RequestId

    string

    リクエストの ID。

    EE5C32A1-BC0E-4B79-817C-103E4EDF****
    Success

    boolean

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

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

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

    true
    Code

    integer

    ステータスコード。リクエストが成功した場合、200 が返されます。

    200
    ErrorCode

    string

    返されるエラーコード。

    mse-100-000
    HttpStatusCode

    integer

    返される HTTP ステータスコード。

    200
    Message

    string

    返されるエラーメッセージ。

    The request is successfully processed.

    DynamicCode

    string

    エラーメッセージの動的な部分。

    code
    DynamicMessage

    string

    エラーメッセージの動的な部分。このパラメーターは、ErrMessage パラメーターの %s 変数を置き換えるために使用されます。

    説明

    ErrMessage パラメーターの戻り値が The Value of Input Parameter %s is not valid で、DynamicMessage パラメーターの戻り値が DtsJobId の場合、指定された DtsJobId パラメーターは無効であることを示します。

    The specified parameter is invalid.
    Data

    integer

    コンシューマーの ID。

    2

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "EE5C32A1-BC0E-4B79-817C-103E4EDF****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "mse-100-000",
  "HttpStatusCode": 200,
  "Message": "The request is successfully processed.\n",
  "DynamicCode": "code",
  "DynamicMessage": "The specified parameter is invalid.",
  "Data": 2
}

    エラーコード

    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

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

    変更履歴

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