批量查询服务。

请求说明

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

请求方式：POST

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

调试

API Explorer

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

去调试

请求参数

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

Action string 必选示例值：ListGatewayServices

要执行的操作，取值：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 可选示例值：-

过滤条件。

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 object[] 示例值：-

服务列表。

Id string 示例值：sd84****

服务 ID。

Name string 示例值：example

服务名称。

GatewayId string 示例值：gd8****

服务所属网关实例 ID。

GatewayName string 示例值：example

服务所属网关实例的名称。

Protocol string[] 示例值：["HTTP","HTTPS"]

协议类型，取值：

HTTP。

HTTPS。

AuthSpec object 示例值：-

认证配置。

Enable boolean 示例值：true

是否开启认证配置。取值：

true：开启。

false：不开启。

Domains object[] 示例值：-

默认域名。

Domain string 示例值：http://example.apigateway-cn-beijing.volceapi.com

默认域名地址。

Type string 示例值：public

默认域名类型，取值：

public：公网。

private：私网。

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 时间。

Tags object[] 示例值：-

标签。

Key string 示例值：example-key

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

Value string 示例值：example-value

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

CustomDomains object[] 示例值：-

自定义域名。

Id string 示例值：d****

自定义域名 ID。

Domain string 示例值：example.com

自定义域名。

DomainSpec object 示例值：-

域名详情。

EnablePublicResolution boolean 示例值：true

是否开启私网域名公网解析。取值：

true：开启。

false：不开启。

ServiceType string 示例值：AIProvider

服务类型，取值：

VeFaas：函数服务。

ECS：云服务器。

K8S：容器服务。

Nacos：注册中心。

FixedIP：固定 IP。

AIProvider：AI 模型代理。

请求示例

返回示例

错误码

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

状态码	错误码	错误信息	说明
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.	未知错误。请稍后重试。如果多次尝试失败，请提交工单。