AddGatewayRoute_微服务引擎_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

请求速率为100/1(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
mse:AddGatewayRoute
Create
Gateway
acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

请求参数

字段名称字段详情
GatewayIdinteger<int64>

网关 ID。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:526参考取值来源:
    GetGateway
    ListGateway
    UpdateGatewayFlowRule
    GatewayBlackWhiteList
Namestring

路由名称。

示例值:test
RouteOrderinteger<int32>

路由顺序。(数值越小优先级越高)

示例值:1
Predicatesobject

匹配规则。

Servicesarray<object>

服务列表(路由指向为单服务、多服务、标签路由时填写)。

DomainIdinteger<int64>

域名 ID。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:20参考取值来源:
    ListGatewayDomain
DestinationTypestring

目标服务类型。展开详情

示例值:Multiple枚举值:VersionOrientedMultipleSingleRedirectMock
DirectResponseJSONobject

Mock 响应配置。

GatewayUniqueIdstring

网关唯一标识 ID。

示例值:gw-492af9b04bb4474cae9d645be8*****参考取值来源:
    UpdateGatewayIsolationRule
    AddGatewayDomain
    ListGateway
    CreateGatewayIsolationRule
    GetGatewayAuthDetail
    GatewayBlackWhiteList
DomainIdListJSONstring

域名列表。

示例值:[0,94]参考取值来源:
    ListGatewayRouteOnAuth
RedirectJSONobject

重定向配置。

deprecatedEnableWafboolean

已废弃,请使用 UpdateGatewayRouteWafStatus 更新路由 WAF 状态。

示例值:true
Fallbackboolean

是否开启 Fallback 服务。

示例值:true
FallbackServicesarray<object>

Fallback 服务。

RouteTypestring

路由类型:展开详情

示例值:Op
Policiesstring

路由策略 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\"}]}"}
Descriptionstring

路由描述

示例值:a route for xxx
AcceptLanguagestring

返回信息的语言类型:展开详情

示例值:zh

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:03A3E2F4-6804-5663-9D5D-2EC47A1*****
HttpStatusCodeinteger<int32>

HTTP 状态码。

示例值:200
Messagestring

响应信息。

示例值:请求处理成功
Codeinteger<int32>

返回代码。

示例值:200
Successboolean

请求结果,取值如下:展开详情

示例值:true
Datainteger<int64>

创建的路由 ID。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:555
ErrorCodestring

错误码。展开详情

示例值:InvalidParameter

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
IllegalRequest
Invalid request:%s诊断
400
InvalidParameter
Parameter error:%s诊断
403
NoPermission
You are not authorized to perform this operation:%s诊断
404
NotFound
Not found:%s诊断
500
InternalError
Console error. Try again later:%s诊断

变更历史

变更时间变更内容概要操作
2024-01-18
新增请求参数Description
2023-03-31
删除返回参数
2023-03-02
新增请求参数RouteType
新增请求参数Policies
2022-09-15
变更请求参数Services
2022-09-13
变更请求参数Services
新增请求参数Fallback
新增请求参数FallbackServices
2022-07-28
变更请求参数Services
  • 1
  • 2
  • 10 条/页

相关示例