ListGateways - API Gateway

查詢閘道列表。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

apig:ListGateways

list

*Gateway

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

無

請求文法

GET /v1/gateways HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
gatewayId	string	否	根據閘道 ID 精確查詢。	gw-cpv4sqdl****
pageNumber	integer	否	分頁頁碼。	1
pageSize	integer	否	分頁大小。	10
name	string	否	根據閘道名稱精確查詢。	itemcenter-gateway
keyword	string	否	關鍵字，按照全匹配搜尋，不區分大小寫。	dev
gatewayType	string	否	閘道類型。枚舉值： AI : AI 閘道。 API : API 閘道。	API
resourceGroupId	string	否	資源群組。	rg-aekzq6bzz5uyg2q
tag	array<object>	否	標籤列表。
	object	否	標籤。
key	string	否	標籤鍵。	owner
value	string	否	標籤值。	zhangsan

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
requestId	string	請求 ID。	5B626361-070A-56A7-B127-ADAC8F3655DB
code	string	回應狀態碼。	Ok
message	string	回應訊息。	success
data	object	閘道列表查詢結果。
pageNumber	integer	分頁頁碼。	1
pageSize	integer	分頁大小。	10
totalSize	integer	總數量。	6
items	array<object>	閘道列表。
	array<object>	閘道資訊。
gatewayId	string	閘道 ID。	gw-cpv54p5***
name	string	閘道名稱。	itemcenter-gateway
chargeType	string	付費類型： POSTPAY 後付費（按量付費）。 PREPAY 預付費（包年包月）。枚舉值： PREPAY : 包年包月。 POSTPAY : 按量付費。	POSTPAY
gatewayType	string	閘道類型。枚舉值： AI : AI 閘道。 API : API 閘道。	API
status	string	閘道狀態： Running：執行中。 Creating：建立中。 CreateFailed：建立失敗。 Upgrading：升級中。 UpgradeFailed：升級失敗。 Restarting：重新啟動中。 RestartFailed：重新啟動失敗。 Deleting：釋放中。 DeleteFailed：釋放失敗。枚舉值： Restarting : 重新啟動中。 Creating : 建立中。 Upgrading : 升級中。 DeleteFailed : 釋放失敗。 Running : 執行中。 RestartFailed : 重新啟動失敗。 Deleting : 釋放中。 CreateFailed : 建立失敗。 UpgradeFailed : 升級失敗。	Running
spec	string	閘道規格： apigw.small.x1：小規格。枚舉值： apigw.small.x1 : apigw.small.x1	apigw.small.x1
replicas	string	閘道執行個體節點數。	2
createTimestamp	integer	建立時間戳記，單位：毫秒。	1719386834548
updateTimestamp	integer	更新時間戳記。單位：毫秒。	1719386834548
expireTimestamp	integer	包年包月到期時間戳記。單位：毫秒。	172086834548
createFrom	string	閘道建立來源： Console：控制台。枚舉值： Console : 控制台。	Console
version	string	閘道版本。	2.0.2
targetVersion	string	閘道的目標版本。當和 version 不一致時，可以進行版本升級。	2.0.2
loadBalancers	array<object>	閘道的入口位址列表。
	array<object>	閘道的入口位址資訊。
loadBalancerId	string	負載平衡 ID。	nlb-xqwioje1c91r***
addressType	string	負載平衡位址類型： Internet：公網。 Intranet：私網。枚舉值： Intranet : 私網。 Internet : 公網。	Internet
type	string	閘道的負載平衡類型： NLB：網路型負載平衡。 CLB：傳統型負載平衡。枚舉值： NLB : 網路型負載平衡。 CLB : 傳統型負載平衡。	NLB
status	string	負載平衡的狀態： Ready：可用。 NotCreate：未關聯執行個體。枚舉值： Ready : Ready NotCreate : NotCreate	Ready
address	string	負載平衡位址。	nlb-xoh3pghr***.cn-hangzhou.nlb.aliyuncs.com
addressIpVersion	string	協定版本： ipv4：ipv4。 ipv6：ipv6。枚舉值： ipv4 : ipv4 ipv6 : ipv6	ipv4
mode	string	閘道的負載平衡提供模式： Managed：雲端原生 API 閘道管理的。枚舉值： Managed : Managed	Managed
gatewayDefault	boolean	是否是閘道預設的入口位址。	true
ports	array<object>	監聽的連接埠列表。
	object	監聽的連接埠資訊。
