批量查询服务。 ## 请求说明 * 请求方式：POST * 请求地址：https://open.volcengineapi.com?Action=ListGatewayServices&Version=2021\-03\-03 ## 调试 [去调试](https://api.volcengine.com/api-explorer/debug?action=ListGatewayServices&serviceCode=apig&version=2021-03-03&groupName=) ## 请求参数 |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |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](https://www.volcengine.com/docs/6569/1337084?lang=zh) 查询网关实例 ID。 | |Filter |Object of [ServiceFilter](https://www.volcengine.com/docs/6569/1628097#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网关。 | ## 请求示例 ```json POST https://open.volcengineapi.com?Action=ListGatewayServices&Version=2021-03-03 Content-Type: application/json { "PageNumber": 1, "PageSize": 10, "GatewayId": "gd8****", "Filter": { "Name": "example", "Status": "Running", "GatewayType": "standard", "ServiceType": "AIProvider" } } ``` ## 返回参数 |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Total |Long |10 |过滤后的总个数。 | |Items |Array of [GatewayServiceResponse](https://www.volcengine.com/docs/6569/1628097#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](https://www.volcengine.com/docs/6569/1628097#authspec) |\- |认证配置。 | |Domains |Array of [Server](https://www.volcengine.com/docs/6569/1628097#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](https://tools.ietf.org/html/rfc3339) 格式的 UTC+8 时间。 | |CustomDomains |Array of [CustomDomain](https://www.volcengine.com/docs/6569/1628097#customdomain) |\- |自定义域名。 | |DomainSpec |Object of [DomainSpec](https://www.volcengine.com/docs/6569/1628097#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 |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Id |String |d\*\*\*\* |自定义域名 ID。 | |Domain |String |example.com |自定义域名。 | ### DomainSpec |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |EnablePublicResolution |Boolean |true |是否开启私网域名公网解析。取值：

* **true**：开启。

* **false**：不开启。 | ## 返回示例 ```json Content-Type: application/json { "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "ListGatewayServices", "Version": "2021-03-03", "Service": "apig", "Region": "cn-beijing" }, "Result": { "Total": 10, "Items": [ { "Id": "sd84****", "Name": "example", "Status": "Running", "Domains": [ { "Type": "public", "Domain": "http://example.apigateway-cn-beijing.volceapi.com" } ], "Message": "", "AuthSpec": { "Enable": true }, "Comments": "example", "Protocol": [ "HTTP", "HTTPS" ], "GatewayId": "gd8****", "CreateTime": "2025-01-01T00:00:00+08:00", "DomainSpec": { "EnablePublicResolution": true }, "GatewayName": "example", "ServiceType": "AIProvider", "CustomDomains": [ { "Id": "d****", "Domain": "example.com" } ] } ] } } ``` ## 错误码本接口无特有的错误码。更多信息请参见 [公共错误码](https://www.volcengine.com/docs/6569/1337089)。

API 网关