文档

AddGatewayRoute - 添加网关路由

更新时间:

添加网关路由。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
mse:AddGatewayRouteWrite
  • Gateway
    acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

请求参数

名称类型必填描述示例值
GatewayIdlong

网关 ID。

526
Namestring

路由名称。

test
RouteOrderinteger

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

1
Predicatesobject

匹配规则。

PathPredicatesobject

路由匹配。

Pathstring

路径。

/test
Typestring

路由匹配:

  • 前缀:PRE。
  • 精确:EQUAL。
  • 正则:ERGULAR。
PRE
IgnoreCaseboolean

忽略大小写。

true
MethodPredicatesarray

方法匹配。

string

具体方法。

GET
HeaderPredicatesobject []

请求头匹配。

Keystring

请求头 Key。

debug
Valuestring

对应的 Value。

test
Typestring

匹配类型。

PRE
QueryPredicatesobject []

URL 参数匹配。

Keystring

参数名。

userid
Valuestring

匹配值。

test
Typestring

匹配类型。

PRE
Servicesobject []

服务列表。

ServiceIdlong

服务 ID。

353
Percentinteger

权重百分比。

80
Versionstring

服务版本。

v1
Namestring

名称。

user
SourceTypestring

来源类型。

MSE
Namespacestring

服务所在命名空间。

default
GroupNamestring

服务分组名称。

test
AgreementTypestring

协议类型。

DUBBO
HttpDubboTranscoderobject

Dubbo 协议转换体。

DubboServiceNamestring

Dubbo 服务名称。

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

Dubbot 服务版本。

0.0.0
DubboServiceGroupstring

服务组。

MothedMapListobject []

Dubbo 转发规则列表。

DubboMothedNamestring

Dubbo 方法名。

sayHello
HttpMothedstring

Http 方法。

说明 支持 http 方法参数值。
  • ALL_GET。
  • ALL_POST。
  • ALL_PUT。
  • ALL_DELETE。
  • ALL_PATCH。
  • ALL_GET
    Mothedpathstring

    方法匹配路径。

    /mytestzbk/sayhello
    PassThroughAllHeadersstring

    Header 透传类型。

    说明 透传类型枚举值。
  • 透传所有:PASS_ALL。
  • 不透传:PASS_NOT。
  • 指定参数:PASS_ASSIGN。
  • PASS_NOT
    PassThroughListarray

    指定透传 Header 列表

    string

    指定 Header 透传值。

    x-forward
    ParamMapsListobject []

    参数映射列表。

    ExtractKeySpecstring

    入参位置。

    说明 入参位置枚举值。
  • 请求参数:ALL_QUERY_PARAMETER
    • 请求头:ALL_HEADER
    • 请求路径:ALL_PATH
    • 请求体:ALL_BODY
    ALL_QUERY_PARAMETER
    ExtractKeystring

    入参位提取 Key。

    name
    MappingTypestring

    后端参数类型。

    java.lang.String
    ServicePortinteger

    服务端口。

    443
    DomainIdlong

    域名 ID。

    20
    DestinationTypestring

    目标服务类型。

    • Single:单服务
    • Multiple:多服务
    • VersionOriented:标签路由
    • Mock:Mock
    • Redirect:重定向
    Multiple
    DirectResponseJSONobject

    Mock 响应配置。

    Codelong

    Mock 返回码。

    403
    Bodystring

    Mock 返回值。

    hello
    GatewayUniqueIdstring

    网关唯一标识 ID。

    gw-492af9b04bb4474cae9d645be8*****
    DomainIdListJSONstring

    域名列表。

    [0,94]
    RedirectJSONobject

    重定向配置。

    Codeinteger

    返回码。

    302
    Hoststring

    重定向主机名。

    test.com
    Pathstring

    重定向路径。

    /test
    EnableWafboolean

    是否开启 WAF。

    true
    Fallbackboolean

    是否开启 Fallback 服务。

    true
    FallbackServicesobject []

    Fallback 服务。

    ServiceIdlong

    服务 ID。

    353
    Percentinteger

    权重百分比。

    80
    Versionstring

    服务版本。

    v1
    Namestring

    名称。

    user
    SourceTypestring

    来源类型。

    MSE
    Namespacestring

    服务所在命名空间。

    default
    GroupNamestring

    服务分组名称。

    test
    AgreementTypestring

    协议类型。

    DUBBO
    ServicePortinteger

    服务端口。

    443
    RouteTypestring

    路由类型:

    Op:管控路由。

    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:中文
    • en:英文
    zh

    返回参数

    名称类型描述示例值
    object

    数据结构。

    RequestIdstring

    请求 ID。

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

    HTTP 状态码。

    200
    Messagestring

    响应信息。

    请求处理成功
    Codeinteger

    返回代码。

    200
    Successboolean

    请求结果,取值如下:

    • true:请求成功。
    • false:请求失败。
    true
    Datalong

    创建的路由 ID。

    555
    ErrorCodestring

    错误码。

    • 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错误码错误信息描述
    400IllegalRequestInvalid request:%s非法请求: %s
    400InvalidParameterParameter error:%s请求参数错误:%s
    403NoPermissionYou are not authorized to perform this operation:%s没有权限使用此接口:%s
    404NotFoundNot found:%s资源不存在:%s
    500InternalErrorConsole error. Try again later:%s控制台错误.稍后重试:%s

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2024-01-18OpenAPI 入参发生变更看变更集
    变更项变更内容
    入参OpenAPI 入参发生变更
      新增入参:Description
    2023-03-31API 内部配置变更,不影响调用看变更集
    变更项变更内容
    API 内部配置变更,不影响调用
    2023-03-02OpenAPI 入参发生变更看变更集
    变更项变更内容
    入参OpenAPI 入参发生变更
      新增入参:RouteType
      新增入参:Policies
    2022-07-28API 内部配置变更,不影响调用看变更集
    变更项变更内容
    API 内部配置变更,不影响调用
    2022-02-18新增 OpenAPI看变更集
    • 本页导读 (1)