調用ListIngresses擷取Ingress路由規則列表-Serverless 應用引擎-阿里雲 - Serverless App Engine

調用ListIngresses介面擷取Ingress列表。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

sae:ListIngresses

get

*全部資源

*

無

請求文法

GET /pop/v1/sam/ingress/IngressList HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
NamespaceId	string	是	命名空間 ID。	cn-beijing
AppId	string	否	應用 ID。	bbf3a590-6d13-46fe-8ca9-c947a20b****
CurrentPage	integer	否	當前頁數。
PageSize	integer	否	分頁大小。

返回參數

名稱	類型	描述	樣本值
	object	返回資料。
RequestId	string	請求 ID。	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	附加資訊。取值說明如下：請求正常，返回 success。請求異常，返回具體異常錯誤碼。	success
TraceId	string	調用鏈 ID，用於精確查詢調用資訊。	0a98a02315955564772843261e****
Data	object	返回結果。
CurrentPage	integer	當前頁。
TotalSize	integer	查詢到的總數。
PageSize	integer	每頁資料條數。
IngressList	array<object>	路由規則列表。
	array<object>	路由規則資訊。
SlbId	string	SLB ID。	lb-uf62****6d13tq2u5
NamespaceId	string	命名空間 ID。	cn-shanghai
Description	string	路由規則名稱。	test
ListenerPort	string	SLB 監聽連接埠。	80
SlbType	string	SLB 類型。取值說明如下： internet：公網。 intranet：私網。	internet
CertId	string	CLB 認證 ID。	13624***73809_16f8e549a20_1175189789_12**3210
CertIds	string	ALB 多認證 ID。	87*35-cn-hangzhou,812*3-cn-hangzhou
Name	string	路由規則名稱。	lb-uf6jt0nu4z6ior943**-80-f5**
Id	integer	路由規則 ID。	18
LoadBalanceType	string	Server Load Balancer 的類型。取值說明如下： clb：傳統型負載平衡 CLB（原 SLB）。 alb：應用型負載平衡 ALB。	clb
ListenerProtocol	string	Server Load Balancer 支援的請求轉寄協議。取值說明如下： HTTP：適用於需要對資料內容進行識別的應用。 HTTPS：適用於需要加密傳輸的應用。在 CreateIngress 和 UpadateIngress 中，該參數非必填項，如果建立或更新網關路由規則時未填寫該參數，則調用該 API 時不返回。	HTTP
MseGatewayId	string	MSE 雲原生網關執行個體 ID。	gw-d5df01a1bae748f1a7c4e325d2fd****
MseGatewayPort	string	服務對應的連接埠。	80
MseGatewayProtocol	string	MSE 雲原生網關支援的請求轉寄協議。取值說明如下： HTTP：適用於需要對資料內容進行識別的應用。 HTTPS：適用於需要加密傳輸的應用。	HTTP
RequestTimeout	integer	請求逾時時間。
IdleTimeout	integer	串連空閑逾時時間。
CreateTime	integer	建立時間。
DefaultRule	object	預設規則。
ContainerPort	integer	容器連接埠。
AppName	string	應用程式名稱。
AppId	string	應用 ID。
BackendProtocol	string	後端協議。
Rules	array<object>	規則。
	array<object>
AppName	string	應用程式名稱。
ContainerPort	integer	容器連接埠。
Domain	string	網域名稱。
AppId	string	應用 ID。
Path	string	路徑。
BackendProtocol	string	後端協議。
RewritePath	string	重寫路徑。
RuleActions	array<object>	規則動作列表。
	object	規則動作。
ActionType	string	動作類型。
ActionConfig	string	動作配置。
CorsConfig	object	跨網域設定。
Enable	string	是否開啟。
ExposeHeaders	string	允許暴露的 Header。
AllowHeaders	string	允許的 Header。
AllowMethods	string	允許的方法。
AllowOrigin	string	允許訪問的來源。
AllowCredentials	string	允許的攜帶憑證。
MaxAge	string	到期時間。
ErrorCode	string	錯誤碼。取值說明如下：請求成功：不返回 ErrorCode 欄位。請求失敗：返回 ErrorCode 欄位。具體資訊，請參見本文的錯誤碼列表。
Code	string	介面狀態或 POP 錯誤碼。取值說明如下： 2xx：成功。 3xx：重新導向。 4xx：請求錯誤。 5xx：伺服器錯誤。	200
Success	boolean	擷取 Ingress 列表是否成功。取值說明如下： true：擷取成功。 false：擷取失敗。	true

樣本

正常返回樣本

JSON格式

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "CurrentPage": 0,
    "TotalSize": 0,
    "PageSize": 0,
    "IngressList": [
      {
        "SlbId": "lb-uf62****6d13tq2u5",
        "NamespaceId": "cn-shanghai",
        "Description": "test",
        "ListenerPort": "80",
        "SlbType": "internet",
        "CertId": "13624*****73809_16f8e549a20_1175189789_12****3210",
        "CertIds": "87***35-cn-hangzhou,812***3-cn-hangzhou",
        "Name": "lb-uf6jt0nu4z6ior943****-80-f5****",
        "Id": 18,
        "LoadBalanceType": "clb",
        "ListenerProtocol": "HTTP",
        "MseGatewayId": "gw-d5df01a1bae748f1a7c4e325d2fd****",
        "MseGatewayPort": "80",
        "MseGatewayProtocol": "HTTP",
        "RequestTimeout": 0,
        "IdleTimeout": 0,
        "CreateTime": 0,
        "DefaultRule": {
          "ContainerPort": 0,
          "AppName": "",
          "AppId": "",
          "BackendProtocol": ""
        },
        "Rules": [
          {
            "AppName": "",
            "ContainerPort": 0,
            "Domain": "",
            "AppId": "",
            "Path": "",
            "BackendProtocol": "",
            "RewritePath": "",
            "RuleActions": [
              {
                "ActionType": "",
                "ActionConfig": ""
              }
            ]
          }
        ],
        "CorsConfig": {
          "Enable": "",
          "ExposeHeaders": "",
          "AllowHeaders": "",
          "AllowMethods": "",
          "AllowOrigin": "",
          "AllowCredentials": "",
          "MaxAge": ""
        }
      }
    ]
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	InvalidParameter.NotEmpty	You must specify the parameter %s.	不合法的參數：%s不可為空。
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.	不合法的參數{%s}。
400	InvalidParameter.WithMessage	The parameter is invalid {%s}: %s	不合法的參數{%s}：%s。

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

變更歷史

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