文档

ListGatewayRouteOnAuth - 获取开启鉴权的路由列表

更新时间:

获取开启鉴权的路由列表。

调试

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

授权信息

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

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

请求参数

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

网关唯一标识 ID。

gw-c9bc5afd61014165bd58f621b491****
Typestring

鉴权类型:

  • JWT
JWT
AcceptLanguagestring

返回信息的语言类型:

  • zh:中文
  • en:英文
zh

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

58E06A0A-BD2C-47A0-99C2-B100F353****
HttpStatusCodeinteger

HTTP 状态码。

200
Messagestring

返回信息。

请求处理成功
Codeinteger

响应码。

200
Successboolean

请求结果,取值如下:

  • true:请求成功。
  • false:请求失败。
true
Dataarray<object>

数据概览。

object

节点数据。

Idinteger

路由 ID。

12
Namestring

路由名称。

ceshi
GatewayUniqueIdstring

网关唯一标识 ID。

gw-7ea3da97b96543e19f6c597c****
GatewayIdstring

网关 ID。

399
RoutePredicatesobject

路由匹配。

PathPredicatesobject

路由匹配。

Pathstring

路径。

/api
Typestring

匹配类型。

PRE
DomainIdlong

域名 ID。

235
DomainNamestring

域名。

123.com
DomainIdListarray

域名 ID 列表。

long

域名 ID 列表。

1
DomainNameListarray

域名列表。

string

域名列表。

test.com

示例

正常返回示例

JSON格式

{
  "RequestId": "58E06A0A-BD2C-47A0-99C2-B100F353****",
  "HttpStatusCode": 200,
  "Message": "请求处理成功",
  "Code": 200,
  "Success": true,
  "Data": [
    {
      "Id": 12,
      "Name": "ceshi",
      "GatewayUniqueId": "gw-7ea3da97b96543e19f6c597c****",
      "GatewayId": "399",
      "RoutePredicates": {
        "PathPredicates": {
          "Path": "/api",
          "Type": "PRE"
        }
      },
      "DomainId": 235,
      "DomainName": "123.com",
      "DomainIdList": [
        1
      ],
      "DomainNameList": [
        "test.com"
      ]
    }
  ]
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2023-08-24API 内部配置变更,不影响调用查看变更详情