批量查询服务。

请求说明

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

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

调试

API Explorer

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListGatewayServices	接口名称。当前 API 的名称为 ListGatewayServices。
Version	String	是	2021-03-03	接口版本。当前 API 的版本为 2021-03-03。
PageNumber	Long	否	1	分页查询的页号。取值最小限制为 1，默认值为 1。
PageSize	Long	否	10	每页个数。取值范围为 0~100，默认值为 10。
GatewayId	String	否	gd8****	网关实例 ID。您可以通过 ListGateways 查询网关实例 ID。
Filter	Object of ServiceFilter	否	-	过滤条件。

ServiceFilter

参数	类型	是否必选	示例值	描述
Name	String	否	example	网关实例的名称。
Status	String	否	Running	网关实例状态，取值： Creating：创建中。 CreatedFailed：创建失败。 Running：运行中。 Deleting：删除中。 DeletedFailed：删除失败。 Abnormal：异常。
ServiceType	String	否	AIProvider	服务类型，取值： VeFaas：函数服务。 ECS：云服务器。 K8S：容器服务。 Nacos：注册中心。 FixedIP：固定 IP。 AIProvider：AI 模型代理。
GatewayType	String	否	standard	网管实例类型，取值： standard：标准网关。 serverless：Serverless网关。

请求示例

返回参数

参数	类型	示例值	描述
Total	Long	10	过滤后的总个数。
Items	Array of GatewayServiceResponse	-	服务列表。

GatewayServiceResponse

参数	类型	示例值	描述
Id	String	sd84****	服务 ID。
Name	String	example	服务名称。
GatewayId	String	gd8****	服务所属网关实例 ID。
GatewayName	String	example	服务所属网关实例的名称。
Protocol	Array of String	["HTTP","HTTPS"]	协议类型，取值： HTTP。 HTTPS。
AuthSpec	Object of AuthSpec	-	认证配置。
Domains	Array of Server	-	默认域名。
Status	String	Running	服务状态，取值： Creating：创建中。 CreatedFailed：创建失败。 Running：运行中。 Deleting：删除中。 DeletedFailed：删除失败。 Abnormal：异常。
Message	String	-	服务创建失败、删除失败或异常时的错误信息。
Comments	String	example	服务的备注信息。
CreateTime	String	2025-01-01T00:00:00+08:00	服务实例创建时间。标准 RFC3339 格式的 UTC+8 时间。
CustomDomains	Array of CustomDomain	-	自定义域名。
DomainSpec	Object of DomainSpec	-	域名详情。
ServiceType	String	AIProvider	服务类型，取值： VeFaas：函数服务。 ECS：云服务器。 K8S：容器服务。 Nacos：注册中心。 FixedIP：固定 IP。 AIProvider：AI 模型代理。

AuthSpec

参数	类型	示例值	描述
Enable	Boolean	true	是否开启认证配置。取值： true：开启。 false：不开启。

Server

参数	类型	示例值	描述
Domain	String	http://example.apigateway-cn-beijing.volceapi.com	默认域名地址。
Type	String	public	默认域名类型，取值： public：公网。 private：私网。

CustomDomain

DomainSpec

参数	类型	示例值	描述
EnablePublicResolution	Boolean	true	是否开启私网域名公网解析。取值： true：开启。 false：不开启。

返回示例

错误码

本接口无特有的错误码。更多信息请参见公共错误码。