全部產品
Search

搜尋本產品

    Platform For AI：ListGateway - 查詢私人網關列表

    文件中心

    Platform For AI：ListGateway - 查詢私人網關列表

    更新時間：Jan 14, 2026

    查詢私人網關列表。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    eas:ListGateway

    list

    *全部資源

    *

    		 無 無

    請求文法

    GET /api/v2/gateways HTTP/1.1

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    GatewayId

    string

    否

    私人網關 ID。如何擷取私人網關 ID，請參見 ListResources 介面返回結果中的 private_gateway_id 欄位。

    gw-1uhcqmsc7x22******
    PageNumber

    integer

    否

    網關列表的請求頁碼，預設為 1.

    1
    PageSize

    integer

    否

    分頁查詢時設定的每頁顯示的服務數量，預設為 100。

    100
    GatewayName

    string

    否

    私人網關別名。

    mygateway1
    ResourceName

    string

    否

    資源群組 ID。如何擷取資源群組，請參見 ListResources 介面返回結果中的 ResourceId 欄位。

    eas-r-4gt8twzwllfo******
    InternetEnabled

    boolean

    否

    開啟公網。

    true
    Status

    string

    否

    網關狀態。

    Running
    ChargeType

    string

    否

    付費類型。

    枚舉值：

    • PostPaid :

      後付費

    • PrePaid :

      預付費

    PrePaid
    Sort

    string

    否

    排序欄位

    枚舉值：

    • Status :

      狀態

    • ChargeType :

      付費類型

    • CreateTime :

      建立時間

    • UpdateTime :

      更新時間

    • InternetEnabled :

      開啟公網

    • GatewayType :

      網關類型

    • GatewayName :

      網關名稱

    CreateTime
    Order

    string

    否

    排序方式。

    枚舉值：

    • asc :

      升序

    • desc :

      倒序

    asc
    GatewayType

    string

    否

    網關類型。

    枚舉值：

    • FullyManaged :

      全託管專屬網關

    • Application :

      應用型專屬網關

    Application
    Label

    object

    否

    按標籤過濾。

    string

    否

    按{"key":"value"}格式填寫。Value 可為 null 或Null 字元，代表只按 Key 過濾，Value 可為任意值。

    {"key1":"value1","key2":null}

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回結果。

    RequestId

    string

    請求 ID。

    40325405-579C-4D82****
    Gateways

    array<object>

    私人網關列表。

    array<object>

    私人網關詳情。

    GatewayId

    string

    私人網關 ID。

    gw-1uhcqmsc7x22******
    GatewayName

    string

    私人網關別名。

    mygateway1
    InstanceType

    string

    私人網關使用的機型。

    2c4g
    IntranetDomain

    string

    內網訪問網域名稱。

    gw-1uhcqmsc7x22******-1801786532******-vpc.cn-wulanchabu.pai-eas.aliyuncs.com
    InternetEnabled

    boolean

    公網訪問是否開啟。

    true
    InternetDomain

    string

    公網訪問網域名稱。

    gw-1uhcqmsc7x22******-1801786532******.cn-wulanchabu.pai-eas.aliyuncs.com
    CreateTime

    string

    私人網關建立時間。使用 UTC 時間。

    2020-05-19T14:19:42Z
    UpdateTime

    string

    私人網關更新時間。使用 UTC 時間。

    2021-02-24T11:52:17Z
    Status

    string

    私人網關狀態。

    枚舉值：

    • Creating :

      建立中

    • Stopped :

      已停止

    • Failed :

      失敗

    • Running :

      運行中

    • Deleted :

      已刪除

    • Deleting :

      刪除中

    • Waiting :

      等待中

    Running
    Replicas

    integer

    私人網關節點數。

    2
    IsDefault

    boolean

    是否預設私人網關。

    true
    ChargeType

    string

    付費類型，取值如下：

    • PrePaid：預付費。

    • PostPaid：後付費。

    PostPaid
    SSLRedirectionEnabled

    boolean

    HTTP 重新導向 HTTPS 是否開啟。

    true
    IntranetEnabled

    boolean

    開啟內網。

    Labels

    array<object>

    網關標籤列表

    object

    網關標籤對象

    LabelKey

    string

    網關標籤鍵

    key1
    LabelValue

    string

    網關標籤值

    value1
    PageNumber

    integer

    返回查詢的服務列表的當前頁碼。

    1
    PageSize

    integer

    返回每頁顯示的服務數量。

    100
    TotalCount

    integer

    網關總數。

    5

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "40325405-579C-4D82****",
  "Gateways": [
    {
      "GatewayId": "gw-1uhcqmsc7x22******",
      "GatewayName": "mygateway1",
      "InstanceType": "2c4g",
      "IntranetDomain": "gw-1uhcqmsc7x22******-1801786532******-vpc.cn-wulanchabu.pai-eas.aliyuncs.com",
      "InternetEnabled": true,
      "InternetDomain": "gw-1uhcqmsc7x22******-1801786532******.cn-wulanchabu.pai-eas.aliyuncs.com",
      "CreateTime": "2020-05-19T14:19:42Z",
      "UpdateTime": "2021-02-24T11:52:17Z",
      "Status": "Running",
      "Replicas": 2,
      "IsDefault": true,
      "ChargeType": "PostPaid",
      "SSLRedirectionEnabled": true,
      "IntranetEnabled": true,
      "Labels": [
        {
          "LabelKey": "key1",
          "LabelValue": "value1"
        }
      ]
    }
  ],
  "PageNumber": 1,
  "PageSize": 100,
  "TotalCount": 5
}

    錯誤碼

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

    變更歷史

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