すべてのプロダクト
Search

このプロダクト

    Microservices Engine:GetGatewayAuthConsumerDetail

    ドキュメントセンター

    Microservices Engine:GetGatewayAuthConsumerDetail

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

    get

    *Gateway

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    GatewayUniqueId

    string

    必須

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

    gw-1a4ab101d5924b6f92c5ec98a84*****
    Id

    integer

    必須

    コンシューマーの ID です。

    120
    AcceptLanguage

    string

    任意

    応答の言語。有効な値：

    • zh：中国語

    • en：英語

    zh

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーターです。

    RequestId

    string

    リクエスト ID です。

    316F5F64-F73D-42DC-8632-01E308B6****
    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

    object

    返されたデータです。

    Id

    integer

    コンシューマーの ID です。

    12
    Name

    string

    コンシューマーの名前です。

    test
    ConsumerStatus

    boolean

    コンシューマーのステータス。有効な値：

    • true：有効

    • false：無効

    true
    PrimaryUser

    string

    作成者です。

    123
    GatewayUniqueId

    string

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

    gw-7ea3da97b96543e19f6c597cd4a9****
    Type

    string

    認証タイプ。有効な値：

    • JWT

    JWT
    GmtCreate

    string

    コンシューマー認証レコードが作成された時間です。

    2031-03-30 02:35:12
    GmtModified

    string

    コンシューマー認証レコードが変更された時間です。

    2023-02-01 14:17:57
    Description

    string

    説明です。

    Description

    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 <Content of a token> のように Authorization ヘッダーに格納されます。

    Authorization
    TokenPass

    boolean

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

    true
    TokenPosition

    string

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

    HEADER
    TokenPrefix

    string

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

    Bearer

    KeyName

    string

    JWT ベースの ID 認証に使用されるキーの名前です。

    iss
    KeyValue

    string

    JWT ベースの ID 認証に使用されるキーの値です。

    abcd
    ResourceList

    array<object>

    リソースリストです。

    object

    リソースリストです。

    Id

    integer

    コンシューマーの承認済みリソースの ID です。

    16
    ConsumerId

    integer

    コンシューマー ID です。

    123
    RouteId

    integer

    ルートの ID です。

    3458
    RouteName

    string

    ルートの名前です。

    test
    ResourceStatus

    boolean

    リソース権限付与の状態。有効な値：

    • true：リソース権限付与は有効です。

    • false：リソース権限付与は無効です。

    true
    GatewayUniqueId

    string

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

    gw-4822033a8513496fa10f05c934f*****
    GmtCreate

    string

    コンシューマー認証レコードに関連付けられたリソースが作成された時間です。

    2022-12-06 01:38:03
    GmtModified

    string

    コンシューマー認証レコードに関連付けられたリソースが変更された時間です。

    2022-12-06 01:38:03

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "316F5F64-F73D-42DC-8632-01E308B6****",
  "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": {
    "Id": 12,
    "Name": "test",
    "ConsumerStatus": true,
    "PrimaryUser": "123",
    "GatewayUniqueId": "gw-7ea3da97b96543e19f6c597cd4a9****",
    "Type": "JWT",
    "GmtCreate": " 2031-03-30 02:35:12",
    "GmtModified": "2023-02-01 14:17:57",
    "Description": "Description\n",
    "EncodeType": "RSA",
    "Jwks": "{\n      \"keys\": [\n            {\n                  \"e\": \"AQAB\",\n                  \"kid\": \"DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ\",\n                  \"kty\": \"RSA\",\n                  \"n\": \"xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ\"\n            }\n      ]\n}",
    "TokenName": "Authorization",
    "TokenPass": true,
    "TokenPosition": "HEADER",
    "TokenPrefix": "Bearer ",
    "KeyName": "iss",
    "KeyValue": "abcd",
    "ResourceList": [
      {
        "Id": 16,
        "ConsumerId": 123,
        "RouteId": 3458,
        "RouteName": "test",
        "ResourceStatus": true,
        "GatewayUniqueId": "gw-4822033a8513496fa10f05c934f*****",
        "GmtCreate": "2022-12-06 01:38:03",
        "GmtModified": "2022-12-06 01:38:03"
      }
    ]
  }
}

    エラーコード

    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

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

    変更履歴

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