protocol	string	協定： TCP。 UDP。枚舉值： TCP : TCP UDP : UDP	TCP
port	integer	連接埠號。	443
ipv4Addresses	array	IPv4 位址列表。
	string	參數。	["47.100.100.100"]
ipv6Addresses	array	IPv6 位址列表。
	string	參數。	["2408:4000:0:0:0:0:0:1"]
securityGroup	object	閘道安全性群組資訊。
securityGroupId	string	安全性群組 ID。	sg-bp1apxihjdbt3***
zones	array<object>	閘道的可用區資訊。
	array<object>	可用區資訊。
zoneId	string	可用區 ID。	cn-hangzhou-i
vSwitch	object	虛擬交換器。
vSwitchId	string	虛擬交換器 ID。	vsw-bp14efvkcfbrt4***
vSwitch	object	虛擬交換器資訊。
vSwitchId	string	虛擬交換器 ID。	vsw-bp14efv***
vpc	object	閘道的 VPC 資訊。
vpcId	string	VPC 網路 ID。	vpc-uf664ny***
resourceGroupId	string	資源群組 ID。	rg-xxxx
tags	array<object>	標籤列表。
	object	標籤。
key	string	標籤鍵。	owner
value	string	標籤值。	zhangsan
subDomainInfos	array	二級網域列表。
	SubDomainInfo	二級網域資訊。
legacy	boolean	是否是 AI 閘道上線前建立的閘道執行個體。	true
gatewayEdition	string	閘道執行個體版本：普通執行個體：Professional Serverless：Serverless。	Serverless

樣本

正常返回樣本

JSON格式

{
  "requestId": "5B626361-070A-56A7-B127-ADAC8F3655DB",
  "code": "Ok",
  "message": "success",
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalSize": 6,
    "items": [
      {
        "gatewayId": "gw-cpv54p5***",
        "name": "itemcenter-gateway",
        "chargeType": "POSTPAY",
        "gatewayType": "API",
        "status": "Running",
        "spec": "apigw.small.x1",
        "replicas": "2",
        "createTimestamp": 1719386834548,
        "updateTimestamp": 1719386834548,
        "expireTimestamp": 172086834548,
        "createFrom": "Console",
        "version": "2.0.2",
        "targetVersion": "2.0.2",
        "loadBalancers": [
          {
            "loadBalancerId": "nlb-xqwioje1c91r***",
            "addressType": "Internet",
            "type": "NLB",
            "status": "Ready",
            "address": "nlb-xoh3pghr***.cn-hangzhou.nlb.aliyuncs.com\n",
            "addressIpVersion": "ipv4",
            "mode": "Managed",
            "gatewayDefault": true,
            "ports": [
              {
                "protocol": "TCP",
                "port": 443
              }
            ],
            "ipv4Addresses": [
              "[\"47.100.100.100\"]"
            ],
            "ipv6Addresses": [
              "[\"2408:4000:0:0:0:0:0:1\"]"
            ]
          }
        ],
        "securityGroup": {
          "securityGroupId": "sg-bp1apxihjdbt3***"
        },
        "zones": [
          {
            "zoneId": "cn-hangzhou-i",
            "vSwitch": {
              "vSwitchId": "vsw-bp14efvkcfbrt4***"
            }
          }
        ],
        "vSwitch": {
          "vSwitchId": "vsw-bp14efv***"
        },
        "vpc": {
          "vpcId": "vpc-uf664ny***"
        },
        "resourceGroupId": "rg-xxxx",
        "tags": [
          {
            "key": "owner",
            "value": "zhangsan"
          }
        ],
        "subDomainInfos": [
          {
            "domainId": "d-cpudb0llhtgl2djvq2sg",
            "name": "abc.com",
            "protocol": "HTTP",
            "networkType": "Intranet"
          }
        ],
        "legacy": true,
        "gatewayEdition": "Serverless"
      }
    ]
  }
}

錯誤碼

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

變更歷史

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