x-amazon-apigateway-endpoint-配置对象 - Amazon API Gateway
x-amazon-apigateway-endpoint-配置示例
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

x-amazon-apigateway-endpoint-配置对象

指定 API 的终端节点配置的详细信息。此扩展是 OpenAPI 操作对象的扩展属性。此对象应该存在于 Swagger 2.0 的顶级供应商扩展中。对于 OpenAPI 3.0，它应该存在于服务器对象的供应商扩展下。

属性
属性名称 类型 描述
disableExecuteApiEndpoint Boolean

指定客户端是否可以使用默认 execute-api 终端节点调用您的 API。默认情况下，客户端可以使用默认 https://{api_id}.execute-api.{region}.amazonaws.com 终端节点调用您的 API。如果要求客户端使用自定义域名来调用 API，请指定 true。
vpcEndpointIds String 数组

用于为 REST API 创建 Route 53 别名记录的 VpcEndpoint 标识符列表。仅 PRIVATE 终端节点类型的 REST API 支持它。

x-amazon-apigateway-endpoint-配置示例

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

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

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

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