Help Center/ API Gateway/ User Guide/ Managing APIs/ API Design File Extension Definitions/ x-apigateway-backend.httpVpcMemberGroupEndpoints.memberGroupUrlInfos
Updated on 2025-09-26 GMT+08:00

x-apigateway-backend.httpVpcMemberGroupEndpoints.memberGroupUrlInfos

Meaning: HTTP VPC backend service definition. It is restricted. To use it, submit a service ticket.

Scope of effect: x-apigateway-backend

Example:

paths:
  '/users/{userId}':
    get:
      produces:
        - "application/json"
      parameters:
        - name: "X-Auth-Token"
          description: "Authentication 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"
Table 1 Parameter description

Parameter

Mandatory

Type

Description

scheme

Yes

String

Backend request protocol. HTTP and HTTPS are supported.

method

Yes

String

Backend request method. The options include GET, POST, PUT, DELETE, HEAD, OPTIONS, PATCH, and ANY.

path

Yes

String

Request address, which can contain request parameters enclosed with braces ({}). For example, /getUserInfo/{userId}. Special characters, such as asterisks (*), slashes (/), percent signs (%), hyphens (-), underscores (_), and periods (.), are allowed. It can contain a maximum of 512 characters and must comply with URI specifications.

Environment variables are supported. Each must start with a letter and can consist of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

name

Yes

String

Name of the VPC channel's backend server group. It can contain 3 to 64 characters, starting with a letter. Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed. Chinese characters must be in UTF-8 or Unicode format.