文档首页> API网关 APIG> 开发指南（阿布扎比区域）> 导入导出API> 扩展定义> x-apigateway-backend> x-apigateway-backend.httpVpcEndpoints
更新时间：2023-05-09 GMT+08:00
查看PDF

x-apigateway-backend.httpVpcEndpoints

含义：API网关定义的HTTP VPC类型API后端服务定义。

作用域：x-apigateway-backend

示例：

paths:
  '/users/{userId}':
    get:
      produces:
        - "application/json"
      parameters:
        - name: "X-Auth-Token"
          description: "认证token"
          type: "string"
          in: "header"
          required: true
      responses:
        default:
          description: "default response"
      x-apigateway-request-type: "public"
      x-apigateway-backend:
        type: "HTTP-VPC"
        httpVpcEndpoints:
          name: "vpc-test-1"
          scheme: "http"
          method: "GET"
          path: "/users"
          timeout: 30000
表1 参数说明

参数

是否必选

类型

说明

name

是

Array

VPC通道名称

scheme

是

String

后端请求协议定义，支持http、https

method

是

String

后端请求方法，支持GET、POST、PUT、DELETE、HEAD、OPTIONS、PATCH、ANY

path

是

String

后端请求路径，支持路径变量

timeout

否

Number

后端请求超时时间，单位毫秒，缺省值为5000，取值范围为1 ~ 60000
父主题： x-apigateway-backend