全部產品
Search

搜尋本產品

    Microservices Engine：ListGatewayAuthConsumer - 擷取網關鑒權消費者列表

    文件中心

    Microservices Engine：ListGatewayAuthConsumer - 擷取網關鑒權消費者列表

    更新時間：Dec 16, 2025

    擷取網關鑒權消費者列表。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    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

    code 僅僅用來和 success 同步。

    200
    ErrorCode

    string

    錯誤碼。

    mse-100-000
    HttpStatusCode

    integer

    HTTP 狀態代碼。

    200
    Message

    string

    返回資訊。

    請求處理成功
    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

    鑒權消費者描述。

    描述
    GmtCreate

    string

    建立時間。

    2021-09-13 19:24:23
    GmtModified

    string

    修改時間。

    2022-01-07 18:07:57

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "dc63-465d-8ef5-20dc18af****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "mse-100-000",
  "HttpStatusCode": 200,
  "Message": "請求處理成功",
  "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": "描述",
        "GmtCreate": "2021-09-13 19:24:23",
        "GmtModified": "2022-01-07 18:07:57"
      }
    ]
  }
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 IllegalRequest Invalid request:%s 非法請求： %s
    400 InvalidParameter Parameter error:%s 請求參數錯誤：%s
    500 InternalError Console error. Try again later:%s 控制台錯誤.稍後重試：%s
    403 NoPermission You are not authorized to perform this operation:%s 沒有許可權使用此介面：%s
    404 NotFound Not found:%s 資源不存在：%s

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。