批量查询网关实例。

请求说明

API 网关已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅服务地址文档，根据业务所在地域，选择最合适的接入点。

请求方式：POST

请求地址：https://apig.cn-beijing.volcengineapi.com?Action=ListGateways&Version=2021-03-03

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：ListGateways

要执行的操作，取值：ListGateways。

Version string 必选示例值：2021-03-03

API的版本，取值：2021-03-03。

PageNumber long 可选示例值：1

分页查询的页号。取值最小限制为 1，默认值为 1。

PageSize long 可选示例值：10

每页个数。取值范围为 0~100，默认值为 10。

Filter object 可选示例值：-

过滤条件。

Name string 可选示例值：test

网关名称。

Status string 可选示例值：Running

实例状态，取值：

Creating：创建中。

CreatedFailed：创建失败。

Running：运行中。

Deleting：删除中。

DeletedFailed：删除失败。

Abnormal：异常。

Type string 可选示例值：standard

网关类型，取值：

standard：标准网关。

serverless：Serverless 网关。

elastic：弹性网关。

Tags object[] 可选示例值：-

标签。

Key string 必选示例值：example-key

标签键。长度限制为 1~256 个字符。

Value string 可选示例值：example-value

标签值。长度限制为 0~256 个字符。

VpcIds string[] 可选示例值：["vpc-rrd****"]

网关实例所在的私有网络的 ID。

Ids string[] 可选示例值：["gd8****"]

网关实例 ID。长度限制为 0~50 个。

ProjectName string 可选示例值：default

网关实例所属项目名称。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

Total long 示例值：10

过滤后的网关实例总个数。

Items object[] 示例值：-

网关实例列表。

Id string 示例值：gd8****

网关实例 ID。

Name string 示例值：example

网关实例名称。

Region string 示例值：cn-beijing

网关实例所属的地域。

NetworkSpec object 示例值：-

网络配置。

VpcId string 示例值：vpc-rrd****

网关实例所在的私有网络的 ID。

SubnetId string 示例值：subnet-5g3****

子网 ID。

SubnetIds string[] 示例值：["subnet-5g3****","subnet-2fe****"]

私有网络子网 ID 列表。

子网必须是上述私有网络的子网。

最少需要输入两个不同可用区的子网。

Status string 示例值：Running

网关状态，取值：

Creating：创建中。

CreatedFailed：创建失败。

Updating：更新中。

Running：运行中。

Deleting：删除中。

DeletedFailed：删除失败。

Abnormal：异常。

Message string 示例值：-

网关创建失败、删除失败或异常时的错误信息。

CreateTime string 示例值：2025-01-01T00:00:00+08:00

网关实例创建时间。标准 RFC3339 格式的 UTC+8 时间。

MonitorSpec object 示例值：-

监控配置。

Enable boolean 示例值：true

是否开启托管 Prometheus（VMP）服务。取值：

true：开启。

false：不开启。

WorkspaceID string 示例值：e28ae****

Prometheus 工作区 ID。详情请参见创建通用工作区。

说明

当MonitorSpec.Enable值为 true 时，需要配置本参数。

LogSpec object 示例值：-

日志配置。

Enable boolean 示例值：true

是否开启日志服务。取值：

true：开启。

false：不开启。

ProjectId string 示例值：fc69****

日志项目 ID。详情请参见创建日志项目。

说明

当LogSpec.Enable值为 true 时，需要配置本参数。

TopicId string 示例值：b****

日志主题 ID，取值为空时会在当前项目中生成名称为“网关实例 ID - accessLog”的主题。详情请参见创建日志主题。

说明

当LogSpec.Enable值为 true 时，需要配置本参数。

Comments string 示例值：example

网关实例备注信息。

ResourceSpec object 示例值：-

规格配置。

Replicas integer 示例值：3

节点数量。整数形式，取值范围为 2~100。

InstanceSpecCode string 示例值：2c4g

节点规格，取值：

1c2g。

2c4g。

4c8g。

8c16g。

CLBSpecCode string 示例值：small_1

CLB 规格，取值：

small_1：小型 I。

small_2：小型 II。

medium_1：中型 I。

medium_2：中型 II。

large_1：大型 I。

large_2：大型 II。

PublicNetworkBillingType string 示例值：traffic

公网网络计费方式，取值：

traffic：按实际流量计费。

bandwidth：按带宽上限计费。

PublicNetworkBandwidth integer 示例值：20

公网带宽上限。单位为 Mbps，取值范围为 0~500，默认值为 0。

说明

当ResourceSpec.PublicNetworkBillingType取值为 bandwidth 时，需要配置本参数。

NetworkType object 示例值：-

网络类型。

EnablePublicNetwork boolean 示例值：true

是否开启公网。取值：

true：开启。

false：不开启。

EnablePrivateNetwork boolean 示例值：true

是否开启私网。取值：

true：开启。

false：不开启。

Type string 示例值：standard

网关类型，取值：

standard：标准网关。

serverless：Serverless 网关。

elastic：弹性网关。

Tags object[] 示例值：-

标签。

Key string 示例值：example-key

标签键。长度限制为 1~256 个字符。

Value string 示例值：example-value

标签值。长度限制为 0~256 个字符。

Version string 示例值：1.16.0

网关版本。

Events object[] 示例值：-

网关实例对应的事件信息。

Code string 示例值：example

事件代码。

Description string 示例值：example

事件描述。

CreateTime string 示例值：2025-01-01T00:00:00+08:00

事件创建时间。

Data object 示例值：{"example-key":"example-value"}

事件附带信息。

ProjectName string 示例值：default

网关实例所属的项目名称。

CustomLog object 示例值：-

网关实例自定义日志。

RequestHeaders object[] 示例值：-

请求头。长度限制为 0~20 个。

Key string 示例值：test

字段值。

AliasesInLog string 示例值：alias

日志规则的字段别名。

ResponseHeaders object[] 示例值：-

响应头。长度限制为 0~20 个。

Key string 示例值：test

字段值。

AliasesInLog string 示例值：alias

字段别名。

CustomVariables object[] 示例值：-

自定义变量。长度限制为 0~20 个。

Key string 示例值：test

字段值。

AliasesInLog string 示例值：alias

字段别名。

TraceSpec object 示例值：-

链路追踪配置。

Enable boolean 示例值：true

是否开启链路追踪。取值：

true：开启。

false：不开启。

TraceType string 示例值：tls

链路追踪类型，取值：

tls：日志服务。

apm：应用性能监控全链路版。

TLSTraceSpec object 示例值：-

日志服务链路追踪配置。

ProjectId string 示例值：fc69****

日志项目 ID。详情请参见创建日志项目。

TraceId string 示例值：0fda****

Trace ID。详情请参见创建 Trace 实例。

APMTraceSpec object 示例值：-

应用性能监控全链路版链路追踪配置。

AdvancedSettings object 示例值：-

网关高级配置。

EnableGatewayAPI boolean 示例值：true

是否启用 Gateway API。取值：

true：开启。

false：不开启。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
500	InternalError	The request has failed due to an unknown error.	未知错误。请稍后重试。如果多次尝试失败，请提交工单。