首页 服务网格 ASM 开发参考 API参考指南 API目录 ASM网关 DescribeIstioGatewayRouteDetail - 查看网关路由详情

DescribeIstioGatewayRouteDetail - 查看网关路由详情

更新时间: 2023-08-28 18:11:28

调用DescribeIstioGatewayRouteDetail查看网关路由详情。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

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

服务网格实例ID。

c08ba3fd1e6484b0f8cc1ad8fe10d****
IstioGatewayNamestring

ASM网关名称。

ingressgateway
RouteNamestring

路由名称。

demo-route

返回参数

名称类型描述示例值
object

响应内容。

RouteDetailobject

路由详情

RouteNamestring

路由名称。

demo-route
RouteTypestring

路由类型,取值HTTPTLSTCP

HTTP
MatchRequestobject

路由匹配规则。

URIobject

URI匹配规则 。

MatchingModestring

路由规则匹配模式,取值:

  • exact:精准匹配。

  • prefix:前缀匹配。

  • regex:正则匹配。

prefix
MatchingContentstring

用于匹配的内容。

/ratings/v2/
Headersobject []

用于判断是否匹配的请求头部列表。

Namestring

Header匹配的键。

x-request-id
MatchingModestring

Header值匹配方式,取值:

  • exact:精准匹配。

  • prefix:前缀匹配。

  • regex:正则匹配。

exact
MatchingContentstring

用于Header匹配的内容。

v1
TLSMatchAttributesobject []

TLS连接匹配属性列表。

TLSPortinteger

TLS端口。

443
SNIHostsarray

服务器名称标识列表。

string

SNI值中可以使用通配符前缀,例如*.com将匹配foo.example.comexample.com

说明 SNI值必须是相应虚拟服务主机的子集。
*.com
Portsarray

端口列表。

integer

指定主机上要寻址的端口。

443
HTTPAdvancedOptionsobject

HTTP路由高级配置选项。

HTTPRedirectobject

HTTP重定向。

Uristring

在重定向时,使用此值覆盖URL的路径部分。

/v1/getProductRatings
Authoritystring

在重定向时,使用此值覆盖URL的Authority或Host部分。

newratings.default.svc.cluster.local
RedirectCodeinteger

在重定向上,指定要在重定向响应中使用的HTTP状态代码。默认响应代码为301。

301
Delegateobject

虚拟服务流量代理。

Namestring

名称。

reviews
Namespacestring

命名空间。

default
Rewriteobject

重写虚拟服务。

Uristring

用这个值重写URI的路径(或前缀)部分。

/v1/getProductRatings
Authoritystring

使用此值重写Authority或Host头。

newratings.default.svc.cluster.local
Timeoutstring

超时时长。

5s
Retriesobject

请求重试配置。

Attemptsinteger

给定请求允许的重试次数。

3
PerTryTimeoutstring

请求的每次尝试超时时间。

2s
RetryOnstring

用于指定重试发生的条件,例如connect-failure,refused-stream,503

connect-failure,refused-stream,503
RetryRemoteLocalitiesobject

用于指定重试是否应重试到其他位置的标志。

Valueboolean

用于指定重试是否应重试到其他位置的标志,取值:

  • true:其他位置也重试

  • false:其他位置不重试

默认false

false
Faultobject

故障注入设置。

Delayobject

设置延迟。

FixedDelaystring

固定延迟时间。

5s
ExponentialDelaystring

指数型延迟等待时间,等待时间为2的x次方,x为输入参数。

3
Percentageobject

将注入延迟的请求的百分比。

Valuefloat

使用提供的错误码中止的请求的百分比,用小数表示。

0.1
Abortobject

提前中止带有预先指定的错误码的请求。

HttpStatusinteger

HTTP状态码。

400
Percentageobject

使用提供的错误码中止的请求的百分比。

Valuefloat

流量镜像百分比。用小数表示

0.1
Mirrorobject

除了将请求转发到预期目标之外,还将HTTP通信镜像到另一个目标。

Hoststring

服务注册表中服务的名称。

reviews.default.svc.cluster.local
Subsetstring

服务中子集的名称

v1
MirrorPercentageobject

使用提供的错误码中止的请求的百分比。

Valuefloat

使用提供的错误码中止的请求的百分比,用小数表示。

0.2
RouteDestinationsobject []

L4路由规则加权目的地列表。

Destinationobject

Destination唯一标识请求或连接应转发到的服务实例。

Hoststring

服务注册表中服务的名称。

