文档首页/ API网关 APIG/ 用户指南/ 管理API/ APIG的API设计文件扩展定义/ x-apigateway-backend.httpVpcMemberGroupEndpoints
更新时间:2025-09-26 GMT+08:00
分享

x-apigateway-backend.httpVpcMemberGroupEndpoints

含义: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-MEMBER-GROUP"
        httpVpcMemberGroupEndpoints:
          memberGroupUrlInfos:
            - name: "xxxxx"
              scheme: "http"
              method: "GET"
              path: "/users"
          enableClientSsl:false          
          enableSmChannel: false          
          retryCount: 0
          timeout: 5000
          name: "VPC_6ZZ0"
表1 参数说明

参数

是否必选

类型

说明

memberGroupUrlInfos

x-apigateway-backend.httpVpcMemberGroupEndpoints.memberGroupUrlInfos

服务器分组URL信息。

name

String

负载通道名称。长度为3~64位的字符串,字符串由中文、英文字母、数字、中划线、下划线、点组成,且只能以英文或中文开头。中文字符必须为UTF-8或者unicode编码。

timeout

Number

后端请求超时时间,单位毫秒,缺省值为5000,取值范围为1~60000。

retryCount

String

请求后端服务的重试次数,默认为-1,范围[-1,10]。

当该值为-1时,幂等的接口会重试1次,非幂等的不会重试。POST,PATCH方法为非幂等;GET,HEAD,PUT,OPTIONS和DELETE等方法为幂等的。

缺省值:-1

enableClientSsl

Boolean

是否开启双向认证。

enableSmChannel

Boolean

是否启用SM商密通道。

仅实例支持SM系列商密算法的实例时支持开启。

相关文档