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​
要执行的操作,取值:ListGatewayLBs。​
​
Version string 必选 示例值:2021-03-03​
API的版本,取值:2021-03-03。​
​
Id string 必选 示例值:gd8****​
网关实例 ID。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
Total long 示例值:10​
过滤后的访问入口总个数。​
​
Items object[] 示例值:-​
访问入口列表。​
LoadBalancerId string 示例值:lb9h****​
访问入口 ID。​
​
IPList object[] 示例值:-​
访问入口的 IP 地址列表。​
IP string 示例值:10.0.0.1​
访问入口的 IP 地址。​
​
NetworkType string 示例值:public​
访问入口的网络类型,取值:​
  • public:公网。​
  • private:私网。​
​
​
Ports object[] 示例值:-​
访问入口的端口列表。​
Number integer 示例值:443​
访问入口的端口。​
​
Protocol string 示例值:HTTPS​
访问入口的端口协议,取值:​
  • HTTP。​
  • HTTPS。​
​
​
SourceType string 示例值:Managed​
访问入口来源,取值:​
  • Imported:非托管。​
  • Managed:托管。​
​
Type string 示例值:CLB​
访问入口的负载均衡类型,取值:​
  • CLB:负载均衡。​
  • PLB:私网负载均衡。​
​
ImportedCLBSpec object 示例值:-​
访问入口配置。​
Id string 示例值:clb-mjox****​
负载均衡实例 ID。​
​
Scheduler string 示例值:wrr​
负载均衡监听器调度算法,取值:​
  • wrr:加权轮询。​
  • wlc:加权最小连接数。​
  • sh:源地址哈希。​
​
Name string 示例值:example​
负载均衡实例名称。​
​
Spec string 示例值:small_1​
负载均衡实例规格。​
​
​
Status string 示例值:Running​
访问入口的生效状态,取值:​
  • Updating:配置中。​
  • Running:运行中。​
  • SyncFailed:配置错误。​
  • Abnormal:实例状态异常。​
  • Detaching:解绑中。​
​
Message string 示例值:-​
访问入口的状态信息。​
​
​
​
​
请求示例​
​
POST https://apig.cn-beijing.volcengineapi.com?Action=ListGatewayLBs&Version=2021-03-03​
Content-Type: application/json​
{​
"Id": "gd8****"​
}​
​
返回示例​
​
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"​
}​
}​
]​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
InvalidParameter​
The specified parameter %s is invalid.​
请求参数值不合法。请确认参数后重试。​
404​
ResourceNotFound​
The specified resource %s %s cannot be found.​
指定资源找不到。请确认参数后重试。​
500​
InternalError​
The request has failed due to an unknown error.​
未知错误。请稍后重试。如果多次尝试失败,请提交工单。​
​
​
最近更新时间:2026.10.28 14:59:49
这个页面对您有帮助吗?
有用
有用
无用
无用