ListGatewayRoute - 网关路由列表

调用ListGatewayRoute接口查询网关路由列表。

调试

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

调试

授权信息

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

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

请求参数

名称 类型 必填 描述 示例值
PageNumber integer

页码。

1
PageSize integer

每页展示实例数。

10
OrderItem string

排序属性。

GmtCreate
DescSort boolean

排序。该字段目前不可用,下线中。

false
FilterParams object

过滤条件,格式为{"key1":"value1"}。

GatewayId long

网关ID。

81
Name string

网关名称。

test
Status integer

状态

1
DefaultServiceId long

缺省服务id。

1
RouteOrder integer

顺序

1
DomainId long

域名id。

284
GatewayUniqueId string

网关唯一标识ID。

gw-30a0106924c94bca8712ec4e79fc5acc
DomainName string

关联域名

*.alites.com
AcceptLanguage string

返回信息的语言类型:

  • zh:中文
  • en:英文
zh

返回参数

名称 类型 描述 示例值
object

数据结构。

RequestId string

请求ID。

83F02EAB-ECDF-55C6-B332-8649E5E7AF2C
HttpStatusCode integer

HTTP状态码。

200
Message string

错误信息。

You are not authorized to perform this operation.
Code integer

代码。

200
Success boolean

请求结果,取值如下:

  • true:请求成功。
  • false:请求失败。
true
Data object

返回数据。

TotalSize long

总条数。

36
PageNumber integer

页码。

11
PageSize integer

分页大小。

10
Result array

数据结构。

object

返回集合。

Id long

ID。

47
Name string

名称。

test
GatewayUniqueId string

网关唯一标识。

gw-cf0e7f52ecc7429dbc7ba4d5e3656100
GatewayId long

网关ID。

496
Status integer

状态。

2
RouteOrder integer

顺序

1
DefaultServiceName string

默认服务名称。

test
DefaultServiceId long

默认服务id。

1
Predicates string

匹配规则

