x-amazon-apigateway-endpoint-配置對象 - Amazon API 网关

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

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

指定的端點組態詳細資訊API。這個擴展是打開API操作對象的擴展屬性。這個物件應該位於 Swagger 2.0 的上層廠商延伸中。對於 Open API 3.0,它應該出現在服務器對象的供應商擴展下。

屬性名稱 類型 描述
disableExecuteApiEndpoint Boolean

指定用戶端是否可以使用API預設execute-api端點呼叫您的。默認情況下,客戶端可以API使用默認https://{api_id}.execute-api.{region}.amazonaws.com端點調用您的。如果要求用戶端使用自訂網域名稱呼叫您的API,請指定true

vpcEndpointIds String 陣列

要針對其建立 Route 53 別名記錄的 VpcEndpoint 識別碼清單RESTAPI。它僅支援PRIVATE端RESTAPIs點類型。

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

下列範例會將指定的VPC端點關聯至RESTAPI。

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

下列範例會停用API.

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