使用ListGateways查询网关列表-API 网关-阿里云-API 网关(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"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。