首页 微服务引擎MSE API参考指南 API目录 云原生网关 路由配置 UpdateGatewayRouteWafStatus - 更新路由防护状态

UpdateGatewayRouteWafStatus - 更新路由防护状态

调试

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

调试

授权信息

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

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

请求参数

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

路由条目ID。

645
GatewayUniqueIdstring

网关唯一ID。

gw-86575c0bc9f04ecfbacb92b8e392****
AcceptLanguagestring

返回信息的语言类型:

  • zh:中文
  • en:英文
zh
EnableWafboolean

是否开启WAF。

true

返回参数

名称类型描述示例值
object

Schema of Response。

RequestIdstring

ID of the Request。

7466566F-F30F-4A29-965D-3E0AF21D****
HttpStatusCodeinteger

HTTP状态码。

200
Messagestring

响应信息。

success
Codeinteger

状态码。说明200表示成功。

200
Successboolean

请求结果,取值如下:

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

返回数据。

Idlong

路由ID。

12
Namestring

消息路由名称。

test
GatewayUniqueIdstring

网关唯一ID。

gw-7ea3da97b96543e19f6c597cd4a9****
GatewayIdlong

网关ID。

102
DefaultServiceIdlong

默认服务ID。

1
DefaultServiceNamestring

默认服务名称。

test
Statusinteger

路由状态。

1
GmtCreatestring

创建时间。

2022-01-26T09:52:41.000+0000
GmtModifiedstring

修改日期。

2022-02-24T06:08:29.230+0000
RouteOrderinteger

路由顺序。

1
Predicatesstring

匹配规则。

