查询服务详情。 ## 请求说明 API 网关已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅 [服务地址](https://docs.volcengine.com/docs/6569/2603628?lang=zh&TagIDs=2%2C286) 文档，根据业务所在地域，选择最合适的接入点。 * 请求方式：POST * 请求地址：https://apig.cn\-beijing.volcengineapi.com?Action=GetGatewayService&Version=2021\-03\-03 ## 调试 [去调试](https://api.volcengine.com/api-explorer/debug?action=GetGatewayService&serviceCode=apig&version=2021-03-03&groupName=) ## 请求参数 |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Action |String |是 |GetGatewayService |接口名称。当前 API 的名称为 `GetGatewayService`。 | |Version |String |是 |2021\-03\-03 |接口版本。当前 API 的版本为 `2021-03-03`。 | |Id |String |是 |sd84\*\*\*\* |服务 ID。您可以通过 [ListGatewayServices](https://www.volcengine.com/docs/6569/1628097?lang=zh) 查询服务 ID。 | ## 请求示例 ```json POST https://apig.cn-beijing.volcengineapi.com?Action=GetGatewayService&Version=2021-03-03 Content-Type: application/json { "Id": "sd84****" } ``` ## 返回参数 |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |GatewayService |Object of [GatewayServiceResponse](https://docs.volcengine.com/docs/6569/1628096#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://docs.volcengine.com/docs/6569/1628096#authspec) |\- |认证配置。 | |Domains |Array of [Server](https://docs.volcengine.com/docs/6569/1628096#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+0 时间。 | |CustomDomains |Array of [CustomDomain](https://docs.volcengine.com/docs/6569/1628096#customdomain) |\- |自定义域名。 | |DomainSpec |Object of [DomainSpec](https://docs.volcengine.com/docs/6569/1628096#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": "GetGatewayService", "Version": "2021-03-03", "Service": "apig", "Region": "cn-beijing" }, "Result": { "GatewayService": { "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)。