全部產品
Search

搜尋本產品

    Microservices Engine：AddGatewayRoute - 添加網關路由

    文件中心

    Microservices Engine：AddGatewayRoute - 添加網關路由

    更新時間：Jun 01, 2026

    添加網關路由。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    mse:AddGatewayRoute

    create

    *Gateway

    acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    GatewayId

    integer

    否

    網關 ID。

    526
    Name

    string

    是

    路由名稱。

    test
    RouteOrder

    integer

    否

    路由順序。（數值越小優先順序越高）

    1
    Predicates

    array

    否

    匹配規則。

    PathPredicates

    object

    否

    路由匹配。

    Path

    string

    否

    路徑。

    /test
    Type

    string

    否

    路由匹配：

    • 首碼：PRE。

    • 精確：EQUAL。

    • 正則：ERGULAR。

    PRE
    IgnoreCase

    boolean

    否

    忽略大小寫。

    true
    MethodPredicates

    array

    否

    方法匹配。

    string

    否

    具體方法。

    GET
    HeaderPredicates

    array

    否

    要求標頭匹配。

    object

    否

    要求標頭。

    Key

    string

    否

    要求標頭 Key。

    debug
    Value

    string

    否

    對應的 Value。

    test
    Type

    string

    否

    匹配類型。

    PRE
    QueryPredicates

    array

    否

    URL 參數匹配。

    object

    否

    URL 參數。

    Key

    string

    否

    參數名。

    userid
    Value

    string

    否

    匹配值。

    test
    Type

    string

    否

    匹配類型。

    PRE
    Services

    array

    否

    服務列表（路由指向為單服務、多服務、標籤路由時填寫）。

    array

    否

    服務列表。

    ServiceId

    integer

    否

    服務 ID。

    353
    Percent

    integer

    否

    當前服務/服務版本分流百分比（只在使用多服務、標籤路由時填寫）。

    80
    Version

    string

    否

    服務版本（只在使用標籤路由時填寫）。

    v1
    Name

    string

    否

    名稱。

    user
    SourceType

    string

    否

    來源類型。

    MSE
    Namespace

    string

    否

    服務所在命名空間。

    default
    GroupName

    string

    否

    服務分組名稱。

    test
    AgreementType

    string

    否

    協議類型。

    DUBBO
    HttpDubboTranscoder

    object

    否

    Dubbo 協議轉換體。

    DubboServiceName

    string

    否

    Dubbo 服務名稱。

    org.apache.dubbo.samples.basic.api.DemoService
    DubboServiceVersion

    string

    否

    Dubbot 服務版本。

    0.0.0
    DubboServiceGroup

    string

    否

    服務組。

    group
    MothedMapList

    array

    否

    Dubbo 轉寄規則列表。

    array

    否

    方法映射。

    DubboMothedName

    string

    否

    Dubbo 方法名。

    sayHello
    HttpMothed

    string

    否

    HTTP 方法。

    說明

    支援 HTTP 方法參數值。

    • ALL_GET。

    • ALL_POST。

    • ALL_PUT。

    • ALL_DELETE。

    • ALL_PATCH。

    ALL_GET
    Mothedpath

    string

    否

    方法匹配路徑。

    /mytestzbk/sayhello
    PassThroughAllHeaders

    string

    否

    Header 透傳類型。

    說明

    透傳類型枚舉值。

    • 透傳所有：PASS_ALL。

    • 不透傳：PASS_NOT。

    • 指定參數：PASS_ASSIGN。

    PASS_NOT
    PassThroughList

    array

    否

    指定透傳 Header 列表

    string

    否

    指定 Header 透傳值。

    x-forward
    ParamMapsList

    array

    否

    參數映射列表。

    object

    否

    參數映射體。

    ExtractKeySpec

    string

    否

    入參位置。

    說明

    入參位置枚舉值。

    • 請求參數：ALL_QUERY_PARAMETER

    • 要求標頭：ALL_HEADER

    • 請求路徑：ALL_PATH

    • 請求體：ALL_BODY

    ALL_QUERY_PARAMETER
    ExtractKey

    string

    否

    入參位提取 Key。

    name
    MappingType

    string

    否

    後端參數類型。

    java.lang.String
    ServicePort

    integer

    否

    服務連接埠。

    443
    DomainId

    integer

    否

    網域名稱 ID。

    20
    DestinationType

    string

    否

    目標服務類型。

    • Single：單服務

    • Multiple：多服務

    • VersionOriented：標籤路由

    • Mock：Mock

    • Redirect：重新導向

    Multiple
    DirectResponseJSON

    object

    否

    Mock 響應配置。

    Code

    integer

    否

    Mock 返回碼。

    403
    Body

    string

    否

    Mock 傳回值。

    hello
    GatewayUniqueId

    string

    是

    網關唯一標識 ID。

    gw-492af9b04bb4474cae9d645be8*****
    DomainIdListJSON

    string

    是

    網域名稱列表。

    [0,94]
    RedirectJSON

    object

    否

    重新導向配置。

    Code

    integer

    否

    返回碼。

    302
    Host

    string

    否

    重新導向主機名稱。

    test.com
    Path

    string

    否

    重新導向路徑。

    /test
    EnableWaf deprecated

    boolean

    否

    已廢棄，請使用 UpdateGatewayRouteWafStatus 更新路由 WAF 狀態。

    true
    Fallback

    boolean

    否

    是否開啟 Fallback 服務。

    true
    FallbackServices

    array

    否

    Fallback 服務。

    object

    否

    ServiceId

    integer

    否

    服務 ID。

    353
    Percent

    integer

    否

    權重百分比。

    80
    Version

    string

    否

    服務版本。

    v1
    Name

    string

    否

    名稱。

    user
    SourceType

    string

    否

    來源類型。

    MSE
    Namespace

    string

    否

    服務所在命名空間。

    default
    GroupName

    string

    否

    服務分組名稱。

    test
    AgreementType

    string

    否

    協議類型。

    DUBBO
    ServicePort

    integer

    否

    服務連接埠。

    443
    RouteType

    string

    否

    路由類型：

    Op：管控路由。

    Op
    Policies

    string

    否

    路由策略 JSON 字串。

    {"CORS":"{\"allowMethods\":\"GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH\",\"allowHeaders\":\"*\",\"exposeHeaders\":\"*\",\"unitNum\":12,\"allowCredentials\":true,\"status\":\"off\",\"allowOrigins\":\"*\",\"timeUnit\":\"h\"}","Timeout":"{\"unitNum\":10,\"timeUnit\":\"s\",\"status\":\"off\"}","Retry":"{\"attempts\":2,\"retryOn\":[\"5xx\"],\"status\":\"off\"}","HTTPRewrite":"{\"pathType\":\"EQUAL\",\"path\":\"/o\",\"status\":\"off\"}","Waf":"{\"enabled\":false}","HeaderOp":"{\"status\":\"off\",\"headerOpItems\":[{\"directionType\":\"Request\",\"opType\":\"Add\",\"key\":\"kkk\",\"value\":\"ll\"}]}"}
    Description

    string

    否

    路由描述

    a route for xxx
    AcceptLanguage

    string

    否

    返回資訊的語言類型：

    • zh：中文

    • en：英文

    zh

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    資料結構。

    RequestId

    string

    請求 ID。

    03A3E2F4-6804-5663-9D5D-2EC47A1*****
    HttpStatusCode

    integer

    HTTP 狀態代碼。

    200
    Message

    string

    響應資訊。

    請求處理成功
    Code

    integer

    傳回碼。

    200
    Success

    boolean

    請求結果，取值如下：

    • true：請求成功。

    • false：請求失敗。

    true
    Data

    integer

    建立的路由 ID。

    555
    ErrorCode

    string

    錯誤碼。

    • InvalidParameter：參數錯誤：缺失、格式不對

    • IllegalRequest：請求非法：參數越權

    • NoPermission：許可權專用

    • NotFound：資源 404

    • InternalError：內部錯誤

    InvalidParameter

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "03A3E2F4-6804-5663-9D5D-2EC47A1*****",
  "HttpStatusCode": 200,
  "Message": "請求處理成功",
  "Code": 200,
  "Success": true,
  "Data": 555,
  "ErrorCode": "InvalidParameter"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 IllegalRequest Invalid request:%s 非法請求： %s
    400 InvalidParameter Parameter error:%s 請求參數錯誤：%s
    500 InternalError Console error. Try again later:%s 控制台錯誤.稍後重試：%s
    403 NoPermission You are not authorized to perform this operation:%s 沒有許可權使用此介面：%s
    404 NotFound Not found:%s 資源不存在：%s

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。