{\"PathPredicates\":{\"Path\":\"/metas\",\"Type\":\"PRE\",\"IgnoreCase\":false}}
RoutePredicatesobject

路由匹配。

PathPredicatesobject

路由匹配。

Pathstring

路径。

/zookeeper/mmgw/unlogined/common.getBu
Typestring

匹配类型。

PRE
IgnoreCaseboolean

是否忽略大小写。

true
MethodPredicatesarray

匹配方法。

string

方法。

GET
HeaderPredicatesarray

请求头匹配规则。

object

请求头。

Keystring

请求头KEY。

alibo
Valuestring

值。

200
Typestring

匹配类型。

PRE
QueryPredicatesarray

参数匹配规则。

object

参数。

Keystring

参数名称。

instanceId
Valuestring

匹配值。

test
Typestring

类型。

PRE
DomainIdlong

域名ID。

235
DomainNamestring

域名。

nbhamster.com
Servicesstring

服务。

[{\"Percent\":100,\"ServiceId\":126}]
RouteServicesarray

服务。

object

服务。

ServiceIdlong

服务id。

547
ServiceNamestring

服务名称。

b-service
Percentinteger

权重。

80
Versionstring

服务版本。

v1
Namestring

服务名称。

test-aixue-gray
SourceTypestring

服务来源。

K8S
Namespacestring

命名空间。

default
GroupNamestring

服务分组名称。

DEFAULT_GROUP
HTTPRewriteobject

重写策略信息。

Statusstring

HTTP状态。

off
Pathstring

HTTP请求路径。

/test/client
Hoststring

域名。

aliyuncs.com
PathTypestring

HTTP请求路径类型。

PRE
Patternstring

匹配Pattern。

/test
Substitutionstring

替换。

test
HeaderOpobject

Header设置信息。

Statusstring

状态。

off
HeaderOpItemsarray

设置策略。

object

设置策略。

DirectionTypestring

请求或者响应。

Response
OpTypestring

操作类型。

Add
Keystring

Header Key。

debug
Valuestring

设置值。

test
DestinationTypestring

目标服务类型。

Single
DirectResponseobject

Mock信息。

Codeinteger

返回值。

200
Bodystring

Mock返回值。

[{\"key\":\"h68d13466.sqa.eu95\",\"dims\":\"groupName=All}]
Corsobject

跨域配置。

Statusstring

状态。

off
AllowOriginsstring

跨域。

*
AllowMethodsstring

跨域方法。

GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH
AllowHeadersstring

跨域Header。

*
ExposeHeadersstring

响应头。

*
TimeUnitstring

时间单位。

s
UnitNumlong

时间数。

1
AllowCredentialsboolean

允许携带凭证。

true
Timeoutobject

超时配置。

UnitNuminteger

时间数。

10
TimeUnitstring

时间单位。

s
Statusstring

状态。

off
Retryobject

重试配置。

Attemptsinteger

给定请求允许的重试次数。

1
RetryOnarray

重试条件。

string

重试条件。

5xx
HttpCodesarray

HTTP状态码。

string

HTTP状态码。

500
Statusstring

重试状态。

on
DomainIdListarray

域名ID列表。

long

域名ID列表。

1
DomainNameListarray

域名列表。

string

域名列表。

test.com
Redirectobject

重定向配置。

Codeinteger

响应码。

200
Hoststring

主机。

ww.al.c
Pathstring

路径。

/
EnableWafboolean

是否开启WAF。

0

示例

正常返回示例

JSON格式

{
  "RequestId": "7466566F-F30F-4A29-965D-3E0AF21D****",
  "HttpStatusCode": 200,
  "Message": "success",
  "Code": 200,
  "Success": true,
  "Data": {
    "Id": 12,
    "Name": "test",
    "GatewayUniqueId": "gw-7ea3da97b96543e19f6c597cd4a9****",
    "GatewayId": 102,
    "DefaultServiceId": 1,
    "DefaultServiceName": "test",
    "Status": 1,
    "GmtCreate": "2022-01-26T09:52:41.000+0000",
    "GmtModified": "2022-02-24T06:08:29.230+0000",
    "RouteOrder": 1,
    "Predicates": "{\\\"PathPredicates\\\":{\\\"Path\\\":\\\"/metas\\\",\\\"Type\\\":\\\"PRE\\\",\\\"IgnoreCase\\\":false}}",
    "RoutePredicates": {
      "PathPredicates": {
        "Path": "/zookeeper/mmgw/unlogined/common.getBu",
        "Type": "PRE",
        "IgnoreCase": true
      },
      "MethodPredicates": [
        "GET"
      ],
      "HeaderPredicates": [
        {
          "Key": "alibo",
          "Value": "200",
          "Type": "PRE"
        }
      ],
      "QueryPredicates": [
        {
          "Key": "instanceId",
          "Value": "test",
          "Type": "PRE"
        }
      ]
    },
    "DomainId": 235,
    "DomainName": "nbhamster.com",
    "Services": "[{\\\"Percent\\\":100,\\\"ServiceId\\\":126}]",
    "RouteServices": [
      {
        "ServiceId": 547,
        "ServiceName": "b-service",
        "Percent": 80,
        "Version": "v1",
        "Name": "test-aixue-gray",
        "SourceType": "K8S",
        "Namespace": "default",
        "GroupName": "DEFAULT_GROUP"
      }
    ],
    "HTTPRewrite": {
      "Status": "off",
      "Path": "/test/client",
      "Host": "aliyuncs.com",
      "PathType": "PRE",
      "Pattern": "/test",
      "Substitution": "test"
    },
    "HeaderOp": {
      "Status": "off",
      "HeaderOpItems": [
        {
          "DirectionType": "Response",
          "OpType": "Add",
          "Key": "debug",
          "Value": "test"
        }
      ]
    },
    "DestinationType": "Single",
    "DirectResponse": {
      "Code": 200,
      "Body": "[{\\\"key\\\":\\\"h68d13466.sqa.eu95\\\",\\\"dims\\\":\\\"groupName=All}]"
    },
    "Cors": {
      "Status": "off",
      "AllowOrigins": "*",
      "AllowMethods": "GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH",
      "AllowHeaders": "*",
      "ExposeHeaders": "*",
      "TimeUnit": "s",
      "UnitNum": 1,
      "AllowCredentials": true
    },
    "Timeout": {
      "UnitNum": 10,
      "TimeUnit": "s",
      "Status": "off"
    },
    "Retry": {
      "Attempts": 1,
      "RetryOn": [
        "5xx"
      ],
      "HttpCodes": [
        "500"
      ],
      "Status": "on"
    },
    "DomainIdList": [
      1
    ],
    "DomainNameList": [
      "test.com"
    ],
    "Redirect": {
      "Code": 200,
      "Host": "ww.al.c",
      "Path": "/"
    },
    "EnableWaf": true
  }
}

错误码

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

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

阿里云首页 微服务引擎 相关技术圈