You need to enable JavaScript to run this app.
文档中心
API 网关

API 网关

复制全文
下载 pdf
网关管理
ListGatewayLBs - 批量查询网关访问入口
复制全文
下载 pdf
ListGatewayLBs - 批量查询网关访问入口
批量查询网关的访问入口。​
请求说明​
API 网关已在全球多个地域部署服务,旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅 服务地址 文档,根据业务所在地域,选择最合适的接入点。​
  • 请求方式:POST​
  • 请求地址:https://apig.cn-beijing.volcengineapi.com?Action=ListGatewayLBs&Version=2021-03-03​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
​
参数​
类型​
是否必选​
示例值​
描述​
Action​
String​
是​
ListGatewayLBs​
接口名称。当前 API 的名称为 ListGatewayLBs。​
Version​
String​
是​
2021-03-03​
接口版本。当前 API 的版本为 2021-03-03。​
Id​
String​
是​
gd8****​
网关实例 ID。​
​
请求示例​
​
POST https://apig.cn-beijing.volcengineapi.com?Action=ListGatewayLBs&Version=2021-03-03​
Content-Type: application/json​
{​
"Id": "gd8****"​
}​
​
返回参数​
​
参数​
类型​
示例值​
描述​
Total​
Long​
10​
过滤后的访问入口总个数。​
Items​
Array of GatewayLBItem​
-​
访问入口列表。​
​
GatewayLBItem​
​
参数​
类型​
示例值​
描述​
LoadBalancerId​
String​
lb9h****​
访问入口 ID。​
IPList​
Array of LoadBalancerIP​
-​
访问入口的 IP 地址列表。​
Ports​
Array of Port​
-​
访问入口的端口列表。​
SourceType​
String​
Managed​
访问入口来源,取值:​
  • Imported:非托管。​
  • Managed:托管。​
Type​
String​
CLB​
访问入口的负载均衡类型,取值:​
  • CLB:负载均衡。​
  • PLB:私网负载均衡。​
ImportedCLBSpec​
-​
访问入口配置。​
Status​
String​
Running​
访问入口的生效状态,取值:​
  • Updating:配置中。​
  • Running:运行中。​
  • SyncFailed:配置错误。​
  • Abnormal:实例状态异常。​
  • Detaching:解绑中。​
Message​
String​
-​
访问入口的状态信息。​
​
LoadBalancerIP​
​
参数​
类型​
示例值​
描述​
IP​
String​
10.0.0.1​
访问入口的 IP 地址。​
NetworkType​
String​
public​
访问入口的网络类型,取值:​
  • public:公网。​
  • private:私网。​
​
Port​
​
参数​
类型​
示例值​
描述​
Number​
Integer​
443​
访问入口的端口。​
Protocol​
String​
HTTPS​
访问入口的端口协议,取值:​
  • HTTP。​
  • HTTPS。​
​
ImportedCLBSpecResponse​
​
参数​
类型​
示例值​
描述​
Id​
String​
clb-mjox****​
负载均衡实例 ID。​
Scheduler​
String​
wrr​
负载均衡监听器调度算法,取值:​
  • wrr:加权轮询。​
  • wlc:加权最小连接数。​
  • sh:源地址哈希。​
Name​
String​
example​
负载均衡实例名称。​
Spec​
String​
small_1​
负载均衡实例规格。​
​
返回示例​
​
Content-Type: application/json​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "ListGatewayLBs",​
"Version": "2021-03-03",​
"Service": "apig",​
"Region": "cn-beijing"​
},​
"Result": {​
"Total": 10,​
"Items": [​
{​
"Type": "CLB",​
"Ports": [​
{​
"Number": 443,​
"Protocol": "HTTPS"​
}​
],​
"IPList": [​
{​
"IP": "10.0.0.1",​
"NetworkType": "public"​
}​
],​
"Status": "Running",​
"Message": "",​
"SourceType": "Managed",​
"LoadBalancerId": "lb9h****",​
"ImportedCLBSpec": {​
"Id": "clb-mjox****",​
"Name": "example",​
"Spec": "small_1",​
"Scheduler": "wrr"​
}​
}​
]​
}​
}​
​
错误码​
本接口无特有的错误码。更多信息请参见 公共错误码。​
最近更新时间:2026.07.29 10:20:01
这个页面对您有帮助吗?
有用
有用
无用
无用