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

x-apigateway-backend.httpVpcMemberGroupEndpoints.memberGroupUrlInfos

含义: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 参数说明

参数

是否必选

类型

说明

scheme

String

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

method

String

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

path

String

请求地址。可以包含请求参数,用{}标识,比如/getUserInfo/{userId},支持 * / %- _ . 等特殊字符,总长度不超过512字符,且满足URI规范。

支持环境变量,使用环境变量时,每个变量名的长度为3~32位的字符串,字符串由英文字母、数字、中划线、下划线组成,且只能以英文开头。

name

String

VPC通道后端服务器组名称。支持汉字、英文、数字、下划线、中划线、点,且只能以英文和汉字开头,总长度为3~64字符。中文字符必须为UTF-8或者unicode编码。

相关文档