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

x-apigateway-backend.httpVpcMemberGroupEndpoints

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

memberGroupUrlInfos

Yes

x-apigateway-backend.httpVpcMemberGroupEndpoints.memberGroupUrlInfos

URL of a server group.

name

Yes

String

Load balance channel name. It can contain 3 to 64 characters, starting with a letter. Only letters, digits, hyphens (-), underscores (_), and periods (.) are allowed. Chinese characters must be in UTF-8 or Unicode format.

timeout

No

Number

Backend request timeout in milliseconds. The value ranges from 1 to 60,000, and the default value is 5000.

retryCount

No

String

Number of retry attempts to request the backend service. The default value is –1. The value ranges from –1 to 10.

–1 indicates that idempotent APIs will retry once and non-idempotent APIs will not retry. POST and PATCH are non-idempotent. GET, HEAD, PUT, OPTIONS, and DELETE are idempotent.

Default value: -1

enableClientSsl

No

Boolean

Indicates whether to enable two-way authentication.

enableSmChannel

No

Boolean

Indicates whether to enable SM cryptographic algorithms.

This feature is only available if the gateway supports the SM cryptographic algorithms.