文档

QueryAllSwimmingLane - 查询当前泳道组内所有泳道

更新时间:

用于查询当前泳道组内所有泳道。

调试

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

授权信息

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

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

请求参数

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

MSE 命名空间名字

default
GroupIdlong

泳道组 ID

186
AcceptLanguagestring

返回信息的语言类型:

  • zh:中文
  • en:英文
zh

返回参数

名称类型描述示例值
object

RestResult

RequestIdstring

请求 ID。

DC34E4A3-5F1C-4E40-86EA-02EDF967****
Successboolean

请求结果,取值如下:

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

错误码。

Success
Messagestring

返回信息。

OK
Dataobject []

数据概览。

[{id:100,name:"test"}]
Namestring

泳道组名称。

swimmingGroup
UserIdstring

泳道所属的用户 id。

12345
MessageQueueFilterSidestring

在哪一侧实现消息灰度。

Client
Namespacestring

泳道所属的 MSE 命名空间。

default
RecordCanaryDetailboolean

是否记录请求详情(全链路灰度可观测)。

false
Idlong

泳道组 Id。

123
RegionIdstring

所属地域。

cn-hangzhou
MessageQueueGrayEnableboolean

是否开启消息灰度。

false
enableRulesboolean

是否开启规则。

true
EntryRulesobject []

入口应用规则列表

pathsarray

路径列表

string

路径

/
pathstring

路径

/adump/wxb/prod
conditionstring

条件

AND
restItemsobject []

Rest 匹配规则列表

typestring

匹配类型

cookie
namestring

名称

test
operatorstring

操作符

rawvalue
nameListarray

匹配列表

string

匹配名称

test
datumstring

数值

x
condstring

匹配符

==
divisorinteger

除数

10
remainderinteger

余数

10
rateinteger

百分比

30
valuestring

test
gmtCreatestring

泳道创建时间。

1683598484000
gmtModifiedstring

泳道更新时间。

1683598484000
groupIdstring

泳道组 Id。

72709
GroupIdstring

泳道组 Id。

6859
tagstring

泳道对应的标签。

gray
Tagstring

泳道对应的标签。

gray
GatewaySwimmingLaneRouteobject

网关路由信息(使用云原生网关为入口时使用)

GatewayIdlong

网关 ID

1
GatewayUniqueIdstring

网关唯一 ID

gw-84efde2ee1464260bdb17a5b****
RouteIdListarray

路由 ID 列表

long
1
CanaryModelinteger

全链路灰度模式:

  • 0: 按请求内容路由

  • 1: 按比例路由

0
Conditionsobject []

匹配条件列表(按内容路由使用)

Namestring

参数名称

name
Valuestring

参数值

xiaoming
Typestring

参数类型:

  • header:Header
  • param:Parameter
header
Condstring

条件:

  • PRE:前缀匹配
  • EQUAL:精确匹配
  • ERGULAR:正则匹配
PRE
Percentageinteger

流量比例(按比例路由使用,取值 0-100)

20

示例

正常返回示例

JSON格式

{
  "RequestId": "DC34E4A3-5F1C-4E40-86EA-02EDF967****",
  "Success": true,
  "ErrorCode": "Success",
  "Message": "OK",
  "Data": [
    {
      "Name": "swimmingGroup",
      "UserId": "12345",
      "MessageQueueFilterSide": "Client",
      "Namespace": "default",
      "RecordCanaryDetail": false,
      "Id": 123,
      "RegionId": "cn-hangzhou",
      "MessageQueueGrayEnable": false,
      "enableRules": true,
      "EntryRules": [
        {
          "paths": [
            "/"
          ],
          "path": "/adump/wxb/prod",
          "condition": "AND",
          "restItems": [
            {
              "type": "cookie",
              "name": "test",
              "operator": "rawvalue",
              "nameList": [
                "test"
              ],
              "datum": "x",
              "cond": "==",
              "divisor": 10,
              "remainder": 10,
              "rate": 30,
              "value": "test"
            }
          ]
        }
      ],
      "gmtCreate": "1683598484000",
      "gmtModified": "1683598484000",
      "groupId": "72709",
      "GroupId": "6859",
      "tag": "gray",
      "Tag": "gray",
      "GatewaySwimmingLaneRoute": {
        "GatewayId": 1,
        "GatewayUniqueId": "gw-84efde2ee1464260bdb17a5b****",
        "RouteIdList": [
          1
        ],
        "CanaryModel": 0,
        "Conditions": [
          {
            "Name": "name",
            "Value": "xiaoming",
            "Type": "header",
            "Cond": "PRE"
          }
        ],
        "Percentage": 20
      }
    }
  ]
}

错误码

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-03-14OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-06-26OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-06-08OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-05-05OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-04-28OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-03-30OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Namespace
  • 本页导读 (1)
文档反馈