すべてのプロダクト
Search

このプロダクト

    Microservices Engine:ListGatewayAuthConsumer

    ドキュメントセンター

    Microservices Engine:ListGatewayAuthConsumer

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

    list

    *Gateway

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    GatewayUniqueId

    string

    必須

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

    gw-0fe488252dc44d55a9dd57875193****
    Name

    string

    任意

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

    test
    Type

    string

    任意

    認証タイプです。有効な値は次のとおりです：

    • JWT

    JWT
    ConsumerStatus

    boolean

    任意

    コンシューマーのステータスです。有効な値は次のとおりです：

    • true: 有効

    • false: 無効

    true
    PageNum

    string

    必須

    返すページ番号です。

    1
    PageSize

    string

    必須

    各ページで返すエントリ数です。

    10
    AcceptLanguage

    string

    任意

    応答の言語です。有効な値は次のとおりです：

    • zh: 中国語

    • en: 英語

    zh

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RestResult<List>

    RequestId

    string

    リクエスト ID です。

    dc63-465d-8ef5-20dc18af****
    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

    データ構造です。

    TotalSize

    integer

    返されたエントリの総数です。

    9
    PageNumber

    integer

    返されたページのページ番号です。

    1
    PageSize

    integer

    ページごとに返されるエントリ数です。

    10
    Result

    array<object>

    返された情報です。

    object

    返された情報です。

    Id

    integer

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

    1
    Name

    string

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

    test
    ConsumerStatus

    boolean

    コンシューマーのステータスです。有効な値は次のとおりです：

    • true: 有効

    • false: 無効

    true
    PrimaryUser

    string

    作成者です。

    123
    GatewayUniqueId

    string

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

    gw-5017305290e14centbrveca****
    Type

    string

    認証タイプです。有効な値は次のとおりです：

    • JWT

    JWT
    Description

    string

    コンシューマーの説明です。

    Description

    GmtCreate

    string

    作成時間です。

    2021-09-13 19:24:23
    GmtModified

    string

    変更時間です。

    2022-01-07 18:07:57

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "dc63-465d-8ef5-20dc18af****",
  "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": {
    "TotalSize": 9,
    "PageNumber": 1,
    "PageSize": 10,
    "Result": [
      {
        "Id": 1,
        "Name": "test",
        "ConsumerStatus": true,
        "PrimaryUser": "123",
        "GatewayUniqueId": "gw-5017305290e14centbrveca****",
        "Type": "JWT",
        "Description": "Description\n",
        "GmtCreate": "2021-09-13 19:24:23",
        "GmtModified": "2022-01-07 18:07:57"
      }
    ]
  }
}

    エラーコード

    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

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

    変更履歴

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