全部產品
Search

搜尋本產品

    API Gateway：ListHttpApis - 擷取HTTP API列表

    文件中心

    API Gateway：ListHttpApis - 擷取HTTP API列表

    更新時間：Mar 30, 2026

    擷取HTTP API列表。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    apig:ListHttpApis

    list

    *HttpApi

    acs:apig:{#regionId}:{#accountId}:httpapi/*

    		 無 無

    請求文法

    GET /v1/http-apis HTTP/1.1

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    keyword

    string

    否

    搜尋關鍵詞，支援 API 名稱模糊搜尋或 API ID 精確搜尋。

    test-
    pageNumber

    integer

    否

    分頁頁碼，從 1 開始，不填預設 1.

    1
    pageSize

    integer

    否

    分頁大小，有效範圍[1, 100]，不填預設 10。

    10
    name

    string

    否

    按照名稱精確搜尋。

    login
    types

    string

    否

    HTTP API 的類型。支援傳入多個類型，採用","分割。

    • Http

    • Rest

    • WebSocket

    • HttpIngress

    Http,Rest
    gatewayId

    string

    否

    雲原生 API Gateway ID。

    gw-cq2avtllh****
    withAuthPolicyInEnvironmentId

    string

    否

    響應中每個 API 資訊攜帶指定環境 ID 下的消費者認證策略資訊。

    env-xxx
    withConsumerInfoById

    string

    否

    響應中每個 API 資訊攜帶指定消費者 ID 的授權規則列表。

    cs-xxx
    withEnvironmentInfo

    boolean

    否

    環境資訊

    true
    withPluginAttachmentByPluginId

    string

    否

    外掛程式 ID，根據此外掛程式 ID 擷取外掛程式發布資訊。

    pl-ct9qn3um1hktue8dqol0
    resourceGroupId

    string

    否

    資源群組 ID。

    rg-ahr5uil8raz0rq3b
    withEnvironmentInfoById

    string

    否

    環境 ID

    env-ctovu5mm1hksb4q8ln40
    withAuthPolicyList

    boolean

    否

    是否開啟了許可權認證策略

    true
    withIngressInfo

    boolean

    否

    是否包含 ingress 資訊

    false
    withPolicyConfigs

    boolean

    否

    是否包含策略資訊

    false
    withAPIsPublishedToEnvironment

    boolean

    否

    是否返回發行到指定環境的 API 資訊

    true
    gatewayType

    string

    否

    網關類型過濾，目前支援 AI、API 兩種網關類型。

    枚舉值：

    • AI :

      AI

    • API :

      API

    API

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回體

    requestId

    string

    請求 ID。

    585657D2-1C20-5B8A-AF17-D727C6490BE4
    code

    string

    響應狀態代碼。

    Ok
    message

    string

    響應訊息。

    success
    data

    object

    API 列表。

    pageNumber

    integer

    分頁頁碼。

    1
    pageSize

    integer

    分頁大小。

    10
    totalSize

    integer

    總數量。

    10
    items

    array

    API 資訊。

    HttpApiInfoByName

    按照 API 名進行分組的 API 資訊。

    樣本

    正常返回樣本

    JSON格式

    {
  "requestId": "585657D2-1C20-5B8A-AF17-D727C6490BE4",
  "code": "Ok",
  "message": "success",
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalSize": 10,
    "items": []
  }
}

    錯誤碼

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

    變更歷史

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