文档

DescribeGreyTagRoute - DescribeGreyTagRoute

更新时间:

根据规则ID查询灰度规则详情。

调试

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

授权信息

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

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

请求语法

GET /pop/v1/sam/tagroute/greyTagRoute

请求参数

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

规则 ID。

1

返回参数

名称类型描述示例值
object

返回数据。

RequestIdstring

请求 ID。

9D29CBD0-45D3-410B-9826-52F86F90****
Messagestring

调用结果的附加信息。

success
TraceIdstring

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

0a98a02315955564772843261e****
Dataobject

灰度规则信息。

GreyTagRouteIdlong

灰度规则 ID,全局唯一。

16
Namestring

规则名称。

rule-name
Descriptionstring

规则描述。

test
ScRulesarray<object>

Spring Cloud 应用的灰度规则。

object

灰度规则数据。

pathstring

Spring Cloud 应用灰度规则对应的路径。

/path
conditionstring

灰度规则的条件模式,取值说明如下:

  • AND:表示与,即同时满足条件列表中的所有条件。
  • OR:表示或,即满足条件列表中的任一条件。
OR
itemsarray<object>

条件列表。

object

条件列表数据。

typestring

比较类型。取值说明如下:

  • param:表示 Parameter。
  • cookie:表示 Cookie。
  • header:表示 Header。
cookie
namestring

参数名。

test
operatorstring

运算符。取值说明如下:

  • rawvalue:直接比较。
  • list:白名单。
  • mod:对 100 取模。
  • deterministic_proportional_steaming_division:百分比。
rawvalue
valuestring

参数取值,根据 typename 得到的值跟这个值进行比较。

test
condstring

比较操作符。可取值:><>=<===以及!=

==
indexinteger

Spring Cloud 应用不涉及。

N/A
exprstring

Spring Cloud 应用不涉及。

N/A
AlbRulesarray<object>
object
serviceIdstring

路由服务 ID。

22
ingressIdstring

网关路由 ID。

23
conditionstring

灰度规则的条件模式,当前只支持 AND:表示同时满足条件列表中的所有条件。

AND
itemsarray<object>
object
typestring

比较类型。取值说明如下:

  • sourceIp:表示 SourceIp。
  • cookie:表示 Cookie。
  • header:表示 Header。
cookie
namestring

参数名。

example
operatorstring

运算符。取值说明如下:目前只支持 rawvalue:直接比较。

rawvalue
valuestring

参数取值,根据 type 和 name 得到的值跟这个值进行比较。

test
condstring

暂支持==。

==
indexinteger

Alb 应用无需填写。

N/A
exprstring

Alb 应用无需填写。

N/A
DubboRulesarray<object>

Dubbo 服务的灰度规则。

object

灰度规则数据。

serviceNamestring

Dubbo 服务名称。

com.alibaba.edas.boot.EchoService
groupstring

灰度规则对应的 Dubbo 服务的分组。

DUBBO
versionstring

Dubbo 服务版本。

1.0.0
methodNamestring

Dubbo 服务的方法名。

echo
conditionstring

灰度规则的条件模式,取值说明如下:

  • AND:表示与,即同时满足条件列表中的所有条件。
  • OR:表示或,即满足条件列表中的任一条件。
OR
itemsarray<object>

条件列表。

object

条件列表数据。

indexinteger

参数编号,0 表示第一个参数。

0
exprstring

参数值获取表达式。取值说明如下:

  • 留空:直接取当前参数的值。
  • .name:取参数的 name 属性,相当于 args0.getName()。
  • .isEnabled() :取参数的 enabled 属性,相当于 args0.isEnabled()。
  • [0]:当前参数应是一个数组,取数组的第一个值,相当于 args0[0],注意开始没有英文句点(.)。
  • .get(0):当前参数应是一个 List,取 List 的第一个值,相当于 args0.get(0)。
  • .get("key"):当前参数是一个 Map,获取 key 对应的值,相当于 args0.get("key")。
.name
operatorstring

运算符。取值说明如下:

  • rawvalue:直接比较。
  • list:白名单。
  • mod:对 100 取模。
  • deterministic_proportional_steaming_division:百分比。
rawvalue
valuestring

参数取值,根据 exprindex 得到的值跟这个值进行比较。

test
condstring

比较操作符。可取值:><>=<===以及!=

==
typestring

Dubbo 服务不涉及。

N/A
namestring

Dubbo 服务不涉及。

N/A
CreateTimelong

规则被创建的时间戳。单位:毫秒。

1619007592013
UpdateTimelong

规则被更新的时间戳。单位:毫秒。

1609434061000
AppIdstring

应用 ID。

3faaf993-7aed-4bcd-b189-625e6a5a****
ErrorCodestring

错误码。取值说明如下:

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

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

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

查询变更单信息是否成功。取值说明如下:

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

示例

正常返回示例

JSON格式

{
  "RequestId": "9D29CBD0-45D3-410B-9826-52F86F90****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "GreyTagRouteId": 16,
    "Name": "rule-name",
    "Description": "test",
    "ScRules": [
      {
        "path": "/path",
        "condition": "OR",
        "items": [
          {
            "type": "cookie",
            "name": "test",
            "operator": "rawvalue",
            "value": "test",
            "cond": "==",
            "index": 0,
            "expr": "N/A"
          }
        ]
      }
    ],
    "AlbRules": [
      {
        "serviceId": "22",
        "ingressId": "23",
        "condition": "AND",
        "items": [
          {
            "type": "cookie",
            "name": "example",
            "operator": "rawvalue",
            "value": "test",
            "cond": "==",
            "index": 0,
            "expr": "N/A"
          }
        ]
      }
    ],
    "DubboRules": [
      {
        "serviceName": "com.alibaba.edas.boot.EchoService",
        "group": "DUBBO",
        "version": "1.0.0",
        "methodName": "echo",
        "condition": "OR",
        "items": [
          {
            "index": 0,
            "expr": ".name",
            "operator": "rawvalue",
            "value": "test",
            "cond": "==",
            "type": "N/A",
            "name": "N/A"
          }
        ]
      }
    ],
    "CreateTime": 1619007592013,
    "UpdateTime": 1609434061000,
    "AppId": "3faaf993-7aed-4bcd-b189-625e6a5a****"
  },
  "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。

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

变更历史

变更时间变更内容概要操作
暂无变更历史