{\"PathPredicates\":{\"Path\":\"/rpc/compute \",\"Type\":\"PRE\",\"IgnoreCase\":true}}
RoutePredicates object

匹配规则

PathPredicates object

路由Path匹配。

Path string

节点路径。

/getIp
Type string

匹配类型。

PRE
IgnoreCase boolean

忽略大小写

true
MethodPredicates array

HTTP方法匹配

string

方法

GET
HeaderPredicates array

Header匹配

object

Header列表

Key string

Header KEY

userid
Value string

匹配值

test
Type string

匹配类型

PRE
QueryPredicates array

参数匹配

object

参数列表

Key string

参数名称

userid
Value string

匹配值

test
Type string

匹配类型

PRE
GmtCreate string

创建时间。

2022-01-25T07:14:01.817+0000
GmtModified string

修改时间

2022-01-07 18:07:57
Services string

服务。

[]
RouteServices array

服务。

object

服务列表

ServiceId long

服务ID

1563
ServiceName string

服务名称。

hu
Percent integer

权重百分比

11
Version string

服务版本。

v1
Name string

名称。

test
SourceType string

来源类型

MSE
Namespace string

命名空间。

default
GroupName string

服务组名称。

api
AgreementType string

协议类型。

DUBBO
HttpDubboTranscoder object

Dubbo协议转换体。

DubboServiceName string

Dubbo服务名称。

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

Dubbot服务版本。

0.0.0
MothedMapList array

Dubbo转发规则列表。

object

方法映射体。

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
    DubboServiceGroup string

    Dubbo服务组。

    service group
    ServicePort integer

    Dubbo端口。

    20880
    DomainId long

    域名ID。

    265
    DomainName string

    域名。

    y.com
    DestinationType string

    目标类型。

    Single
    DirectResponse object

    Mock配置

    Code integer

    响应码。

    200
    Body string

    Mock返回值

    hello
    DomainIdList array

    域名列表。

    long

    域名ID

    123
    DomainNameList array

    域名列表。

    string

    域名

    test.com
    Redirect object

    重定向

    Code integer

    响应码。

    200
    Host string

    重定向主机名

    test.com
    Path string

    路径。

    /test
    Type string

    路由类型

    Op
    Comment object

    路由备注(ingress)

    Status string

    状态。

    error
    EnableWaf string

    是否开启waf

    false
    Fallback boolean

    是否开启Fallback服务。

    true
    FallbackServices array

    Fallback服务。

    object
    ServiceId long

    服务ID。

    353
    ServiceName string

    服务名称。

    service name
    Percent integer

    权重百分比。

    100
    Version string

    服务版本。

    v1
    Name string

    名称。

    name
    SourceType string

    来源类型。

    MSE
    Namespace string

    服务所在命名空间。

    Namespace
    GroupName string

    服务分组名称。

    test
    AgreementType string

    协议类型。

    DUBBO
    ServicePort integer

    服务端口。

    8848

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "83F02EAB-ECDF-55C6-B332-8649E5E7AF2C",
      "HttpStatusCode": 200,
      "Message": "You are not authorized to perform this operation.",
      "Code": 200,
      "Success": true,
      "Data": {
        "TotalSize": 36,
        "PageNumber": 11,
        "PageSize": 10,
        "Result": [
          {
            "Id": 47,
            "Name": "test",
            "GatewayUniqueId": "gw-cf0e7f52ecc7429dbc7ba4d5e3656100",
            "GatewayId": 496,
            "Status": 2,
            "RouteOrder": 1,
            "DefaultServiceName": "test",
            "DefaultServiceId": 1,
            "Predicates": "{\\\"PathPredicates\\\":{\\\"Path\\\":\\\"/rpc/compute \\\",\\\"Type\\\":\\\"PRE\\\",\\\"IgnoreCase\\\":true}}",
            "RoutePredicates": {
              "PathPredicates": {
                "Path": "/getIp",
                "Type": "PRE",
                "IgnoreCase": true
              },
              "MethodPredicates": [
                "GET"
              ],
              "HeaderPredicates": [
                {
                  "Key": "userid",
                  "Value": "test",
                  "Type": "PRE"
                }
              ],
              "QueryPredicates": [
                {
                  "Key": "userid",
                  "Value": "test",
                  "Type": "PRE"
                }
              ]
            },
            "GmtCreate": "2022-01-25T07:14:01.817+0000",
            "GmtModified": "2022-01-07 18:07:57",
            "Services": "[]",
            "RouteServices": [
              {
                "ServiceId": 1563,
                "ServiceName": "hu",
                "Percent": 11,
                "Version": "v1",
                "Name": "test",
                "SourceType": "MSE",
                "Namespace": "default",
                "GroupName": "api",
                "AgreementType": "DUBBO",
                "HttpDubboTranscoder": {
                  "DubboServiceName": "org.apache.dubbo.samples.basic.api.DemoService",
                  "DubboServiceVersion": "0.0.0",
                  "MothedMapList": [
                    {
                      "DubboMothedName": "sayHello",
                      "HttpMothed": "ALL_GET",
                      "Mothedpath": "/mytestzbk/sayhello",
                      "PassThroughAllHeaders": "PASS_NOT",
                      "PassThroughList": [
                        "x-forward"
                      ],
                      "ParamMapsList": [
                        {
                          "ExtractKeySpec": "ALL_QUERY_PARAMETER",
                          "ExtractKey": "name",
                          "MappingType": "java.lang.String"
                        }
                      ]
                    }
                  ],
                  "DubboServiceGroup": "service group"
                },
                "ServicePort": 20880
              }
            ],
            "DomainId": 265,
            "DomainName": "y.com",
            "DestinationType": "Single",
            "DirectResponse": {
              "Code": 200,
              "Body": "hello"
            },
            "DomainIdList": [
              123
            ],
            "DomainNameList": [
              "test.com"
            ],
            "Redirect": {
              "Code": 200,
              "Host": "test.com",
              "Path": "/test"
            },
            "Type": "Op",
            "Comment": {
              "Status": "error"
            },
            "EnableWaf": "false",
            "Fallback": true,
            "FallbackServices": [
              {
                "ServiceId": 353,
                "ServiceName": "service name",
                "Percent": 100,
                "Version": "v1",
                "Name": "name",
                "SourceType": "MSE\n",
                "Namespace": "Namespace",
                "GroupName": "test",
                "AgreementType": "DUBBO",
                "ServicePort": 8848
              }
            ]
          }
        ]
      }
    }

    错误码

    Http code 错误码 错误信息 描述
    400 duplicatedClusterAliasName duplicated cluster alias name 实例名称已重复,请换一个
    400 illegalRequest illegal request:%s 非法请求:%s
    400 invalidParameter parameter error:%s 请求入参异常:%s
    403 NoPermission You are not authorized to perform this operation. 没有权限使用此接口
    404 clusterNotFound cluster not found 找不到此集群
    500 systemError system error 系统开小差了,请稍后重试
    500 regcenterError register center error:%s 注册配置中心请求错误:%s

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

    变更历史

    变更时间 变更内容概要 操作
    2022-07-28 OpenAPI 返回结构发生变更
    变更项 变更内容
    出参 OpenAPI 返回结构发生变更
    2022-02-18 新增 OpenAPI
    阿里云首页 微服务引擎 相关技术圈