DescribeSwimmingLane - 查询泳道详情

查询泳道详情。

调试

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

授权信息

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

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

请求语法

GET /pop/v1/cas/gray/describeSwimmingLane HTTP/1.1

请求参数

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

命名空间 ID。

cn-beijing:test
GroupIdlong

泳道组 ID。

2074
LaneIdlong

泳道 ID。

9637

返回参数

名称类型描述示例值
object

返回信息。

RequestIdstring

请求 ID。

30375C38-F4ED-4135-A0AE-5C75DC7F****
Messagestring

调用结果的附加信息。取值说明如下:

  • 请求正常,返回 success
  • 请求异常,返回具体异常错误码。
success
TraceIdstring

调用链 ID,用于精确查询调用信息。

0a98a02315955564772843261e****
Dataobject

返回结果。

LaneIdlong

泳道 ID。

9488
LaneNamestring

泳道组名称。

mse-test
LaneTagstring

泳道标签。

{"alicloud.service.tag":"g1"}
Enableboolean

泳道状态:

  • true:开启
  • false:关闭
true
EnableRulesboolean

是否开启了流量规则。

true
CanaryModelinteger

全链路灰度模式:

  • 0: 按请求内容路由

  • 1: 按比例路由

0
Appsarray<object>

应用信息。

appobject

应用信息。

AppIdstring

应用 ID。

6b4c0f64-f679-4580-8105-91eac4******
AppNamestring

应用名称。

test
MseAppIdstring

MSE 实例 ID。

mse-cn-53y49******
MseAppNamestring

MSE 实例名称。

sae-test
mseNamespaceIdstring

MSE 命名空间 ID。

6733e538-d52f-48e6-91a4-192f91******
AppEntryRuleobject

应用入口规则。

Pathsarray

请求路径。

pathstring

URL 路径。

/Path
Percentageinteger

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

50
ConditionJoinerstring

条件之间的逻辑连接符:

  • AND:同时满足所有条件
  • OR:满足任意条件
AND
Conditionsarray<object>

匹配条件。

conditionobject

条件项。

Typestring

参数类型。

Header
Namestring

参数名称。

t
Conditionstring

匹配规则。

==
Valuestring

条件的匹配值。

g1
Valuesarray

条件的匹配值。

valuestring

条件的匹配值。

g1
IndependentPercentageEnableboolean

是否启用按比例灰度。

true
PercentageByPathobject

流量匹配。

integer

流量比例。

100
MseGatewayEntryRuleobject

MSE 网关路由。

RouteIdsarray

路由 ID 列表。

routeIdlong

路由 ID。

["1001","1002"]
Routesarray<object>

路由规则的详细配置。

routeobject

路由配置。

RouteIdlong

路由 ID。

9504
RouteNamestring

路由名称。

demo
RoutePredicateobject

路由规则。

PathPredicateobject

路径匹配规则。

Pathstring

路径。

/Path
Typestring

匹配规则。

Header
Percentageinteger

路径流量比例。

100
Conditionsarray<object>

匹配条件。

conditionobject

条件项。

Typestring

参数类型。

Header
Namestring

参数名称。

t
Conditionstring

匹配规则。

==
Valuestring

条件的匹配值。

g1
PercentageByRouteobject

流量配置。

integer

配置流量比例,范围为 1~100。

100
IndependentPercentageEnableboolean

是否启用按比例灰度。

true
ConditionJoinerstring

条件之间的逻辑连接符。

AND
ErrorCodestring

错误码。取值说明如下:

  • 请求成功:不返回 ErrorCode 字段。
  • 请求失败:返回 ErrorCode 字段。具体信息,请参见本文的错误码列表。
Codestring

接口状态或 POP 错误码。取值说明如下:

  • 2xx:成功。
  • 3xx:重定向。
  • 4xx:请求错误。
  • 5xx:服务器错误。
200
Successboolean

是否成功。取值说明如下:

  • true:查询成功。
  • false:查询失败。
true

示例

正常返回示例

JSON格式

{
  "RequestId": "30375C38-F4ED-4135-A0AE-5C75DC7F****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "LaneId": 9488,
    "LaneName": "mse-test",
    "LaneTag": {
      "alicloud.service.tag": "g1"
    },
    "Enable": true,
    "EnableRules": true,
    "CanaryModel": 0,
    "Apps": [
      {
        "AppId": "6b4c0f64-f679-4580-8105-91eac4******",
        "AppName": "test",
        "MseAppId": "mse-cn-53y49******",
        "MseAppName": "sae-test",
        "mseNamespaceId": "6733e538-d52f-48e6-91a4-192f91******"
      }
    ],
    "AppEntryRule": {
      "Paths": [
        "/Path"
      ],
      "Percentage": 50,
      "ConditionJoiner": "AND",
      "Conditions": [
        {
          "Type": "Header",
          "Name": "t",
          "Condition": "==",
          "Value": "g1",
          "Values": [
            "g1"
          ]
        }
      ],
      "IndependentPercentageEnable": true,
      "PercentageByPath": {
        "key": 100
      }
    },
    "MseGatewayEntryRule": {
      "RouteIds": [
        0
      ],
      "Routes": [
        {
          "RouteId": 9504,
          "RouteName": "demo\n",
          "RoutePredicate": {
            "PathPredicate": {
              "Path": "/Path",
              "Type": "Header"
            }
          }
        }
      ],
      "Percentage": 100,
      "Conditions": [
        {
          "Type": "Header",
          "Name": "t",
          "Condition": "==",
          "Value": "g1"
        }
      ],
      "PercentageByRoute": {
        "key": 100
      },
      "IndependentPercentageEnable": true,
      "ConditionJoiner": "AND"
    }
  },
  "ErrorCode": "空",
  "Code": 200,
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameter.NotEmptyYou must specify the parameter %s.不合法的参数:%s不能为空。
400InvalidParameter.ObviouslyThe specified parameter is invalid {%s}.不合法的参数{%s}。
400InvalidParameter.WithMessageThe parameter is invalid {%s}: %s不合法的参数{%s}:%s。
400MseGatewayRule.CreateFailedCreate MSE Gateway rule failed.创建MSE微服务网关路由失败。
400InternalApiErrorAn exception occurred when calling mse:%s, error message: %s.调用 mse:%s 接口异常,%s

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