reviews
Subsetstring

服务中子集的名称。

v1
Portobject

端口列表。

Numberinteger

指定主机上要寻址的端口。

443
Weightinteger

流量权重,范围:1~100。

80
Headersobject

用于判断是否匹配的请求头部列表。

Requestobject

用于判断是否匹配的请求头部。

Setobject

用给定值覆盖键指定的Header。

string

输入Value值覆盖键Header。

key
Addobject

添加值到Header中。

key
Removearray

删除Header中的值。

string

输入要删除的Key。

key
Responseobject

返回响应前做的处理。

Setobject

用给定值覆盖键指定的Header。

key
Addobject

添加值到Header中。

key
Removearray

删除Header中的值。

string

输入要删除的Key。

key
Domainsarray

匹配的请求域名列表

string

匹配的请求域名

test.asm.aliyun.com
RawVSRoutestring

序列化为JSON的VirtualService原始YAML

{}
HasUnsafeFeaturesboolean

如果为True,说明原始YAML中包含有当前界面上不支持的特性。

true
RequestIdstring

请求ID。

31d3a0f0-07ed-4f6e-9004-1804498c****
Priorityinteger

路由优先级。整数,数字越小,优先级越高。

1
Statusinteger

网关路由状态,取值:

  • 0:在线。

  • 1:下线。

  • 2:创建或更新错误。

1
Descriptionstring

路由描述。

demo route
Namespacestring

命名空间

default

示例

正常返回示例

JSON格式

{
  "RouteDetail": {
    "RouteName": "demo-route",
    "RouteType": "HTTP",
    "MatchRequest": {
      "URI": {
        "MatchingMode": "prefix",
        "MatchingContent": "/ratings/v2/"
      },
      "Headers": [
        {
          "Name": "x-request-id",
          "MatchingMode": "exact",
          "MatchingContent": "v1"
        }
      ],
      "TLSMatchAttributes": [
        {
          "TLSPort": 443,
          "SNIHosts": [
            "*.com"
          ]
        }
      ],
      "Ports": [
        443
      ]
    },
    "HTTPAdvancedOptions": {
      "HTTPRedirect": {
        "Uri": "/v1/getProductRatings",
        "Authority": "newratings.default.svc.cluster.local",
        "RedirectCode": 301
      },
      "Delegate": {
        "Name": "reviews",
        "Namespace": "default"
      },
      "Rewrite": {
        "Uri": "/v1/getProductRatings",
        "Authority": "newratings.default.svc.cluster.local"
      },
      "Timeout": "5s",
      "Retries": {
        "Attempts": 3,
        "PerTryTimeout": "2s",
        "RetryOn": "connect-failure,refused-stream,503",
        "RetryRemoteLocalities": {
          "Value": false
        }
      },
      "Fault": {
        "Delay": {
          "FixedDelay": "5s",
          "ExponentialDelay": "3",
          "Percentage": {
            "Value": 0.1
          }
        },
        "Abort": {
          "HttpStatus": 400,
          "Percentage": {
            "Value": 0.1
          }
        }
      },
      "Mirror": {
        "Host": "reviews.default.svc.cluster.local",
        "Subset": "v1"
      },
      "MirrorPercentage": {
        "Value": 0.2
      }
    },
    "RouteDestinations": [
      {
        "Destination": {
          "Host": "reviews",
          "Subset": "v1",
          "Port": {
            "Number": 443
          }
        },
        "Weight": 80,
        "Headers": {
          "Request": {
            "Set": {
              "key": "key"
            },
            "Add": {
              "test": "test",
              "test2": 1
            },
            "Remove": [
              "key"
            ]
          },
          "Response": {
            "Set": {
              "test": "test",
              "test2": 1
            },
            "Add": {
              "test": "test",
              "test2": 1
            },
            "Remove": [
              "key"
            ]
          }
        }
      }
    ],
    "Domains": [
      "test.asm.aliyun.com"
    ],
    "RawVSRoute": "{}",
    "HasUnsafeFeatures": true
  },
  "RequestId": "31d3a0f0-07ed-4f6e-9004-1804498c****",
  "Priority": 1,
  "Status": 1,
  "Description": "demo route",
  "Namespace": "default"
}

错误码

HTTP status code错误码错误信息描述
500ERR500An internal server error occurred.后端服务异常

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

变更历史

变更时间变更内容概要操作
2023-06-25OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:500
出参OpenAPI 返回结构发生变更
阿里云首页 服务网格 ASM 相关技术圈