

# x-amazon-apigateway-endpoint-configuration 对象
<a name="api-gateway-swagger-extensions-endpoint-configuration"></a>

指定 API 的端点配置的详细信息。此扩展是 [OpenAPI 操作](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#operation-object)对象的扩展属性。此对象应该存在于 Swagger 2.0 的[顶级供应商扩展](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#specification-extensions)中。对于 OpenAPI 3.0，它应该存在于[服务器对象](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#server-object)的供应商扩展下。


| 属性名称 | 类型 | 描述 | 
| --- | --- | --- | 
| disableExecuteApiEndpoint | Boolean |  指定客户端是否可以使用默认 `execute-api` 端点调用您的 API。默认情况下，客户端可以使用默认 `https://{api_id}.execute-api.{region}.amazonaws.com` 端点调用您的 API。如果要求客户端使用自定义域名来调用 API，请指定 `true`。  | 
| vpcEndpointIds | String 数组 |  VpcEndpoint 标识符的列表，可针对这些标识符为 REST API 创建 Route 53 别名。仅 `PRIVATE` 端点类型的 REST API 支持它。  | 
| ipAddressType | string |  可以调用 HTTP API 的 IP 地址类型。使用 `ipv4` 来支持 IPv4 地址类型调用 HTTP API。使用 `dualstack` 来支持 IPv4 和 IPv6 地址类型调用 HTTP API。仅 HTTP API 支持此功能。 | 

## x-amazon-apigateway-endpoint-configuration 示例
<a name="api-gateway-swagger-extensions-endpoint-configuration-example"></a>

以下示例将指定的 VPC 端点与 REST API 关联。

```
"x-amazon-apigateway-endpoint-configuration": {
    "vpcEndpointIds": ["vpce-0212a4ababd5b8c3e", "vpce-01d622316a7df47f9"]
}
```

以下示例禁用 API 的默认端点。

```
"x-amazon-apigateway-endpoint-configuration": {
    "disableExecuteApiEndpoint": true
}
```

以下示例将 HTTP API 的 IP 地址类型设置为双堆栈。

```
"x-amazon-apigateway-endpoint-configuration": {
    "ipAddressType": "dualstack"
}
```