文档

QueryAllSwimmingLaneGroup - 查询所有泳道组

更新时间:

用于查询所有泳道组。

调试

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

授权信息

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

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

请求参数

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

需要查询的 MSE 命名空间名字。

default
AcceptLanguagestring

返回信息的语言类型:

  • zh:中文
  • en:英文
zh

返回参数

名称类型描述示例值
object

RestResult

RequestIdstring

请求 id。

54973C90-F379-4372-9AA5-053A3F7****
Successboolean

请求结果,取值如下:

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

code 仅仅用来和 success 同步。

200
ErrorCodestring

错误码。

mse-100-000
HttpStatusCodeinteger

http 状态码。

200
Messagestring

返回信息。

  • 当请求成功时,返回成功信息。
  • 当请求失败时,返回失败原因。
请求处理成功
DynamicMessagestring

动态错误信息中的占位符。

The specified parameter is invalid.
Dataobject []

数据概览。

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

泳道组名称。

swimmingGroup
UserIdstring

泳道所属的用户 ID。

12345
MessageQueueFilterSidestring

在哪一侧开启消息灰度。

Client
AppIdsstring

应用 Id 列表。

abcde@abcde,abcde@abcde
Namespacestring

泳道所属的 MSE 命名空间。

default
RecordCanaryDetailboolean

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

false
Idlong

泳道组 ID。

123
EntryAppstring

入口应用类型和入口应用 ID。

mse:abcde@abcde
Regionstring

所属地域。

cn-hangzhou
MessageQueueGrayEnableboolean

是否开启消息灰度。

true

示例

正常返回示例

JSON格式

{
  "RequestId": "54973C90-F379-4372-9AA5-053A3F7****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "mse-100-000",
  "HttpStatusCode": 200,
  "Message": "请求处理成功",
  "DynamicMessage": "The specified parameter is invalid.",
  "Data": [
    {
      "Name": "swimmingGroup",
      "UserId": "12345",
      "MessageQueueFilterSide": "Client",
      "AppIds": "abcde@abcde,abcde@abcde",
      "Namespace": "default",
      "RecordCanaryDetail": false,
      "Id": 123,
      "EntryApp": "mse:abcde@abcde",
      "Region": "cn-hangzhou",
      "MessageQueueGrayEnable": 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

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

变更历史

变更时间变更内容概要操作
2023-03-30OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-03-22OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